UIListContacts

来自于:官方立即使用

概述(Beta版)

UIListContacts 展示了一个联系人列表。开发者只需传入数据源,模块会自动将联系人排序,展示出来。列表右侧字母导航条会自动随联系人数量调整。

列表条目(cell)布局如下图所示:

open

打开列表

open({params}, callback(ret))

params

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 内部字段:
{
    x: 0,   //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
    y: 0,   //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
    w: 320, //(可选项)数字类型;模块的宽度;默认:所属的 Window 或 Frame 的宽度
    h: 200  //(可选项)数字类型;模块的高度;默认:w * 2.0/3.0
}

contacts:

  • 类型:数组对象
  • 描述:列表数据源
  • 内部字段:
[{               
       remark: '艾雪瑞',           //字符串类型;条目的标题,不传则不显示
       phonetic: 'aixuerui',      //字符串类型;标题的拼音表示
       dept_name: '创达集团',      //字符串类型;条目的子标题,不传则不显示
       position: '员工'           //字符串类型;条目的职位,不传则不显示
}]

headHidden:

  • 类型:布尔
  • 描述:(可选项)是否隐藏头像和名字后面的职务标签(position)
  • 默认:false

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:模块依附于当前 window

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   eventType: 'show', //字符串类型;交互事件类型,取值范围如下:
                      //show:模块打开,数据排序成功显示在屏幕事件
                      //click:用户点击事件
   key: 'A',          //字符串类型;被点击的条目所在的区域的标题,仅当 eventType 为 click 时有值
   section: 0,        //数字类型;被点击的条目所在的区域在所有区域中的索引,仅当 eventType 为 click 时有值
   index: 0,          //数字类型;被点击的条目在所在区域内的索引,仅当 eventType 为 click 时有值
   contact: {}        //JSON 对象;所选条目的联系人信息,内容同传入的数据一致,仅当 eventType 为 click 时有值
}

示例代码

var UIListContacts = api.require('UIListContacts');
            UIListContacts.open({
                rect : {
                    x : 0,
                    y : 44,
                    w : api.frameWidth,
                    h : api.frameHeight - 104
                },
                contacts : [{
                    "employee_id" : 191,
                    "remark" : "王科研",
                    "phonetic" : "WangKeYang", //名字的拼音
                    "namephonetic" : "WangKeYang88",
                    "position" : "研发",
                    "dept_id" : "002000",
                    "isdeleted" : "N",
                    "tags" : "",
                    "dept_name" : "创达集团",
                    "isremark" : 1,
                    "phones" : [{
                        "phone" : "13366148872",
                        "type" : "1"
                    }]
                }, {
                    "employee_id" : 192,
                    "remark" : "艾瑞雪",
                    "phonetic" : "WangKeYang", //名字的拼音
                    "namephonetic" : "WangKeYang88",
                    "position" : "研发",
                    "dept_id" : "002000",
                    "isdeleted" : "N",
                    "tags" : "",
                    "dept_name" : "创达集团",
                    "isremark" : 1,
                    "phones" : [{
                        "phone" : "13366148872",
                        "type" : "1"
                    }]
                }, {
                    "employee_id" : 193,
                    "remark" : "秋风疾",
                    "phonetic" : "WangKeYang88", //名字的拼音
                    "namephonetic" : "WangKeYang88",
                    "position" : "研发",
                    "dept_id" : "002000",
                    "isdeleted" : "N",
                    "tags" : "",
                    "dept_name" : "创达集团",
                    "isremark" : 1,
                    "phones" : [{
                        "phone" : "13366148872",
                        "type" : "1"
                    }]
                }],
                fixedOn : api.frameName
            }, function(ret) {
                if (ret) {
                    alert(JSON.stringify(ret));
                }
            });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

close

关闭列表模块

close()

示例代码

var UIListContacts = api.require('UIListContacts');
UIListContacts.close();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hide

隐藏列表模块,并没有从内存里清除

hide()

示例代码

var UIListContacts = api.require('UIListContacts');
UIListContacts.hide();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

show

显示已隐藏的列表模块

show()

示例代码

var UIListContacts = api.require('UIListContacts');
UIListContacts.show();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reloadData

刷新列表数据

reloadData({params})

params

contacts:

  • 类型:JSON 对象
  • 描述:列表数据源
  • 内部字段:
[{               
       name: '艾雪瑞',         //字符串类型;条目的标题,不传则不显示
       phonetic: 'aixuerui',  //字符串类型;标题的拼音表示
       remark: '创达集团',     //字符串类型;条目的子标题,不传则不显示
       position: '员工'       //字符串类型;条目的职位,不传则不显示
}]

示例代码

var UIListContacts = api.require('UIListContacts');
UIListContacts.reloadData({
    contacts:[{
        "employee_id": 191,
        "name": "刘德华",
        "phonetic": "WangKeYang",//名字的拼音
        "namephonetic": "WangKeYang88",
        "remark": "备注",
        "position": "研发",
        "dept_id": "002000",
        "isdeleted": "N",
        "tags": "",
        "dept_name": "",
        "isremark": 1,
        "phones": [
            {
            "phone": "13366148872",
            "type": "1"
            }
        ]
    },{
        "employee_id": 192,
        "name": "张学友",
        "phonetic": "WangKeYang",//名字的拼音
        "namephonetic": "WangKeYang88",
        "remark": "备注",
        "position": "研发",
        "dept_id": "002000",
        "isdeleted": "N",
        "tags": "",
        "dept_name": "",
        "isremark": 1,
        "phones": [
            {
            "phone": "13366148872",
            "type": "1"
            }
        ]
    },{
        "employee_id": 193,
        "name": "郭富城",
        "phonetic": "WangKeYang88",//名字的拼音
        "namephonetic": "WangKeYang88",
        "remark": "备注",
        "position": "研发",
        "dept_id": "002000",
        "isdeleted": "N",
        "tags": "",
        "dept_name": "",
        "isremark": 1,
        "phones": [
            {
            "phone": "13366148872",
            "type": "1"
            }
        ]
    }]
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本