• Home
• org.lujian.weixin
• weixin-mp
• 0.0.1
• source code
• MpMenuApi.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.lujian.weixin.mp.api.menu.MpMenuApi Maven / Gradle / Ivy

package org.lujian.weixin.mp.api.menu;

import lombok.val;
import org.lujian.weixin.common.exception.ApiException;
import org.lujian.weixin.common.model.ApiResult;
import org.lujian.weixin.mp.api.MpApi;
import org.lujian.weixin.mp.api.menu.model.Menu;
import org.lujian.weixin.mp.api.menu.model.UserId;
import org.lujian.weixin.mp.api.menu.model.button.Button;
import org.lujian.weixin.mp.api.menu.model.response.GetCurrentSelfMenuInfoResponse;
import org.lujian.weixin.mp.api.menu.model.response.GetMenuResponse;
import org.lujian.weixin.mp.api.menu.model.MenuId;

import java.util.List;

/**
 * 自定义菜单接口调用
 * https://developers.weixin.qq.com/doc/offiaccount/Custom_Menus/Creating_Custom-Defined_Menu.html
 *
 * @author lujian
 */
public class MpMenuApi extends MpApi {

    /**
     * 创建菜单
     *
     * @param menu
     * @throws ApiException
     */
    public void create(String menu) throws ApiException {
        val url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN";
        this.weiXinReqService.post(url, menu, ApiResult.class);
    }

    /**
     * 创建菜单
     *
     * @param menu
     * @throws ApiException
     */
    public void create(Menu menu) throws ApiException {
        val url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN";
        this.weiXinReqService.post(url, menu, ApiResult.class);
    }

    /**
     * 创建菜单
     *
     * @param buttons
     * @throws ApiException
     */
    public void create(List buttons) throws ApiException {
        create(new Menu(buttons));
    }

    /**
     * 公众号当前使用的自定义菜单的配置，
     * 如果公众号是通过API调用设置的菜单，则返回菜单的开发配置，
     * 而如果公众号是在公众平台官网通过网站功能发布菜单，则本接口返回运营者设置的菜单配置。
     *
     * @return
     * @throws ApiException
     */
    public GetCurrentSelfMenuInfoResponse getCurrentSelfMenuInfo() throws ApiException {
        val url = "https://api.weixin.qq.com/cgi-bin/get_current_selfmenu_info?access_token=ACCESS_TOKEN";
        return this.weiXinReqService.get(url, GetCurrentSelfMenuInfoResponse.class);
    }

    /**
     * 删除当前使用的自定义菜单。另请注意，在个性化菜单时，调用此接口会删除默认菜单及全部个性化菜单。
     *
     * @throws ApiException
     */
    public void delete() throws ApiException {
        val url = "https://api.weixin.qq.com/cgi-bin/menu/delete?access_token=ACCESS_TOKEN";
        this.weiXinReqService.get(url, ApiResult.class);
    }

    /**
     * 查询自定义菜单的结构。另外请注意，在设置了个性化菜单后，使用本自定义菜单查询接口可以获取默认菜单和全部个性化菜单信息。
     *
     * @return
     * @throws ApiException
     */
    public GetMenuResponse get() throws ApiException {
        val url = "https://api.weixin.qq.com/cgi-bin/menu/get?access_token=ACCESS_TOKEN";
        return this.weiXinReqService.get(url, GetMenuResponse.class);
    }

    /**
     * 创建个性化菜单
     *
     * @param menu
     * @return
     * @throws ApiException
     */
    public MenuId addConditional(Menu menu) throws ApiException {
        val url = "https://api.weixin.qq.com/cgi-bin/menu/addconditional?access_token=ACCESS_TOKEN";
        return this.weiXinReqService.post(url, menu, MenuId.class);
    }

    /**
     * 删除个性化菜单
     *
     * @param menuid
     * @throws ApiException
     */
    public void delConditional(MenuId menuid) throws ApiException {
        val url = "https://api.weixin.qq.com/cgi-bin/menu/delconditional?access_token=ACCESS_TOKEN";
        this.weiXinReqService.post(url, menuid, ApiResult.class);
    }

    /**
     * 删除个性化菜单
     *
     * @param menuid
     * @throws ApiException
     */
    public void delConditional(String menuid) throws ApiException {
        delConditional(new MenuId(menuid));
    }

    /**
     * 测试个性化菜单匹配结果
     *
     * @param userId
     * @return
     * @throws ApiException
     */
    public Menu tryMatch(UserId userId) throws ApiException {
        val url = "https://api.weixin.qq.com/cgi-bin/menu/trymatch?access_token=ACCESS_TOKEN";
        return this.weiXinReqService.post(url, userId, Menu.class);
    }

    /**
     * 测试个性化菜单匹配结果
     *
     * @param userId
     * @return
     * @throws ApiException
     */
    public Menu tryMatch(String userId) throws ApiException {
        return tryMatch(new UserId(userId));
    }
}