InstanceCreate.Builder (larksuite-oapi 2.8.5 API)

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

封闭类:: InstanceCreate

public static class InstanceCreate.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`InstanceCreate.Builder`	`allowResubmit(Boolean allowResubmit)` 是否配置提交按钮，适用于任务的审批人退回审批单据后，审批提交人可以在同一个审批实例内点击提交，提交单据。
`InstanceCreate.Builder`	`allowSubmitAgain(Boolean allowSubmitAgain)` 是否配置再次提交按钮，适用于周期性提单场景，按照当前表单内容再次发起一个新审批实例。
`InstanceCreate.Builder`	`approvalCode(String approvalCode)` 审批定义 Code。
`InstanceCreate`	`build()`
`InstanceCreate.Builder`	`byteExtra(String byteExtra)` 字节内部扩展字段示例值：{}
`InstanceCreate.Builder`	`cancelBotNotification(String cancelBotNotification)` 取消指定的 Bot 推送通知。
`InstanceCreate.Builder`	`departmentId(String departmentId)` 审批发起人所属部门 ID。
`InstanceCreate.Builder`	`forbidRevoke(Boolean forbidRevoke)` 是否禁止撤销审批实例示例值：false
`InstanceCreate.Builder`	`form(String form)` 填写的审批表单控件值，JSON 数组，传值时需要压缩转义为字符串。
`InstanceCreate.Builder`	`i18nResources(I18nResource[] i18nResources)` 国际化文案。
`InstanceCreate.Builder`	`nodeApproverOpenIdList(NodeApprover[] nodeApproverOpenIdList)` 如果审批定义的流程中，有节点需要发起人自选审批人，则需要通过本参数填写对应节点的审批人（通过用户 open_id 指定审批人）。
`InstanceCreate.Builder`	`nodeApproverUserIdList(NodeApprover[] nodeApproverUserIdList)` 如果审批定义的流程中，有节点需要发起人自选审批人，则需要通过本参数填写对应节点的审批人（通过用户 user_id 指定审批人）。
`InstanceCreate.Builder`	`nodeAutoApprovalList(NodeAutoApproval[] nodeAutoApprovalList)` 设置自动通过的节点。
`InstanceCreate.Builder`	`nodeCcOpenIdList(NodeCc[] nodeCcOpenIdList)` 如果审批定义的流程中，有节点需要发起人自选抄送人，则需要通过本参数填写对应节点的抄送人（通过用户 open_id 指定审批人）。
`InstanceCreate.Builder`	`nodeCcUserIdList(NodeCc[] nodeCcUserIdList)` 如果审批定义的流程中，有节点需要发起人自选抄送人，则需要通过本参数填写对应节点的抄送人（通过用户 user_id 指定审批人）。
`InstanceCreate.Builder`	`openId(String openId)` 审批发起人的 open_id，与 user_id 必须传入其中一个。
`InstanceCreate.Builder`	`title(String title)` 审批实例的展示名称。
`InstanceCreate.Builder`	`titleDisplayMethod(InstanceCreateInstanceCreateTitleDisplayMethodEnum titleDisplayMethod)` 审批详情页 title 展示模式。
`InstanceCreate.Builder`	`titleDisplayMethod(Integer titleDisplayMethod)` 审批详情页 title 展示模式。
`InstanceCreate.Builder`	`userId(String userId)` 审批发起人的 user_id，与 open_id 必须传入其中一个。
`InstanceCreate.Builder`	`uuid(String uuid)` 审批实例 uuid，用于幂等操作，单个企业内的唯一 key。
`InstanceCreate.Builder`	`withLink(Boolean withLink)` 是否可选返回链接示例值：

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

- 构造器详细资料
  - Builder
```
public Builder()
```
- 方法详细资料
  - approvalCode
```
public InstanceCreate.Builder approvalCode(String approvalCode)
```
    审批定义 Code。获取方式：;;- 调用[创建审批定义](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create)接口后，从响应参数 approval_code 获取。;- 登录审批管理后台，在指定审批定义的 URL 中获取，具体操作参见[什么是 Approval Code](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/overview-of-approval-resources#8151e0ae)。
    示例值：7C468A54-8745-2245-9675-08B7C63E7A85
    
    参数:
    
    approvalCode -
    
    返回:
  - userId
```
public InstanceCreate.Builder userId(String userId)
```
    审批发起人的 user_id，与 open_id 必须传入其中一个。如果传入了 user_id 则优先使用 user_id。获取方式参考[如何获取用户的 User ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)。
    示例值：f7cb567e
    
    参数:
    
    userId -
    
    返回:
  - openId
```
public InstanceCreate.Builder openId(String openId)
```
    审批发起人的 open_id，与 user_id 必须传入其中一个。如果传入了 user_id 则优先使用 user_id。获取方式参考[如何获取用户的 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
    示例值：ou_3cda9c969f737aaa05e6915dce306cb9
    
    参数:
    
    openId -
    
    返回:
  - departmentId
```
public InstanceCreate.Builder departmentId(String departmentId)
```
    审批发起人所属部门 ID。如果用户只属于一个部门，可以不填。如果用户属于多个部门，不填值则默认选择部门列表第一个部门。获取方式参见[部门 ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#9c02ed7a)。;;**说明**：;;- 不支持填写根部门。;- 需填写 department_id 类型的部门 ID。
    示例值：9293493ccacbdb9a
    
    参数:
    
    departmentId -
    
    返回:
  - form
```
public InstanceCreate.Builder form(String form)
```
    填写的审批表单控件值，JSON 数组，传值时需要压缩转义为字符串。各控件值的参数说明参考[审批实例表单控件参数](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/approval-instance-form-control-parameters)。
    示例值：[{\"id\":\"111\", \"type\": \"input\", \"value\":\"test\"}]
    
    参数:
    
    form -
    
    返回:
  - nodeApproverUserIdList
```
public InstanceCreate.Builder nodeApproverUserIdList(NodeApprover[] nodeApproverUserIdList)
```
    如果审批定义的流程中，有节点需要发起人自选审批人，则需要通过本参数填写对应节点的审批人（通过用户 user_id 指定审批人）。;;**说明**：如果同时传入了 node_approver_user_id_list、node_approver_open_id_list，则取两个参数的并集生效审批人。
    示例值：
    
    参数:
    
    nodeApproverUserIdList -
    
    返回:
  - nodeApproverOpenIdList
```
public InstanceCreate.Builder nodeApproverOpenIdList(NodeApprover[] nodeApproverOpenIdList)
```
    如果审批定义的流程中，有节点需要发起人自选审批人，则需要通过本参数填写对应节点的审批人（通过用户 open_id 指定审批人）。;;**说明**：如果同时传入了 node_approver_user_id_list、node_approver_open_id_list，则取两个参数的并集生效审批人。
    示例值：
    
    参数:
    
    nodeApproverOpenIdList -
    
    返回:
  - nodeCcUserIdList
```
public InstanceCreate.Builder nodeCcUserIdList(NodeCc[] nodeCcUserIdList)
```
    如果审批定义的流程中，有节点需要发起人自选抄送人，则需要通过本参数填写对应节点的抄送人（通过用户 user_id 指定审批人）。;;**说明**：如果同时传入了 node_cc_user_id_list、node_cc_open_id_list，则取两个参数的并集生效抄送人。
    示例值：
    
    参数:
    
    nodeCcUserIdList -
    
    返回:
  - nodeCcOpenIdList
```
public InstanceCreate.Builder nodeCcOpenIdList(NodeCc[] nodeCcOpenIdList)
```
    如果审批定义的流程中，有节点需要发起人自选抄送人，则需要通过本参数填写对应节点的抄送人（通过用户 open_id 指定审批人）。;;**说明**：如果同时传入了 node_cc_user_id_list、node_cc_open_id_list，则取两个参数的并集生效抄送人。
    示例值：
    
    参数:
    
    nodeCcOpenIdList -
    
    返回:
  - uuid
```
public InstanceCreate.Builder uuid(String uuid)
```
    审批实例 uuid，用于幂等操作，单个企业内的唯一 key。同一个 uuid 只能用于创建一个审批实例，如果冲突则创建失败并返回错误码 60012 ，格式建议为 XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX，不区分大小写。
    示例值：7C468A54-8745-2245-9675-08B7C63E7A87
    
    参数:
    
    uuid -
    
    返回:
  - allowResubmit
```
public InstanceCreate.Builder allowResubmit(Boolean allowResubmit)
```
    是否配置 **提交** 按钮，适用于任务的审批人退回审批单据后，审批提交人可以在同一个审批实例内点击 **提交**，提交单据。
    示例值：true
    
    参数:
    
    allowResubmit -
    
    返回:
  - allowSubmitAgain
```
public InstanceCreate.Builder allowSubmitAgain(Boolean allowSubmitAgain)
```
    是否配置 **再次提交** 按钮，适用于周期性提单场景，按照当前表单内容再次发起一个新审批实例。
    示例值：true
    
    参数:
    
    allowSubmitAgain -
    
    返回:
  - cancelBotNotification
```
public InstanceCreate.Builder cancelBotNotification(String cancelBotNotification)
```
    取消指定的 Bot 推送通知。可选值有：;;- 1：取消审批实例通过推送。;- 2：取消审批实例拒绝推送。;- 4：取消审批实例取消推送。;;支持同时取消多个 bot 推送通知。位运算，即如需取消 1 和 2 两种通知，则需要传入加和值 3。
    示例值：1
    
    参数:
    
    cancelBotNotification -
    
    返回:
  - forbidRevoke
```
public InstanceCreate.Builder forbidRevoke(Boolean forbidRevoke)
```
    是否禁止撤销审批实例
    示例值：false
    
    参数:
    
    forbidRevoke -
    
    返回:
  - i18nResources
```
public InstanceCreate.Builder i18nResources(I18nResource[] i18nResources)
```
    国际化文案。目前只支持为表单的单行、多行文本控件赋值。
    示例值：
    
    参数:
    
    i18nResources -
    
    返回:
  - title
```
public InstanceCreate.Builder title(String title)
```
    审批实例的展示名称。如果填写了该参数，则审批列表中的审批名称使用该参数，如果不填该参数，则审批名称使用审批定义的名称。;;**说明**：这里传入的是国际化文案 Key（即 i18n_resources.texts 参数中的 Key），必须以 @i18n@ 开头，还需要在 i18n_resources.texts 参数中以 Key:Value 格式进行赋值。
    示例值：@i18n@1
    
    参数:
    
    title -
    
    返回:
  - titleDisplayMethod
```
public InstanceCreate.Builder titleDisplayMethod(Integer titleDisplayMethod)
```
    审批详情页 title 展示模式。
    示例值：0
    
    参数:
    
    titleDisplayMethod -
    
    返回:
  - titleDisplayMethod
```
public InstanceCreate.Builder titleDisplayMethod(InstanceCreateInstanceCreateTitleDisplayMethodEnum titleDisplayMethod)
```
    审批详情页 title 展示模式。
    示例值：0
    
    参数:
    
    titleDisplayMethod - InstanceCreateInstanceCreateTitleDisplayMethodEnum
    
    返回:
  - nodeAutoApprovalList
```
public InstanceCreate.Builder nodeAutoApprovalList(NodeAutoApproval[] nodeAutoApprovalList)
```
    设置自动通过的节点。
    示例值：
    
    参数:
    
    nodeAutoApprovalList -
    
    返回:
  - byteExtra
```
public InstanceCreate.Builder byteExtra(String byteExtra)
```
    字节内部扩展字段
    示例值：{}
    
    参数:
    
    byteExtra -
    
    返回:
  - withLink
```
public InstanceCreate.Builder withLink(Boolean withLink)
```
    是否可选返回链接
    示例值：
    
    参数:
    
    withLink -
    
    返回:
  - build
```
public InstanceCreate build()
```

类 InstanceCreate.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

approvalCode

userId

openId

departmentId

form

nodeApproverUserIdList

nodeApproverOpenIdList

nodeCcUserIdList

nodeCcOpenIdList

uuid

allowResubmit

allowSubmitAgain

cancelBotNotification

forbidRevoke

i18nResources

title

titleDisplayMethod

titleDisplayMethod

nodeAutoApprovalList

byteExtra

withLink

build