Skip to content

Commit 5358d68

Browse files
binarywangbinarywang
committed
规范部分javadoc
1 parent e34f6de commit 5358d68

File tree

1 file changed

+75
-73
lines changed

1 file changed

+75
-73
lines changed

‎weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java

Lines changed: 75 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,16 @@ public interface WxMpService {
9494

9595
/**
9696
* <pre>
97-
* 上传多媒体文件
97+
* 新增临时素材
98+
* 本接口即为原“上传多媒体文件”接口。
9899
*
99100
* 上传的多媒体文件有格式和大小限制，如下：
100101
* 图片（image）: 1M，支持JPG格式
101102
* 语音（voice）：2M，播放长度不超过60s，支持AMR\MP3格式
102103
* 视频（video）：10MB，支持MP4格式
103104
* 缩略图（thumb）：64KB，支持JPG格式
104105
*
105-
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
106+
* 详情请见: <a href="http://mp.weixin.qq.com/wiki/15/2d353966323806a202cd2deaafe8e557.html">新增临时素材</a>
106107
* </pre>
107108
* @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
108109
* @param fileType 文件类型，请看{@link me.chanjar.weixin.common.api.WxConsts}
@@ -241,6 +242,7 @@ public interface WxMpService {
241242
public WxMpMaterialFileBatchGetResult materialFileBatchGet(String type, int offset, int count) throws WxErrorException;
242243

243244
/**
245+
* 新增临时素材
244246
* @see #mediaUpload(String, String, InputStream)
245247
* @param mediaType
246248
* @param file
@@ -250,9 +252,10 @@ public interface WxMpService {
250252

251253
/**
252254
* <pre>
253-
* 下载多媒体文件
255+
* 获取临时素材
256+
* 本接口即为原“下载多媒体文件”接口。
254257
* 根据微信文档，视频文件下载不了，会返回null
255-
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
258+
* 详情请见: <a href="http://mp.weixin.qq.com/wiki/9/677a85e3f3849af35de54bb5516c2521.html">获取临时素材</a>
256259
* </pre>
257260
* @params media_id
258261
* @return 保存到本地的临时文件
@@ -465,7 +468,7 @@ public interface WxMpService {
465468
/**
466469
* <pre>
467470
* 换取临时二维码ticket
468-
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
471+
* 详情请见: <a href="http://mp.weixin.qq.com/wiki/18/167e7d94df85d8389df6c94a7a8f78ba.html">生成带参数的二维码</a>
469472
* </pre>
470473
* @param scene_id 参数。
471474
* @param expire_seconds 过期秒数，默认60秒，最小60秒，最大1800秒
@@ -477,7 +480,7 @@ public interface WxMpService {
477480
/**
478481
* <pre>
479482
* 换取永久二维码ticket
480-
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
483+
* 详情请见: <a href="http://mp.weixin.qq.com/wiki/18/167e7d94df85d8389df6c94a7a8f78ba.html">生成带参数的二维码</a>
481484
* </pre>
482485
* @param scene_id 参数。永久二维码时最大值为100000（目前参数只支持1--100000）
483486
* @return
@@ -488,7 +491,7 @@ public interface WxMpService {
488491
/**
489492
* <pre>
490493
* 换取永久字符串二维码ticket
491-
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
494+
* 详情请见: <a href="http://mp.weixin.qq.com/wiki/18/167e7d94df85d8389df6c94a7a8f78ba.html">生成带参数的二维码</a>
492495
* </pre>
493496
*
494497
* @param scene_str 参数。字符串类型长度现在为1到64
@@ -500,7 +503,7 @@ public interface WxMpService {
500503
/**
501504
* <pre>
502505
* 换取二维码图片文件，jpg格式
503-
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
506+
* 详情请见: <a href="http://mp.weixin.qq.com/wiki/18/167e7d94df85d8389df6c94a7a8f78ba.html">生成带参数的二维码</a>
504507
* </pre>
505508
* @param ticket 二维码ticket
506509
* @return
@@ -511,7 +514,7 @@ public interface WxMpService {
511514
/**
512515
* <pre>
513516
* 换取二维码图片url地址
514-
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
517+
* 详情请见: <a href="http://mp.weixin.qq.com/wiki/18/167e7d94df85d8389df6c94a7a8f78ba.html">生成带参数的二维码</a>
515518
* </pre>
516519
* @param ticket 二维码ticket
517520
* @return
@@ -769,78 +772,77 @@ public interface WxMpService {
769772
* @param ip 发起支付的客户端IP
770773
* @param notifyUrl 通知地址
771774
* @return
772-
* @throws WxErrorException
775+
* @throws WxErrorException
773776
* @deprecated Use me.chanjar.weixin.mp.api.WxMpService.getPayInfo(Map<String, String>) instead
774777
*/
775778
@Deprecated
776779
Map<String, String> getJsapiPayInfo(String openId, String outTradeNo, double amt, String body, String ip, String notifyUrl) throws WxErrorException;
777780

781+
/**
782+
* 该接口提供所有微信支付订单的查询,当支付通知处理异常戒丢失的情冴,商户可以通过该接口查询订单支付状态。
783+
* 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_2
784+
* @param transactionId
785+
* @param outTradeNo
786+
*/
787+
WxMpPayResult getJSSDKPayResult(String transactionId, String outTradeNo);
778788

779-
/**
780-
* 该接口提供所有微信支付订单的查询,当支付通知处理异常戒丢失的情冴,商户可以通过该接口查询订单支付状态。
781-
* 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_2
782-
* @param transactionId
783-
* @param outTradeNo
784-
*/
785-
WxMpPayResult getJSSDKPayResult(String transactionId, String outTradeNo);
786-
787-
/**
788-
* 读取支付结果通知
789-
* 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_7
790-
* @param xmlData
791-
* @return
792-
*/
793-
WxMpPayCallback getJSSDKCallbackData(String xmlData);
789+
/**
790+
* 读取支付结果通知
791+
* 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_7
792+
* @param xmlData
793+
* @return
794+
*/
795+
WxMpPayCallback getJSSDKCallbackData(String xmlData);
794796

795-
/**
796-
* 微信支付-申请退款
797-
* 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4
798-
* @param parameters 需要传入的退款参数的Map。以下几项为参数的必须项：<br/>
799-
* <li/> transaction_id
800-
* <li/> out_trade_no （仅在上述transaction_id为空时是必须项）
801-
* <li/> out_refund_no
802-
* <li/> total_fee
803-
* <li/> refund_fee
804-
* @return 退款操作结果
805-
* @throws WxErrorException
806-
*/
807-
public WxMpPayRefundResult refundPay(Map<String, String> parameters) throws WxErrorException;
797+
/**
798+
* 微信支付-申请退款
799+
* 详见 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_4
800+
* @param parameters 需要传入的退款参数的Map。以下几项为参数的必须项：<br/>
801+
* <li/> transaction_id
802+
* <li/> out_trade_no （仅在上述transaction_id为空时是必须项）
803+
* <li/> out_refund_no
804+
* <li/> total_fee
805+
* <li/> refund_fee
806+
* @return 退款操作结果
807+
* @throws WxErrorException
808+
*/
809+
public WxMpPayRefundResult refundPay(Map<String, String> parameters) throws WxErrorException;
808810

809-
/**
810-
* <pre>
811-
* 计算Map键值对是否和签名相符,
812-
* 按照字段名的 ASCII 码从小到大排序(字典序)后,使用 URL 键值对的 格式(即 key1=value1&key2=value2...)拼接成字符串
813-
* </pre>
814-
* @param kvm
815-
* @param signature
816-
* @return
817-
*/
818-
public boolean checkJSSDKCallbackDataSignature(Map<String, String> kvm, String signature);
819-
820-
/**
821-
* 发送微信红包给个人用户
822-
*
823-
* 需要传入的必填参数如下:
824-
* mch_billno//商户订单号
825-
* send_name//商户名称
826-
* re_openid//用户openid
827-
* total_amount//红包总额
828-
* total_num//红包发放总人数
829-
* wishing//红包祝福语
830-
* client_ip//服务器Ip地址
831-
* act_name//活动名称
832-
* remark //备注
833-
* 文档详见:https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_5
834-
*
835-
* 使用现金红包功能需要在xml配置文件中额外设置:
836-
* <partnerId></partnerId>微信商户平台ID
837-
* <partnerKey></partnerKey>商户平台设置的API密钥
838-
*
839-
* @param parameters
840-
* @return
841-
* @throws WxErrorException
842-
*/
843-
public WxRedpackResult sendRedpack(Map<String, String> parameters) throws WxErrorException;
811+
/**
812+
* <pre>
813+
* 计算Map键值对是否和签名相符,
814+
* 按照字段名的 ASCII 码从小到大排序(字典序)后,使用 URL 键值对的 格式(即 key1=value1&key2=value2...)拼接成字符串
815+
* </pre>
816+
* @param kvm
817+
* @param signature
818+
* @return
819+
*/
820+
public boolean checkJSSDKCallbackDataSignature(Map<String, String> kvm, String signature);
821+
822+
/**
823+
* 发送微信红包给个人用户
824+
*
825+
* 需要传入的必填参数如下:
826+
* mch_billno//商户订单号
827+
* send_name//商户名称
828+
* re_openid//用户openid
829+
* total_amount//红包总额
830+
* total_num//红包发放总人数
831+
* wishing//红包祝福语
832+
* client_ip//服务器Ip地址
833+
* act_name//活动名称
834+
* remark //备注
835+
* 文档详见:https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_5
836+
*
837+
* 使用现金红包功能需要在xml配置文件中额外设置:
838+
* <partnerId></partnerId>微信商户平台ID
839+
* <partnerKey></partnerKey>商户平台设置的API密钥
840+
*
841+
* @param parameters
842+
* @return
843+
* @throws WxErrorException
844+
*/
845+
public WxRedpackResult sendRedpack(Map<String, String> parameters) throws WxErrorException;
844846

845847
/**
846848
* 获得卡券api_ticket，不强制刷新卡券api_ticket

0 commit comments

Comments
 (0)