🆕 #1369 【企业微信】增加效率工具-日程相关接口

weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMaterialService.java

@@ -50,8 +50,9 @@ public interface WxMpMaterialService {
    *
    * @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
    * @param file      文件对象
-   * @throws WxErrorException
-   * @see #mediaUpload(String, String, InputStream)
+   * @return the wx media upload result
+   * @throws WxErrorException the wx error exception
+   * @see #mediaUpload(String, String, InputStream) #mediaUpload(String, String, InputStream)
    */
   WxMediaUploadResult mediaUpload(String mediaType, File file) throws WxErrorException;
 
@@ -67,8 +68,9 @@ public interface WxMpMaterialService {
    * @param mediaType   媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
    * @param fileType    文件类型，请看{@link me.chanjar.weixin.common.api.WxConsts}
    * @param inputStream 输入流
-   * @throws WxErrorException
-   * @see #mediaUpload(java.lang.String, java.io.File)
+   * @return the wx media upload result
+   * @throws WxErrorException the wx error exception
+   * @see #mediaUpload(java.lang.String, java.io.File) #mediaUpload(java.lang.String, java.io.File)
    */
   WxMediaUploadResult mediaUpload(String mediaType, String fileType, InputStream inputStream) throws WxErrorException;
 
@@ -83,8 +85,8 @@ public interface WxMpMaterialService {
    * </pre>
    *
    * @param mediaId 媒体文件Id
-   * @return 保存到本地的临时文件
-   * @throws WxErrorException
+   * @return 保存到本地的临时文件 file
+   * @throws WxErrorException the wx error exception
    */
   File mediaDownload(String mediaId) throws WxErrorException;
 
@@ -99,8 +101,8 @@ public interface WxMpMaterialService {
    * </pre>
    *
    * @param mediaId 媒体文件Id
-   * @return 保存到本地的临时文件
-   * @throws WxErrorException
+   * @return 保存到本地的临时文件 file
+   * @throws WxErrorException the wx error exception
    */
   File jssdkMediaDownload(String mediaId) throws WxErrorException;
 
@@ -114,7 +116,7 @@ public interface WxMpMaterialService {
    *
    * @param file 上传的文件对象
    * @return WxMediaImgUploadResult 返回图片url
-   * @throws WxErrorException
+   * @throws WxErrorException the wx error exception
    */
   WxMediaImgUploadResult mediaImgUpload(File file) throws WxErrorException;
 
@@ -139,6 +141,8 @@ public interface WxMpMaterialService {
    *
    * @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
    * @param material  上传的素材, 请看{@link WxMpMaterial}
+   * @return the wx mp material upload result
+   * @throws WxErrorException the wx error exception
    */
   WxMpMaterialUploadResult materialFileUpload(String mediaType, WxMpMaterial material) throws WxErrorException;
 
@@ -159,6 +163,8 @@ public interface WxMpMaterialService {
    * </pre>
    *
    * @param news 上传的图文消息, 请看{@link WxMpMaterialNews}
+   * @return the wx mp material upload result
+   * @throws WxErrorException the wx error exception
    */
   WxMpMaterialUploadResult materialNewsUpload(WxMpMaterialNews news) throws WxErrorException;
 
@@ -171,6 +177,8 @@ public interface WxMpMaterialService {
    * </pre>
    *
    * @param mediaId 永久素材的id
+   * @return the input stream
+   * @throws WxErrorException the wx error exception
    */
   InputStream materialImageOrVoiceDownload(String mediaId) throws WxErrorException;
 
@@ -183,6 +191,8 @@ public interface WxMpMaterialService {
    * </pre>
    *
    * @param mediaId 永久素材的id
+   * @return the wx mp material video info result
+   * @throws WxErrorException the wx error exception
    */
   WxMpMaterialVideoInfoResult materialVideoInfo(String mediaId) throws WxErrorException;
 
@@ -195,6 +205,8 @@ public interface WxMpMaterialService {
    * </pre>
    *
    * @param mediaId 永久素材的id
+   * @return the wx mp material news
+   * @throws WxErrorException the wx error exception
    */
   WxMpMaterialNews materialNewsInfo(String mediaId) throws WxErrorException;
 
@@ -207,6 +219,8 @@ public interface WxMpMaterialService {
    * </pre>
    *
    * @param wxMpMaterialArticleUpdate 用来更新图文素材的bean, 请看{@link WxMpMaterialArticleUpdate}
+   * @return the boolean
+   * @throws WxErrorException the wx error exception
    */
   boolean materialNewsUpdate(WxMpMaterialArticleUpdate wxMpMaterialArticleUpdate) throws WxErrorException;
 
@@ -223,6 +237,8 @@ public interface WxMpMaterialService {
    * </pre>
    *
    * @param mediaId 永久素材的id
+   * @return the boolean
+   * @throws WxErrorException the wx error exception
    */
   boolean materialDelete(String mediaId) throws WxErrorException;
 
@@ -238,6 +254,9 @@ public interface WxMpMaterialService {
    * 详情请见: <a href="http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1444738733&token=&lang=zh_CN">获取素材总数</a>
    * 接口url格式：https://api.weixin.qq.com/cgi-bin/material/get_materialcount?access_token=ACCESS_TOKEN
    * </pre>
+   *
+   * @return the wx mp material count result
+   * @throws WxErrorException the wx error exception
    */
   WxMpMaterialCountResult materialCount() throws WxErrorException;
 
@@ -251,6 +270,8 @@ public interface WxMpMaterialService {
    *
    * @param offset 从全部素材的该偏移位置开始返回，0表示从第一个素材 返回
    * @param count  返回素材的数量，取值在1到20之间
+   * @return the wx mp material news batch get result
+   * @throws WxErrorException the wx error exception
    */
   WxMpMaterialNewsBatchGetResult materialNewsBatchGet(int offset, int count) throws WxErrorException;
 
@@ -265,6 +286,8 @@ public interface WxMpMaterialService {
    * @param type   媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
    * @param offset 从全部素材的该偏移位置开始返回，0表示从第一个素材 返回
    * @param count  返回素材的数量，取值在1到20之间
+   * @return the wx mp material file batch get result
+   * @throws WxErrorException the wx error exception
    */
   WxMpMaterialFileBatchGetResult materialFileBatchGet(String type, int offset, int count) throws WxErrorException;