complexPicker.d.ts 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. /**
  2. * 选人与部门 请求参数定义
  3. * @apiName biz.contact.complexPicker
  4. */
  5. export interface IBizContactComplexPickerParams {
  6. /** 标题 */
  7. title?: string;
  8. /** 企业的corpId */
  9. corpId?: string;
  10. /** 是否多选 */
  11. multiple?: boolean;
  12. /** 超过限定人数返回提示 */
  13. limitTips?: string;
  14. /** 选人组件,用户未选择人的时候,左下角的提示文案 */
  15. pickTips?: string;
  16. /** 最大可选人数 */
  17. maxUsers?: number;
  18. /** 已选用户 */
  19. pickedUsers?: string[];
  20. /** 已选部门 */
  21. pickedDepartments?: string[];
  22. /** 不可选用户 */
  23. disabledUsers?: string[];
  24. /** 不可选部门 */
  25. disabledDepartments?: string[];
  26. /** 必选用户(不可取消选中状态) */
  27. requiredUsers?: string[];
  28. /** 必选部门(不可取消选中状态) */
  29. requiredDepartments?: string[];
  30. /** 微应用的Id */
  31. appId?: number;
  32. /** 选人权限,目前只有GLOBAL这个参数 */
  33. permissionType?: string;
  34. /** 返回人,或者返回人和部门 */
  35. responseUserOnly?: boolean;
  36. /** 0表示从企业最上层开始 */
  37. startWithDepartmentId?: number;
  38. /** 上游业务来源 */
  39. origin?: number;
  40. /** 上游业务来源描述 */
  41. originMeta?: string;
  42. /** 只支持移动端,可以直接跳到具体部门。-1 表示根部门,0 表示当前部门(startWithDepartmentId需要传2,depId才生效) */
  43. deptId?: number;
  44. }
  45. /**
  46. * 选人与部门 返回结果定义
  47. * @apiName biz.contact.complexPicker
  48. */
  49. export interface IBizContactComplexPickerResult {
  50. /** 选择人数 */
  51. selectedCount: number;
  52. /** 返回选人的列表,列表中的对象包含name(用户名),avatar(用户头像),emplId(用户工号)三个字段 */
  53. users?: Array<{
  54. name: string;
  55. avatar: string;
  56. /** 用户工号 */
  57. emplId: string;
  58. /** 员工部门 id */
  59. selectDeptId?: number;
  60. /** 员工部门名称 */
  61. selectDeptName?: string;
  62. }>;
  63. /** 返回已选部门列表,列表中每个对象包含id(部门id)、name(部门名称)、number(部门人数) */
  64. departments?: Array<{
  65. id: string;
  66. name: string;
  67. number: string;
  68. }>;
  69. }
  70. /**
  71. * 选人与部门
  72. * 支持选择部门后,把所选部门转换成对应部门下的人,permissionType可以添加权限校验
  73. * @apiName biz.contact.complexPicker
  74. * @supportVersion ios: 2.9.0 android: 2.9.0 pc: 4.3.5
  75. * @author iOS:晓毒; Android:几米;
  76. */
  77. export declare function complexPicker$(params: IBizContactComplexPickerParams): Promise<IBizContactComplexPickerResult>;
  78. export default complexPicker$;