cn.binarywang.wx.miniapp.api.WxMaTemplateService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weixin-java-miniapp Show documentation
微信小程序 Java SDK
The newest version!
package cn.binarywang.wx.miniapp.api;

import cn.binarywang.wx.miniapp.bean.template.WxMaTemplateAddResult;
import cn.binarywang.wx.miniapp.bean.template.WxMaTemplateLibraryGetResult;
import cn.binarywang.wx.miniapp.bean.template.WxMaTemplateLibraryListResult;
import cn.binarywang.wx.miniapp.bean.template.WxMaTemplateListResult;
import me.chanjar.weixin.common.error.WxErrorException;

import java.util.List;

public interface WxMaTemplateService {

  //获取小程序模板库标题列表
  String TEMPLATE_LIBRARY_LIST_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/library/list";

  //获取模板库某个模板标题下关键词库
  String TEMPLATE_LIBRARY_KEYWORD_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/library/get";

  //组合模板并添加至帐号下的个人模板库
  String TEMPLATE_ADD_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/add";

  //获取帐号下已存在的模板列表
  String TEMPLATE_LIST_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/list";

  //删除帐号下的某个模板
  String TEMPLATE_DEL_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/del";

  /**
   *    * 获取小程序模板库标题列表
   *
   * 详情请见: 获取小程序模板库标题列表
   * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/library/list?access_token=ACCESS_TOKEN
   * 
   * @param offset
   * @param count
   * @return
   */
  WxMaTemplateLibraryListResult findTemplateLibraryList(int offset, int count) throws WxErrorException;

  /**
   *    * 获取模板库某个模板标题下关键词库
   *
   * 详情请见: 获取小程序模板库标题列表
   * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/library/get?access_token=ACCESS_TOKEN
   * 
   * @param id
   * @return
   */
  WxMaTemplateLibraryGetResult findTemplateLibraryKeywordList(String id) throws WxErrorException;

  /**
   *    * 组合模板并添加至帐号下的个人模板库
   *
   * 详情请见: 获取小程序模板库标题列表
   * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/add?access_token=ACCESS_TOKEN
   * 
   * @param id
   * @param keywordIdList
   * @return
   */
  WxMaTemplateAddResult addTemplate(String id, List keywordIdList) throws WxErrorException;

  /**
   *    * 获取帐号下已存在的模板列表
   *
   * 详情请见: 获取小程序模板库标题列表
   * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/list?access_token=ACCESS_TOKEN
   * 
   * @param offset
   * @param count
   * @return
   */
  WxMaTemplateListResult findTemplateList(int offset, int count) throws WxErrorException;

  /**
   *    * 删除帐号下的某个模板
   *
   * 详情请见: 获取小程序模板库标题列表
   * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/list?access_token=ACCESS_TOKEN
   * 
   * @param templateId
   */
  boolean delTemplate(String templateId) throws WxErrorException;
}