Revise javadoc.
This commit is contained in:
parent
9dd5c4d0f5
commit
329999fa93
@ -8,7 +8,7 @@ import com.alibaba.fastjson.JSON;
|
||||
import com.alibaba.fastjson.JSONObject;
|
||||
|
||||
/**
|
||||
* 对微信小程序用户加密数据的解密.
|
||||
* 对微信小程序用户加密数据的解密。
|
||||
*
|
||||
* @since 1.8
|
||||
* @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api/signature.html#wxchecksessionobject">加密数据解密算法</a>
|
||||
|
||||
@ -13,6 +13,8 @@ import com.foxinmy.weixin4j.wxa.api.TemplateApi;
|
||||
import com.foxinmy.weixin4j.wxa.api.TemplateMessageApi;
|
||||
|
||||
/**
|
||||
* The facade of WXA APIs.
|
||||
*
|
||||
* @since 1.8
|
||||
*/
|
||||
public class WeixinProxy {
|
||||
|
||||
@ -7,6 +7,8 @@ import com.foxinmy.weixin4j.model.WeixinAccount;
|
||||
import com.foxinmy.weixin4j.wxa.model.Session;
|
||||
|
||||
/**
|
||||
* 登录凭证校验。
|
||||
*
|
||||
* @since 1.8
|
||||
*/
|
||||
public class LoginApi extends WxaApi {
|
||||
|
||||
@ -9,7 +9,7 @@ import com.foxinmy.weixin4j.http.weixin.WeixinResponse;
|
||||
import com.foxinmy.weixin4j.token.TokenManager;
|
||||
|
||||
/**
|
||||
* 获取二维码.
|
||||
* 获取二维码。
|
||||
*
|
||||
* <p>
|
||||
* 通过后台接口可以获取小程序任意页面的二维码,扫描该二维码可以直接进入小程序对应的页面。
|
||||
|
||||
@ -11,7 +11,7 @@ import com.foxinmy.weixin4j.token.TokenManager;
|
||||
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>
|
||||
* @since 1.8
|
||||
|
||||
@ -6,7 +6,7 @@ import com.foxinmy.weixin4j.exception.WeixinException;
|
||||
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>
|
||||
* @since 1.8
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
/**
|
||||
* APIs.
|
||||
*
|
||||
* @since 1.8
|
||||
*/
|
||||
package com.foxinmy.weixin4j.wxa.api;
|
||||
|
||||
@ -2,7 +2,11 @@ package com.foxinmy.weixin4j.wxa.model;
|
||||
|
||||
import java.io.Serializable;
|
||||
|
||||
import com.foxinmy.weixin4j.wxa.WXBizDataCrypt;
|
||||
|
||||
/**
|
||||
* 登录会话。
|
||||
*
|
||||
* @since 1.8
|
||||
*/
|
||||
public class Session implements Serializable {
|
||||
@ -21,6 +25,17 @@ public class Session implements Serializable {
|
||||
this.openId = openId;
|
||||
}
|
||||
|
||||
/**
|
||||
* 返回会话密钥
|
||||
* <p>注意:会话密钥 session_key 是对用户数据进行
|
||||
* <a href="https://developers.weixin.qq.com/miniprogram/dev/api/signature.html#wxchecksessionobject">加密签名</a>
|
||||
* 的密钥。
|
||||
* 为了应用自身的数据安全,开发者服务器不应该把会话密钥下发到小程序,
|
||||
* 也不应该对外提供这个密钥。</p>
|
||||
*
|
||||
* @return 会话密钥
|
||||
* @see WXBizDataCrypt
|
||||
*/
|
||||
public String getSessionKey() {
|
||||
return sessionKey;
|
||||
}
|
||||
@ -29,6 +44,15 @@ public class Session implements Serializable {
|
||||
this.sessionKey = sessionKey;
|
||||
}
|
||||
|
||||
/**
|
||||
* 返回UnionID
|
||||
* <p>
|
||||
* UnionID 只在满足一定条件的情况下返回。
|
||||
* 具体参看 <a href="https://developers.weixin.qq.com/miniprogram/dev/api/unionID.html">UnionID机制说明</a>。
|
||||
* </p>
|
||||
*
|
||||
* @return UnionID
|
||||
*/
|
||||
public String getUnionId() {
|
||||
return unionId;
|
||||
}
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
/**
|
||||
* Models.
|
||||
*
|
||||
* @since 1.8
|
||||
*/
|
||||
package com.foxinmy.weixin4j.wxa.model;
|
||||
|
||||
@ -4,6 +4,11 @@ import java.io.Serializable;
|
||||
|
||||
import com.alibaba.fastjson.annotation.JSONField;
|
||||
|
||||
/**
|
||||
* 模板消息的模板里的关键词。
|
||||
*
|
||||
* @since 1.8
|
||||
*/
|
||||
public class Keyword implements Serializable {
|
||||
|
||||
private static final long serialVersionUID = 2018052601L;
|
||||
|
||||
@ -5,6 +5,11 @@ import java.util.List;
|
||||
|
||||
import com.alibaba.fastjson.annotation.JSONField;
|
||||
|
||||
/**
|
||||
* 模板消息的模板。
|
||||
*
|
||||
* @since 1.8
|
||||
*/
|
||||
public class Template implements Serializable {
|
||||
|
||||
private static final long serialVersionUID = 2018052601L;
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
/**
|
||||
* Models for {@link com.foxinmy.weixin4j.wxa.api.TemplateApi}.
|
||||
*
|
||||
* @since 1.8
|
||||
*/
|
||||
package com.foxinmy.weixin4j.wxa.model.template;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user