package-summary.html
18.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="zh">
<head>
<!-- Generated by javadoc (1.8.0_121) on Fri May 05 10:54:54 CST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>com.jfinal.weixin.sdk.api (jfinal-weixin 1.9-SNAPSHOT API)</title>
<meta name="date" content="2017-05-05">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="com.jfinal.weixin.sdk.api (jfinal-weixin 1.9-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../../overview-summary.html">概览</a></li>
<li class="navBarCell1Rev">程序包</li>
<li>类</li>
<li><a href="package-use.html">使用</a></li>
<li><a href="package-tree.html">树</a></li>
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../../index-all.html">索引</a></li>
<li><a href="../../../../../help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/jfinal/weixin/iot/protocol/package-summary.html">上一个程序包</a></li>
<li><a href="../../../../../com/jfinal/weixin/sdk/api/bean/package-summary.html">下一个程序包</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/jfinal/weixin/sdk/api/package-summary.html" target="_top">框架</a></li>
<li><a href="package-summary.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">所有类</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="程序包" class="title">程序包 com.jfinal.weixin.sdk.api</h1>
<div class="docSummary">
<div class="block">微信API接口</div>
</div>
<p>请参阅: <a href="#package.description">说明</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="类概要表, 列表类和解释">
<caption><span>类概要</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">类</th>
<th class="colLast" scope="col">说明</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/AccessToken.html" title="com.jfinal.weixin.sdk.api中的类">AccessToken</a></td>
<td class="colLast">
<div class="block">封装 access_token</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/AccessTokenApi.html" title="com.jfinal.weixin.sdk.api中的类">AccessTokenApi</a></td>
<td class="colLast">
<div class="block">认证并获取 access_token API
http://mp.weixin.qq.com/wiki/index.php?</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/ApiConfig.html" title="com.jfinal.weixin.sdk.api中的类">ApiConfig</a></td>
<td class="colLast">
<div class="block">存放 Weixin 服务号需要用到的各个参数</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/ApiConfigKit.html" title="com.jfinal.weixin.sdk.api中的类">ApiConfigKit</a></td>
<td class="colLast">
<div class="block">将 ApiConfig 绑定到 ThreadLocal 的工具类，以方便在当前线程的各个地方获取 ApiConfig 对象：
1：如果控制器继承自 MsgController 该过程是自动的，详细可查看 MsgInterceptor 与之的配合
2：如果控制器继承自 ApiController 该过程是自动的，详细可查看 ApiInterceptor 与之的配合
3：如果控制器没有继承自 MsgController、ApiController，则需要先手动调用
ApiConfigKit.setThreadLocalAppId(appId) 来绑定 appId 到线程之上</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/ApiResult.html" title="com.jfinal.weixin.sdk.api中的类">ApiResult</a></td>
<td class="colLast">
<div class="block">封装 API 响应结果，将 json 字符串转换成 java 数据类型
jackson 中 json 类型与 java 类型对应关系如下：
http://wiki.fasterxml.com/JacksonInFiveMinutes
JSON TYPE JAVA TYPE
object LinkedHashMap<String,Object>
array ArrayList<Object>
string String
number (no fraction) Integer, Long or BigInteger (smallest applicable)
number (fraction) Double (configurable to use BigDecimal)
true|false Boolean
null null
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/AutoReplyInfoApi.html" title="com.jfinal.weixin.sdk.api中的类">AutoReplyInfoApi</a></td>
<td class="colLast">
<div class="block">获取自动回复规则</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/BlackUserApi.html" title="com.jfinal.weixin.sdk.api中的类">BlackUserApi</a></td>
<td class="colLast">
<div class="block">黑名单管理api
接口有问题</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/CallbackIpApi.html" title="com.jfinal.weixin.sdk.api中的类">CallbackIpApi</a></td>
<td class="colLast">
<div class="block">获取微信服务器IP地址
如果公众号基于安全等考虑，需要获知微信服务器的IP地址列表，以便进行相关限制，可以通过该接口获得微信服务器IP地址列表。</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/CardApi.html" title="com.jfinal.weixin.sdk.api中的类">CardApi</a></td>
<td class="colLast">
<div class="block">卡券相关接口
Created by L.cm on 2016/6/16.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/CardCodeApi.html" title="com.jfinal.weixin.sdk.api中的类">CardCodeApi</a></td>
<td class="colLast">
<div class="block">核销卡券接口</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/CardExtApi.html" title="com.jfinal.weixin.sdk.api中的类">CardExtApi</a></td>
<td class="colLast">
<div class="block">特殊卡券接口-特殊票券</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/CardPayApi.html" title="com.jfinal.weixin.sdk.api中的类">CardPayApi</a></td>
<td class="colLast">
<div class="block">付费券点</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/CustomServiceApi.html" title="com.jfinal.weixin.sdk.api中的类">CustomServiceApi</a></td>
<td class="colLast">
<div class="block">多客服功能<br>
仅支持获取客服聊天记录接口，其他功能可以使用微信官方的多客服客户端软件来完成。</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/CustomServiceApi.Articles.html" title="com.jfinal.weixin.sdk.api中的类">CustomServiceApi.Articles</a></td>
<td class="colLast">
<div class="block">客户消息图文封装和 `News` 又略微区别，无法公用</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/DatacubeApi.html" title="com.jfinal.weixin.sdk.api中的类">DatacubeApi</a></td>
<td class="colLast">
<div class="block">数据统计接口</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/GroupsApi.html" title="com.jfinal.weixin.sdk.api中的类">GroupsApi</a></td>
<td class="colLast">
<div class="block">分组Api</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/JsTicket.html" title="com.jfinal.weixin.sdk.api中的类">JsTicket</a></td>
<td class="colLast">
<div class="block">JsTicket返回封装</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/JsTicketApi.html" title="com.jfinal.weixin.sdk.api中的类">JsTicketApi</a></td>
<td class="colLast">
<div class="block">生成签名之前必须先了解一下jsapi_ticket，jsapi_ticket是公众号用于调用微信JS接口的临时票据
https://api.weixin.qq.com/cgi-bin/ticket/getticket?</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/MediaApi.html" title="com.jfinal.weixin.sdk.api中的类">MediaApi</a></td>
<td class="colLast">
<div class="block">素材管理</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/MediaArticles.html" title="com.jfinal.weixin.sdk.api中的类">MediaArticles</a></td>
<td class="colLast">
<div class="block">图文素材</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/MediaFile.html" title="com.jfinal.weixin.sdk.api中的类">MediaFile</a></td>
<td class="colLast">
<div class="block">素材文件，参考自____′↘夏悸 wechat</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/MemberCardApi.html" title="com.jfinal.weixin.sdk.api中的类">MemberCardApi</a></td>
<td class="colLast">
<div class="block">会员卡接口</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/MenuApi.html" title="com.jfinal.weixin.sdk.api中的类">MenuApi</a></td>
<td class="colLast">
<div class="block">menu api</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/MessageApi.html" title="com.jfinal.weixin.sdk.api中的类">MessageApi</a></td>
<td class="colLast">
<div class="block">高级群发相关接口</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/PaymentApi.html" title="com.jfinal.weixin.sdk.api中的类">PaymentApi</a></td>
<td class="colLast">
<div class="block">微信支付api</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/PoiApi.html" title="com.jfinal.weixin.sdk.api中的类">PoiApi</a></td>
<td class="colLast">
<div class="block">微信门店接口
门店poiid体系已做改造，poiid自创建后立刻分配，不再受审核影响发生变化。</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/QrcodeApi.html" title="com.jfinal.weixin.sdk.api中的类">QrcodeApi</a></td>
<td class="colLast">
<div class="block">生成带参数的二维码 API
https://api.weixin.qq.com/cgi-bin/qrcode/create?</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/RedPackApi.html" title="com.jfinal.weixin.sdk.api中的类">RedPackApi</a></td>
<td class="colLast">
<div class="block">微信红包api</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/ReturnCode.html" title="com.jfinal.weixin.sdk.api中的类">ReturnCode</a></td>
<td class="colLast">
<div class="block">微信接口全局返回码</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/SemanticApi.html" title="com.jfinal.weixin.sdk.api中的类">SemanticApi</a></td>
<td class="colLast">
<div class="block">语义接口</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/ShorturlApi.html" title="com.jfinal.weixin.sdk.api中的类">ShorturlApi</a></td>
<td class="colLast">
<div class="block">将一条长链接转成短链接 API
文档地址：http://mp.weixin.qq.com/wiki/6/d2ec191ffdf5a596238385f75f95ecbe.html</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/SnsAccessToken.html" title="com.jfinal.weixin.sdk.api中的类">SnsAccessToken</a></td>
<td class="colLast">
<div class="block">SnsAccessToken
封装 access_token</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/SnsAccessTokenApi.html" title="com.jfinal.weixin.sdk.api中的类">SnsAccessTokenApi</a></td>
<td class="colLast">
<div class="block">网页授权获取 access_token API</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/SnsApi.html" title="com.jfinal.weixin.sdk.api中的类">SnsApi</a></td>
<td class="colLast">
<div class="block">获取用户基本信息(UnionID机制)
http://mp.weixin.qq.com/wiki/1/8a5ce6257f1d3b2afb20f83e72b72ce9.html</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/TagApi.html" title="com.jfinal.weixin.sdk.api中的类">TagApi</a></td>
<td class="colLast">
<div class="block">用户标签接口</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/TemplateData.html" title="com.jfinal.weixin.sdk.api中的类">TemplateData</a></td>
<td class="colLast">
<div class="block">模板消息数据对象</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/TemplateMsgApi.html" title="com.jfinal.weixin.sdk.api中的类">TemplateMsgApi</a></td>
<td class="colLast">
<div class="block">模板消息 API
文档地址：http://mp.weixin.qq.com/wiki/17/304c1885ea66dbedf7dc170d84999a9d.html</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/UserApi.html" title="com.jfinal.weixin.sdk.api中的类">UserApi</a></td>
<td class="colLast">
<div class="block">用户管理 API
https://api.weixin.qq.com/cgi-bin/user/info?</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="枚举概要表, 列表枚举和解释">
<caption><span>枚举概要</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">枚举</th>
<th class="colLast" scope="col">说明</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/JsTicketApi.JsApiType.html" title="com.jfinal.weixin.sdk.api中的枚举">JsTicketApi.JsApiType</a></td>
<td class="colLast">
<div class="block">JSApi的类型
jsapi: 用于分享等js-api
wx_card：用于卡券接口签名凭证api_ticket</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/MediaApi.MediaType.html" title="com.jfinal.weixin.sdk.api中的枚举">MediaApi.MediaType</a></td>
<td class="colLast">
<div class="block">上传的临时多媒体文件有格式
分别有图片（image）、语音（voice）、视频（video）和缩略图（thumb）</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/PaymentApi.BillType.html" title="com.jfinal.weixin.sdk.api中的枚举">PaymentApi.BillType</a></td>
<td class="colLast">
<div class="block">
ALL，返回当日所有订单信息，默认值
SUCCESS，返回当日成功支付的订单
REFUND，返回当日退款订单
REVOKED，已撤销的订单
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/jfinal/weixin/sdk/api/PaymentApi.TradeType.html" title="com.jfinal.weixin.sdk.api中的枚举">PaymentApi.TradeType</a></td>
<td class="colLast">
<div class="block">交易类型枚举
WAP的文档：https://pay.weixin.qq.com/wiki/doc/api/wap.php?</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="程序包com.jfinal.weixin.sdk.api的说明">程序包com.jfinal.weixin.sdk.api的说明</h2>
<div class="block">微信API接口</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../../overview-summary.html">概览</a></li>
<li class="navBarCell1Rev">程序包</li>
<li>类</li>
<li><a href="package-use.html">使用</a></li>
<li><a href="package-tree.html">树</a></li>
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../../index-all.html">索引</a></li>
<li><a href="../../../../../help-doc.html">帮助</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/jfinal/weixin/iot/protocol/package-summary.html">上一个程序包</a></li>
<li><a href="../../../../../com/jfinal/weixin/sdk/api/bean/package-summary.html">下一个程序包</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/jfinal/weixin/sdk/api/package-summary.html" target="_top">框架</a></li>
<li><a href="package-summary.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">所有类</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2017. All rights reserved.</small></p>
</body>
</html>