程序包 com.lark.oapi.service.calendar.v4

类 CalendarService.Calendar

java.lang.Object

com.lark.oapi.service.calendar.v4.CalendarService.Calendar

封闭类:

CalendarService

public static class CalendarService.Calendar
extends Object

构造器概要

构造器

构造器	说明
Calendar(Config config)

方法概要

修饰符和类型	方法	说明
CreateCalendarResp	create(CreateCalendarReq req)	创建共享日历，该接口用于为当前身份（应用 / 用户）创建一个共享日历。
CreateCalendarResp	create(CreateCalendarReq req, RequestOptions reqOptions)	创建共享日历，该接口用于为当前身份（应用 / 用户）创建一个共享日历。
DeleteCalendarResp	delete(DeleteCalendarReq req)	删除共享日历，该接口用于以当前身份（应用 / 用户）删除一个共享日历。
DeleteCalendarResp	delete(DeleteCalendarReq req, RequestOptions reqOptions)	删除共享日历，该接口用于以当前身份（应用 / 用户）删除一个共享日历。
GetCalendarResp	get(GetCalendarReq req)	查询日历信息，该接口用于以当前身份（应用 / 用户）根据日历 ID 获取日历信息。
GetCalendarResp	get(GetCalendarReq req, RequestOptions reqOptions)	查询日历信息，该接口用于以当前身份（应用 / 用户）根据日历 ID 获取日历信息。
ListCalendarResp	list(ListCalendarReq req)	查询日历列表，该接口用于分页获得当前身份（应用 / 用户）的日历列表。
ListCalendarResp	list(ListCalendarReq req, RequestOptions reqOptions)	查询日历列表，该接口用于分页获得当前身份（应用 / 用户）的日历列表。
PatchCalendarResp	patch(PatchCalendarReq req)	更新日历信息，该接口用于以当前身份（应用 / 用户）修改日历信息。
PatchCalendarResp	patch(PatchCalendarReq req, RequestOptions reqOptions)	更新日历信息，该接口用于以当前身份（应用 / 用户）修改日历信息。
PrimaryCalendarResp	primary(PrimaryCalendarReq req)	查询主日历信息，获取当前身份的主日历信息。
PrimaryCalendarResp	primary(PrimaryCalendarReq req, RequestOptions reqOptions)	查询主日历信息，获取当前身份的主日历信息。
SearchCalendarResp	search(SearchCalendarReq req)	搜索日历，该接口用于通过关键字查询公共日历或用户主日历。
SearchCalendarResp	search(SearchCalendarReq req, RequestOptions reqOptions)	搜索日历，该接口用于通过关键字查询公共日历或用户主日历。
SubscribeCalendarResp	subscribe(SubscribeCalendarReq req)	订阅日历，该接口用于以当前身份（应用 / 用户）订阅某个日历。
SubscribeCalendarResp	subscribe(SubscribeCalendarReq req, RequestOptions reqOptions)	订阅日历，该接口用于以当前身份（应用 / 用户）订阅某个日历。
SubscriptionCalendarResp	subscription()	订阅日历变更事件，该接口用于以用户身份订阅当前身份下日历列表中的所有日历变更。
SubscriptionCalendarResp	subscription(RequestOptions reqOptions)	订阅日历变更事件，该接口用于以用户身份订阅当前身份下日历列表中的所有日历变更。
UnsubscribeCalendarResp	unsubscribe(UnsubscribeCalendarReq req)	取消订阅日历，该接口用于以当前身份（应用 / 用户）取消对某日历的订阅状态。
UnsubscribeCalendarResp	unsubscribe(UnsubscribeCalendarReq req, RequestOptions reqOptions)	取消订阅日历，该接口用于以当前身份（应用 / 用户）取消对某日历的订阅状态。
UnsubscriptionCalendarResp	unsubscription()	取消订阅日历变更事件，该接口用于以用户身份取消订阅当前身份下日历列表中的日历变更事件。
UnsubscriptionCalendarResp	unsubscription(RequestOptions reqOptions)	取消订阅日历变更事件，该接口用于以用户身份取消订阅当前身份下日历列表中的日历变更事件。

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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Calendar

public Calendar(Config config)

方法详细资料

create

public CreateCalendarResp create(CreateCalendarReq req,
 RequestOptions reqOptions)
                          throws Exception

创建共享日历，该接口用于为当前身份（应用 / 用户）创建一个共享日历。;;身份由 Header Authorization 的 Token 类型决定。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/create ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/CreateCalendarSample.java ;

抛出:

Exception

create

public CreateCalendarResp create(CreateCalendarReq req)
                          throws Exception

创建共享日历，该接口用于为当前身份（应用 / 用户）创建一个共享日历。;;身份由 Header Authorization 的 Token 类型决定。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/create ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/CreateCalendarSample.java ;

抛出:

Exception

delete

public DeleteCalendarResp delete(DeleteCalendarReq req,
 RequestOptions reqOptions)
                          throws Exception

删除共享日历，该接口用于以当前身份（应用 / 用户）删除一个共享日历。;;身份由 Header Authorization 的 Token 类型决定。

当前身份必须对日历具有 owner 权限。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/delete ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/DeleteCalendarSample.java ;

抛出:

Exception

delete

public DeleteCalendarResp delete(DeleteCalendarReq req)
                          throws Exception

删除共享日历，该接口用于以当前身份（应用 / 用户）删除一个共享日历。;;身份由 Header Authorization 的 Token 类型决定。

当前身份必须对日历具有 owner 权限。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/delete ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/DeleteCalendarSample.java ;

抛出:

Exception

get

public GetCalendarResp get(GetCalendarReq req,
 RequestOptions reqOptions)
                    throws Exception

查询日历信息，该接口用于以当前身份（应用 / 用户）根据日历 ID 获取日历信息。;;身份由 Header Authorization 的 Token 类型决定。

当前身份必须对日历有访问权限。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/GetCalendarSample.java ;

抛出:

Exception

get

public GetCalendarResp get(GetCalendarReq req)
                    throws Exception

查询日历信息，该接口用于以当前身份（应用 / 用户）根据日历 ID 获取日历信息。;;身份由 Header Authorization 的 Token 类型决定。

当前身份必须对日历有访问权限。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/GetCalendarSample.java ;

抛出:

Exception

list

public ListCalendarResp list(ListCalendarReq req,
 RequestOptions reqOptions)
                      throws Exception

查询日历列表，该接口用于分页获得当前身份（应用 / 用户）的日历列表。;;身份由 Header Authorization 的 Token 类型决定。

调用时首先使用 page_token 分页拉取存量数据，之后使用 sync_token 增量同步变更数据。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/ListCalendarSample.java ;

抛出:

Exception

list

public ListCalendarResp list(ListCalendarReq req)
                      throws Exception

查询日历列表，该接口用于分页获得当前身份（应用 / 用户）的日历列表。;;身份由 Header Authorization 的 Token 类型决定。

调用时首先使用 page_token 分页拉取存量数据，之后使用 sync_token 增量同步变更数据。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/ListCalendarSample.java ;

抛出:

Exception

patch

public PatchCalendarResp patch(PatchCalendarReq req,
 RequestOptions reqOptions)
                        throws Exception

更新日历信息，该接口用于以当前身份（应用 / 用户）修改日历信息。;;身份由 Header Authorization 的 Token 类型决定。

当前身份对日历有 owner 权限时，可修改全局字段：summary, description, permission。;;当前身份对日历不具有 owner 权限时，仅可修改对自己生效的字段：color, summary_alias。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/patch ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/PatchCalendarSample.java ;

抛出:

Exception

patch

public PatchCalendarResp patch(PatchCalendarReq req)
                        throws Exception

更新日历信息，该接口用于以当前身份（应用 / 用户）修改日历信息。;;身份由 Header Authorization 的 Token 类型决定。

当前身份对日历有 owner 权限时，可修改全局字段：summary, description, permission。;;当前身份对日历不具有 owner 权限时，仅可修改对自己生效的字段：color, summary_alias。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/patch ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/PatchCalendarSample.java ;

抛出:

Exception

primary

public PrimaryCalendarResp primary(PrimaryCalendarReq req,
 RequestOptions reqOptions)
                            throws Exception

查询主日历信息，获取当前身份的主日历信息。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/PrimaryCalendarSample.java ;

抛出:

Exception

primary

public PrimaryCalendarResp primary(PrimaryCalendarReq req)
                            throws Exception

查询主日历信息，获取当前身份的主日历信息。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/PrimaryCalendarSample.java ;

抛出:

Exception

search

public SearchCalendarResp search(SearchCalendarReq req,
 RequestOptions reqOptions)
                          throws Exception

搜索日历，该接口用于通过关键字查询公共日历或用户主日历。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/search ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/SearchCalendarSample.java ;

抛出:

Exception

search

public SearchCalendarResp search(SearchCalendarReq req)
                          throws Exception

搜索日历，该接口用于通过关键字查询公共日历或用户主日历。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/search ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/SearchCalendarSample.java ;

抛出:

Exception

subscribe

public SubscribeCalendarResp subscribe(SubscribeCalendarReq req,
 RequestOptions reqOptions)
                                throws Exception

订阅日历，该接口用于以当前身份（应用 / 用户）订阅某个日历。;;身份由 Header Authorization 的 Token 类型决定。

- 仅可订阅类型为 primary 或 shared 的公开日历。;- 可订阅日历数量上限为1000。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscribe ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/SubscribeCalendarSample.java ;

抛出:

Exception

subscribe

public SubscribeCalendarResp subscribe(SubscribeCalendarReq req)
                                throws Exception

订阅日历，该接口用于以当前身份（应用 / 用户）订阅某个日历。;;身份由 Header Authorization 的 Token 类型决定。

- 仅可订阅类型为 primary 或 shared 的公开日历。;- 可订阅日历数量上限为1000。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscribe ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/SubscribeCalendarSample.java ;

抛出:

Exception

subscription

public SubscriptionCalendarResp subscription(RequestOptions reqOptions)
                                      throws Exception

订阅日历变更事件，该接口用于以用户身份订阅当前身份下日历列表中的所有日历变更。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscription ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/SubscriptionCalendarSample.java ;

抛出:

Exception

subscription

public SubscriptionCalendarResp subscription()
                                      throws Exception

订阅日历变更事件，该接口用于以用户身份订阅当前身份下日历列表中的所有日历变更。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/subscription ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/SubscriptionCalendarSample.java ;

抛出:

Exception

unsubscribe

public UnsubscribeCalendarResp unsubscribe(UnsubscribeCalendarReq req,
 RequestOptions reqOptions)
                                    throws Exception

取消订阅日历，该接口用于以当前身份（应用 / 用户）取消对某日历的订阅状态。;;身份由 Header Authorization 的 Token 类型决定。

仅可操作已经被当前身份订阅的日历。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscribe ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/UnsubscribeCalendarSample.java ;

抛出:

Exception

unsubscribe

public UnsubscribeCalendarResp unsubscribe(UnsubscribeCalendarReq req)
                                    throws Exception

取消订阅日历，该接口用于以当前身份（应用 / 用户）取消对某日历的订阅状态。;;身份由 Header Authorization 的 Token 类型决定。

仅可操作已经被当前身份订阅的日历。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscribe ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/UnsubscribeCalendarSample.java ;

抛出:

Exception

unsubscription

public UnsubscriptionCalendarResp unsubscription(RequestOptions reqOptions)
                                          throws Exception

取消订阅日历变更事件，该接口用于以用户身份取消订阅当前身份下日历列表中的日历变更事件。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscription ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/UnsubscriptionCalendarSample.java ;

抛出:

Exception

unsubscription

public UnsubscriptionCalendarResp unsubscription()
                                          throws Exception

取消订阅日历变更事件，该接口用于以用户身份取消订阅当前身份下日历列表中的日历变更事件。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/unsubscription ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/UnsubscriptionCalendarSample.java ;

抛出:

Exception