Senparc.Weixin.XML 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Senparc.Weixin</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Senparc.Weixin.Config">
  8. <summary>
  9. 全局设置
  10. </summary>
  11. </member>
  12. <member name="F:Senparc.Weixin.Config.TIME_OUT">
  13. <summary>
  14. 请求超时设置(以毫秒为单位),默认为10秒。
  15. 说明:此处常量专为提供给方法的参数的默认值,不是方法内所有请求的默认超时时间。
  16. </summary>
  17. </member>
  18. <member name="P:Senparc.Weixin.Config.IsDebug">
  19. <summary>
  20. 指定是否是Debug状态,如果是,系统会自动输出日志
  21. </summary>
  22. </member>
  23. <member name="T:Senparc.Weixin.Containers.BaseContainer`1">
  24. <summary>
  25. 微信容器接口(如Ticket、AccessToken)
  26. </summary>
  27. <typeparam name="T"></typeparam>
  28. </member>
  29. <member name="F:Senparc.Weixin.Containers.BaseContainer`1._collectionList">
  30. <summary>
  31. 所有数据集合的列表
  32. </summary>
  33. </member>
  34. <member name="M:Senparc.Weixin.Containers.BaseContainer`1.GetCollectionList">
  35. <summary>
  36. 获取完整的数据集合的列表,包括所有的Container数据在内(建议不要进行任何修改操作)
  37. </summary>
  38. <returns></returns>
  39. </member>
  40. <member name="M:Senparc.Weixin.Containers.BaseContainer`1.GetAllItems">
  41. <summary>
  42. 获取所有容器内已经注册的项目
  43. (此方法将会遍历Dictionary,当数据项很多的时候效率会明显降低)
  44. </summary>
  45. <returns></returns>
  46. </member>
  47. <member name="M:Senparc.Weixin.Containers.BaseContainer`1.TryGetItem(System.String)">
  48. <summary>
  49. 尝试获取某一项Bag
  50. </summary>
  51. <param name="key"></param>
  52. <returns></returns>
  53. </member>
  54. <member name="M:Senparc.Weixin.Containers.BaseContainer`1.TryGetItem``1(System.String,System.Func{`0,``0})">
  55. <summary>
  56. 尝试获取某一项Bag中的具体某个属性
  57. </summary>
  58. <param name="key"></param>
  59. <param name="property">具体某个属性</param>
  60. <returns></returns>
  61. </member>
  62. <member name="M:Senparc.Weixin.Containers.BaseContainer`1.Update(System.String,`0)">
  63. <summary>
  64. 更新数据项
  65. </summary>
  66. <param name="key"></param>
  67. <param name="value">为null时删除该项</param>
  68. </member>
  69. <member name="M:Senparc.Weixin.Containers.BaseContainer`1.Update(System.String,System.Action{`0})">
  70. <summary>
  71. 更新数据项
  72. </summary>
  73. <param name="key"></param>
  74. <param name="partialUpdate">为null时删除该项</param>
  75. </member>
  76. <member name="M:Senparc.Weixin.Containers.BaseContainer`1.CheckRegistered(System.String)">
  77. <summary>
  78. 检查Key是否已经注册
  79. </summary>
  80. <param name="key"></param>
  81. <returns></returns>
  82. </member>
  83. <member name="P:Senparc.Weixin.Containers.BaseContainer`1.ItemCollection">
  84. <summary>
  85. 获取当前容器的数据项集合
  86. </summary>
  87. <returns></returns>
  88. </member>
  89. <member name="T:Senparc.Weixin.Containers.IBaseContainerBag">
  90. <summary>
  91. IBaseContainerBag
  92. </summary>
  93. </member>
  94. <member name="T:Senparc.Weixin.Containers.BaseContainerBag">
  95. <summary>
  96. BaseContainer容器中的Value类型
  97. </summary>
  98. </member>
  99. <member name="P:Senparc.Weixin.Containers.BaseContainerBag.Key">
  100. <summary>
  101. 通常为AppId
  102. </summary>
  103. </member>
  104. <member name="P:Senparc.Weixin.Context.MessageContainer`1.MaxRecordCount">
  105. <summary>
  106. 最大记录条数(保留尾部),如果小于等于0则不限制
  107. </summary>
  108. </member>
  109. <member name="T:Senparc.Weixin.Context.IMessageContext`2">
  110. <summary>
  111. 微信消息上下文(单个用户)接口
  112. </summary>
  113. <typeparam name="TRequest">请求消息类型</typeparam>
  114. <typeparam name="TResponse">响应消息类型</typeparam>
  115. </member>
  116. <member name="P:Senparc.Weixin.Context.IMessageContext`2.UserName">
  117. <summary>
  118. 用户名(OpenID)
  119. </summary>
  120. </member>
  121. <member name="P:Senparc.Weixin.Context.IMessageContext`2.LastActiveTime">
  122. <summary>
  123. 最后一次活动时间(用户主动发送Resquest请求的时间)
  124. </summary>
  125. </member>
  126. <member name="P:Senparc.Weixin.Context.IMessageContext`2.RequestMessages">
  127. <summary>
  128. 接收消息记录
  129. </summary>
  130. </member>
  131. <member name="P:Senparc.Weixin.Context.IMessageContext`2.ResponseMessages">
  132. <summary>
  133. 响应消息记录
  134. </summary>
  135. </member>
  136. <member name="P:Senparc.Weixin.Context.IMessageContext`2.MaxRecordCount">
  137. <summary>
  138. 最大储存容量(分别针对RequestMessages和ResponseMessages)
  139. </summary>
  140. </member>
  141. <member name="P:Senparc.Weixin.Context.IMessageContext`2.StorageData">
  142. <summary>
  143. 临时储存数据,如用户状态等,出于保持.net 3.5版本,这里暂不使用dynamic
  144. </summary>
  145. </member>
  146. <member name="P:Senparc.Weixin.Context.IMessageContext`2.ExpireMinutes">
  147. <summary>
  148. 用于覆盖WeixinContext所设置的默认过期时间
  149. </summary>
  150. </member>
  151. <member name="P:Senparc.Weixin.Context.IMessageContext`2.AppStoreState">
  152. <summary>
  153. AppStore状态,系统属性,请勿操作
  154. </summary>
  155. </member>
  156. <member name="T:Senparc.Weixin.Context.MessageContext`2">
  157. <summary>
  158. 微信消息上下文(单个用户)
  159. </summary>
  160. </member>
  161. <member name="M:Senparc.Weixin.Context.MessageContext`2.OnMessageContextRemoved(Senparc.Weixin.Context.WeixinContextRemovedEventArgs{`0,`1})">
  162. <summary>
  163. 执行上下文被移除的事件
  164. 注意:此事件不是实时触发的,而是等过期后任意一个人发过来的下一条消息执行之前触发。
  165. </summary>
  166. <param name="e"></param>
  167. </member>
  168. <member name="M:Senparc.Weixin.Context.MessageContext`2.#ctor">
  169. <summary>
  170. </summary>
  171. <param name="maxRecordCount">maxRecordCount如果小于等于0,则不限制</param>
  172. </member>
  173. <member name="M:Senparc.Weixin.Context.MessageContext`2.OnRemoved">
  174. <summary>
  175. 此上下文被清除的时候触发
  176. </summary>
  177. </member>
  178. <member name="P:Senparc.Weixin.Context.MessageContext`2.AppStoreState">
  179. <summary>
  180. AppStore状态,系统属性,请勿操作
  181. </summary>
  182. </member>
  183. <member name="E:Senparc.Weixin.Context.MessageContext`2.MessageContextRemoved">
  184. <summary>
  185. 当MessageContext被删除时触发的事件
  186. </summary>
  187. </member>
  188. <member name="T:Senparc.Weixin.Context.MessageQueue`3">
  189. <summary>
  190. 微信消息列队(针对单个账号的往来消息)
  191. </summary>
  192. <typeparam name="TM"></typeparam>
  193. </member>
  194. <member name="F:Senparc.Weixin.Context.WeixinContextGlobal.UseWeixinContext">
  195. <summary>
  196. 是否开启上下文记录
  197. </summary>
  198. </member>
  199. <member name="T:Senparc.Weixin.Context.WeixinContext`3">
  200. <summary>
  201. 微信消息上下文(全局)
  202. 默认过期时间:90分钟
  203. </summary>
  204. </member>
  205. <member name="M:Senparc.Weixin.Context.WeixinContext`3.Restore">
  206. <summary>
  207. 重置所有上下文参数,所有记录将被清空
  208. </summary>
  209. </member>
  210. <member name="M:Senparc.Weixin.Context.WeixinContext`3.GetMessageContext(System.String)">
  211. <summary>
  212. 获取MessageContext,如果不存在,返回null
  213. 这个方法的更重要意义在于操作TM队列,及时移除过期信息,并将最新活动的对象移到尾部
  214. </summary>
  215. <param name="userName">用户名(OpenId)</param>
  216. <returns></returns>
  217. </member>
  218. <member name="M:Senparc.Weixin.Context.WeixinContext`3.GetMessageContext(System.String,System.Boolean)">
  219. <summary>
  220. 获取MessageContext
  221. </summary>
  222. <param name="userName">用户名(OpenId)</param>
  223. <param name="createIfNotExists">True:如果用户不存在,则创建一个实例,并返回这个最新的实例
  224. False:用户储存在,则返回null</param>
  225. <returns></returns>
  226. </member>
  227. <member name="M:Senparc.Weixin.Context.WeixinContext`3.GetMessageContext(`1)">
  228. <summary>
  229. 获取MessageContext,如果不存在,使用requestMessage信息初始化一个,并返回原始实例
  230. </summary>
  231. <returns></returns>
  232. </member>
  233. <member name="M:Senparc.Weixin.Context.WeixinContext`3.GetMessageContext(`2)">
  234. <summary>
  235. 获取MessageContext,如果不存在,使用requestMessage信息初始化一个,并返回原始实例
  236. </summary>
  237. <returns></returns>
  238. </member>
  239. <member name="M:Senparc.Weixin.Context.WeixinContext`3.InsertMessage(`1)">
  240. <summary>
  241. 记录请求信息
  242. </summary>
  243. <param name="requestMessage">请求信息</param>
  244. </member>
  245. <member name="M:Senparc.Weixin.Context.WeixinContext`3.InsertMessage(`2)">
  246. <summary>
  247. 记录响应信息
  248. </summary>
  249. <param name="responseMessage">响应信息</param>
  250. </member>
  251. <member name="M:Senparc.Weixin.Context.WeixinContext`3.GetLastRequestMessage(System.String)">
  252. <summary>
  253. 获取最新一条请求数据,如果不存在,则返回Null
  254. </summary>
  255. <param name="userName">用户名(OpenId)</param>
  256. <returns></returns>
  257. </member>
  258. <member name="M:Senparc.Weixin.Context.WeixinContext`3.GetLastResponseMessage(System.String)">
  259. <summary>
  260. 获取最新一条响应数据,如果不存在,则返回Null
  261. </summary>
  262. <param name="userName">用户名(OpenId)</param>
  263. <returns></returns>
  264. </member>
  265. <member name="P:Senparc.Weixin.Context.WeixinContext`3.MessageCollection">
  266. <summary>
  267. 所有MessageContext集合,不要直接操作此对象
  268. </summary>
  269. </member>
  270. <member name="P:Senparc.Weixin.Context.WeixinContext`3.MessageQueue">
  271. <summary>
  272. MessageContext列队(LastActiveTime升序排列),不要直接操作此对象
  273. </summary>
  274. </member>
  275. <member name="P:Senparc.Weixin.Context.WeixinContext`3.ExpireMinutes">
  276. <summary>
  277. 每一个MessageContext过期时间
  278. </summary>
  279. </member>
  280. <member name="P:Senparc.Weixin.Context.WeixinContext`3.MaxRecordCount">
  281. <summary>
  282. 最大储存上下文数量(分别针对请求和响应信息)
  283. </summary>
  284. </member>
  285. <member name="T:Senparc.Weixin.Context.WeixinContextRemovedEventArgs`2">
  286. <summary>
  287. 对话上下文被删除时触发事件的事件数据
  288. </summary>
  289. </member>
  290. <member name="P:Senparc.Weixin.Context.WeixinContextRemovedEventArgs`2.OpenId">
  291. <summary>
  292. 该用户的OpenId
  293. </summary>
  294. </member>
  295. <member name="P:Senparc.Weixin.Context.WeixinContextRemovedEventArgs`2.LastActiveTime">
  296. <summary>
  297. 最后一次响应时间
  298. </summary>
  299. </member>
  300. <member name="P:Senparc.Weixin.Context.WeixinContextRemovedEventArgs`2.MessageContext">
  301. <summary>
  302. 上下文对象
  303. </summary>
  304. </member>
  305. <member name="T:Senparc.Weixin.Entities.IEntityBase">
  306. <summary>
  307. 所有微信自定义实体的基础接口
  308. </summary>
  309. </member>
  310. <member name="T:Senparc.Weixin.Entities.IJsonIgnoreNull">
  311. <summary>
  312. 生成JSON时忽略NULL对象
  313. </summary>
  314. </member>
  315. <member name="T:Senparc.Weixin.Entities.QyJsonResult">
  316. <summary>
  317. 企业号JSON返回结果
  318. </summary>
  319. </member>
  320. <member name="P:Senparc.Weixin.Entities.QyJsonResult.P2PData">
  321. <summary>
  322. 为P2P返回结果做准备
  323. </summary>
  324. </member>
  325. <member name="T:Senparc.Weixin.Entities.MessageBase">
  326. <summary>
  327. 所有Request和Response消息的基类
  328. </summary>
  329. </member>
  330. <member name="T:Senparc.Weixin.IEncryptPostModel">
  331. <summary>
  332. 接收解密信息统一接口
  333. </summary>
  334. </member>
  335. <member name="T:Senparc.Weixin.EncryptPostModel">
  336. <summary>
  337. 接收加密信息统一基类
  338. </summary>
  339. </member>
  340. <member name="M:Senparc.Weixin.EncryptPostModel.SetSecretInfo(System.String,System.String)">
  341. <summary>
  342. 设置服务器内部保密信息
  343. </summary>
  344. <param name="token"></param>
  345. <param name="encodingAESKey"></param>
  346. <param name="appId"></param>
  347. </member>
  348. <member name="T:Senparc.Weixin.CommonJsonSendType">
  349. <summary>
  350. CommonJsonSend中的http提交类型
  351. </summary>
  352. </member>
  353. <member name="T:Senparc.Weixin.ReturnCode">
  354. <summary>
  355. 公众号返回码(JSON)
  356. 应该更名为ReturnCode_MP,但为减少项目中的修改,此处依旧用ReturnCode命名
  357. </summary>
  358. </member>
  359. <member name="F:Senparc.Weixin.ReturnCode.客服帐号名长度超过限制">
  360. <summary>
  361. 客服帐号名长度超过限制(仅允许10个英文字符,不包括@及@后的公众号的微信号)(invalid kf_acount length)
  362. </summary>
  363. </member>
  364. <member name="F:Senparc.Weixin.ReturnCode.客服帐号名包含非法字符">
  365. <summary>
  366. 客服帐号名包含非法字符(仅允许英文+数字)(illegal character in kf_account)
  367. </summary>
  368. </member>
  369. <member name="F:Senparc.Weixin.ReturnCode.客服帐号个数超过限制">
  370. <summary>
  371. 客服帐号个数超过限制(10个客服账号)(kf_account count exceeded)
  372. </summary>
  373. </member>
  374. <member name="T:Senparc.Weixin.ReturnCode_QY">
  375. <summary>
  376. 企业号返回码
  377. </summary>
  378. </member>
  379. <member name="T:Senparc.Weixin.Language">
  380. <summary>
  381. 语言
  382. </summary>
  383. </member>
  384. <member name="F:Senparc.Weixin.Language.zh_CN">
  385. <summary>
  386. 中文简体
  387. </summary>
  388. </member>
  389. <member name="F:Senparc.Weixin.Language.zh_TW">
  390. <summary>
  391. 中文繁体
  392. </summary>
  393. </member>
  394. <member name="F:Senparc.Weixin.Language.en">
  395. <summary>
  396. 英文
  397. </summary>
  398. </member>
  399. <member name="T:Senparc.Weixin.AppStoreState">
  400. <summary>
  401. AppStore状态
  402. </summary>
  403. </member>
  404. <member name="F:Senparc.Weixin.AppStoreState.None">
  405. <summary>
  406. 无状态
  407. </summary>
  408. </member>
  409. <member name="F:Senparc.Weixin.AppStoreState.Enter">
  410. <summary>
  411. 已进入应用状态
  412. </summary>
  413. </member>
  414. <member name="F:Senparc.Weixin.AppStoreState.Exit">
  415. <summary>
  416. 退出App状态(临时传输状态,退出后即为None)
  417. </summary>
  418. </member>
  419. <member name="T:Senparc.Weixin.Exceptions.ErrorJsonResultException">
  420. <summary>
  421. JSON返回错误代码(比如token_access相关操作中使用)。
  422. </summary>
  423. </member>
  424. <member name="T:Senparc.Weixin.Exceptions.WeixinException">
  425. <summary>
  426. 微信自定义异常基类
  427. </summary>
  428. </member>
  429. <member name="M:Senparc.Weixin.Exceptions.ErrorJsonResultException.#ctor(System.String,System.Exception,Senparc.Weixin.Entities.WxJsonResult,System.String)">
  430. <summary>
  431. </summary>
  432. <param name="message"></param>
  433. <param name="inner"></param>
  434. <param name="jsonResult"></param>
  435. <param name="url"></param>
  436. </member>
  437. <member name="T:Senparc.Weixin.Exceptions.UnknownRequestMsgTypeException">
  438. <summary>
  439. 未知请求类型。
  440. </summary>
  441. </member>
  442. <member name="T:Senparc.Weixin.Helpers.ExpandoJsonConverter">
  443. <summary>
  444. Allows JSON serialization of Expando objects into expected results (e.g., "x: 1, y: 2") instead of the default dictionary serialization.
  445. </summary>
  446. </member>
  447. <member name="M:Senparc.Weixin.Helpers.DateTimeHelper.GetDateTimeFromXml(System.Int64)">
  448. <summary>
  449. 转换微信DateTime时间到C#时间
  450. </summary>
  451. <param name="dateTimeFromXml">微信DateTime</param>
  452. <returns></returns>
  453. </member>
  454. <member name="M:Senparc.Weixin.Helpers.DateTimeHelper.GetDateTimeFromXml(System.String)">
  455. <summary>
  456. 转换微信DateTime时间到C#时间
  457. </summary>
  458. <param name="dateTimeFromXml">微信DateTime</param>
  459. <returns></returns>
  460. </member>
  461. <member name="M:Senparc.Weixin.Helpers.DateTimeHelper.GetWeixinDateTime(System.DateTime)">
  462. <summary>
  463. 获取微信DateTime(UNIX时间戳)
  464. </summary>
  465. <param name="dateTime">时间</param>
  466. <returns></returns>
  467. </member>
  468. <member name="M:Senparc.Weixin.Helpers.FileHelper.GetFileStream(System.String)">
  469. <summary>
  470. 根据完整文件路径获取FileStream
  471. </summary>
  472. <param name="fileName"></param>
  473. <returns></returns>
  474. </member>
  475. <!-- 对于成员“T:Senparc.Weixin.Helpers.IDictionaryExtensions”忽略有格式错误的 XML 注释 -->
  476. <member name="M:Senparc.Weixin.Helpers.IDictionaryExtensions.ToExpando(System.Collections.Generic.IDictionary{System.String,System.Object})">
  477. <summary>
  478. Extension method that turns a dictionary of string and object to an ExpandoObject
  479. Snagged from http://theburningmonk.com/2011/05/idictionarystring-object-to-expandoobject-extension-method/
  480. </summary>
  481. </member>
  482. <member name="T:Senparc.Weixin.Helpers.SerializerHelper">
  483. <summary>
  484. 序列化帮助类
  485. </summary>
  486. </member>
  487. <member name="M:Senparc.Weixin.Helpers.SerializerHelper.DecodeUnicode(System.Text.RegularExpressions.Match)">
  488. <summary>
  489. unicode解码
  490. </summary>
  491. <param name="match"></param>
  492. <returns></returns>
  493. </member>
  494. <member name="M:Senparc.Weixin.Helpers.SerializerHelper.GetJsonString(System.Object,Senparc.Weixin.Helpers.JsonSetting)">
  495. <summary>
  496. 将对象转为JSON字符串
  497. </summary>
  498. <param name="data">需要生成JSON字符串的数据</param>
  499. <param name="jsonSetting">JSON输出设置</param>
  500. <returns></returns>
  501. </member>
  502. <member name="T:Senparc.Weixin.Helpers.JsonSetting">
  503. <summary>
  504. JSON输出设置
  505. </summary>
  506. </member>
  507. <member name="M:Senparc.Weixin.Helpers.JsonSetting.#ctor(System.Boolean,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.Type})">
  508. <summary>
  509. JSON输出设置 构造函数
  510. </summary>
  511. <param name="ignoreNulls">是否忽略当前类型以及具有IJsonIgnoreNull接口,且为Null值的属性。如果为true,符合此条件的属性将不会出现在Json字符串中</param>
  512. <param name="propertiesToIgnore">需要特殊忽略null值的属性名称</param>
  513. <param name="typesToIgnore">指定类型(Class,非Interface)下的为null属性不生成到Json中</param>
  514. </member>
  515. <member name="P:Senparc.Weixin.Helpers.JsonSetting.IgnoreNulls">
  516. <summary>
  517. 是否忽略当前类型以及具有IJsonIgnoreNull接口,且为Null值的属性。如果为true,符合此条件的属性将不会出现在Json字符串中
  518. </summary>
  519. </member>
  520. <member name="P:Senparc.Weixin.Helpers.JsonSetting.PropertiesToIgnore">
  521. <summary>
  522. 需要特殊忽略null值的属性名称
  523. </summary>
  524. </member>
  525. <member name="P:Senparc.Weixin.Helpers.JsonSetting.TypesToIgnore">
  526. <summary>
  527. 指定类型(Class,非Interface)下的为null属性不生成到Json中
  528. </summary>
  529. </member>
  530. <member name="T:Senparc.Weixin.Helpers.WeixinJsonConventer">
  531. <summary>
  532. 微信JSON转换器
  533. </summary>
  534. </member>
  535. <member name="M:Senparc.Weixin.BrowserUtility.BroswerUtility.SideInWeixinBroswer(System.Web.HttpContextBase)">
  536. <summary>
  537. 判断是否在微信内置浏览器中
  538. </summary>
  539. <param name="httpContext"></param>
  540. <returns></returns>
  541. </member>
  542. <member name="T:Senparc.Weixin.CommonAPIs.CommonJsonSend">
  543. <summary>
  544. CommonJsonSend
  545. </summary>
  546. </member>
  547. <member name="M:Senparc.Weixin.CommonAPIs.CommonJsonSend.Send(System.String,System.String,System.Object,Senparc.Weixin.CommonJsonSendType,System.Int32,System.Boolean,Senparc.Weixin.Helpers.JsonSetting)">
  548. <summary>
  549. 向需要AccessToken的API发送消息的公共方法
  550. </summary>
  551. <param name="accessToken">这里的AccessToken是通用接口的AccessToken,非OAuth的。如果不需要,可以为null,此时urlFormat不要提供{0}参数</param>
  552. <param name="urlFormat"></param>
  553. <param name="data">如果是Get方式,可以为null</param>
  554. <param name="sendType"></param>
  555. <param name="timeOut">代理请求超时时间(毫秒)</param>
  556. <param name="jsonSetting"></param>
  557. <returns></returns>
  558. </member>
  559. <member name="M:Senparc.Weixin.CommonAPIs.CommonJsonSend.Send``1(System.String,System.String,System.Object,Senparc.Weixin.CommonJsonSendType,System.Int32,System.Boolean,Senparc.Weixin.Helpers.JsonSetting)">
  560. <summary>
  561. 向需要AccessToken的API发送消息的公共方法
  562. </summary>
  563. <param name="accessToken">这里的AccessToken是通用接口的AccessToken,非OAuth的。如果不需要,可以为null,此时urlFormat不要提供{0}参数</param>
  564. <param name="urlFormat">用accessToken参数填充{0}</param>
  565. <param name="data">如果是Get方式,可以为null</param>
  566. <param name="sendType"></param>
  567. <param name="timeOut">代理请求超时时间(毫秒)</param>
  568. <param name="checkValidationResult"></param>
  569. <param name="jsonSetting"></param>
  570. <returns></returns>
  571. </member>
  572. <member name="M:Senparc.Weixin.Utilities.WeixinUtility.ApiUtility.IsAppId(System.String)">
  573. <summary>
  574. 判断accessTokenOrAppId参数是否是AppId
  575. </summary>
  576. <param name="accessTokenOrAppId"></param>
  577. <returns></returns>
  578. </member>
  579. <member name="M:Senparc.Weixin.XmlUtility.XmlUtility.Deserialize``1(System.String)">
  580. <summary>
  581. 反序列化
  582. </summary>
  583. <param name="type">类型</param>
  584. <param name="xml">XML字符串</param>
  585. <returns></returns>
  586. </member>
  587. <member name="M:Senparc.Weixin.XmlUtility.XmlUtility.Deserialize``1(System.IO.Stream)">
  588. <summary>
  589. 反序列化
  590. </summary>
  591. <param name="type"></param>
  592. <param name="xml"></param>
  593. <returns></returns>
  594. </member>
  595. <member name="M:Senparc.Weixin.XmlUtility.XmlUtility.Serializer``1(``0)">
  596. <summary>
  597. 序列化
  598. 说明:此方法序列化复杂类,如果没有声明XmlInclude等特性,可能会引发“使用 XmlInclude 或 SoapInclude 特性静态指定非已知的类型。”的错误。
  599. </summary>
  600. <param name="type">类型</param>
  601. <param name="obj">对象</param>
  602. <returns></returns>
  603. </member>
  604. <member name="M:Senparc.Weixin.XmlUtility.XmlUtility.Convert(System.IO.Stream)">
  605. <summary>
  606. 序列化将流转成XML字符串
  607. </summary>
  608. <param name="stream"></param>
  609. <returns></returns>
  610. </member>
  611. <member name="M:Senparc.Weixin.HttpUtility.Get.GetJson``1(System.String,System.Text.Encoding)">
  612. <summary>
  613. GET方式请求URL,并返回T类型
  614. </summary>
  615. <typeparam name="T">接收JSON的数据类型</typeparam>
  616. <param name="url"></param>
  617. <param name="encoding"></param>
  618. <returns></returns>
  619. </member>
  620. <member name="M:Senparc.Weixin.HttpUtility.Get.Download(System.String,System.IO.Stream)">
  621. <summary>
  622. 从Url下载
  623. </summary>
  624. <param name="url"></param>
  625. <param name="stream"></param>
  626. </member>
  627. <member name="M:Senparc.Weixin.HttpUtility.Post.GetResult``1(System.String)">
  628. <summary>
  629. 获取Post结果
  630. </summary>
  631. <typeparam name="T"></typeparam>
  632. <param name="returnText"></param>
  633. <returns></returns>
  634. </member>
  635. <member name="M:Senparc.Weixin.HttpUtility.Post.PostFileGetJson``1(System.String,System.Net.CookieContainer,System.Collections.Generic.Dictionary{System.String,System.String},System.Collections.Generic.Dictionary{System.String,System.String},System.Text.Encoding,System.Int32)">
  636. <summary>
  637. 发起Post请求
  638. </summary>
  639. <typeparam name="T">返回数据类型(Json对应的实体)</typeparam>
  640. <param name="url">请求Url</param>
  641. <param name="cookieContainer">CookieContainer,如果不需要则设为null</param>
  642. <param name="encoding"></param>
  643. <param name="timeOut">代理请求超时时间(毫秒)</param>
  644. <param name="fileDictionary"></param>
  645. <param name="postDataDictionary"></param>
  646. <returns></returns>
  647. </member>
  648. <member name="M:Senparc.Weixin.HttpUtility.Post.PostGetJson``1(System.String,System.Net.CookieContainer,System.IO.Stream,System.Text.Encoding,System.Int32,System.Boolean)">
  649. <summary>
  650. 发起Post请求
  651. </summary>
  652. <typeparam name="T">返回数据类型(Json对应的实体)</typeparam>
  653. <param name="url">请求Url</param>
  654. <param name="cookieContainer">CookieContainer,如果不需要则设为null</param>
  655. <param name="fileStream">文件流</param>
  656. <param name="encoding"></param>
  657. <param name="timeOut">代理请求超时时间(毫秒)</param>
  658. <param name="checkValidationResult">验证服务器证书回调自动验证</param>
  659. <returns></returns>
  660. </member>
  661. <member name="M:Senparc.Weixin.HttpUtility.Post.PostGetJson``1(System.String,System.Net.CookieContainer,System.Collections.Generic.Dictionary{System.String,System.String},System.Text.Encoding,System.Int32)">
  662. <summary>
  663. PostGetJson
  664. </summary>
  665. <param name="url"></param>
  666. <param name="cookieContainer"></param>
  667. <param name="formData"></param>
  668. <param name="encoding"></param>
  669. <param name="timeOut"></param>
  670. <typeparam name="T"></typeparam>
  671. <returns></returns>
  672. </member>
  673. <member name="M:Senparc.Weixin.HttpUtility.Post.Download(System.String,System.String,System.IO.Stream)">
  674. <summary>
  675. 使用Post方法上传数据并下载文件或结果
  676. </summary>
  677. <param name="url"></param>
  678. <param name="data"></param>
  679. <param name="stream"></param>
  680. </member>
  681. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.HttpGet(System.String,System.Text.Encoding)">
  682. <summary>
  683. 使用Get方法获取字符串结果(没有加入Cookie)
  684. </summary>
  685. <param name="url"></param>
  686. <returns></returns>
  687. </member>
  688. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.HttpGet(System.String,System.Net.CookieContainer,System.Text.Encoding,System.Int32)">
  689. <summary>
  690. 使用Get方法获取字符串结果(加入Cookie)
  691. </summary>
  692. <param name="url"></param>
  693. <param name="cookieContainer"></param>
  694. <param name="encoding"></param>
  695. <returns></returns>
  696. </member>
  697. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.HttpPost(System.String,System.Net.CookieContainer,System.Collections.Generic.Dictionary{System.String,System.String},System.Text.Encoding,System.Int32)">
  698. <summary>
  699. 使用Post方法获取字符串结果,常规提交
  700. </summary>
  701. <returns></returns>
  702. </member>
  703. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.HttpPost(System.String,System.Net.CookieContainer,System.IO.Stream,System.Collections.Generic.Dictionary{System.String,System.String},System.String,System.Text.Encoding,System.Int32,System.Boolean)">
  704. <summary>
  705. 使用Post方法获取字符串结果
  706. </summary>
  707. <param name="url"></param>
  708. <param name="cookieContainer"></param>
  709. <param name="postStream"></param>
  710. <param name="fileDictionary">需要上传的文件,Key:对应要上传的Name,Value:本地文件名</param>
  711. <param name="encoding"></param>
  712. <param name="timeOut"></param>
  713. <param name="checkValidationResult">验证服务器证书回调自动验证</param>
  714. <param name="refererUrl"></param>
  715. <returns></returns>
  716. </member>
  717. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.CheckValidationResult(System.Object,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)">
  718. <summary>
  719. 验证服务器证书
  720. </summary>
  721. <param name="sender"></param>
  722. <param name="certificate"></param>
  723. <param name="chain"></param>
  724. <param name="errors"></param>
  725. <returns></returns>
  726. </member>
  727. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.IsWeixinClientRequest(System.Web.HttpContext)">
  728. <summary>
  729. 请求是否发起自微信客户端的浏览器
  730. </summary>
  731. <param name="httpContext"></param>
  732. <returns></returns>
  733. </member>
  734. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.GetQueryString(System.Collections.Generic.Dictionary{System.String,System.String})">
  735. <summary>
  736. 组装QueryString的方法
  737. 参数之间用&amp;连接,首位没有符号,如:a=1&amp;b=2&amp;c=3
  738. </summary>
  739. <param name="formData"></param>
  740. <returns></returns>
  741. </member>
  742. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.FillFormDataStream(System.Collections.Generic.Dictionary{System.String,System.String},System.IO.Stream)">
  743. <summary>
  744. 填充表单信息的Stream
  745. </summary>
  746. <param name="formData"></param>
  747. <param name="stream"></param>
  748. </member>
  749. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.HtmlEncode(System.String)">
  750. <summary>
  751. 封装System.Web.HttpUtility.HtmlEncode
  752. </summary>
  753. <param name="html"></param>
  754. <returns></returns>
  755. </member>
  756. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.HtmlDecode(System.String)">
  757. <summary>
  758. 封装System.Web.HttpUtility.HtmlDecode
  759. </summary>
  760. <param name="html"></param>
  761. <returns></returns>
  762. </member>
  763. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.UrlEncode(System.String)">
  764. <summary>
  765. 封装System.Web.HttpUtility.UrlEncode
  766. </summary>
  767. <param name="url"></param>
  768. <returns></returns>
  769. </member>
  770. <member name="M:Senparc.Weixin.HttpUtility.RequestUtility.UrlDecode(System.String)">
  771. <summary>
  772. 封装System.Web.HttpUtility.UrlDecode
  773. </summary>
  774. <param name="url"></param>
  775. <returns></returns>
  776. </member>
  777. <member name="T:Senparc.Weixin.Entities.WxJsonResult">
  778. <summary>
  779. 公众号JSON返回结果(用于菜单接口等)
  780. </summary>
  781. </member>
  782. <member name="P:Senparc.Weixin.Entities.WxJsonResult.P2PData">
  783. <summary>
  784. 为P2P返回结果做准备
  785. </summary>
  786. </member>
  787. <member name="T:Senparc.Weixin.MessageHandlers.IMessageHandlerDocument">
  788. <summary>
  789. 为IMessageHandler单独提供XDocument类型的属性接口(主要是ResponseDocument)。
  790. 分离这个接口的目的是为了在MvcExtension中对IMessageHandler解耦,使用IMessageHandlerDocument接口直接操作XML。
  791. </summary>
  792. </member>
  793. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandlerDocument.RequestDocument">
  794. <summary>
  795. 在构造函数中转换得到原始XML数据
  796. </summary>
  797. </member>
  798. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandlerDocument.ResponseDocument">
  799. <summary>
  800. 根据ResponseMessageBase获得转换后的ResponseDocument
  801. 注意:这里每次请求都会根据当前的ResponseMessageBase生成一次,如需重用此数据,建议使用缓存或局部变量
  802. </summary>
  803. </member>
  804. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandlerDocument.FinalResponseDocument">
  805. <summary>
  806. 最后返回的ResponseDocument。
  807. 如果是Senparc.Weixin.MP引用,并且未设置未加密,则应当和ResponseDocument一致;除此以外(Senparc.Weixin.QY或已加密),则应当在ResponseDocument基础上进行加密
  808. </summary>
  809. </member>
  810. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandlerDocument.TextResponseMessage">
  811. <summary>
  812. 文字返回信息。当TextResponseMessage不为null时,才获取ResponseDocument
  813. </summary>
  814. </member>
  815. <member name="M:Senparc.Weixin.MessageHandlers.IMessageHandler`2.Execute">
  816. <summary>
  817. 执行微信请求
  818. </summary>
  819. </member>
  820. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandler`2.WeixinOpenId">
  821. <summary>
  822. 发送者用户名(OpenId)
  823. </summary>
  824. </member>
  825. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandler`2.CancelExcute">
  826. <summary>
  827. 取消执行Execute()方法。一般在OnExecuting()中用于临时阻止执行Execute()。
  828. 默认为False。
  829. 如果在执行OnExecuting()执行前设为True,则所有OnExecuting()、Execute()、OnExecuted()代码都不会被执行。
  830. 如果在执行OnExecuting()执行过程中设为True,则后续Execute()及OnExecuted()代码不会被执行。
  831. 建议在设为True的时候,给ResponseMessage赋值,以返回友好信息。
  832. </summary>
  833. </member>
  834. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandler`2.RequestMessage">
  835. <summary>
  836. 请求实体
  837. </summary>
  838. </member>
  839. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandler`2.ResponseMessage">
  840. <summary>
  841. 响应实体
  842. 只有当执行Execute()方法后才可能有值
  843. </summary>
  844. </member>
  845. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandler`2.UsedMessageAgent">
  846. <summary>
  847. 是否使用了MessageAgent代理
  848. </summary>
  849. </member>
  850. <member name="P:Senparc.Weixin.MessageHandlers.IMessageHandler`2.OmitRepeatedMessage">
  851. <summary>
  852. 忽略重复发送的同一条消息(通常因为微信服务器没有收到及时的响应)
  853. </summary>
  854. </member>
  855. <member name="T:Senparc.Weixin.MessageHandlers.MessageHandler`3">
  856. <summary>
  857. 微信请求的集中处理方法
  858. 此方法中所有过程,都基于Senparc.Weixin的基础功能,只为简化代码而设。
  859. </summary>
  860. </member>
  861. <member name="M:Senparc.Weixin.MessageHandlers.MessageHandler`3.CommonInitialize(System.Xml.Linq.XDocument,System.Int32,System.Object)">
  862. <summary>
  863. 构造函数公用的初始化方法
  864. </summary>
  865. <param name="postDataDocument"></param>
  866. <param name="maxRecordCount"></param>
  867. <param name="postData"></param>
  868. </member>
  869. <member name="M:Senparc.Weixin.MessageHandlers.MessageHandler`3.#ctor(System.IO.Stream,System.Int32,System.Object)">
  870. <summary>
  871. </summary>
  872. <param name="inputStream"></param>
  873. <param name="maxRecordCount"></param>
  874. <param name="postData">需要传入到Init的参数</param>
  875. </member>
  876. <member name="M:Senparc.Weixin.MessageHandlers.MessageHandler`3.#ctor(System.Xml.Linq.XDocument,System.Int32,System.Object)">
  877. <summary>
  878. 使用postDataDocument的构造函数
  879. </summary>
  880. <param name="postDataDocument"></param>
  881. <param name="maxRecordCount"></param>
  882. <param name="postData">需要传入到Init的参数</param>
  883. </member>
  884. <member name="M:Senparc.Weixin.MessageHandlers.MessageHandler`3.#ctor(Senparc.Weixin.Entities.RequestMessageBase,System.Int32,System.Object)">
  885. <summary>
  886. 使用requestMessageBase的构造函数
  887. </summary>
  888. <param name="postDataDocument"></param>
  889. <param name="maxRecordCount"></param>
  890. <param name="postData">需要传入到Init的参数</param>
  891. </member>
  892. <member name="M:Senparc.Weixin.MessageHandlers.MessageHandler`3.Init(System.Xml.Linq.XDocument,System.Object)">
  893. <summary>
  894. 初始化,获取RequestDocument。
  895. Init中需要对上下文添加当前消息(如果使用上下文)
  896. </summary>
  897. <param name="requestDocument"></param>
  898. </member>
  899. <member name="M:Senparc.Weixin.MessageHandlers.MessageHandler`3.Execute">
  900. <summary>
  901. 执行微信请求
  902. </summary>
  903. </member>
  904. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.WeixinContext">
  905. <summary>
  906. 全局消息上下文
  907. </summary>
  908. </member>
  909. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.CurrentMessageContext">
  910. <summary>
  911. 当前用户消息上下文
  912. </summary>
  913. </member>
  914. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.WeixinOpenId">
  915. <summary>
  916. 发送者用户名(OpenId)
  917. </summary>
  918. </member>
  919. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.UserName">
  920. <summary>
  921. </summary>
  922. </member>
  923. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.CancelExcute">
  924. <summary>
  925. 取消执行Execute()方法。一般在OnExecuting()中用于临时阻止执行Execute()。
  926. 默认为False。
  927. 如果在执行OnExecuting()执行前设为True,则所有OnExecuting()、Execute()、OnExecuted()代码都不会被执行。
  928. 如果在执行OnExecuting()执行过程中设为True,则后续Execute()及OnExecuted()代码不会被执行。
  929. 建议在设为True的时候,给ResponseMessage赋值,以返回友好信息。
  930. </summary>
  931. </member>
  932. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.RequestDocument">
  933. <summary>
  934. 在构造函数中转换得到原始XML数据
  935. </summary>
  936. </member>
  937. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.ResponseDocument">
  938. <summary>
  939. 根据ResponseMessageBase获得转换后的ResponseDocument
  940. 注意:这里每次请求都会根据当前的ResponseMessageBase生成一次,如需重用此数据,建议使用缓存或局部变量
  941. </summary>
  942. </member>
  943. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.FinalResponseDocument">
  944. <summary>
  945. 最后返回的ResponseDocument。
  946. 如果是Senparc.Weixin.QY,则应当和ResponseDocument一致;如果是Senparc.Weixin.QY,则应当在ResponseDocument基础上进行加密
  947. </summary>
  948. </member>
  949. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.RequestMessage">
  950. <summary>
  951. 请求实体
  952. </summary>
  953. </member>
  954. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.ResponseMessage">
  955. <summary>
  956. 响应实体
  957. 正常情况下只有当执行Execute()方法后才可能有值。
  958. 也可以结合Cancel,提前给ResponseMessage赋值。
  959. </summary>
  960. </member>
  961. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.UsedMessageAgent">
  962. <summary>
  963. 是否使用了MessageAgent代理
  964. </summary>
  965. </member>
  966. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.OmitRepeatedMessage">
  967. <summary>
  968. 忽略重复发送的同一条消息(通常因为微信服务器没有收到及时的响应)
  969. </summary>
  970. </member>
  971. <member name="P:Senparc.Weixin.MessageHandlers.MessageHandler`3.TextResponseMessage">
  972. <summary>
  973. 文字类型返回消息
  974. </summary>
  975. </member>
  976. <member name="T:Senparc.Weixin.Entities.RequestMessageBase">
  977. <summary>
  978. 接收到请求的消息
  979. </summary>
  980. </member>
  981. <member name="T:Senparc.Weixin.Entities.ResponseMessageBase">
  982. <summary>
  983. 响应回复消息
  984. </summary>
  985. </member>
  986. <member name="M:Senparc.Weixin.StreamUtility.StreamUtility.GetBase64String(System.IO.Stream)">
  987. <summary>
  988. 获取Stream的Base64字符串
  989. </summary>
  990. <param name="stream"></param>
  991. <returns></returns>
  992. </member>
  993. <member name="M:Senparc.Weixin.StreamUtility.StreamUtility.GetStreamFromBase64String(System.String,System.String)">
  994. <summary>
  995. 将base64String反序列化到流,或保存成文件
  996. </summary>
  997. <param name="base64String"></param>
  998. <param name="savePath">如果为null则不保存</param>
  999. <returns></returns>
  1000. </member>
  1001. <member name="M:Senparc.Weixin.StreamUtility.StreamUtility.SaveFileFromStream(System.IO.MemoryStream,System.String)">
  1002. <summary>
  1003. 将memoryStream保存到文件
  1004. </summary>
  1005. <param name="memoryStream"></param>
  1006. <param name="savePath"></param>
  1007. </member>
  1008. <member name="T:Senparc.Weixin.WeixinTrace">
  1009. <summary>
  1010. 微信日志跟踪
  1011. </summary>
  1012. </member>
  1013. <member name="M:Senparc.Weixin.WeixinTrace.TimeLog">
  1014. <summary>
  1015. 统一时间格式
  1016. </summary>
  1017. </member>
  1018. <member name="M:Senparc.Weixin.WeixinTrace.Log(System.String)">
  1019. <summary>
  1020. 记录日志
  1021. </summary>
  1022. <param name="message"></param>
  1023. </member>
  1024. <member name="M:Senparc.Weixin.WeixinTrace.SendLog(System.String,System.String)">
  1025. <summary>
  1026. API请求日志
  1027. </summary>
  1028. <param name="url"></param>
  1029. <param name="returnText"></param>
  1030. </member>
  1031. <member name="M:Senparc.Weixin.WeixinTrace.ErrorJsonResultExceptionLog(Senparc.Weixin.Exceptions.ErrorJsonResultException)">
  1032. <summary>
  1033. ErrorJsonResultException 日志
  1034. </summary>
  1035. <param name="ex"></param>
  1036. </member>
  1037. </members>
  1038. </doc>