# 通讯录选人、部门、群组

# 选人和选部门

# 使用说明

支持选人和选部门。选择部门后,把所选部门转换成对应部门下的人。

Android iOS PC 是否需要鉴权
支持 支持 支持 需要
// 全量引入调用方式
yy.biz.contact.complexPicker({
  title: "测试标题", //标题
  corpId: "xxx", //企业的corpId
  multiple: true, //是否多选
  limitTips: "超出了", //超过限定人数返回提示
  maxUsers: 1000, //最大可选人数
  pickedUsers: [], //已选用户
  pickedDepartments: [], //已选部门
  disabledUsers: [], //不可选用户
  disabledDepartments: [], //不可选部门
  requiredUsers: [], //必选用户(不可取消选中状态)
  requiredDepartments: [], //必选部门(不可取消选中状态)
  appId: 158, //应用的Id
  groupId: '2803561600', // 定位到某个群
  groupName: 'xxxx', // 群聊名称
  //permissionType:"xxx",          //可添加权限校验,选人权限,目前只有GLOBAL这个参数
  //responseUserOnly:false,        //返回人,或者返回人和部门
  //startWithDepartmentId:0 ,   //仅支持0和-1
  onSuccess: function (result) {
    /**
        {
            selectedCount:1,                              //选择人数
            users:[{"name":"","avatar":"","userid":""}],//返回选人的列表,列表中的对象包含name(用户名),avatar(用户头像),emplId(用户工号)三个字段
            departments:[{"id":,"name":"","number":}]//返回已选部门列表,列表中每个对象包含id(部门id)、name(部门名称)、number(部门人数)
        }
        */
  },
  onFail: function (err) {}
});

// 按需加载调用方式,参数与全量引入相同
complexPicker({...});

# 参数说明

参数 参数类型 说明
title String 标题
corpId String 企业的 corpId
multiple Boolean 是否多选
limitTips String 超过限定人数返回提示
maxUsers Number 最大可选人数
pickedUsers Array[String] 已选用户
pickedDepartments Array[String] 已选部门
disabledUsers Array[String] 不可选用户
disabledDepartments Array[String] 不可选部门
requiredUsers Array[String] 必选用户 (不可取消选中状态)
requiredDepartments Array[String] 必选部门 (不可取消选中状态)
appId Number 应用 id
groupId Number 群 id, groupId 与 groupName 需同时存在
groupName Number 群名称,groupId 与 groupName 需同时存在
showGroups Boolean 是否展示我的群组入口
showPartner Boolean 是否展示我的伙伴入口,默认为 false
permissionType String 暂时没用  ,可不传选人权限,目前只有 GLOBAL 这个参数
responseUserOnly Boolean true:返回部门和人员信息;
false:只返回部门信息
startWithDepartmentId Number 暂时没用,可不传 0 表示从企业最上层开始
-1 表示从自己所在部门开始

# 返回说明

参数 说明
selectedCount 选择人数
users 返回选人的列表,列表中的对象包含 name (用户名)、avatar (用户头像)、userid (用户工号)三个字段
departments 返回已选部门列表,列表中每个对象包含 id (部门 id)、name (部门名称)、number (部门人数)

# 调试

biz.contact.complexPicker

# 选择部门信息

# 使用说明

接口会返回部门的信息,是以部门为维度,不是以人为维度。

Android iOS PC 是否需要鉴权
支持 支持 支持 需要
// 全量引入调用方式
yy.biz.contact.departmentsPicker({
  title: "测试标题", //标题
  corpId: "xxx", //企业的corpId
  multiple: true, //是否多选
  limitTips: "超出了", //超过限定人数返回提示
  maxDepartments: 100, //最大选择部门数量
  pickedDepartments: [], //已选部门
  disabledDepartments: [], //不可选部门
  requiredDepartments: [], //必选部门(不可取消选中状态)
  appId: 158, //微应用的Id
  //permissionType:"xxx",          //选人权限,目前只有GLOBAL这个参数
  onSuccess: function (result) {
    /**
      {
        userCount:1,                              //选择人数
        departmentsCount:1,//选择的部门数量
        departments:[{"id":,"name":"","number":}]//返回已选部门列表,列表中每个对象包含id(部门id)、name(部门名称)、number(部门人数)
      }
      */
  },
  onFail: function (err) {}
});

// 按需加载调用方式,参数与全量引入相同
departmentsPicker({...});

# 参数说明

参数 参数类型 说明
title String 标题
corpId String 企业的 corpId
multiple Boolean 是否多选
limitTips String 超过限定人数返回提示
maxDepartments Number 最大可选部门数
pickedDepartments Array[String] 已选部门
disabledDepartments Array[String] 不可选部门
requiredDepartments Array[String] 必选部门 (不可取消选中状态)
appId Number 应用的 Id
permissionType String 暂时没用,可不传选人权限,目前只有 GLOBAL 这个参数

# 返回说明

参数 说明
userCount 选择人数
departmentsCount 选择的部门数
departments 返回已选部门列表,列表中每个对象包含 id (部门 id)、name (部门名称)、number (部门人数)

# 调试

biz.contact.departmentsPicker

# 选择群组

# 使用说明

支持选择群组。

Android iOS PC 是否需要鉴权
支持 支持 支持 需要
// 全量引入调用方式
yy.biz.group.groupComplexPicker({
  title: '测试'; //标题
  corpId: '1'; //企业的corpId
  multiple: true; //是否多选
  limitTips: '超出了',//超过限定群组返回提示
  maxGroups: 100 //最大可选群组数量
  pickedGroups: [];  //已选群组
  disabledGroups: []; //不可选群组
  onSuccess: function (result) {
    /**
       {
         groupCount:1,//选择的群组数量
         groups:[{"id":,"name":"","number":,"avatar"}]//返回已选群组列表,列表中每个对象包含id(群id)、name(群名称)、number(群人数)avatar(群头像)
     }
        */
  },
  onFail: function (err) {}
});

// 按需加载调用方式,参数与全量引入相同
groupComplexPicker({...});

# 参数说明

参数 参数类型 说明
title String 标题
corpId String 企业的 corpId
multiple Boolean 是否多选
limitTips String 超过限定群组返回提示
maxGroups Number 最大可选群组数
pickedGroups Array[String] 已经选择群组
disabledGroups Array[String] 不可选用群组
requiredGroups Array[String] 必须选用群组

# 返回说明

参数 说明
groupCount 已经选择群组数量
groups 返回已选群组列表,列表中每个对象包含id(群id)、name(群名称)、number(群人数)avatar(群头像)

# 调试

biz.group.groupComplexPicker
上次更新: 9/23/2020, 1:04:43 AM
foo