ListMessageReq.Builder (larksuite-oapi 2.8.5 API)

java.lang.Object
- com.lark.oapi.service.im.v1.model.ListMessageReq.Builder

封闭类:: ListMessageReq

public static class ListMessageReq.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ListMessageReq`	`build()`
`ListMessageReq.Builder`	`cardMsgContentType(String cardMsgContentType)` `card_msg_content_type` 参数仅控制卡片消息的返回格式，不会影响其他类型消息的返回格式。
`ListMessageReq.Builder`	`containerId(String containerId)` 容器 ID。
`ListMessageReq.Builder`	`containerIdType(String containerIdType)` 容器类型。
`ListMessageReq.Builder`	`endTime(String endTime)` 待查询历史信息的结束时间，秒级时间戳。
`ListMessageReq.Builder`	`onlyThreadRootMessages(Boolean onlyThreadRootMessages)` 话题群是否仅返回话题根消息示例值：
`ListMessageReq.Builder`	`pageSize(Integer pageSize)` 分页大小，即单次请求所返回的数据条目数。
`ListMessageReq.Builder`	`pageToken(String pageToken)` 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值：GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ==
`ListMessageReq.Builder`	`sortType(ListMessageReadHistoryMessageV1SortTypeEnum sortType)` 消息排序方式。
`ListMessageReq.Builder`	`sortType(String sortType)` 消息排序方式。
`ListMessageReq.Builder`	`startTime(String startTime)` 待查询历史信息的起始时间，秒级时间戳。
`ListMessageReq.Builder`	`withSenderName(Boolean withSenderName)` 是否返回消息发送者的名称示例值：false

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

- 构造器详细资料
  - Builder
```
public Builder()
```
- 方法详细资料
  - containerIdType
```
public ListMessageReq.Builder containerIdType(String containerIdType)
```
    容器类型。;;**可选值有**：;- `chat`：包含单聊（p2p）和群聊（group）;- `thread`：话题;;**注意**：对于 **普通对话群** 中的话题消息，通过 `chat` 容器类型仅能获取到话题的根消息，你可通过指定容器类型为 `thread` 获取话题回复中的所有消息。
    示例值：chat
    
    参数:
    
    containerIdType -
    
    返回:
  - containerId
```
public ListMessageReq.Builder containerId(String containerId)
```
    容器 ID。ID 类型与 container_id_type 取值一致。;;- 群聊或单聊的 ID 获取方式参见[群 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description)。;- 话题 ID 获取参见[话题概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/thread-introduction)的 **如何获取 thread_id** 章节。
    示例值：oc_234jsi43d3ssi993d43545f
    
    参数:
    
    containerId -
    
    返回:
  - startTime
```
public ListMessageReq.Builder startTime(String startTime)
```
    待查询历史信息的起始时间，秒级时间戳。;;**注意**：`thread` 容器类型暂不支持获取指定时间范围内的消息。
    示例值：1608594809
    
    参数:
    
    startTime -
    
    返回:
  - endTime
```
public ListMessageReq.Builder endTime(String endTime)
```
    待查询历史信息的结束时间，秒级时间戳。;;**注意**：`thread` 容器类型暂不支持获取指定时间范围内的消息。
    示例值：1609296809
    
    参数:
    
    endTime -
    
    返回:
  - sortType
```
public ListMessageReq.Builder sortType(String sortType)
```
    消息排序方式。;;**注意**：使用 `page_token` 分页请求时，排序方式（`sort_type`）均与第一次请求一致，不支持中途改换排序方式。
    示例值：ByCreateTimeAsc
    
    参数:
    
    sortType -
    
    返回:
  - sortType
```
public ListMessageReq.Builder sortType(ListMessageReadHistoryMessageV1SortTypeEnum sortType)
```
    消息排序方式。;;**注意**：使用 `page_token` 分页请求时，排序方式（`sort_type`）均与第一次请求一致，不支持中途改换排序方式。
    示例值：ByCreateTimeAsc
    
    参数:
    
    sortType - ListMessageReadHistoryMessageV1SortTypeEnum
    
    返回:
  - pageSize
```
public ListMessageReq.Builder pageSize(Integer pageSize)
```
    分页大小，即单次请求所返回的数据条目数。
    示例值：20
    
    参数:
    
    pageSize -
    
    返回:
  - pageToken
```
public ListMessageReq.Builder pageToken(String pageToken)
```
    分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
    示例值：GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ==
    
    参数:
    
    pageToken -
    
    返回:
  - cardMsgContentType
```
public ListMessageReq.Builder cardMsgContentType(String cardMsgContentType)
```
    `card_msg_content_type` 参数仅控制卡片消息的返回格式，不会影响其他类型消息的返回格式。;;1. **不传该参数（默认）**：返回的卡片结构参考[接收消息内容](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/events/message_content)中的卡片消息结构，不支持返回发送时的原始卡片 JSON。;2. **传入 `user_card_content`**：返回发送时的原始卡片 JSON。1.0 卡片请参考[卡片 JSON 1.0 结构](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-structure)；2.0 卡片请参考[卡片 JSON 2.0 结构](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-structure)。; * **版本区分**：当返回的消息体为卡片时，可通过 `schema` 字段来区分该卡片是 1.0 还是 2.0 版本，详情参考[卡片 JSON 2.0 版本更新说明](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-breaking-changes-release-notes)。;;> **注意：如果 `card_msg_content_type` 参数的传值方式发生变更，请务必在代码中做好返回格式的兼容处理。**
    示例值：user_card_content
    
    参数:
    
    cardMsgContentType -
    
    返回:
  - onlyThreadRootMessages
```
public ListMessageReq.Builder onlyThreadRootMessages(Boolean onlyThreadRootMessages)
```
    话题群是否仅返回话题根消息
    示例值：
    
    参数:
    
    onlyThreadRootMessages -
    
    返回:
  - withSenderName
```
public ListMessageReq.Builder withSenderName(Boolean withSenderName)
```
    是否返回消息发送者的名称
    示例值：false
    
    参数:
    
    withSenderName -
    
    返回:
  - build
```
public ListMessageReq build()
```

类 ListMessageReq.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

containerIdType

containerId

startTime

endTime

sortType

sortType

pageSize

pageToken

cardMsgContentType

onlyThreadRootMessages

withSenderName

build