程序包 com.lark.oapi.service.contact.v3.model

类 User.Builder

java.lang.Object
com.lark.oapi.service.contact.v3.model.User.Builder
封闭类:
User
public static class User.Builder extends Object

  • 构造器详细资料

    • Builder

      public Builder()

  • 方法详细资料

    • unionId

      public User.Builder unionId(String unionId)
      用户的union_id，应用开发商发布的不同应用中同一用户的标识，不同ID的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)

      示例值：on_94a1ee5551019f18cd73d9f111898cf2

      参数:
      unionId -
      返回:

    • userId

      public User.Builder userId(String userId)
      用户的user_id，租户内用户的唯一标识，不同ID的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)

      示例值：3e3cf96b

      参数:
      userId -
      返回:

    • openId

      public User.Builder openId(String openId)
      用户的open_id，应用内用户的唯一标识，不同ID的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)

      示例值：ou_7dab8a3d3cdcc9da365777c7ad535d62

      参数:
      openId -
      返回:

    • name

      public User.Builder name(String name)
      用户名

      示例值：张三

      参数:
      name -
      返回:

    • enName

      public User.Builder enName(String enName)
      英文名

      示例值：San Zhang

      参数:
      enName -
      返回:

    • nickname

      public User.Builder nickname(String nickname)
      别名

      示例值：Alex Zhang

      参数:
      nickname -
      返回:

    • email

      public User.Builder email(String email)
      邮箱;;注意：;1. 非中国大陆手机号成员必须同时添加邮箱;2. 邮箱不可重复

      示例值：zhangsan@gmail.com

      参数:
      email -
      返回:

    • mobile

      public User.Builder mobile(String mobile)
      手机号，在本企业内不可重复；未认证企业仅支持添加中国大陆手机号，通过飞书认证的企业允许添加海外手机号，注意国际电话区号前缀中必须包含加号 +

      示例值：13011111111 (其他例子，中国大陆手机号: 13011111111 或 +8613011111111, 非中国大陆手机号: +41446681800)

      参数:
      mobile -
      返回:

    • mobileVisible

      public User.Builder mobileVisible(Boolean mobileVisible)
      手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码

      示例值：false

      参数:
      mobileVisible -
      返回:

    • gender

      public User.Builder gender(Integer gender)
      性别

      示例值：1

      参数:
      gender -
      返回:

    • gender

      public User.Builder gender(UserGenderTypeEnum gender)
      性别

      示例值：1

      参数:
      gender - UserGenderTypeEnum
      返回:

    • avatarKey

      public User.Builder avatarKey(String avatarKey)
      头像的文件Key，可通过“消息与群组/消息/图片信息”中的“上传图片”接口上传并获取头像文件 Key;;“上传图片”功能参见[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)

      示例值：2500c7a9-5fff-4d9a-a2de-3d59614ae28g

      参数:
      avatarKey -
      返回:

    • avatar

      public User.Builder avatar(AvatarInfo avatar)
      用户头像信息

      示例值：

      参数:
      avatar -
      返回:

    • status

      public User.Builder status(UserStatus status)
      用户状态，枚举类型，包括is_frozen、is_resigned、is_activated、is_exited 。;;用户状态转移参见：[用户状态图](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/field-overview#4302b5a1)

      示例值：

      参数:
      status -
      返回:

    • departmentIds

      public User.Builder departmentIds(String[] departmentIds)
      用户所属部门的ID列表，一个用户可属于多个部门。;;ID值的类型与查询参数中的department_id_type 对应。;;不同 ID 的说明与department_id的获取方式参见 [部门ID说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)

      示例值：od-4e6ac4d14bcd5071a37a39de902c7141

      参数:
      departmentIds -
      返回:

    • leaderUserId

      public User.Builder leaderUserId(String leaderUserId)
      用户的直接主管的用户ID，ID值与查询参数中的user_id_type 对应。;;不同 ID 的说明参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction);;获取方式参见[如何获取user_id](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get)

      示例值：ou_7dab8a3d3cdcc9da365777c7ad535d62

      参数:
      leaderUserId -
      返回:

    • city

      public User.Builder city(String city)
      工作城市

      示例值：杭州

      参数:
      city -
      返回:

    • country

      public User.Builder country(String country)
      国家或地区Code缩写，具体写入格式请参考 [国家/地区码表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/country-code-description)

      示例值：CN

      参数:
      country -
      返回:

    • workStation

      public User.Builder workStation(String workStation)
      工位

      示例值：北楼-H34

      参数:
      workStation -
      返回:

    • joinTime

      public User.Builder joinTime(Integer joinTime)
      入职时间，时间戳格式，表示从1970年1月1日开始所经过的秒数

      示例值：2147483647

      参数:
      joinTime -
      返回:

    • isTenantManager

      public User.Builder isTenantManager(Boolean isTenantManager)
      是否是租户超级管理员

      示例值：false

      参数:
      isTenantManager -
      返回:

    • employeeNo

      public User.Builder employeeNo(String employeeNo)
      工号

      示例值：1

      参数:
      employeeNo -
      返回:

    • employeeType

      public User.Builder employeeType(Integer employeeType)
      员工类型，可选值有：;- `1`：正式员工;- `2`：实习生;- `3`：外包;- `4`：劳务;- `5`：顾问 ;同时可读取到自定义员工类型的 int 值，可通过下方接口获取到该租户的自定义员工类型的名称，参见[获取人员类型](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list)

      示例值：1

      参数:
      employeeType -
      返回:

    • orders

      public User.Builder orders(UserOrder[] orders)
      用户排序信息。;;用于标记通讯录下组织架构的人员顺序，人员可能存在多个部门中，且有不同的排序。

      示例值：

      参数:
      orders -
      返回:

    • customAttrs

      public User.Builder customAttrs(UserCustomAttr[] customAttrs)
      自定义字段，请确保你的组织管理员已在管理后台/组织架构/成员字段管理/自定义字段管理/全局设置中开启了“允许开放平台 API 调用“，否则该字段不会生效/返回。;;更多详情参见[用户接口相关问题](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN#77061525)

      示例值：

      参数:
      customAttrs -
      返回:

    • enterpriseEmail

      public User.Builder enterpriseEmail(String enterpriseEmail)
      企业邮箱，请先确保已在管理后台启用飞书邮箱服务;;创建用户时，企业邮箱的使用方式参见[用户接口相关问题](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN#77061525)

      示例值：demo@mail.com

      参数:
      enterpriseEmail -
      返回:

    • jobTitle

      public User.Builder jobTitle(String jobTitle)
      职务

      示例值：xxxxx

      参数:
      jobTitle -
      返回:

    • isFrozen

      public User.Builder isFrozen(Boolean isFrozen)
      是否暂停用户

      示例值：false

      参数:
      isFrozen -
      返回:

    • geo

      public User.Builder geo(String geo)
      数据驻留地

      示例值：cn

      参数:
      geo -
      返回:

    • jobLevelId

      public User.Builder jobLevelId(String jobLevelId)
      职级ID

      示例值：mga5oa8ayjlp9rb

      参数:
      jobLevelId -
      返回:

    • jobFamilyId

      public User.Builder jobFamilyId(String jobFamilyId)
      序列ID

      示例值：mga5oa8ayjlp9rb

      参数:
      jobFamilyId -
      返回:

    • subscriptionIds

      public User.Builder subscriptionIds(String[] subscriptionIds)
      分配给用户的席位ID列表

      示例值：

      参数:
      subscriptionIds -
      返回:

    • assignInfo

      public User.Builder assignInfo(UserAssignInfo[] assignInfo)
      用户席位列表

      示例值：

      参数:
      assignInfo -
      返回:

    • departmentPath

      public User.Builder departmentPath(DepartmentDetail[] departmentPath)
      部门路径

      示例值：

      参数:
      departmentPath -
      返回:

    • dottedLineLeaderUserIds

      public User.Builder dottedLineLeaderUserIds(String[] dottedLineLeaderUserIds)
      虚线上级ID

      示例值：

      参数:
      dottedLineLeaderUserIds -
      返回:

    • build

      public User build()