ListCalendarEventReq.Builder (larksuite-oapi 2.8.5 API)

java.lang.Object
- com.lark.oapi.service.calendar.v4.model.ListCalendarEventReq.Builder

封闭类:: ListCalendarEventReq

public static class ListCalendarEventReq.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ListCalendarEventReq.Builder`	`anchorTime(String anchorTime)` 时间锚点，Unix 时间戳（秒）。
`ListCalendarEventReq`	`build()`
`ListCalendarEventReq.Builder`	`calendarId(String calendarId)` 日历 ID。
`ListCalendarEventReq.Builder`	`endTime(String endTime)` 时间区间的结束时间， Unix 时间戳（秒）。
`ListCalendarEventReq.Builder`	`opUserId(String opUserId)` 应用身份下指定操作用户的日历日程数据示例值：ou_7d8a6e6df7621556ce0d21922b676706ccs
`ListCalendarEventReq.Builder`	`pageSize(Integer pageSize)` 一次请求要求返回的最大日程数量。
`ListCalendarEventReq.Builder`	`pageToken(String pageToken)` 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值：ListCalendarsPageToken_1632452910_1632539310
`ListCalendarEventReq.Builder`	`startTime(String startTime)` 时间区间的开始时间， Unix 时间戳（秒），与end_time搭配使用，用于拉取指定时间区间内的日程数据.
`ListCalendarEventReq.Builder`	`syncToken(String syncToken)` 增量同步标记，第一次请求不填。
`ListCalendarEventReq.Builder`	`userIdType(ListCalendarEventUserIdTypeEnum userIdType)` 此次调用中使用的用户ID的类型示例值：
`ListCalendarEventReq.Builder`	`userIdType(String userIdType)` 此次调用中使用的用户ID的类型示例值：

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

- 构造器详细资料
  - Builder
```
public Builder()
```
- 方法详细资料
  - pageSize
```
public ListCalendarEventReq.Builder pageSize(Integer pageSize)
```
    一次请求要求返回的最大日程数量。实际返回的日程数量可能小于该值，也可能为空，可以根据响应体里的has_more字段来判断是否还有更多日程。
    示例值：50
    
    参数:
    
    pageSize -
    
    返回:
  - anchorTime
```
public ListCalendarEventReq.Builder anchorTime(String anchorTime)
```
    时间锚点，Unix 时间戳（秒）。anchor_time 用于设置一个时间点，以便直接拉取该时间点之后的日程数据，从而避免拉取全量日程数据。可使用 page_token 或 sync_token 进行分页或增量拉取 anchor_time 之后的所有日程数据。;;**使用说明**：;;- 对于单次日程，会获取到 **日程结束时间 >= anchor_time** 的日程信息。;- 对于重复性日程，目前设置 anchor_time 后均会获取到，包括在 anchor_time 之前的已结束的历史重复性日程。;- 对于例外日程，会获取到 **original_time >= anchor_time** 以及 **日程结束时间 >= anchor_time** 的日程信息，其中 original_time 从例外日程 ID 中获取，ID 结构为 `{uid}_{original_time}`。;;**注意**：该参数不可与 start_time 和 end_time 一起使用。;;**默认值**：空
    示例值：1609430400
    
    参数:
    
    anchorTime -
    
    返回:
  - pageToken
```
public ListCalendarEventReq.Builder pageToken(String pageToken)
```
    分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
    示例值：ListCalendarsPageToken_1632452910_1632539310
    
    参数:
    
    pageToken -
    
    返回:
  - syncToken
```
public ListCalendarEventReq.Builder syncToken(String syncToken)
```
    增量同步标记，第一次请求不填。当分页查询结束（page_token 返回值为空）时，接口会返回 sync_token 字段，下次调用可使用该 sync_token 增量获取日历变更数据。;;**默认值**：空
    示例值：ListCalendarsSyncToken_1632452910
    
    参数:
    
    syncToken -
    
    返回:
  - startTime
```
public ListCalendarEventReq.Builder startTime(String startTime)
```
    时间区间的开始时间， Unix 时间戳（秒），与end_time搭配使用，用于拉取指定时间区间内的日程数据.;;**注意**：;;- 该方式只能一次性返回数据，无法进行分页。一次性返回的数据大小受page_size限制，超过限制的数据将被截断。;- 在使用start_time和end_time时，不能与page_token或sync_token一起使用。;- 在使用start_time和end_time时，不能与anchor_time一起使用。;;**默认值**：空
    示例值：1631777271
    
    参数:
    
    startTime -
    
    返回:
  - endTime
```
public ListCalendarEventReq.Builder endTime(String endTime)
```
    时间区间的结束时间， Unix 时间戳（秒）。与start_time搭配使用，用于拉取指定时间区间内的日程数据.;;**注意**：;;- 该方式只能一次性返回数据，无法进行分页。一次性返回的数据大小受page_size限制，超过限制的数据将被截断。;- 在使用start_time和end_time时不能与page_token或sync_token一起使用。;- 在使用start_time和end_time时，不能与anchor_time一起使用。;;**默认值**：空
    示例值：1631777271
    
    参数:
    
    endTime -
    
    返回:
  - userIdType
```
public ListCalendarEventReq.Builder userIdType(String userIdType)
```
    此次调用中使用的用户ID的类型
    示例值：
    
    参数:
    
    userIdType -
    
    返回:
  - userIdType
```
public ListCalendarEventReq.Builder userIdType(ListCalendarEventUserIdTypeEnum userIdType)
```
    此次调用中使用的用户ID的类型
    示例值：
    
    参数:
    
    userIdType - ListCalendarEventUserIdTypeEnum
    
    返回:
  - opUserId
```
public ListCalendarEventReq.Builder opUserId(String opUserId)
```
    应用身份下指定操作用户的日历日程数据
    示例值：ou_7d8a6e6df7621556ce0d21922b676706ccs
    
    参数:
    
    opUserId -
    
    返回:
  - calendarId
```
public ListCalendarEventReq.Builder calendarId(String calendarId)
```
    日历 ID。关于日历 ID 可参见[日历 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/introduction)。
    示例值：feishu.cn_xxxxxxxxxx@group.calendar.feishu.cn
    
    参数:
    
    calendarId -
    
    返回:
  - build
```
public ListCalendarEventReq build()
```

类 ListCalendarEventReq.Builder

构造器概要

方法概要

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

构造器详细资料

Builder

方法详细资料

pageSize

anchorTime

pageToken

syncToken

startTime

endTime

userIdType

userIdType

opUserId

calendarId

build