ExternalInstance.Builder (larksuite-oapi 2.8.5 API)

java.lang.Object
- com.lark.oapi.service.approval.v4.model.ExternalInstance.Builder

封闭类:: ExternalInstance

public static class ExternalInstance.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ExternalInstance.Builder`	`approvalCode(String approvalCode)` 审批定义 Code。
`ExternalInstance`	`build()`
`ExternalInstance.Builder`	`ccList(CcNode[] ccList)` 抄送列表示例值：
`ExternalInstance.Builder`	`departmentId(String departmentId)` 发起人的部门 ID，department_id类型的参数，获取方式参见[部门 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#9c02ed7a)。
`ExternalInstance.Builder`	`departmentName(String departmentName)` 审批发起人的部门名称。
`ExternalInstance.Builder`	`displayMethod(ExternalInstanceExternalInstanceDisplayMethodEnum displayMethod)` 列表页打开审批实例的方式。
`ExternalInstance.Builder`	`displayMethod(String displayMethod)` 列表页打开审批实例的方式。
`ExternalInstance.Builder`	`endTime(String endTime)` 审批实例结束时间。
`ExternalInstance.Builder`	`extra(String extra)` 审批实例扩展参数，JSON 格式，传值时需要压缩转义为字符串。
`ExternalInstance.Builder`	`form(ExternalInstanceForm[] form)` 用户提交审批时填写的表单数据，用于所有审批列表中展示。
`ExternalInstance.Builder`	`i18nResources(I18nResource[] i18nResources)` 国际化文案示例值：
`ExternalInstance.Builder`	`instanceId(String instanceId)` 审批实例唯一标识，自定义设置。
`ExternalInstance.Builder`	`links(ExternalInstanceLink links)` 审批实例链接信息。
`ExternalInstance.Builder`	`openId(String openId)` 审批发起人 open_id。
`ExternalInstance.Builder`	`resourceRegion(String resourceRegion)` 保留字段，无需填写示例值：cn
`ExternalInstance.Builder`	`startTime(String startTime)` 审批发起时间，Unix 毫秒时间戳。
`ExternalInstance.Builder`	`status(ExternalInstanceExternalInstanceStatusEnum status)` 审批实例状态;实例状态不影响任务状态，实例状态为通过时仍可同步待办状态的任务，所以同步时需要保证整体的状态一致性示例值：PENDING
`ExternalInstance.Builder`	`status(String status)` 审批实例状态;实例状态不影响任务状态，实例状态为通过时仍可同步待办状态的任务，所以同步时需要保证整体的状态一致性示例值：PENDING
`ExternalInstance.Builder`	`taskList(ExternalInstanceTaskNode[] taskList)` 任务列表示例值：
`ExternalInstance.Builder`	`title(String title)` 审批展示名称。
`ExternalInstance.Builder`	`trusteeshipCacheConfig(TrusteeshipInstanceCacheConfig trusteeshipCacheConfig)` 托管预缓存策略。
`ExternalInstance.Builder`	`trusteeshipUrls(TrusteeshipUrls trusteeshipUrls)` 单据托管回调接入方的接口 URL 地址。
`ExternalInstance.Builder`	`trusteeshipUrlToken(String trusteeshipUrlToken)` 单据托管认证 token，托管回调会附带此 token，帮助业务认证。
`ExternalInstance.Builder`	`trusteeshipUserIdType(String trusteeshipUserIdType)` 用户的类型，会影响请求参数用户标识域的选择，包括加签操作回传的目标用户，目前仅支持 user_id。
`ExternalInstance.Builder`	`updateMode(ExternalInstanceExternalInstanceUpdateModeEnum updateMode)` 更新方式。
`ExternalInstance.Builder`	`updateMode(String updateMode)` 更新方式。
`ExternalInstance.Builder`	`updateTime(String updateTime)` 审批实例最近更新时间，Unix 毫秒时间戳，用于推送数据版本控制。
`ExternalInstance.Builder`	`userId(String userId)` 审批发起人 user_id。
`ExternalInstance.Builder`	`userName(String userName)` 审批发起人的用户名。

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

- 构造器详细资料
  - Builder
```
public Builder()
```
- 方法详细资料
  - approvalCode
```
public ExternalInstance.Builder approvalCode(String approvalCode)
```
    审批定义 Code。[创建三方审批定义](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create)的返回值，用来指定当前实例属于的审批定义。
    示例值：81D31358-93AF-92D6-7425-01A5D67C4E71
    
    参数:
    
    approvalCode -
    
    返回:
  - status
```
public ExternalInstance.Builder status(String status)
```
    审批实例状态;实例状态不影响任务状态，实例状态为通过时仍可同步待办状态的任务，所以同步时需要保证整体的状态一致性
    示例值：PENDING
    
    参数:
    
    status -
    
    返回:
  - status
```
public ExternalInstance.Builder status(ExternalInstanceExternalInstanceStatusEnum status)
```
    审批实例状态;实例状态不影响任务状态，实例状态为通过时仍可同步待办状态的任务，所以同步时需要保证整体的状态一致性
    示例值：PENDING
    
    参数:
    
    status - ExternalInstanceExternalInstanceStatusEnum
    
    返回:
  - extra
```
public ExternalInstance.Builder extra(String extra)
```
    审批实例扩展参数，JSON 格式，传值时需要压缩转义为字符串。单据编号通过传 business_key 参数来实现，目前仅托管模式支持展示三方的单据编号，其余模式仅展示单据来源(biz_type)，可通过[创建三方审批定义](https://open.feishu.cn/document%2FuAjLw4CM%2FukTMukTMukTM%2Freference%2Fapproval-v4%2Fexternal_approval%2Fcreate)接口指定。;;**注意**：以下示例值未转义，使用时请注意转义。你可查看请求体示例中转义后的 extra 示例值。
    示例值：{\"business_key\":\"xxx\"}
    
    参数:
    
    extra -
    
    返回:
  - instanceId
```
public ExternalInstance.Builder instanceId(String instanceId)
```
    审批实例唯一标识，自定义设置。需确保证在当前企业和应用内唯一。
    示例值：24492654
    
    参数:
    
    instanceId -
    
    返回:
  - links
```
public ExternalInstance.Builder links(ExternalInstanceLink links)
```
    审批实例链接信息。设置的链接用于在审批中心 **已发起** 列表内点击跳转，跳回三方审批系统查看审批详情。
    示例值：
    
    参数:
    
    links -
    
    返回:
  - title
```
public ExternalInstance.Builder title(String title)
```
    审批展示名称。;; ;**说明**：;;- 如果设置了 title 参数，则审批实例名称按照 title 展示。如果未设置 title，审批实例的标题取自对应审批定义（approval_code）的 name 参数。;- 这里传入的是国际化文案 Key（即 i18n_resources.texts 参数中的 Key），还需要在 i18n_resources.texts 参数中以 Key:Value 格式进行赋值。;- Key 需要以 @i18n@ 开头。
    示例值：@i18n@1
    
    参数:
    
    title -
    
    返回:
  - form
```
public ExternalInstance.Builder form(ExternalInstanceForm[] form)
```
    用户提交审批时填写的表单数据，用于所有审批列表中展示。可传多个值，最多展示前 3 个，长度不超过 2048 字符。;;![image.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/69fd0009295b654b28ba2fb46727b4aa_KWIEEvsNPu.png?height=294&maxWidth=200&width=626)
    示例值：[{ "name": "@i18n@2", "value": "@i18n@3" }]
    
    参数:
    
    form -
    
    返回:
  - userId
```
public ExternalInstance.Builder userId(String userId)
```
    审批发起人 user_id。发起人可在审批中心的 **已发起** 列表中看到所有已发起的审批。在 **待办**、**已办**、**抄送我** 列表中，该字段用来展示审批的发起人。获取方式参见[如何获取用户的 User ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)。; ;**注意**：审批发起人的 open_id 和 user_id 需至少传入一个。
    示例值：a987sf9s
    
    参数:
    
    userId -
    
    返回:
  - userName
```
public ExternalInstance.Builder userName(String userName)
```
    审批发起人的用户名。如果发起人不是真实的用户（例如是某个部门），没有 user_id，则可以使用该参数传入一个名称。; ;**说明**：; ;- 这里传入的是国际化文案 Key（即 i18n_resources.texts 参数中的 Key），还需要在 i18n_resources.texts 参数中以 Key:Value 格式进行赋值。;;- Key 需要以 @i18n@ 开头。
    示例值：@i18n@9
    
    参数:
    
    userName -
    
    返回:
  - openId
```
public ExternalInstance.Builder openId(String openId)
```
    审批发起人 open_id。发起人可在审批中心的 **已发起** 列表中看到所有已发起的审批。在 **待办**、**已办**、**抄送我** 列表中，该字段用来展示审批的发起人。获取方式参见[如何获取用户的 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)。; ;**注意**：审批发起人的 open_id 和 user_id 需至少传入一个。
    示例值：ou_be73cbc0ee35eb6ca54e9e7cc14998c1
    
    参数:
    
    openId -
    
    返回:
  - departmentId
```
public ExternalInstance.Builder departmentId(String departmentId)
```
    发起人的部门 ID，department_id类型的参数，获取方式参见[部门 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#9c02ed7a)。
    示例值：743b25b8ef662f36
    
    参数:
    
    departmentId -
    
    返回:
  - departmentName
```
public ExternalInstance.Builder departmentName(String departmentName)
```
    审批发起人的部门名称。如果发起人不是真实的用户或没有部门，则可以使用该参数传入部门名称。;;**说明**：; ;- 这里传入的是国际化文案 Key（即 i18n_resources.texts 参数中的 Key），还需要在 i18n_resources.texts 参数中以 Key:Value 格式进行赋值。;- Key 需要以 @i18n@ 开头。
    示例值：@i18n@10
    
    参数:
    
    departmentName -
    
    返回:
  - startTime
```
public ExternalInstance.Builder startTime(String startTime)
```
    审批发起时间，Unix 毫秒时间戳。
    示例值：1556468012678
    
    参数:
    
    startTime -
    
    返回:
  - endTime
```
public ExternalInstance.Builder endTime(String endTime)
```
    审批实例结束时间。未结束的审批为 0，Unix 毫秒时间戳。
    示例值：1556468012678
    
    参数:
    
    endTime -
    
    返回:
  - updateTime
```
public ExternalInstance.Builder updateTime(String updateTime)
```
    审批实例最近更新时间，Unix 毫秒时间戳，用于推送数据版本控制。;;如果 update_mode 值为 UPDATE，则仅当传过来的 update_time 有变化时（变大），才会更新审批中心中的审批实例信息。; ;**说明**：使用该参数主要用来避免并发时，旧数据更新了新数据。
    示例值：1556468012678
    
    参数:
    
    updateTime -
    
    返回:
  - displayMethod
```
public ExternalInstance.Builder displayMethod(String displayMethod)
```
    列表页打开审批实例的方式。
    示例值：BROWSER
    
    参数:
    
    displayMethod -
    
    返回:
  - displayMethod
```
public ExternalInstance.Builder displayMethod(ExternalInstanceExternalInstanceDisplayMethodEnum displayMethod)
```
    列表页打开审批实例的方式。
    示例值：BROWSER
    
    参数:
    
    displayMethod - ExternalInstanceExternalInstanceDisplayMethodEnum
    
    返回:
  - updateMode
```
public ExternalInstance.Builder updateMode(String updateMode)
```
    更新方式。; ;- 当 update_mode 取值为 REPLACE 时，每次都以当前推送的数据为最终数据，会删上一次成功同步的记录中不在本次推送数据中的任务和抄送记录。;- 当 update_mode 取值为 UPDATE 时，不会删除审批中心的数据，而只进行新增，更新实例、任务和抄送数据。;;;推荐使用Update模式，性能与稳定性会更好;;**默认值**：REPLACE
    示例值：UPDATE
    
    参数:
    
    updateMode -
    
    返回:
  - updateMode
```
public ExternalInstance.Builder updateMode(ExternalInstanceExternalInstanceUpdateModeEnum updateMode)
```
    更新方式。; ;- 当 update_mode 取值为 REPLACE 时，每次都以当前推送的数据为最终数据，会删上一次成功同步的记录中不在本次推送数据中的任务和抄送记录。;- 当 update_mode 取值为 UPDATE 时，不会删除审批中心的数据，而只进行新增，更新实例、任务和抄送数据。;;;推荐使用Update模式，性能与稳定性会更好;;**默认值**：REPLACE
    示例值：UPDATE
    
    参数:
    
    updateMode - ExternalInstanceExternalInstanceUpdateModeEnum
    
    返回:
  - taskList
```
public ExternalInstance.Builder taskList(ExternalInstanceTaskNode[] taskList)
```
    任务列表
    示例值：
    
    参数:
    
    taskList -
    
    返回:
  - ccList
```
public ExternalInstance.Builder ccList(CcNode[] ccList)
```
    抄送列表
    示例值：
    
    参数:
    
    ccList -
    
    返回:
  - i18nResources
```
public ExternalInstance.Builder i18nResources(I18nResource[] i18nResources)
```
    国际化文案
    示例值：
    
    参数:
    
    i18nResources -
    
    返回:
  - trusteeshipUrlToken
```
public ExternalInstance.Builder trusteeshipUrlToken(String trusteeshipUrlToken)
```
    单据托管认证 token，托管回调会附带此 token，帮助业务认证。
    示例值：788981c886b1c28ac29d1e68efd60683d6d90dfce80938ee9453e2a5f3e9e306
    
    参数:
    
    trusteeshipUrlToken -
    
    返回:
  - trusteeshipUserIdType
```
public ExternalInstance.Builder trusteeshipUserIdType(String trusteeshipUserIdType)
```
    用户的类型，会影响请求参数用户标识域的选择，包括加签操作回传的目标用户，目前仅支持 user_id。
    示例值：user_id
    
    参数:
    
    trusteeshipUserIdType -
    
    返回:
  - trusteeshipUrls
```
public ExternalInstance.Builder trusteeshipUrls(TrusteeshipUrls trusteeshipUrls)
```
    单据托管回调接入方的接口 URL 地址。
    示例值：
    
    参数:
    
    trusteeshipUrls -
    
    返回:
  - trusteeshipCacheConfig
```
public ExternalInstance.Builder trusteeshipCacheConfig(TrusteeshipInstanceCacheConfig trusteeshipCacheConfig)
```
    托管预缓存策略。
    示例值：
    
    参数:
    
    trusteeshipCacheConfig -
    
    返回:
  - resourceRegion
```
public ExternalInstance.Builder resourceRegion(String resourceRegion)
```
    保留字段，无需填写
    示例值：cn
    
    参数:
    
    resourceRegion -
    
    返回:
  - build
```
public ExternalInstance build()
```

类 ExternalInstance.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

approvalCode

status

status

extra

instanceId

links

title

form

userId

userName

openId

departmentId

departmentName

startTime

endTime

updateTime

displayMethod

displayMethod

updateMode

updateMode

taskList

ccList

i18nResources

trusteeshipUrlToken

trusteeshipUserIdType

trusteeshipUrls

trusteeshipCacheConfig

resourceRegion

build