类 ExternalInstance.Builder

java.lang.Object
com.lark.oapi.service.approval.v4.model.ExternalInstance.Builder
封闭类:
ExternalInstance

public static class ExternalInstance.Builder extends Object
  • 构造器详细资料

    • Builder

      public Builder()
  • 方法详细资料

    • approvalCode

      public ExternalInstance.Builder approvalCode(String approvalCode)
      审批定义 code, 创建审批定义返回的值,表示该实例属于哪个流程;该字段会影响到列表中该实例的标题,标题取自对应定义的 name 字段

      示例值:81D31358-93AF-92D6-7425-01A5D67C4E71

      参数:
      approvalCode -
      返回:
    • status

      public ExternalInstance.Builder status(String status)
      审批实例状态

      示例值:PENDING

      参数:
      status -
      返回:
    • status

      审批实例状态

      示例值:PENDING

      参数:
      status - ExternalInstanceStatusEnum
      返回:
    • extra

      public ExternalInstance.Builder extra(String extra)
      审批实例扩展 JSON

      示例值:{\"xxx\":\"xxx\"}

      参数:
      extra -
      返回:
    • instanceId

      public ExternalInstance.Builder instanceId(String instanceId)
      审批实例唯一标识,用户自定义,需确保证租户下唯一

      示例值:24492654

      参数:
      instanceId -
      返回:
    • links

      审批实例链接集合 ,用于【已发起】列表的跳转,跳转回三方系统; pc_link 和 mobile_link 必须填一个,填写的是哪一端的链接,即会跳转到该链接,不受平台影响

      示例值:

      参数:
      links -
      返回:
    • title

      public ExternalInstance.Builder title(String title)
      审批展示名称,如果填写了该字段,则审批列表中的审批名称使用该字段,如果不填该字段,则审批名称使用审批定义的名称

      示例值:@i18n@1

      参数:
      title -
      返回:
    • form

      用户提交审批时填写的表单数据,用于所有审批列表中展示。可传多个值,但审批中心pc展示前2个,移动端展示前3个,长度不超过2048字符

      示例值:[{ "name": "@i18n@2", "value": "@i18n@3" }]

      参数:
      form -
      返回:
    • userId

      public ExternalInstance.Builder userId(String userId)
      审批发起人 user_id,发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】,【已审批】【抄送我】列表中,该字段展示审批是谁发起的。审批发起人 open id,和 user id 二者至少填一个。

      示例值:a987sf9s

      参数:
      userId -
      返回:
    • userName

      public ExternalInstance.Builder userName(String userName)
      审批发起人 用户名,如果发起人不是真实的用户(例如是某个部门),没有 user_id,则可以使用该字段传名称

      示例值:@i18n@9

      参数:
      userName -
      返回:
    • openId

      public ExternalInstance.Builder openId(String openId)
      审批发起人 open id,和 user id 二者至少填一个

      示例值:ou_be73cbc0ee35eb6ca54e9e7cc14998c1

      参数:
      openId -
      返回:
    • departmentId

      public ExternalInstance.Builder departmentId(String departmentId)
      发起人部门,用于列表中展示发起人所属部门。不传则不展示。如果用户没加入任何部门,传 "",将展示租户名称传 department_name 展示部门名称

      示例值:od-8ec33278bc2

      参数:
      departmentId -
      返回:
    • departmentName

      public ExternalInstance.Builder departmentName(String departmentName)
      审批发起人 部门,如果发起人不是真实的用户(例如是某个部门),没有 department_id,则可以使用该字段传名称

      示例值:@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)
      审批实例最近更新时间;用于推送数据版本控制如果 update_mode 值为 UPDATE,则只有传过来的 update_time 有变化时(变大),才会更新审批中心中的审批实例信息。使用该字段主要用来避免并发时老的数据更新了新的数据

      示例值:1556468012678

      参数:
      updateTime -
      返回:
    • displayMethod

      public ExternalInstance.Builder displayMethod(String displayMethod)
      列表页打开审批实例的方式

      示例值:BROWSER

      参数:
      displayMethod -
      返回:
    • displayMethod

      public ExternalInstance.Builder displayMethod(ExternalInstanceDisplayMethodEnum displayMethod)
      列表页打开审批实例的方式

      示例值:BROWSER

      参数:
      displayMethod - ExternalInstanceDisplayMethodEnum
      返回:
    • updateMode

      public ExternalInstance.Builder updateMode(String updateMode)
      更新方式, 当 update_mode=REPLACE时,每次都以当前推送的数据为最终数据,会删掉审批中心中多余的任务、抄送数据(不在这次推送的数据中); 当 update_mode=UPDATE时,则不会删除审批中心的数据,而只是进行新增和更新实例、任务数据

      示例值:UPDATE

      参数:
      updateMode -
      返回:
    • updateMode

      更新方式, 当 update_mode=REPLACE时,每次都以当前推送的数据为最终数据,会删掉审批中心中多余的任务、抄送数据(不在这次推送的数据中); 当 update_mode=UPDATE时,则不会删除审批中心的数据,而只是进行新增和更新实例、任务数据

      示例值:UPDATE

      参数:
      updateMode - ExternalInstanceUpdateModeEnum
      返回:
    • 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 -
      返回:
    • build

      public ExternalInstance build()