niko/weixin4j
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #164 from sutra/wxa-doc

Browse Source 
Update WeChat official documentation links for wxa.
This commit is contained in:
jinyu 2018-10-22 11:10:03 +08:00 committed by GitHub
commit 57484c0d44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WXBizDataCrypt.java
View File

@ -11,7 +11,7 @@ import com.alibaba.fastjson.JSONObject;
* 对微信小程序用户加密数据的解密。 * 对微信小程序用户加密数据的解密。
* *
* @since 1.8 * @since 1.8
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/signature.html#wxchecksessionobject">加密数据解密算法</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html">开放数据校验与解密</a>
*/ */
public class WXBizDataCrypt { public class WXBizDataCrypt {

4
weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/CustomMessageApi.java
View File

@ -35,7 +35,7 @@ public class CustomMessageApi extends TokenManagerApi {
* *
* @param customMessage the {@link CustomMessage}. * @param customMessage the {@link CustomMessage}.
* @throws WeixinException indicates getting access token failed, or sending custom message failed. * @throws WeixinException indicates getting access token failed, or sending custom message failed.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/custommsg/conversation.html">发送客服消息</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/send.html">发送客服消息</a>
*/ */
public void sendCustomMessage(final CustomMessage customMessage) public void sendCustomMessage(final CustomMessage customMessage)
throws WeixinException { throws WeixinException {
@ -61,7 +61,7 @@ public class CustomMessageApi extends TokenManagerApi {
* @param toUser 普通用户(openid) * @param toUser 普通用户(openid)
* @param command "Typing"：对用户下发“正在输入"状态；"CancelTyping"：取消对用户的”正在输入"状态 * @param command "Typing"：对用户下发“正在输入"状态；"CancelTyping"：取消对用户的”正在输入"状态
* @throws WeixinException indicates getting access token failed, or sending typing status failed. * @throws WeixinException indicates getting access token failed, or sending typing status failed.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/custommsg/typing.html">客服输入状态</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/typing.html">客服输入状态</a>
*/ */
public void typingCustomMessage(String toUser, Command command) public void typingCustomMessage(String toUser, Command command)
throws WeixinException { throws WeixinException {

2
weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/LoginApi.java
View File

@ -37,7 +37,7 @@ public class LoginApi extends WxaApi {
* @param grantType 填写为 authorization_code * @param grantType 填写为 authorization_code
* @return the session. * @return the session.
* @throws WeixinException 发生错误时。比如 <code>js_code</code> 无效。 * @throws WeixinException 发生错误时。比如 <code>js_code</code> 无效。
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/api-login.html#%E7%99%BB%E5%BD%95%E5%87%AD%E8%AF%81%E6%A0%A1%E9%AA%8C">登录凭证校验<a/> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html">登录凭证校验<a/>
*/ */
public Session jscode2session(String jsCode, String grantType) throws WeixinException { public Session jscode2session(String jsCode, String grantType) throws WeixinException {
String jscode2sessionUri = getRequestUri("sns_jscode2session", String jscode2sessionUri = getRequestUri("sns_jscode2session",

8
weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java
View File

@ -17,7 +17,7 @@ import com.foxinmy.weixin4j.token.TokenManager;
* 目前微信支持两种二维码，小程序码，小程序二维码。 * 目前微信支持两种二维码，小程序码，小程序二维码。
* </p> * </p>
* *
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/qrcode.html">获取二维码</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/qr-code.html">获取二维码</a>
* @since 1.8 * @since 1.8
*/ */
public class QrCodeApi extends TokenManagerApi { public class QrCodeApi extends TokenManagerApi {
@ -47,7 +47,7 @@ public class QrCodeApi extends TokenManagerApi {
* @return image bytes of WXA code. * @return image bytes of WXA code.
* @throws WeixinException indicates getting access token failed or getting WXA code failed. * @throws WeixinException indicates getting access token failed or getting WXA code failed.
* *
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/qrcode.html#%E8%8E%B7%E5%8F%96%E5%B0%8F%E7%A8%8B%E5%BA%8F%E7%A0%81">获取小程序码</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/getWXACode.html">获取小程序码</a>
*/ */
public byte[] getWxaCode( public byte[] getWxaCode(
String path, String path,
@ -96,7 +96,7 @@ public class QrCodeApi extends TokenManagerApi {
* @return image bytes of WXA code. * @return image bytes of WXA code.
* @throws WeixinException indicates getting access token failed or getting WXA code failed. * @throws WeixinException indicates getting access token failed or getting WXA code failed.
* *
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/qrcode.html#%E8%8E%B7%E5%8F%96%E5%B0%8F%E7%A8%8B%E5%BA%8F%E7%A0%81">获取小程序码</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/getWXACodeUnlimit.html">获取小程序码</a>
*/ */
public byte[] getWxaCodeUnlimit( public byte[] getWxaCodeUnlimit(
String scene, String scene,
@ -125,7 +125,7 @@ public class QrCodeApi extends TokenManagerApi {
* @return image bytes of WXA QR code. * @return image bytes of WXA QR code.
* @throws WeixinException indicates getting access token failed or getting WXA QR code failed. * @throws WeixinException indicates getting access token failed or getting WXA QR code failed.
* *
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/qrcode.html#%E8%8E%B7%E5%8F%96%E5%B0%8F%E7%A8%8B%E5%BA%8F%E4%BA%8C%E7%BB%B4%E7%A0%81">获取小程序二维码</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/createWXAQRCode.html">获取小程序二维码</a>
*/ */
public byte[] createWxaQrCode( public byte[] createWxaQrCode(
String path, String path,

4
weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/SecCheckApi.java
View File

@ -62,7 +62,7 @@ public class SecCheckApi extends TokenManagerApi {
* *
* @param inputStream the image input stream. * @param inputStream the image input stream.
* @throws WeixinException indicates getting access token failed, or the content is risky. * @throws WeixinException indicates getting access token failed, or the content is risky.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/imgSecCheck.html">校验一张图片是否含有违法违规内容</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/sec-check/imgSecCheck.html">校验一张图片是否含有违法违规内容</a>
*/ */
public void imgSecCheck(InputStream inputStream) throws WeixinException { public void imgSecCheck(InputStream inputStream) throws WeixinException {
final String imgSecCheckUri = this.getAccessTokenRequestUri("wxa_img_sec_check"); final String imgSecCheckUri = this.getAccessTokenRequestUri("wxa_img_sec_check");
@ -86,7 +86,7 @@ public class SecCheckApi extends TokenManagerApi {
* *
* @param content 要检测的文本内容，长度不超过 500KB，编码格式为 UTF-8。 * @param content 要检测的文本内容，长度不超过 500KB，编码格式为 UTF-8。
* @throws WeixinException indicates getting access token failed, or the content is risky. * @throws WeixinException indicates getting access token failed, or the content is risky.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/msgSecCheck.html">检查一段文本是否含有违法违规内容</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/sec-check/msgSecCheck.html">检查一段文本是否含有违法违规内容</a>
*/ */
public void msgSecCheck(String content) throws WeixinException { public void msgSecCheck(String content) throws WeixinException {
final Map<String, String> params = new HashMap<String, String>(1); final Map<String, String> params = new HashMap<String, String>(1);

14
weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateApi.java
View File

@ -12,9 +12,9 @@ import com.foxinmy.weixin4j.token.TokenManager;
import com.foxinmy.weixin4j.wxa.model.template.Template; import com.foxinmy.weixin4j.wxa.model.template.Template;
/** /**
* 模版消息管理。 * 模板消息管理。
* *
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/notice.html#%E6%A8%A1%E7%89%88%E6%B6%88%E6%81%AF%E7%AE%A1%E7%90%86">模版消息管理</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/template-message.html">模板消息管理</a>
* @since 1.8 * @since 1.8
*/ */
public class TemplateApi extends TokenManagerApi { public class TemplateApi extends TokenManagerApi {
@ -33,7 +33,7 @@ public class TemplateApi extends TokenManagerApi {
* @param pageable the pagination information. * @param pageable the pagination information.
* @return templates in library. * @return templates in library.
* @throws WeixinException indicates getting access token failed or getting templates failed. * @throws WeixinException indicates getting access token failed or getting templates failed.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/notice.html#1%E8%8E%B7%E5%8F%96%E5%B0%8F%E7%A8%8B%E5%BA%8F%E6%A8%A1%E6%9D%BF%E5%BA%93%E6%A0%87%E9%A2%98%E5%88%97%E8%A1%A8">获取小程序模板库标题列表</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/getTemplateLibraryList.html">获取小程序模板库标题列表</a>
*/ */
public Pagedata<Template> getTemplatesInLibrary(final Pageable pageable) throws WeixinException { public Pagedata<Template> getTemplatesInLibrary(final Pageable pageable) throws WeixinException {
final TemplateListResult r = post( final TemplateListResult r = post(
@ -50,7 +50,7 @@ public class TemplateApi extends TokenManagerApi {
* @param id 模板标题id，可通过接口获取，也可登录小程序后台查看获取 * @param id 模板标题id，可通过接口获取，也可登录小程序后台查看获取
* @return the template in library with specified ID. * @return the template in library with specified ID.
* @throws WeixinException indicates getting access token failed or getting template failed. * @throws WeixinException indicates getting access token failed or getting template failed.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/notice.html#2%E8%8E%B7%E5%8F%96%E6%A8%A1%E6%9D%BF%E5%BA%93%E6%9F%90%E4%B8%AA%E6%A8%A1%E6%9D%BF%E6%A0%87%E9%A2%98%E4%B8%8B%E5%85%B3%E9%94%AE%E8%AF%8D%E5%BA%93">获取模板库某个模板标题下关键词库</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/getTemplateLibraryById.html">获取模板库某个模板标题下关键词库</a>
*/ */
public Template getTemplateInLibrary(String id) throws WeixinException { public Template getTemplateInLibrary(String id) throws WeixinException {
final Map<String, String> params = new HashMap<String, String>(1); final Map<String, String> params = new HashMap<String, String>(1);
@ -70,7 +70,7 @@ public class TemplateApi extends TokenManagerApi {
* @param keywordIds 开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如[3,5,4]或[4,5,3]），最多支持10个关键词组合 * @param keywordIds 开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如[3,5,4]或[4,5,3]），最多支持10个关键词组合
* @return the added template ID. * @return the added template ID.
* @throws WeixinException indicates getting access token failed or adding template failed. * @throws WeixinException indicates getting access token failed or adding template failed.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/notice.html#3%E7%BB%84%E5%90%88%E6%A8%A1%E6%9D%BF%E5%B9%B6%E6%B7%BB%E5%8A%A0%E8%87%B3%E5%B8%90%E5%8F%B7%E4%B8%8B%E7%9A%84%E4%B8%AA%E4%BA%BA%E6%A8%A1%E6%9D%BF%E5%BA%93">组合模板并添加至帐号下的个人模板库</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/addTemplate.html">组合模板并添加至帐号下的个人模板库</a>
*/ */
public String addTemplate(String id, int[] keywordIds) throws WeixinException { public String addTemplate(String id, int[] keywordIds) throws WeixinException {
final AddTemplateParameter params = new AddTemplateParameter(id, keywordIds); final AddTemplateParameter params = new AddTemplateParameter(id, keywordIds);
@ -88,7 +88,7 @@ public class TemplateApi extends TokenManagerApi {
* @param pageable the pagination information. * @param pageable the pagination information.
* @return the templates. * @return the templates.
* @throws WeixinException indicates getting access token failed or getting template failed. * @throws WeixinException indicates getting access token failed or getting template failed.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/notice.html#4%E8%8E%B7%E5%8F%96%E5%B8%90%E5%8F%B7%E4%B8%8B%E5%B7%B2%E5%AD%98%E5%9C%A8%E7%9A%84%E6%A8%A1%E6%9D%BF%E5%88%97%E8%A1%A8">获取帐号下已存在的模板列表</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/getTemplateList.html">获取帐号下已存在的模板列表</a>
*/ */
public List<Template> getTemplates(final Pageable pageable) throws WeixinException { public List<Template> getTemplates(final Pageable pageable) throws WeixinException {
final TemplateListResult r = post( final TemplateListResult r = post(
@ -104,7 +104,7 @@ public class TemplateApi extends TokenManagerApi {
* *
* @param id 要删除的模板id * @param id 要删除的模板id
* @throws WeixinException indicates getting access token failed or deleting template failed. * @throws WeixinException indicates getting access token failed or deleting template failed.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/notice.html#5%E5%88%A0%E9%99%A4%E5%B8%90%E5%8F%B7%E4%B8%8B%E7%9A%84%E6%9F%90%E4%B8%AA%E6%A8%A1%E6%9D%BF">删除帐号下的某个模板</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/deleteTemplate.html">删除帐号下的某个模板</a>
*/ */
public void deleteTemplate(String id) throws WeixinException { public void deleteTemplate(String id) throws WeixinException {
final Map<String, String> params = new HashMap<String, String>(1); final Map<String, String> params = new HashMap<String, String>(1);

6
weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateMessageApi.java
View File

@ -7,9 +7,9 @@ import com.foxinmy.weixin4j.exception.WeixinException;
import com.foxinmy.weixin4j.token.TokenManager; import com.foxinmy.weixin4j.token.TokenManager;
/** /**
* 发送模版消息。 * 发送模板消息。
* *
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/notice.html#%E5%8F%91%E9%80%81%E6%A8%A1%E7%89%88%E6%B6%88%E6%81%AF">发送模版消息</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/template-message.html">发送模板消息</a>
* @since 1.8 * @since 1.8
*/ */
public class TemplateMessageApi extends TokenManagerApi { public class TemplateMessageApi extends TokenManagerApi {
@ -32,7 +32,7 @@ public class TemplateMessageApi extends TokenManagerApi {
* @param data 模板内容，不填则下发空模板。 * @param data 模板内容，不填则下发空模板。
* @param emphasisKeyword 模板需要放大的关键词，不填则默认无放大。 * @param emphasisKeyword 模板需要放大的关键词，不填则默认无放大。
* @throws WeixinException indicates getting access token failed, or sending template message failed. * @throws WeixinException indicates getting access token failed, or sending template message failed.
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/notice.html#%E5%8F%91%E9%80%81%E6%A8%A1%E7%89%88%E6%B6%88%E6%81%AF">发送模版消息</a> * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/sendTemplateMessage.html">发送模板消息</a>
*/ */
public void sendTemplateMessage( public void sendTemplateMessage(
final String toUser, final String toUser,