diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaCodeService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaCodeService.java index fbe08184..ad102805 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaCodeService.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaCodeService.java @@ -1,14 +1,10 @@ package cn.binarywang.wx.miniapp.api; -import java.util.List; - -import cn.binarywang.wx.miniapp.bean.code.WxMaCategory; -import cn.binarywang.wx.miniapp.bean.code.WxMaCodeAuditStatus; -import cn.binarywang.wx.miniapp.bean.code.WxMaCodeCommitRequest; -import cn.binarywang.wx.miniapp.bean.code.WxMaCodeSubmitAuditRequest; -import cn.binarywang.wx.miniapp.bean.code.WxMaCodeVersionDistribution; +import cn.binarywang.wx.miniapp.bean.code.*; import me.chanjar.weixin.common.error.WxErrorException; +import java.util.List; + /** * 小程序代码管理相关 API(大部分只能是第三方平台调用) * 文档:https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1489140610_Uavc4&token=&lang=zh_CN @@ -18,7 +14,7 @@ import me.chanjar.weixin.common.error.WxErrorException; */ public interface WxMaCodeService { /** - * 为授权的小程序帐号上传小程序代码 + * 为授权的小程序帐号上传小程序代码. */ String COMMIT_URL = "https://api.weixin.qq.com/wxa/commit"; String GET_QRCODE_URL = "https://api.weixin.qq.com/wxa/get_qrcode"; @@ -35,7 +31,7 @@ public interface WxMaCodeService { String UNDO_CODE_AUDIT_URL = "https://api.weixin.qq.com/wxa/undocodeaudit"; /** - * 为授权的小程序帐号上传小程序代码(仅仅支持第三方开放平台) + * 为授权的小程序帐号上传小程序代码(仅仅支持第三方开放平台). * * @param commitRequest 参数 * @throws WxErrorException 上传失败时抛出,具体错误码请看类注释文档 @@ -43,19 +39,19 @@ public interface WxMaCodeService { void commit(WxMaCodeCommitRequest commitRequest) throws WxErrorException; /** - * 获取体验小程序的体验二维码 + * 获取体验小程序的体验二维码. * 文档地址: * https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1489140610_Uavc4&token=&lang=zh_CN * * @param path 指定体验版二维码跳转到某个具体页面(如果不需要的话,则不需要填path参数,可在路径后以“?参数”方式传入参数) - * 具体的路径加参数需要urlencode(方法内部处理),比如page/index?action=1编码后得到page%2Findex%3Faction%3D1 + * 具体的路径加参数需要urlencode(方法内部处理),比如page/index?action=1编码后得到page%2Findex%3Faction%3D1 * @return 二维码 bytes * @throws WxErrorException 上传失败时抛出,具体错误码请看类注释文档 */ byte[] getQrCode(String path) throws WxErrorException; /** - * 获取授权小程序帐号的可选类目 + * 获取授权小程序帐号的可选类目. * * @return List * @throws WxErrorException 获取失败时返回,具体错误码请看此接口的注释文档 @@ -63,7 +59,7 @@ public interface WxMaCodeService { List getCategory() throws WxErrorException; /** - * 获取小程序的第三方提交代码的页面配置(仅供第三方开发者代小程序调用) + * 获取小程序的第三方提交代码的页面配置(仅供第三方开发者代小程序调用). * * @return page_list 页面配置列表 * @throws WxErrorException 获取失败时返回,具体错误码请看此接口的注释文档 @@ -71,7 +67,7 @@ public interface WxMaCodeService { List getPage() throws WxErrorException; /** - * 将第三方提交的代码包提交审核(仅供第三方开发者代小程序调用) + * 将第三方提交的代码包提交审核(仅供第三方开发者代小程序调用). * * @param auditRequest 提交审核参数 * @return 审核编号 @@ -80,7 +76,7 @@ public interface WxMaCodeService { long submitAudit(WxMaCodeSubmitAuditRequest auditRequest) throws WxErrorException; /** - * 查询某个指定版本的审核状态(仅供第三方代小程序调用) + * 查询某个指定版本的审核状态(仅供第三方代小程序调用). * * @param auditId 提交审核时获得的审核id * @return 审核状态 @@ -89,7 +85,7 @@ public interface WxMaCodeService { WxMaCodeAuditStatus getAuditStatus(long auditId) throws WxErrorException; /** - * 查询最新一次提交的审核状态(仅供第三方代小程序调用) + * 查询最新一次提交的审核状态(仅供第三方代小程序调用). * * @return 审核状态 * @throws WxErrorException 查询失败时返回,具体错误码请看此接口的注释文档 @@ -97,14 +93,14 @@ public interface WxMaCodeService { WxMaCodeAuditStatus getLatestAuditStatus() throws WxErrorException; /** - * 发布已通过审核的小程序(仅供第三方代小程序调用) + * 发布已通过审核的小程序(仅供第三方代小程序调用). * * @throws WxErrorException 发布失败时抛出,具体错误码请看此接口的注释文档 */ void release() throws WxErrorException; /** - * 修改小程序线上代码的可见状态(仅供第三方代小程序调用) + * 修改小程序线上代码的可见状态(仅供第三方代小程序调用). * * @param action 设置可访问状态,发布后默认可访问,close为不可见,open为可见 * @throws WxErrorException 发布失败时抛出,具体错误码请看此接口的注释文档 @@ -112,14 +108,14 @@ public interface WxMaCodeService { void changeVisitStatus(String action) throws WxErrorException; /** - * 小程序版本回退(仅供第三方代小程序调用) + * 小程序版本回退(仅供第三方代小程序调用). * * @throws WxErrorException 失败时抛出,具体错误码请看此接口的注释文档 */ void revertCodeRelease() throws WxErrorException; /** - * 查询当前设置的最低基础库版本及各版本用户占比 (仅供第三方代小程序调用) + * 查询当前设置的最低基础库版本及各版本用户占比 (仅供第三方代小程序调用). * * @return 小程序版本分布信息 * @throws WxErrorException 失败时抛出,具体错误码请看此接口的注释文档 @@ -127,7 +123,7 @@ public interface WxMaCodeService { WxMaCodeVersionDistribution getSupportVersion() throws WxErrorException; /** - * 设置最低基础库版本(仅供第三方代小程序调用) + * 设置最低基础库版本(仅供第三方代小程序调用). * * @param version 版本 * @throws WxErrorException 失败时抛出,具体错误码请看此接口的注释文档 @@ -135,7 +131,7 @@ public interface WxMaCodeService { void setSupportVersion(String version) throws WxErrorException; /** - * 小程序审核撤回 + * 小程序审核撤回. * 单个帐号每天审核撤回次数最多不超过1次,一个月不超过10次 * * @throws WxErrorException 失败时抛出,具体错误码请看此接口的注释文档 diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/code/WxMaCodeAuditStatus.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/code/WxMaCodeAuditStatus.java index 36c33eaf..64874850 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/code/WxMaCodeAuditStatus.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/code/WxMaCodeAuditStatus.java @@ -18,18 +18,24 @@ import java.io.Serializable; public class WxMaCodeAuditStatus implements Serializable { private static final long serialVersionUID = 4655119308692217268L; /** - * 审核 ID + * 审核 ID. */ @SerializedName(value = "auditId", alternate = {"auditid"}) private Long auditId; /** - * 审核状态,其中0为审核成功,1为审核失败,2为审核中 + * 审核状态. + * 其中0为审核成功,1为审核失败,2为审核中 */ private Integer status; /** - * 当status=1,审核被拒绝时,返回的拒绝原因 + * 当status=1,审核被拒绝时,返回的拒绝原因. */ private String reason; + /** + * 当status=1,审核被拒绝时,会返回审核失败的小程序截图示例。 xxx丨yyy丨zzz是media_id可通过获取永久素材接口 拉取截图内容). + */ + @SerializedName(value = "screenshot") + private String screenShot; public static WxMaCodeAuditStatus fromJson(String json) { return WxMaGsonBuilder.create().fromJson(json, WxMaCodeAuditStatus.class); diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java index 7d688d31..8dfd7a85 100644 --- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java +++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java @@ -22,7 +22,7 @@ import java.util.Map; public interface WxOpenMaService extends WxMaService { /** - * 设置小程序服务器域名 + * 设置小程序服务器域名. * *
    *     授权给第三方的小程序,其服务器域名只可以为第三方的服务器,当小程序通过第三方发布代码上线后,小程序原先自己配置的服务器域名将被删除,
@@ -170,21 +170,13 @@ public interface WxOpenMaService extends WxMaService {
 
   /**
    * 获得小程序的域名配置信息
-   *
-   * @return
    */
   WxOpenMaDomainResult getDomain() throws WxErrorException;
 
   /**
    * 修改域名
    *
-   * @param action              delete删除, set覆盖, get获取
-   * @param requestdomainList
-   * @param wsrequestdomainList
-   * @param uploaddomainList
-   * @param downloaddomainList
-   * @return
-   * @throws WxErrorException
+   * @param action delete删除, set覆盖, get获取
    */
   WxOpenMaDomainResult modifyDomain(String action, List requestdomainList, List wsrequestdomainList, List uploaddomainList, List downloaddomainList) throws WxErrorException;
 
@@ -198,17 +190,13 @@ public interface WxOpenMaService extends WxMaService {
   /**
    * 设置小程序的业务域名
    *
-   * @param action     add添加, delete删除, set覆盖
-   * @param domainList
+   * @param action add添加, delete删除, set覆盖
    * @return 直接返回字符串
    */
   String setWebViewDomain(String action, List domainList) throws WxErrorException;
 
   /**
    * 获取小程序的信息
-   *
-   * @return
-   * @throws WxErrorException
    */
   String getAccountBasicInfo() throws WxErrorException;
 
@@ -225,16 +213,11 @@ public interface WxOpenMaService extends WxMaService {
    * 解除绑定小程序体验者
    *
    * @param wechatid 体验者微信号(不是openid)
-   * @return
-   * @throws WxErrorException
    */
   WxOpenResult unbindTester(String wechatid) throws WxErrorException;
 
   /**
    * 获得体验者列表
-   *
-   * @return
-   * @throws WxErrorException
    */
   WxOpenMaTesterListResult getTesterList() throws WxErrorException;
 
@@ -245,17 +228,11 @@ public interface WxOpenMaService extends WxMaService {
    * @param userVersion 用户定义版本
    * @param userDesc    用户定义版本描述
    * @param extInfo     第三方自定义的配置
-   * @return
-   * @throws WxErrorException
    */
   WxOpenResult codeCommit(Long templateId, String userVersion, String userDesc, WxMaOpenCommitExtInfo extInfo) throws WxErrorException;
 
   /**
    * 获取体验小程序的体验二维码
-   *
-   * @param pagePath
-   * @param params
-   * @return
    */
   File getTestQrcode(String pagePath, Map params) throws WxErrorException;
 
@@ -264,9 +241,6 @@ public interface WxOpenMaService extends WxMaService {
    * 

* 注意:该接口可获取已设置的二级类目及用于代码审核的可选三级类目。 *

- * - * @return WxOpenMaCategoryListResult - * @throws WxErrorException */ WxOpenMaCategoryListResult getCategoryList() throws WxErrorException; @@ -280,69 +254,42 @@ public interface WxOpenMaService extends WxMaService { /** * 将第三方提交的代码包提交审核(仅供第三方开发者代小程序调用) - * - * @param submitAuditMessage - * @return - * @throws WxErrorException */ WxOpenMaSubmitAuditResult submitAudit(WxOpenMaSubmitAuditMessage submitAuditMessage) throws WxErrorException; /** * 查询某个指定版本的审核状态(仅供第三方代小程序调用) - * - * @param auditid - * @return - * @throws WxErrorException */ WxOpenMaQueryAuditResult getAuditStatus(Long auditid) throws WxErrorException; /** - * 查询最新一次提交的审核状态(仅供第三方代小程序调用) - * - * @return - * @throws WxErrorException + * 查询最新一次提交的审核状态(仅供第三方代小程序调用). */ WxOpenMaQueryAuditResult getLatestAuditStatus() throws WxErrorException; /** - * 发布已通过审核的小程序(仅供第三方代小程序调用) - * - * @return - * @throws WxErrorException + * 发布已通过审核的小程序(仅供第三方代小程序调用). */ WxOpenResult releaesAudited() throws WxErrorException; /** * 11. 小程序版本回退(仅供第三方代小程序调用) - * - * @return - * @throws WxErrorException */ WxOpenResult revertCodeReleaes() throws WxErrorException; /** * 15. 小程序审核撤回 - *

* 单个帐号每天审核撤回次数最多不超过1次,一个月不超过10次。 - *

- * - * @return - * @throws WxErrorException */ WxOpenResult undoCodeAudit() throws WxErrorException; /** * 查询当前设置的最低基础库版本及各版本用户占比 (仅供第三方代小程序调用) - * @return - * @throws WxErrorException */ String getSupportVersion() throws WxErrorException; /** * 设置最低基础库版本(仅供第三方代小程序调用) - * @param version - * @return - * @throws WxErrorException */ String setSupportVersion(String version) throws WxErrorException; diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryAuditResult.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryAuditResult.java index 41a761d6..8f0739f9 100644 --- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryAuditResult.java +++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryAuditResult.java @@ -29,4 +29,9 @@ public class WxOpenMaQueryAuditResult extends WxOpenResult { * 审核失败原因. */ String reason; + /** + * 当status=1,审核被拒绝时,会返回审核失败的小程序截图示例。 xxx丨yyy丨zzz是media_id可通过获取永久素材接口 拉取截图内容). + */ + @SerializedName(value = "screenshot") + private String screenShot; }