me.chanjar.weixin.cp.api.WxCpMenuService Maven / Gradle / Ivy
package me.chanjar.weixin.cp.api;
import me.chanjar.weixin.common.bean.menu.WxMenu;
import me.chanjar.weixin.common.error.WxErrorException;
/**
*
* 菜单管理相关接口
* Created by BinaryWang on 2017/6/24.
*
*
* @author Binary Wang
*/
public interface WxCpMenuService {
/**
*
* 自定义菜单创建接口
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口
*
* 注意: 这个方法使用WxCpConfigStorage里的agentId
*
*
* @param menu 菜单对象
* @throws WxErrorException the wx error exception
* @see #create(Integer, WxMenu) #create(Integer, WxMenu)
*/
void create(WxMenu menu) throws WxErrorException;
/**
*
* 自定义菜单创建接口
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口
*
* 注意: 这个方法不使用WxCpConfigStorage里的agentId，需要开发人员自己给出
*
*
* @param agentId 企业号应用的id
* @param menu 菜单对象
* @throws WxErrorException the wx error exception
* @see #create(me.chanjar.weixin.common.bean.menu.WxMenu) #create(me.chanjar.weixin.common.bean.menu.WxMenu)
*/
void create(Integer agentId, WxMenu menu) throws WxErrorException;
/**
*
* 自定义菜单删除接口
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口
*
* 注意: 这个方法使用WxCpConfigStorage里的agentId
*
*
* @throws WxErrorException the wx error exception
* @see #delete(Integer) #delete(Integer)
*/
void delete() throws WxErrorException;
/**
*
* 自定义菜单删除接口
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口
*
* 注意: 这个方法不使用WxCpConfigStorage里的agentId，需要开发人员自己给出
*
*
* @param agentId 企业号应用的id
* @throws WxErrorException the wx error exception
* @see #delete() #delete()
*/
void delete(Integer agentId) throws WxErrorException;
/**
*
* 自定义菜单查询接口
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口
*
* 注意: 这个方法使用WxCpConfigStorage里的agentId
*
*
* @return the wx menu
* @throws WxErrorException the wx error exception
* @see #get(Integer) #get(Integer)
*/
WxMenu get() throws WxErrorException;
/**
*
* 自定义菜单查询接口
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口
*
* 注意: 这个方法不使用WxCpConfigStorage里的agentId，需要开发人员自己给出
*
*
* @param agentId 企业号应用的id
* @return the wx menu
* @throws WxErrorException the wx error exception
* @see #get() #get()
*/
WxMenu get(Integer agentId) throws WxErrorException;
}