11package me .chanjar .weixin .mp .api ;
22
33import me .chanjar .weixin .common .error .WxErrorException ;
4- import me .chanjar .weixin .mp .bean .card .*;
5- import me .chanjar .weixin .mp .bean .membercard .*;
4+ import me .chanjar .weixin .mp .bean .card .CardUpdateResult ;
5+ import me .chanjar .weixin .mp .bean .card .MemberCardActivateUserFormRequest ;
6+ import me .chanjar .weixin .mp .bean .card .MemberCardActivateUserFormResult ;
7+ import me .chanjar .weixin .mp .bean .card .MemberCardUpdateRequest ;
8+ import me .chanjar .weixin .mp .bean .card .WxMpCardCreateResult ;
9+ import me .chanjar .weixin .mp .bean .membercard .ActivatePluginParam ;
10+ import me .chanjar .weixin .mp .bean .membercard .WxMpMemberCardActivatedMessage ;
11+ import me .chanjar .weixin .mp .bean .membercard .WxMpMemberCardCreateMessage ;
12+ import me .chanjar .weixin .mp .bean .membercard .WxMpMemberCardUpdateMessage ;
13+ import me .chanjar .weixin .mp .bean .membercard .WxMpMemberCardUpdateResult ;
14+ import me .chanjar .weixin .mp .bean .membercard .WxMpMemberCardUserInfoResult ;
615
716/**
8- * 会员卡相关接口
17+ * 会员卡相关接口.
918 *
1019 * @author YuJian(mgcnrx11 @ gmail.com)
1120 * @author yuanqixun
@@ -18,46 +27,38 @@ public interface WxMpMemberCardService {
1827 String MEMBER_CARD_USER_INFO_GET = "https://api.weixin.qq.com/card/membercard/userinfo/get" ;
1928 String MEMBER_CARD_UPDATE_USER = "https://api.weixin.qq.com/card/membercard/updateuser" ;
2029 /**
21- * 会员卡激活之微信开卡接口(wx_activate=true情况调用)
30+ * 会员卡激活之微信开卡接口(wx_activate=true情况调用).
2231 */
2332 String MEMBER_CARD_ACTIVATEUSERFORM = "https://api.weixin.qq.com/card/membercard/activateuserform/set" ;
2433
2534 /**
26- * 获取会员卡开卡插件参数
35+ * 获取会员卡开卡插件参数.
2736 */
2837 String MEMBER_CARD_ACTIVATE_URL = "https://api.weixin.qq.com/card/membercard/activate/geturl" ;
2938
3039 /**
31- * 会员卡信息更新
40+ * 会员卡信息更新.
3241 */
3342 String MEMBER_CARD_UPDATE = "https://api.weixin.qq.com/card/update" ;
3443
3544
3645 /**
37- * 得到WxMpService
46+ * 得到WxMpService.
3847 */
3948 WxMpService getWxMpService ();
4049
4150 /**
42- * 会员卡创建接口
43- *
44- * @param createJson
45- * @return
46- * @throws WxErrorException
51+ * 会员卡创建接口.
4752 */
4853 WxMpCardCreateResult createMemberCard (String createJson ) throws WxErrorException ;
4954
5055 /**
51- * 会员卡创建接口
52- *
53- * @param createMessageMessage
54- * @return WxMpCardCreateResult
55- * @throws WxErrorException
56+ * 会员卡创建接口.
5657 */
5758 WxMpCardCreateResult createMemberCard (WxMpMemberCardCreateMessage createMessageMessage ) throws WxErrorException ;
5859
5960 /**
60- * 会员卡激活接口
61+ * 会员卡激活接口.
6162 *
6263 * @param activatedMessage 激活所需参数
6364 * @return 返回json字符串
@@ -66,7 +67,7 @@ public interface WxMpMemberCardService {
6667 String activateMemberCard (WxMpMemberCardActivatedMessage activatedMessage ) throws WxErrorException ;
6768
6869 /**
69- * 拉取会员信息接口
70+ * 拉取会员信息接口.
7071 *
7172 * @param cardId 会员卡的CardId,微信分配
7273 * @param code 领取会员的会员卡Code
@@ -76,10 +77,10 @@ public interface WxMpMemberCardService {
7677 WxMpMemberCardUserInfoResult getUserInfo (String cardId , String code ) throws WxErrorException ;
7778
7879 /**
79- * 当会员持卡消费后,支持开发者调用该接口更新会员信息。会员卡交易后的每次信息变更需通过该接口通知微信,便于后续消息通知及其他扩展功能。
80- * <p>
81- * 1.开发者可以同时传入add_bonus和bonus解决由于同步失败带来的幂等性问题。同时传入add_bonus和bonus时
82- * add_bonus作为积分变动消息中的变量值,而bonus作为卡面上的总积分额度显示。余额变动同理。
80+ * 当会员持卡消费后,支持开发者调用该接口更新会员信息.
81+ * 会员卡交易后的每次信息变更需通过该接口通知微信,便于后续消息通知及其他扩展功能。
82+ * 1.开发者可以同时传入add_bonus和bonus解决由于同步失败带来的幂等性问题。
83+ * 同时传入add_bonus和bonus时 add_bonus作为积分变动消息中的变量值,而bonus作为卡面上的总积分额度显示。余额变动同理。
8384 * 2.开发者可以传入is_notify_bonus控制特殊的积分对账变动不发送消息,余额变动同理。
8485 *
8586 * @param updateUserMessage 更新会员信息所需字段消息
@@ -89,29 +90,17 @@ public interface WxMpMemberCardService {
8990 WxMpMemberCardUpdateResult updateUserMemberCard (WxMpMemberCardUpdateMessage updateUserMessage ) throws WxErrorException ;
9091
9192 /**
92- * 设置会员卡激活的字段(会员卡设置:wx_activate=true 时需要)
93- *
94- * @param userFormRequest
95- * @return
96- * @throws WxErrorException
93+ * 设置会员卡激活的字段(会员卡设置:wx_activate=true 时需要).
9794 */
9895 MemberCardActivateUserFormResult setActivateUserForm (MemberCardActivateUserFormRequest userFormRequest ) throws WxErrorException ;
9996
10097 /**
101- * 获取会员卡开卡插件参数(跳转型开卡组件需要参数)
102- *
103- * @param cardId
104- * @param outStr
105- * @return
106- * @throws WxErrorException
98+ * 获取会员卡开卡插件参数(跳转型开卡组件需要参数).
10799 */
108100 ActivatePluginParam getActivatePluginParam (String cardId , String outStr ) throws WxErrorException ;
109101
110102 /**
111- * 更新会员卡信息
112- * @param memberCardUpdateRequest
113- * @return
114- * @throws WxErrorException
103+ * 更新会员卡信息.
115104 */
116105 CardUpdateResult updateCardInfo (MemberCardUpdateRequest memberCardUpdateRequest ) throws WxErrorException ;
117106}
0 commit comments