通讯录
选择部门和人
使用说明
客户端 | Android | iOS | PC |
---|---|---|---|
支持说明 | 支持 | 支持 | 支持 |
const params = {
maxUsers: 20,
pickedUsers:[21866056,65446616],
pickedDepartments:[10093492,10009041]
};
window.ksoxz_sdk.chooseContact({
params,
onSuccess,
onError,
})
参数说明
参数 | 类型 | 是否必须 | 描述 | 备注 |
---|---|---|---|---|
title | string | 否 | 选择页面的标题 | PC 不支持,PC 的 UI 没有主标题 |
multiple | boolean | 否 | 是否多选 | 默认为 true;false 表示单选,true 表示多选 |
maxUsers | number | 是 | 选择用户的上限 | / |
pickedUsers | number[] | 否 | 已选成员 ID | / |
pickedDepartments | number[] | 否 | 已选部门 ID | / |
returnUserOnly | boolean | 否 | 是否只返回用户列表 | 默认为 false;false 表示:返回选中的成员和部门;true 表示:只返回用户列表,当选中部门时,会返回部门下的所有成员,而不返回选中的部门 |
dataSourceUsers | number[] | 否 | 用已有的数据展示 | 选用此参数时,通讯录列表仅展示此参数下的人员清单 |
isSupportSelectDepartment | boolean | 否 | 是否可选部门 | 默认为 true;false 表示:不可选成员部门;true 表示:可选成员部门 |
showGroupEntrance | boolean | 否 | 是否显示群聊入口 | 默认为 false |
isSupportSelectGroupMember | boolean | 否 | 是否可以选择群聊成员 | 默认为 true |
返回结果
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
users | user[] | 选中的用户集合 | |
departments | department[] | 选中的部门集合 | |
groups | group[] | 选中的群聊集合 |
user 对象
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
userId | number | 用户 id | |
userName | string | 用户姓名 | |
avatar | string | 用户头像 | |
companyId | number | 企业 id |
department 对象
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
companyId | number | 企业 id | |
departmentId | string | 部门 id | |
departmentName | string | 部门名称 |
group 对象
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
chatId | number | 群聊 id | |
chatName | string | 群聊名称 |
创建群聊
使用说明
客户端 | Android | iOS | PC |
---|---|---|---|
支持说明 | 支持 | 支持 | 支持 |
window.ksoxz_sdk.createGroupChat({
onSuccess,
onError,
})
返回结果
状态 | 参数 | 类型 | 描述 | 备注 |
---|---|---|---|---|
状态 | status | string | 返回创建的状态 | success、error |
错误码 | code | string | 错误码 | 0006、0007 |
描述 | msg | string | 错误码描述 | 0006: 已经调起通讯录、进入已有群聊或者取消创建群 0007:其他异常 |
群成员选择器
使用说明
客户端 | Android | iOS | PC |
---|---|---|---|
支持说明 | / | / | 支持 |
const params = {
chatid: 1266863,
checkYourself: true,
maxUsers: 20,
pickedUsers: [21866056,65446616]
};
window.ksoxz_sdk.chooseGroupMember({
params,
onSuccess,
onError,
})
参数说明
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
chatid | number | 群聊的 chatid | |
checkYourself | boolean | 是否默认选中自己 | 默认是 false; false 表示成员列表中不会默认选中自己;true 表示成员列表中默认选中自己; |
maxUsers | number | 选择用户的上限 | |
pickedUsers | number[] | 已选成员 ID |
返回结果
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
users | user[] | 用户集合 |
user
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
userId | number | 用户 id | |
userName | string | 用户姓名 | |
avatar | string | 用户头像 |