BaseMessage.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="zh">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_161) on Fri Apr 06 17:21:00 CST 2018 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>BaseMessage (spring-boot-dingtalk-robot-starter 1.0.0.RELEASE API)</title>
  8. <meta name="date" content="2018-04-06">
  9. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
  10. <script type="text/javascript" src="../../../../../../script.js"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="BaseMessage (spring-boot-dingtalk-robot-starter 1.0.0.RELEASE API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":10,"i1":6,"i2":6};
  23. var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"],8:["t4","具体方法"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>您的浏览器已禁用 JavaScript。</div>
  31. </noscript>
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="导航">
  41. <li><a href="../../../../../../overview-summary.html">概览</a></li>
  42. <li><a href="package-summary.html">程序包</a></li>
  43. <li class="navBarCell1Rev">类</li>
  44. <li><a href="class-use/BaseMessage.html">使用</a></li>
  45. <li><a href="package-tree.html">树</a></li>
  46. <li><a href="../../../../../../deprecated-list.html">已过时</a></li>
  47. <li><a href="../../../../../../index-all.html">索引</a></li>
  48. <li><a href="../../../../../../help-doc.html">帮助</a></li>
  49. </ul>
  50. </div>
  51. <div class="subNav">
  52. <ul class="navList">
  53. <li><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/ActionCardMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类"><span class="typeNameLink">上一个类</span></a></li>
  54. <li><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/DingTalkResponse.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类"><span class="typeNameLink">下一个类</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../../../../../../index.html?cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html" target="_top">框架</a></li>
  58. <li><a href="BaseMessage.html" target="_top">无框架</a></li>
  59. </ul>
  60. <ul class="navList" id="allclasses_navbar_top">
  61. <li><a href="../../../../../../allclasses-noframe.html">所有类</a></li>
  62. </ul>
  63. <div>
  64. <script type="text/javascript"><!--
  65. allClassesLink = document.getElementById("allclasses_navbar_top");
  66. if(window==top) {
  67. allClassesLink.style.display = "block";
  68. }
  69. else {
  70. allClassesLink.style.display = "none";
  71. }
  72. //-->
  73. </script>
  74. </div>
  75. <div>
  76. <ul class="subNavList">
  77. <li>概要:&nbsp;</li>
  78. <li>嵌套&nbsp;|&nbsp;</li>
  79. <li><a href="#field.summary">字段</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
  81. <li><a href="#method.summary">方法</a></li>
  82. </ul>
  83. <ul class="subNavList">
  84. <li>详细资料:&nbsp;</li>
  85. <li><a href="#field.detail">字段</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
  87. <li><a href="#method.detail">方法</a></li>
  88. </ul>
  89. </div>
  90. <a name="skip.navbar.top">
  91. <!-- -->
  92. </a></div>
  93. <!-- ========= END OF TOP NAVBAR ========= -->
  94. <!-- ======== START OF CLASS DATA ======== -->
  95. <div class="header">
  96. <div class="subTitle">cn.snowheart.dingtalk.robot.starter.entity</div>
  97. <h2 title="类 BaseMessage" class="title">类 BaseMessage</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <ul class="inheritance">
  101. <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">java.lang.Object</a></li>
  102. <li>
  103. <ul class="inheritance">
  104. <li>cn.snowheart.dingtalk.robot.starter.entity.BaseMessage</li>
  105. </ul>
  106. </li>
  107. </ul>
  108. <div class="description">
  109. <ul class="blockList">
  110. <li class="blockList">
  111. <dl>
  112. <dt>所有已实现的接口:</dt>
  113. <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="java.io中的类或接口">Serializable</a></dd>
  114. </dl>
  115. <dl>
  116. <dt>直接已知子类:</dt>
  117. <dd><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/ActionCardMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">ActionCardMessage</a>, <a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/FeedCardMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">FeedCardMessage</a>, <a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/LinkMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">LinkMessage</a>, <a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/MarkdownMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">MarkdownMessage</a>, <a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/TextMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">TextMessage</a></dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public abstract class <span class="typeNameLabel">BaseMessage</span>
  122. extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>
  123. implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="java.io中的类或接口">Serializable</a></pre>
  124. <div class="block">请求消息的抽象类</div>
  125. <dl>
  126. <dt><span class="simpleTagLabel">版本:</span></dt>
  127. <dd>1.0.0</dd>
  128. <dt><span class="simpleTagLabel">作者:</span></dt>
  129. <dd>Wanxiang Liu</dd>
  130. <dt><span class="seeLabel">另请参阅:</span></dt>
  131. <dd><a href="../../../../../../serialized-form.html#cn.snowheart.dingtalk.robot.starter.entity.BaseMessage">序列化表格</a></dd>
  132. </dl>
  133. </li>
  134. </ul>
  135. </div>
  136. <div class="summary">
  137. <ul class="blockList">
  138. <li class="blockList">
  139. <!-- =========== FIELD SUMMARY =========== -->
  140. <ul class="blockList">
  141. <li class="blockList"><a name="field.summary">
  142. <!-- -->
  143. </a>
  144. <h3>字段概要</h3>
  145. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="字段概要表, 列表字段和解释">
  146. <caption><span>字段</span><span class="tabEnd">&nbsp;</span></caption>
  147. <tr>
  148. <th class="colFirst" scope="col">限定符和类型</th>
  149. <th class="colLast" scope="col">字段和说明</th>
  150. </tr>
  151. <tr class="altColor">
  152. <td class="colFirst"><code>protected <a href="../../../../../../cn/snowheart/dingtalk/robot/starter/type/MessageType.html" title="cn.snowheart.dingtalk.robot.starter.type中的枚举">MessageType</a></code></td>
  153. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html#msgtype">msgtype</a></span></code>
  154. <div class="block">消息类型</div>
  155. </td>
  156. </tr>
  157. </table>
  158. </li>
  159. </ul>
  160. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  161. <ul class="blockList">
  162. <li class="blockList"><a name="constructor.summary">
  163. <!-- -->
  164. </a>
  165. <h3>构造器概要</h3>
  166. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="构造器概要表, 列表构造器和解释">
  167. <caption><span>构造器</span><span class="tabEnd">&nbsp;</span></caption>
  168. <tr>
  169. <th class="colOne" scope="col">构造器和说明</th>
  170. </tr>
  171. <tr class="altColor">
  172. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html#BaseMessage--">BaseMessage</a></span>()</code>&nbsp;</td>
  173. </tr>
  174. </table>
  175. </li>
  176. </ul>
  177. <!-- ========== METHOD SUMMARY =========== -->
  178. <ul class="blockList">
  179. <li class="blockList"><a name="method.summary">
  180. <!-- -->
  181. </a>
  182. <h3>方法概要</h3>
  183. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
  184. <caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">具体方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  185. <tr>
  186. <th class="colFirst" scope="col">限定符和类型</th>
  187. <th class="colLast" scope="col">方法和说明</th>
  188. </tr>
  189. <tr id="i0" class="altColor">
  190. <td class="colFirst"><code><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/type/MessageType.html" title="cn.snowheart.dingtalk.robot.starter.type中的枚举">MessageType</a></code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html#getMsgtype--">getMsgtype</a></span>()</code>&nbsp;</td>
  192. </tr>
  193. <tr id="i1" class="rowColor">
  194. <td class="colFirst"><code>protected abstract void</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html#init--">init</a></span>()</code>
  196. <div class="block">初始化MmessageType方法</div>
  197. </td>
  198. </tr>
  199. <tr id="i2" class="altColor">
  200. <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="java.util中的类或接口">Map</a></code></td>
  201. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html#toMessageMap--">toMessageMap</a></span>()</code>
  202. <div class="block">返回Message对象组装出来的Map对象,供后续JSON序列化</div>
  203. </td>
  204. </tr>
  205. </table>
  206. <ul class="blockList">
  207. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  208. <!-- -->
  209. </a>
  210. <h3>从类继承的方法&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a></h3>
  211. <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="java.lang中的类或接口">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="java.lang中的类或接口">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="java.lang中的类或接口">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="java.lang中的类或接口">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="java.lang中的类或接口">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="java.lang中的类或接口">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="java.lang中的类或接口">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="java.lang中的类或接口">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="java.lang中的类或接口">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="java.lang中的类或接口">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="java.lang中的类或接口">wait</a></code></li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </li>
  216. </ul>
  217. </div>
  218. <div class="details">
  219. <ul class="blockList">
  220. <li class="blockList">
  221. <!-- ============ FIELD DETAIL =========== -->
  222. <ul class="blockList">
  223. <li class="blockList"><a name="field.detail">
  224. <!-- -->
  225. </a>
  226. <h3>字段详细资料</h3>
  227. <a name="msgtype">
  228. <!-- -->
  229. </a>
  230. <ul class="blockListLast">
  231. <li class="blockList">
  232. <h4>msgtype</h4>
  233. <pre>protected&nbsp;<a href="../../../../../../cn/snowheart/dingtalk/robot/starter/type/MessageType.html" title="cn.snowheart.dingtalk.robot.starter.type中的枚举">MessageType</a> msgtype</pre>
  234. <div class="block">消息类型</div>
  235. </li>
  236. </ul>
  237. </li>
  238. </ul>
  239. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  240. <ul class="blockList">
  241. <li class="blockList"><a name="constructor.detail">
  242. <!-- -->
  243. </a>
  244. <h3>构造器详细资料</h3>
  245. <a name="BaseMessage--">
  246. <!-- -->
  247. </a>
  248. <ul class="blockListLast">
  249. <li class="blockList">
  250. <h4>BaseMessage</h4>
  251. <pre>public&nbsp;BaseMessage()</pre>
  252. </li>
  253. </ul>
  254. </li>
  255. </ul>
  256. <!-- ============ METHOD DETAIL ========== -->
  257. <ul class="blockList">
  258. <li class="blockList"><a name="method.detail">
  259. <!-- -->
  260. </a>
  261. <h3>方法详细资料</h3>
  262. <a name="getMsgtype--">
  263. <!-- -->
  264. </a>
  265. <ul class="blockList">
  266. <li class="blockList">
  267. <h4>getMsgtype</h4>
  268. <pre>public&nbsp;<a href="../../../../../../cn/snowheart/dingtalk/robot/starter/type/MessageType.html" title="cn.snowheart.dingtalk.robot.starter.type中的枚举">MessageType</a>&nbsp;getMsgtype()</pre>
  269. </li>
  270. </ul>
  271. <a name="init--">
  272. <!-- -->
  273. </a>
  274. <ul class="blockList">
  275. <li class="blockList">
  276. <h4>init</h4>
  277. <pre>protected abstract&nbsp;void&nbsp;init()</pre>
  278. <div class="block">初始化MmessageType方法</div>
  279. </li>
  280. </ul>
  281. <a name="toMessageMap--">
  282. <!-- -->
  283. </a>
  284. <ul class="blockListLast">
  285. <li class="blockList">
  286. <h4>toMessageMap</h4>
  287. <pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="java.util中的类或接口">Map</a>&nbsp;toMessageMap()</pre>
  288. <div class="block">返回Message对象组装出来的Map对象,供后续JSON序列化</div>
  289. <dl>
  290. <dt><span class="returnLabel">返回:</span></dt>
  291. <dd>Map</dd>
  292. </dl>
  293. </li>
  294. </ul>
  295. </li>
  296. </ul>
  297. </li>
  298. </ul>
  299. </div>
  300. </div>
  301. <!-- ========= END OF CLASS DATA ========= -->
  302. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  303. <div class="bottomNav"><a name="navbar.bottom">
  304. <!-- -->
  305. </a>
  306. <div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
  307. <a name="navbar.bottom.firstrow">
  308. <!-- -->
  309. </a>
  310. <ul class="navList" title="导航">
  311. <li><a href="../../../../../../overview-summary.html">概览</a></li>
  312. <li><a href="package-summary.html">程序包</a></li>
  313. <li class="navBarCell1Rev">类</li>
  314. <li><a href="class-use/BaseMessage.html">使用</a></li>
  315. <li><a href="package-tree.html">树</a></li>
  316. <li><a href="../../../../../../deprecated-list.html">已过时</a></li>
  317. <li><a href="../../../../../../index-all.html">索引</a></li>
  318. <li><a href="../../../../../../help-doc.html">帮助</a></li>
  319. </ul>
  320. </div>
  321. <div class="subNav">
  322. <ul class="navList">
  323. <li><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/ActionCardMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类"><span class="typeNameLink">上一个类</span></a></li>
  324. <li><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/entity/DingTalkResponse.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类"><span class="typeNameLink">下一个类</span></a></li>
  325. </ul>
  326. <ul class="navList">
  327. <li><a href="../../../../../../index.html?cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html" target="_top">框架</a></li>
  328. <li><a href="BaseMessage.html" target="_top">无框架</a></li>
  329. </ul>
  330. <ul class="navList" id="allclasses_navbar_bottom">
  331. <li><a href="../../../../../../allclasses-noframe.html">所有类</a></li>
  332. </ul>
  333. <div>
  334. <script type="text/javascript"><!--
  335. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  336. if(window==top) {
  337. allClassesLink.style.display = "block";
  338. }
  339. else {
  340. allClassesLink.style.display = "none";
  341. }
  342. //-->
  343. </script>
  344. </div>
  345. <div>
  346. <ul class="subNavList">
  347. <li>概要:&nbsp;</li>
  348. <li>嵌套&nbsp;|&nbsp;</li>
  349. <li><a href="#field.summary">字段</a>&nbsp;|&nbsp;</li>
  350. <li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
  351. <li><a href="#method.summary">方法</a></li>
  352. </ul>
  353. <ul class="subNavList">
  354. <li>详细资料:&nbsp;</li>
  355. <li><a href="#field.detail">字段</a>&nbsp;|&nbsp;</li>
  356. <li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
  357. <li><a href="#method.detail">方法</a></li>
  358. </ul>
  359. </div>
  360. <a name="skip.navbar.bottom">
  361. <!-- -->
  362. </a></div>
  363. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  364. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  365. </body>
  366. </html>