User.Builder (larksuite-oapi 2.8.5 API)

java.lang.Object
- com.lark.oapi.service.contact.v3.model.User.Builder

封闭类:: User

public static class User.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

构造器
构造器和说明
`Builder()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`User.Builder`	`assignInfo(UserAssignInfo[] assignInfo)` 用户席位列表。
`User.Builder`	`avatar(AvatarInfo avatar)` 租户icon信息示例值：
`User.Builder`	`avatarKey(String avatarKey)` 头像的文件Key 示例值：2500c7a9-5fff-4d9a-a2de-3d59614ae28g
`User`	`build()`
`User.Builder`	`city(String city)` 工作城市。
`User.Builder`	`country(String country)` 国家或地区 Code 缩写。
`User.Builder`	`customAttrs(UserCustomAttr[] customAttrs)` 自定义字段。
`User.Builder`	`departmentIds(String[] departmentIds)` 用户所属部门的ID列表，一个用户可属于多个部门。
`User.Builder`	`departmentPath(DepartmentDetail[] departmentPath)` 部门路径。
`User.Builder`	`description(String description)` 用户签名示例值：xxx
`User.Builder`	`dottedLineLeaderUserIds(String[] dottedLineLeaderUserIds)` 虚线上级ID 示例值：
`User.Builder`	`email(String email)` 邮箱。
`User.Builder`	`employeeNo(String employeeNo)` 工号。
`User.Builder`	`employeeType(Integer employeeType)` 员工类型。
`User.Builder`	`enName(String enName)` 英文名。
`User.Builder`	`enterpriseEmail(String enterpriseEmail)` 企业邮箱。
`User.Builder`	`gender(Integer gender)` 性别。
`User.Builder`	`gender(UserGenderTypeEnum gender)` 性别。
`User.Builder`	`geo(String geo)` 数据驻留地示例值：cn
`User.Builder`	`idpType(String idpType)` 租户类型示例值：6645182361178734852
`User.Builder`	`isFrozen(Boolean isFrozen)` 是否为暂停状态的用户。
`User.Builder`	`isTenantManager(Boolean isTenantManager)` 是否是租户超级管理员示例值：false
`User.Builder`	`jobFamilyId(String jobFamilyId)` 序列 ID。
`User.Builder`	`jobLevelId(String jobLevelId)` 职级 ID。
`User.Builder`	`jobTitle(String jobTitle)` 职务。
`User.Builder`	`joinTime(Integer joinTime)` 入职时间。
`User.Builder`	`leaderUserId(String leaderUserId)` 用户的直接主管的 open_id。
`User.Builder`	`mobile(String mobile)` 手机号。
`User.Builder`	`mobileVisible(Boolean mobileVisible)` 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。
`User.Builder`	`name(String name)` 用户名。
`User.Builder`	`needSendNotification(Boolean needSendNotification)` 是否发送提示消息示例值：true
`User.Builder`	`nickname(String nickname)` 别名。
`User.Builder`	`notificationOption(NotificationOption notificationOption)` 示例值：
`User.Builder`	`openId(String openId)` 用户的 open_id，应用内用户的唯一标识。
`User.Builder`	`orders(UserOrder[] orders)` 用户排序信息。
`User.Builder`	`positions(UserPosition[] positions)` 职位信息示例值：
`User.Builder`	`status(UserStatus status)` 用户状态。
`User.Builder`	`subscriptionIds(String[] subscriptionIds)` 分配给用户的席位 ID 列表。
`User.Builder`	`timeZone(String timeZone)` 用户时区示例值：
`User.Builder`	`unionId(String unionId)` 用户的 union_id，应用开发商发布的不同应用中同一用户的标识。
`User.Builder`	`userId(String userId)` 用户的 user_id，租户内用户的唯一标识。
`User.Builder`	`workStation(String workStation)` 工位。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - 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)
```
    邮箱。
    示例值：zhangsan@gmail.com
    
    参数:
    
    email -
    
    返回:
  - mobile
```
public User.Builder mobile(String mobile)
```
    手机号。
    示例值：130xxxx1111
    
    参数:
    
    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
    示例值：2500c7a9-5fff-4d9a-a2de-3d59614ae28g
    
    参数:
    
    avatarKey -
    
    返回:
  - avatar
```
public User.Builder avatar(AvatarInfo avatar)
```
    租户icon信息
    示例值：
    
    参数:
    
    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)
    示例值：
    
    参数:
    
    departmentIds -
    
    返回:
  - leaderUserId
```
public User.Builder leaderUserId(String leaderUserId)
```
    用户的直接主管的 open_id。;;关于用户 ID 的说明可参见 [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)。
    示例值：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 值，通过 int 值调用[获取人员类型](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list)接口，进而获取到该租户的自定义员工类型的名称。
    示例值：1
    
    参数:
    
    employeeType -
    
    返回:
  - positions
```
public User.Builder positions(UserPosition[] positions)
```
    职位信息
    示例值：
    
    参数:
    
    positions -
    
    返回:
  - 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)
```
    企业邮箱。如果企业管理员已在管理后台启用飞书邮箱服务，则会返回该值。
    示例值：demo@mail.com
    
    参数:
    
    enterpriseEmail -
    
    返回:
  - idpType
```
public User.Builder idpType(String idpType)
```
    租户类型
    示例值：6645182361178734852
    
    参数:
    
    idpType -
    
    返回:
  - timeZone
```
public User.Builder timeZone(String timeZone)
```
    用户时区
    示例值：
    
    参数:
    
    timeZone -
    
    返回:
  - description
```
public User.Builder description(String description)
```
    用户签名
    示例值：xxx
    
    参数:
    
    description -
    
    返回:
  - jobTitle
```
public User.Builder jobTitle(String jobTitle)
```
    职务。
    示例值：xxxxx
    
    参数:
    
    jobTitle -
    
    返回:
  - needSendNotification
```
public User.Builder needSendNotification(Boolean needSendNotification)
```
    是否发送提示消息
    示例值：true
    
    参数:
    
    needSendNotification -
    
    返回:
  - notificationOption
```
public User.Builder notificationOption(NotificationOption notificationOption)
```
    示例值：
    
    参数:
    
    notificationOption -
    
    返回:
  - isFrozen
```
public User.Builder isFrozen(Boolean isFrozen)
```
    是否为暂停状态的用户。;;**可能值有：**;;- true：是;- false：否
    示例值：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()
```

类 User.Builder

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Builder

方法详细资料

unionId

userId

openId

name

enName

nickname

email

mobile

mobileVisible

gender

gender

avatarKey

avatar

status

departmentIds

leaderUserId

city

country

workStation

joinTime

isTenantManager

employeeNo

employeeType

positions

orders

customAttrs

enterpriseEmail

idpType

timeZone

description

jobTitle

needSendNotification

notificationOption

isFrozen

geo

jobLevelId

jobFamilyId

subscriptionIds

assignInfo

departmentPath

dottedLineLeaderUserIds

build