diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WXBizDataCrypt.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WXBizDataCrypt.java index 6c2ffe7d..361461a9 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WXBizDataCrypt.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WXBizDataCrypt.java @@ -8,7 +8,7 @@ import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; /** - * 对微信小程序用户加密数据的解密. + * 对微信小程序用户加密数据的解密。 * * @since 1.8 * @see 加密数据解密算法 diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WeixinProxy.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WeixinProxy.java index df9fc2fd..d86f10e0 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WeixinProxy.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/WeixinProxy.java @@ -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 { diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/LoginApi.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/LoginApi.java index 1a664931..ddb5500a 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/LoginApi.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/LoginApi.java @@ -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 { diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java index bd87e0aa..85540a1a 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/QrCodeApi.java @@ -9,7 +9,7 @@ import com.foxinmy.weixin4j.http.weixin.WeixinResponse; import com.foxinmy.weixin4j.token.TokenManager; /** - * 获取二维码. + * 获取二维码。 * *
* 通过后台接口可以获取小程序任意页面的二维码,扫描该二维码可以直接进入小程序对应的页面。 diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateApi.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateApi.java index a4bbc910..e1bd0fac 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateApi.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateApi.java @@ -11,7 +11,7 @@ import com.foxinmy.weixin4j.token.TokenManager; import com.foxinmy.weixin4j.wxa.model.template.Template; /** - * 模版消息管理 + * 模版消息管理。 * * @see 模版消息管理 * @since 1.8 diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateMessageApi.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateMessageApi.java index ebc85901..3424e529 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateMessageApi.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/TemplateMessageApi.java @@ -6,7 +6,7 @@ import com.foxinmy.weixin4j.exception.WeixinException; import com.foxinmy.weixin4j.token.TokenManager; /** - * 发送模版消息 + * 发送模版消息。 * * @see 发送模版消息 * @since 1.8 diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/package-info.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/package-info.java index 4033640a..552586c2 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/package-info.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/package-info.java @@ -1,4 +1,6 @@ /** + * APIs. + * * @since 1.8 */ package com.foxinmy.weixin4j.wxa.api; diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/Session.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/Session.java index 679c7918..d35e76db 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/Session.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/Session.java @@ -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; } + /** + * 返回会话密钥 + *
注意:会话密钥 session_key 是对用户数据进行 + * 加密签名 + * 的密钥。 + * 为了应用自身的数据安全,开发者服务器不应该把会话密钥下发到小程序, + * 也不应该对外提供这个密钥。
+ * + * @return 会话密钥 + * @see WXBizDataCrypt + */ public String getSessionKey() { return sessionKey; } @@ -29,6 +44,15 @@ public class Session implements Serializable { this.sessionKey = sessionKey; } + /** + * 返回UnionID + *+ * UnionID 只在满足一定条件的情况下返回。 + * 具体参看 UnionID机制说明。 + *
+ * + * @return UnionID + */ public String getUnionId() { return unionId; } diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/package-info.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/package-info.java index e12e627b..f34f12bf 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/package-info.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/package-info.java @@ -1,4 +1,6 @@ /** + * Models. + * * @since 1.8 */ package com.foxinmy.weixin4j.wxa.model; diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/Keyword.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/Keyword.java index e1526400..b4ed513a 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/Keyword.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/Keyword.java @@ -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; diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/Template.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/Template.java index d349abc2..f38f53ec 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/Template.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/Template.java @@ -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; diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/package-info.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/package-info.java index f44be914..ff95918c 100644 --- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/package-info.java +++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/model/template/package-info.java @@ -1,4 +1,6 @@ /** * Models for {@link com.foxinmy.weixin4j.wxa.api.TemplateApi}. + * + * @since 1.8 */ package com.foxinmy.weixin4j.wxa.model.template;