com.lark.oapi.service.im.v1.resource

类 ChatMenuTree

java.lang.Object

com.lark.oapi.service.im.v1.resource.ChatMenuTree

public class ChatMenuTree
extends Object

构造器概要

构造器

构造器和说明
ChatMenuTree(Config config)

方法概要

限定符和类型	方法和说明
CreateChatMenuTreeResp	create(CreateChatMenuTreeReq req) 添加群菜单，在指定群组中添加一个或多个群菜单。
CreateChatMenuTreeResp	create(CreateChatMenuTreeReq req, RequestOptions reqOptions) 添加群菜单，在指定群组中添加一个或多个群菜单。
DeleteChatMenuTreeResp	delete(DeleteChatMenuTreeReq req) 删除群菜单，删除指定群内的一级菜单。
DeleteChatMenuTreeResp	delete(DeleteChatMenuTreeReq req, RequestOptions reqOptions) 删除群菜单，删除指定群内的一级菜单。
GetChatMenuTreeResp	get(GetChatMenuTreeReq req) 获取群菜单，获取指定群组内的群菜单信息，包括所有一级或二级菜单的名称、跳转链接、图标等信息。
GetChatMenuTreeResp	get(GetChatMenuTreeReq req, RequestOptions reqOptions) 获取群菜单，获取指定群组内的群菜单信息，包括所有一级或二级菜单的名称、跳转链接、图标等信息。
SortChatMenuTreeResp	sort(SortChatMenuTreeReq req) 排序群菜单，调整指定群组内的群菜单排列顺序，成功调用后接口会返回群组内所有群菜单信息。
SortChatMenuTreeResp	sort(SortChatMenuTreeReq req, RequestOptions reqOptions) 排序群菜单，调整指定群组内的群菜单排列顺序，成功调用后接口会返回群组内所有群菜单信息。

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

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

构造器详细资料

ChatMenuTree

public ChatMenuTree(Config config)

方法详细资料

create

public CreateChatMenuTreeResp create(CreateChatMenuTreeReq req,
                                     RequestOptions reqOptions)
                              throws Exception

添加群菜单，在指定群组中添加一个或多个群菜单。成功调用后接口会返回当前群组内所有群菜单信息。

## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用当前接口的机器人必须在对应的群组内。;;## 使用限制;;- 该接口是向群内追加菜单，群内已存在的菜单不会被覆盖。;- 一个群内最多有 3 个一级菜单，每个一级菜单最多配置 5 个二级菜单。;- 不支持在已有的一级菜单中追加二级菜单。;- 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=create&project=im&resource=chat.menu_tree&version=v1 ;

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

抛出:

Exception

create

public CreateChatMenuTreeResp create(CreateChatMenuTreeReq req)
                              throws Exception

添加群菜单，在指定群组中添加一个或多个群菜单。成功调用后接口会返回当前群组内所有群菜单信息。

## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用当前接口的机器人必须在对应的群组内。;;## 使用限制;;- 该接口是向群内追加菜单，群内已存在的菜单不会被覆盖。;- 一个群内最多有 3 个一级菜单，每个一级菜单最多配置 5 个二级菜单。;- 不支持在已有的一级菜单中追加二级菜单。;- 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=create&project=im&resource=chat.menu_tree&version=v1 ;

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

抛出:

Exception

delete

public DeleteChatMenuTreeResp delete(DeleteChatMenuTreeReq req,
                                     RequestOptions reqOptions)
                              throws Exception

删除群菜单，删除指定群内的一级菜单。成功调用后接口会返回群组内最新的群菜单信息。

## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用当前接口的用户或者机器人必须在对应的会话内。;;## 使用限制;;- 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。;- 仅支持删除群组内的一级菜单。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=delete&project=im&resource=chat.menu_tree&version=v1 ;

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

抛出:

Exception

delete

public DeleteChatMenuTreeResp delete(DeleteChatMenuTreeReq req)
                              throws Exception

删除群菜单，删除指定群内的一级菜单。成功调用后接口会返回群组内最新的群菜单信息。

## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用当前接口的用户或者机器人必须在对应的会话内。;;## 使用限制;;- 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。;- 仅支持删除群组内的一级菜单。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=delete&project=im&resource=chat.menu_tree&version=v1 ;

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

抛出:

Exception

get

public GetChatMenuTreeResp get(GetChatMenuTreeReq req,
                               RequestOptions reqOptions)
                        throws Exception

获取群菜单，获取指定群组内的群菜单信息，包括所有一级或二级菜单的名称、跳转链接、图标等信息。

## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用当前接口的机器人必须在对应的群组内。;;## 使用限制;;该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=im&resource=chat.menu_tree&version=v1 ;

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

抛出:

Exception

get

public GetChatMenuTreeResp get(GetChatMenuTreeReq req)
                        throws Exception

获取群菜单，获取指定群组内的群菜单信息，包括所有一级或二级菜单的名称、跳转链接、图标等信息。

## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用当前接口的机器人必须在对应的群组内。;;## 使用限制;;该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=im&resource=chat.menu_tree&version=v1 ;

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

抛出:

Exception

sort

public SortChatMenuTreeResp sort(SortChatMenuTreeReq req,
                                 RequestOptions reqOptions)
                          throws Exception

排序群菜单，调整指定群组内的群菜单排列顺序，成功调用后接口会返回群组内所有群菜单信息。

## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用当前接口的机器人必须在对应的群组内。;;## 使用限制;;- 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。;- 仅支持调整群组内一级菜单的排序。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=sort&project=im&resource=chat.menu_tree&version=v1 ;

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

抛出:

Exception

sort

public SortChatMenuTreeResp sort(SortChatMenuTreeReq req)
                          throws Exception

排序群菜单，调整指定群组内的群菜单排列顺序，成功调用后接口会返回群组内所有群菜单信息。

## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用当前接口的机器人必须在对应的群组内。;;## 使用限制;;- 该接口仅支持群模式为 `group` 的群组，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_mode` 参数取值是否为 `group`。;- 仅支持调整群组内一级菜单的排序。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=sort&project=im&resource=chat.menu_tree&version=v1 ;

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

抛出:

Exception