diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java index b5bf50c9..bd0b322f 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java @@ -28,9 +28,9 @@ public interface WxCpService { * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=验证消息真实性 * * - * @param msgSignature - * @param timestamp - * @param nonce + * @param msgSignature 消息签名 + * @param timestamp 时间戳 + * @param nonce 随机数 * @param data 微信传输过来的数据,有可能是echoStr,有可能是xml消息 */ boolean checkSignature(String msgSignature, String timestamp, String nonce, String data); @@ -41,14 +41,13 @@ public interface WxCpService { * 企业在员工验证成功后,调用本方法告诉企业号平台该员工关注成功。 * * - * @param userId + * @param userId 用户id */ void userAuthenticated(String userId) throws WxErrorException; /** * 获取access_token, 不强制刷新access_token * - * @throws WxErrorException * @see #getAccessToken(boolean) */ String getAccessToken() throws WxErrorException; @@ -63,14 +62,12 @@ public interface WxCpService { * * * @param forceRefresh 强制刷新 - * @throws me.chanjar.weixin.common.exception.WxErrorException */ String getAccessToken(boolean forceRefresh) throws WxErrorException; /** * 获得jsapi_ticket,不强制刷新jsapi_ticket * - * @throws WxErrorException * @see #getJsapiTicket(boolean) */ String getJsapiTicket() throws WxErrorException; @@ -84,7 +81,6 @@ public interface WxCpService { * * * @param forceRefresh 强制刷新 - * @throws WxErrorException */ String getJsapiTicket(boolean forceRefresh) throws WxErrorException; @@ -113,15 +109,13 @@ public interface WxCpService { * @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts} * @param fileType 文件类型,请看{@link me.chanjar.weixin.common.api.WxConsts} * @param inputStream 输入流 - * @throws WxErrorException */ WxMediaUploadResult mediaUpload(String mediaType, String fileType, InputStream inputStream) - throws WxErrorException, IOException; + throws WxErrorException, IOException; /** - * @param mediaType - * @param file - * @throws WxErrorException + * @param mediaType 媒体类型 + * @param file 文件对象 * @see #mediaUpload(String, String, InputStream) */ WxMediaUploadResult mediaUpload(String mediaType, File file) throws WxErrorException; @@ -133,20 +127,18 @@ public interface WxCpService { * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件 * * - * @param media_id + * @param mediaId 媒体id * @return 保存到本地的临时文件 - * @throws WxErrorException */ - File mediaDownload(String media_id) throws WxErrorException; + File mediaDownload(String mediaId) throws WxErrorException; /** *
* 发送消息 - * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=发送消息 + * 详情请见: http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E ** - * @param message - * @throws WxErrorException + * @param message 要发送的消息对象 */ void messageSend(WxCpMessage message) throws WxErrorException; @@ -158,8 +150,7 @@ public interface WxCpService { * 注意: 这个方法使用WxCpConfigStorage里的agentId * * - * @param menu - * @throws WxErrorException + * @param menu 菜单对象 * @see #menuCreate(Integer, WxMenu) */ void menuCreate(WxMenu menu) throws WxErrorException; @@ -173,8 +164,7 @@ public interface WxCpService { * * * @param agentId 企业号应用的id - * @param menu - * @throws WxErrorException + * @param menu 菜单对象 * @see #menuCreate(me.chanjar.weixin.common.bean.menu.WxMenu) */ void menuCreate(Integer agentId, WxMenu menu) throws WxErrorException; @@ -187,7 +177,6 @@ public interface WxCpService { * 注意: 这个方法使用WxCpConfigStorage里的agentId * * - * @throws WxErrorException * @see #menuDelete(Integer) */ void menuDelete() throws WxErrorException; @@ -201,7 +190,6 @@ public interface WxCpService { * * * @param agentId 企业号应用的id - * @throws WxErrorException * @see #menuDelete() */ void menuDelete(Integer agentId) throws WxErrorException; @@ -214,7 +202,6 @@ public interface WxCpService { * 注意: 这个方法使用WxCpConfigStorage里的agentId * * - * @throws WxErrorException * @see #menuGet(Integer) */ WxMenu menuGet() throws WxErrorException; @@ -228,7 +215,6 @@ public interface WxCpService { * * * @param agentId 企业号应用的id - * @throws WxErrorException * @see #menuGet() */ WxMenu menuGet(Integer agentId) throws WxErrorException; @@ -242,7 +228,6 @@ public interface WxCpService { * * @param depart 部门 * @return 部门id - * @throws WxErrorException */ Integer departCreate(WxCpDepart depart) throws WxErrorException; @@ -251,8 +236,6 @@ public interface WxCpService { * 部门管理接口 - 查询所有部门 * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=部门管理接口 * - * - * @throws WxErrorException */ List
* 批量删除成员 - * * http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E6.89.B9.E9.87.8F.E5.88.A0.E9.99.A4.E6.88.90.E5.91.98 ** * @param userids 员工UserID列表。对应管理端的帐号 - * @throws WxErrorException */ void userDelete(String[] userids) throws WxErrorException; /** * 获取用户 * - * @param userid - * @throws WxErrorException + * @param userid 用户id */ WxCpUser userGet(String userid) throws WxErrorException; /** * 创建标签 * - * @param tagName + * @param tagName 标签名 */ String tagCreate(String tagName) throws WxErrorException; /** * 更新标签 * - * @param tagId - * @param tagName + * @param tagId 标签id + * @param tagName 标签名 */ void tagUpdate(String tagId, String tagName) throws WxErrorException; /** * 删除标签 * - * @param tagId + * @param tagId 标签id */ void tagDelete(String tagId) throws WxErrorException; @@ -380,24 +353,24 @@ public interface WxCpService { /** * 获取标签成员 * - * @param tagId + * @param tagId 标签ID */ List
+ ** - * @param redirectUri - * @param state + * @param redirectUri 跳转链接地址 + * @param state 状态码 * @return url */ String oauth2buildAuthorizationUrl(String redirectUri, String state); @@ -423,7 +396,7 @@ public interface WxCpService { * 注意: 这个方法使用WxCpConfigStorage里的agentId * * - * @param code + * @param code 微信oauth授权返回的代码 * @return [userid, deviceid] * @see #oauth2getUserInfo(Integer, String) */ @@ -439,7 +412,7 @@ public interface WxCpService { * * * @param agentId 企业号应用的id - * @param code + * @param code 微信oauth授权返回的代码 * @return [userid, deviceid] * @see #oauth2getUserInfo(String) */ @@ -449,8 +422,8 @@ public interface WxCpService { /** * 移除标签成员 * - * @param tagId - * @param userIds + * @param tagId 标签id + * @param userIds 用户id列表 */ void tagRemoveUsers(String tagId, List* 构造oauth2授权的url连接 ** - * @param state + * @param state 状态码 * @return url */ String oauth2buildAuthorizationUrl(String state); @@ -408,8 +381,8 @@ public interface WxCpService { * 详情请见: http://qydev.weixin.qq.com/wiki/index.php?title=企业获取code *