类 Task.Builder

java.lang.Object
com.lark.oapi.service.task.v1.model.Task.Builder
封闭类:
Task

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

    • Builder

      public Builder()
  • 方法详细资料

    • id

      public Task.Builder id(String id)
      任务的唯一ID,例如"83912691-2e43-47fc-94a4-d512e03984fa"

      示例值:83912691-2e43-47fc-94a4-d512e03984fa

      参数:
      id -
      返回:
    • summary

      public Task.Builder summary(String summary)
      任务的标题,类型为文本字符串。;如果要在任务标题中插入 URL 或者 @某个用户,请使用rich_summary字段。;创建任务时,任务标题(summary字段)和任务富文本标题(rich_summary字段)不能同时为空,需要至少填充其中一个字段。;无效输入:'<'md-alert>;任务标题和任务富文本标题同时存在时只使用富文本标题。;无效输入:'<'/md-alert>

      示例值:完成本季度OKR编写

      参数:
      summary -
      返回:
    • description

      public Task.Builder description(String description)
      任务的描述,类型为文本字符串。;如果要在任务描述中插入 URL 或者 @某个用户,请使用rich_description字段。;无效输入:'<'md-alert>;任务备注和任务富文本备注同时存在时只使用富文本备注。;无效输入:'<'/md-alert>

      示例值:对本次会议内容复盘总结,编写更新本季度OKR

      参数:
      description -
      返回:
    • completeTime

      public Task.Builder completeTime(String completeTime)
      任务的完成时间戳(单位为秒),完成时间为0则表示任务尚未完成。;不支持部分完成,只有整个任务完成,该字段才会有非0值。

      示例值:1623499200

      参数:
      completeTime -
      返回:
    • creatorId

      public Task.Builder creatorId(String creatorId)
      任务的创建者 ID。;其中查询字段 user_id_type 是用于控制返回体中 creator_id 的类型,不传时默认返回 open_id。;特别的,使用tenant_access_token 调用接口时,如果是user_id_type是openid,则返回代表该应用身份的openid;当user_id_type为user_id时,不返回creator_id。原因是user_id代表一个真实飞书用户的id,应用身份没有user_id。使用user_access_token调用接口正常返回创建者。

      示例值:ou_99e1a581b36ecc4862cbfbce473f346a

      参数:
      creatorId -
      返回:
    • extra

      public Task.Builder extra(String extra)
      附属信息。;接入方可以传入base64 编码后的自定义的数据。用户如果需要对当前任务备注信息,但对外不显示,可使用该字段进行存储。;该数据会在获取任务详情时,原样返回给用户。

      示例值:dGVzdA==

      参数:
      extra -
      返回:
    • createTime

      public Task.Builder createTime(String createTime)
      任务的创建时间的Unix时间戳(单位为秒)

      示例值:1623392486

      参数:
      createTime -
      返回:
    • updateTime

      public Task.Builder updateTime(String updateTime)
      任务的更新时间的Unix时间戳(单位为秒);创建任务时update_time与create_time相同

      示例值:1623392486

      参数:
      updateTime -
      返回:
    • due

      public Task.Builder due(Due due)
      任务的截止时间设置

      示例值:

      参数:
      due -
      返回:
    • origin

      public Task.Builder origin(Origin origin)
      任务关联的第三方平台来源信息

      示例值:

      参数:
      origin -
      返回:
    • canEdit

      public Task.Builder canEdit(Boolean canEdit)
      此字段用于控制该任务在飞书任务中心是否可编辑,默认为false;无效输入:'<'md-alert>;已经废弃,向前兼容故仍然保留,但不推荐使用;无效输入:'<'/md-alert>

      示例值:true

      参数:
      canEdit -
      返回:
    • custom

      public Task.Builder custom(String custom)
      自定义完成配置。;此字段用于设置完成任务时的页面跳转,或展示提示语。详细参见:[任务字段补充说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/Supplementary-directions-of-task-fields)

      示例值:{\"custom_complete\":{\"android\":{\"href\":\"https://www.feishu.cn/\",\"tip\":{\"zh_cn\":\"你好\",\"en_us\":\"hello\"}},\"ios\":{\"href\":\"https://www.feishu.cn/\",\"tip\":{\"zh_cn\":\"你好\",\"en_us\":\"hello\"}},\"pc\":{\"href\":\"https://www.feishu.cn/\",\"tip\":{\"zh_cn\":\"你好\",\"en_us\":\"hello\"}}}}

      参数:
      custom -
      返回:
    • source

      public Task.Builder source(Integer source)
      任务创建的来源

      示例值:6

      参数:
      source -
      返回:
    • source

      public Task.Builder source(TaskSourceEnum source)
      任务创建的来源

      示例值:6

      参数:
      source - TaskSourceEnum
      返回:
    • followers

      public Task.Builder followers(Follower[] followers)
      任务的关注者

      示例值:ou_03c21c80caea2c816665f8056dc59027

      参数:
      followers -
      返回:
    • collaborators

      public Task.Builder collaborators(Collaborator[] collaborators)
      任务的执行者

      示例值:ou_558d4999baae26e32aa2fd9bb228660b

      参数:
      collaborators -
      返回:
    • collaboratorIds

      public Task.Builder collaboratorIds(String[] collaboratorIds)
      创建任务时添加的执行者用户id列表。;传入的值为 user_id 或 open_id ,由user_id_type 决定。user_id和open_id的获取可见文档:[如何获取相关id](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get)。

      示例值:["ou_1400208f15333e20e11339d39067844b", "ou_84ed6312949945c8ae6168f10829e9e6"]

      参数:
      collaboratorIds -
      返回:
    • followerIds

      public Task.Builder followerIds(String[] followerIds)
      创建任务时添加的关注者用户id列表。;传入的值为 user_id 或 open_id ,由user_id_type 决定。user_id和open_id的获取可见文档:[如何获取相关id](https://open.feishu.cn/document/home/user-identity-introduction/how-to-get)。

      示例值:["ou_1400208f15333e20e11339d39067844b", "ou_84ed6312949945c8ae6168f10829e9e6"]

      参数:
      followerIds -
      返回:
    • repeatRule

      public Task.Builder repeatRule(String repeatRule)
      重复任务的规则表达式。;语法格式参见[RRule语法规范](https://www.ietf.org/rfc/rfc2445.txt) 4.3.10小节

      示例值:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR

      参数:
      repeatRule -
      返回:
    • richSummary

      public Task.Builder richSummary(String richSummary)
      富文本任务标题。语法格式参见[Markdown模块](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/markdown-module);。创建任务时,任务标题(summary字段)和任务富文本标题(rich_summary字段)不能同时为空,需要至少填充其中一个字段。

      示例值:完成本季度OKR编写\[飞书开放平台](https://open.feishu.cn/)

      参数:
      richSummary -
      返回:
    • richDescription

      public Task.Builder richDescription(String richDescription)
      富文本任务备注。语法格式参见[Markdown模块](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/markdown-module)

      示例值:对本次会议内容复盘总结,编写更新本季度OKR\[飞书开放平台](https://open.feishu.cn/)

      参数:
      richDescription -
      返回:
    • build

      public Task build()