类 CreateChatReqBody.Builder

java.lang.Object
com.lark.oapi.service.im.v1.model.CreateChatReqBody.Builder
封闭类:
CreateChatReqBody

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

    • Builder

      public Builder()
  • 方法详细资料

    • avatar

      public CreateChatReqBody.Builder avatar(String avatar)
      群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==)

      示例值:default-avatar_44ae0ca3-e140-494b-956f-78091e348435

      参数:
      avatar -
      返回:
    • name

      public CreateChatReqBody.Builder name(String name)
      群名称;; **注意:** ;- 公开群名称的长度不得少于2个字符;- 私有群若未填写群名称,群名称默认设置为 ”`(无主题)`“

      示例值:测试群名称

      参数:
      name -
      返回:
    • description

      public CreateChatReqBody.Builder description(String description)
      群描述

      示例值:测试群描述

      参数:
      description -
      返回:
    • i18nNames

      public CreateChatReqBody.Builder i18nNames(I18nNames i18nNames)
      群国际化名称

      示例值:

      参数:
      i18nNames -
      返回:
    • ownerId

      public CreateChatReqBody.Builder ownerId(String ownerId)
      创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID值应与查询参数中的 ==user_id_type== 对应;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取用户的Open ID

      示例值:4d7a3c6g

      参数:
      ownerId -
      返回:
    • userIdList

      public CreateChatReqBody.Builder userIdList(String[] userIdList)
      创建群时邀请的群成员,ID 类型在查询参数 ==user_id_type== 中指定;当ID类型为`open_id`时,可参考[如何获取 Open ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)来获取用户的Open ID;;**注意**:;- 最多同时邀请 50 个用户;- 为便于在客户端查看效果,建议调试接口时加入开发者自身ID

      示例值:["4d7a3c6g"]

      参数:
      userIdList -
      返回:
    • botIdList

      public CreateChatReqBody.Builder botIdList(String[] botIdList)
      创建群时邀请的群机器人;可参考[如何获取应用的 App ID?](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-app-id)来获取应用的App ID; ;**注意:** ;- 拉机器人入群请使用`app_id`;- 最多同时邀请5个机器人,并且群组最多容纳 15 个机器人

      示例值:["cli_a10fbf7e94b8d01d"]

      参数:
      botIdList -
      返回:
    • chatMode

      public CreateChatReqBody.Builder chatMode(String chatMode)
      群模式;;**可选值有**:;- `group`:群组

      示例值:group

      参数:
      chatMode -
      返回:
    • chatType

      public CreateChatReqBody.Builder chatType(String chatType)
      群类型;;**可选值有**:;- `private`:私有群;- `public`:公开群

      示例值:private

      参数:
      chatType -
      返回:
    • external

      public CreateChatReqBody.Builder external(Boolean external)
      是否是外部群;若群组需要邀请不同租户的用户或机器人,请指定为外部群;

      示例值:false

      参数:
      external -
      返回:
    • joinMessageVisibility

      public CreateChatReqBody.Builder joinMessageVisibility(String joinMessageVisibility)
      入群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

      示例值:all_members

      参数:
      joinMessageVisibility -
      返回:
    • leaveMessageVisibility

      public CreateChatReqBody.Builder leaveMessageVisibility(String leaveMessageVisibility)
      退群消息可见性;;**可选值有**:;- `only_owner`:仅群主和管理员可见;- `all_members`:所有成员可见;- `not_anyone`:任何人均不可见

      示例值:all_members

      参数:
      leaveMessageVisibility -
      返回:
    • membershipApproval

      public CreateChatReqBody.Builder membershipApproval(String membershipApproval)
      加群审批;;**可选值有**:;- `no_approval_required`:无需审批;- `approval_required`:需要审批

      示例值:no_approval_required

      参数:
      membershipApproval -
      返回:
    • build

      public CreateChatReqBody build()