complexPicker.d.ts 3.2 KB

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