serialized-form.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  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>序列化表格 (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="\u5E8F\u5217\u5316\u8868\u683C (spring-boot-dingtalk-robot-starter 1.0.0.RELEASE API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. </script>
  23. <noscript>
  24. <div>您的浏览器已禁用 JavaScript。</div>
  25. </noscript>
  26. <!-- ========= START OF TOP NAVBAR ======= -->
  27. <div class="topNav"><a name="navbar.top">
  28. <!-- -->
  29. </a>
  30. <div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
  31. <a name="navbar.top.firstrow">
  32. <!-- -->
  33. </a>
  34. <ul class="navList" title="导航">
  35. <li><a href="overview-summary.html">概览</a></li>
  36. <li>程序包</li>
  37. <li>类</li>
  38. <li>使用</li>
  39. <li><a href="overview-tree.html">树</a></li>
  40. <li><a href="deprecated-list.html">已过时</a></li>
  41. <li><a href="index-all.html">索引</a></li>
  42. <li><a href="help-doc.html">帮助</a></li>
  43. </ul>
  44. </div>
  45. <div class="subNav">
  46. <ul class="navList">
  47. <li>上一个</li>
  48. <li>下一个</li>
  49. </ul>
  50. <ul class="navList">
  51. <li><a href="index.html?serialized-form.html" target="_top">框架</a></li>
  52. <li><a href="serialized-form.html" target="_top">无框架</a></li>
  53. </ul>
  54. <ul class="navList" id="allclasses_navbar_top">
  55. <li><a href="allclasses-noframe.html">所有类</a></li>
  56. </ul>
  57. <div>
  58. <script type="text/javascript"><!--
  59. allClassesLink = document.getElementById("allclasses_navbar_top");
  60. if(window==top) {
  61. allClassesLink.style.display = "block";
  62. }
  63. else {
  64. allClassesLink.style.display = "none";
  65. }
  66. //-->
  67. </script>
  68. </div>
  69. <a name="skip.navbar.top">
  70. <!-- -->
  71. </a></div>
  72. <!-- ========= END OF TOP NAVBAR ========= -->
  73. <div class="header">
  74. <h1 title="序列化表格" class="title">序列化表格</h1>
  75. </div>
  76. <div class="serializedFormContainer">
  77. <ul class="blockList">
  78. <li class="blockList">
  79. <h2 title="程序包">程序包&nbsp;cn.snowheart.dingtalk.robot.starter.entity</h2>
  80. <ul class="blockList">
  81. <li class="blockList"><a name="cn.snowheart.dingtalk.robot.starter.entity.ActionCardMessage">
  82. <!-- -->
  83. </a>
  84. <h3>类<a href="cn/snowheart/dingtalk/robot/starter/entity/ActionCardMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">cn.snowheart.dingtalk.robot.starter.entity.ActionCardMessage</a>扩展<a href="cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">BaseMessage</a>实现可序列化</h3>
  85. <ul class="blockList">
  86. <li class="blockList">
  87. <h3>序列化字段</h3>
  88. <ul class="blockList">
  89. <li class="blockList">
  90. <h4>title</h4>
  91. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> title</pre>
  92. <div class="block">标题</div>
  93. </li>
  94. <li class="blockList">
  95. <h4>text</h4>
  96. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> text</pre>
  97. <div class="block">正文,支持MarkDown语法</div>
  98. </li>
  99. <li class="blockList">
  100. <h4>hideAvatar</h4>
  101. <pre><a href="cn/snowheart/dingtalk/robot/starter/type/HideAvatarType.html" title="cn.snowheart.dingtalk.robot.starter.type中的枚举">HideAvatarType</a> hideAvatar</pre>
  102. <div class="block">是否隐藏头像
  103. 0 - 不隐藏头像
  104. 1 - 隐藏头像</div>
  105. </li>
  106. <li class="blockList">
  107. <h4>btnOrientation</h4>
  108. <pre><a href="cn/snowheart/dingtalk/robot/starter/type/ButtonOrientationType.html" title="cn.snowheart.dingtalk.robot.starter.type中的枚举">ButtonOrientationType</a> btnOrientation</pre>
  109. <div class="block">按钮排列方式
  110. 0 - 垂直排列
  111. 1 - 水平排列</div>
  112. </li>
  113. <li class="blockList">
  114. <h4>isButtonView</h4>
  115. <pre>boolean isButtonView</pre>
  116. <div class="block">是否为按钮跳转布局,默认为false。
  117. 但只在Button个数为1时,分辨布局方式起作用。
  118. true - 使用独立跳转ActionCard发消息
  119. false - 使用整体跳转ActionCard发消息</div>
  120. </li>
  121. <li class="blockListLast">
  122. <h4>buttons</h4>
  123. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="java.util中的类或接口">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="java.util中的类或接口">E</a>&gt; buttons</pre>
  124. <div class="block">操作按钮成员变量
  125. 这个成员变量没有Set方法,主要是为了防止按钮过多造成的较差体验</div>
  126. </li>
  127. </ul>
  128. </li>
  129. </ul>
  130. </li>
  131. <li class="blockList"><a name="cn.snowheart.dingtalk.robot.starter.entity.BaseMessage">
  132. <!-- -->
  133. </a>
  134. <h3>类<a href="cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">cn.snowheart.dingtalk.robot.starter.entity.BaseMessage</a>扩展<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>实现可序列化</h3>
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <h3>序列化字段</h3>
  138. <ul class="blockList">
  139. <li class="blockListLast">
  140. <h4>msgtype</h4>
  141. <pre><a href="cn/snowheart/dingtalk/robot/starter/type/MessageType.html" title="cn.snowheart.dingtalk.robot.starter.type中的枚举">MessageType</a> msgtype</pre>
  142. <div class="block">消息类型</div>
  143. </li>
  144. </ul>
  145. </li>
  146. </ul>
  147. </li>
  148. <li class="blockList"><a name="cn.snowheart.dingtalk.robot.starter.entity.FeedCardMessage">
  149. <!-- -->
  150. </a>
  151. <h3>类<a href="cn/snowheart/dingtalk/robot/starter/entity/FeedCardMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">cn.snowheart.dingtalk.robot.starter.entity.FeedCardMessage</a>扩展<a href="cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">BaseMessage</a>实现可序列化</h3>
  152. <ul class="blockList">
  153. <li class="blockList">
  154. <h3>序列化字段</h3>
  155. <ul class="blockList">
  156. <li class="blockListLast">
  157. <h4>feedCardItems</h4>
  158. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="java.util中的类或接口">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="java.util中的类或接口">E</a>&gt; feedCardItems</pre>
  159. <div class="block">消息明细条目</div>
  160. </li>
  161. </ul>
  162. </li>
  163. </ul>
  164. </li>
  165. <li class="blockList"><a name="cn.snowheart.dingtalk.robot.starter.entity.LinkMessage">
  166. <!-- -->
  167. </a>
  168. <h3>类<a href="cn/snowheart/dingtalk/robot/starter/entity/LinkMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">cn.snowheart.dingtalk.robot.starter.entity.LinkMessage</a>扩展<a href="cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">BaseMessage</a>实现可序列化</h3>
  169. <ul class="blockList">
  170. <li class="blockList">
  171. <h3>序列化字段</h3>
  172. <ul class="blockList">
  173. <li class="blockList">
  174. <h4>text</h4>
  175. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> text</pre>
  176. <div class="block">消息简介</div>
  177. </li>
  178. <li class="blockList">
  179. <h4>title</h4>
  180. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> title</pre>
  181. <div class="block">消息标题</div>
  182. </li>
  183. <li class="blockList">
  184. <h4>picUrl</h4>
  185. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> picUrl</pre>
  186. <div class="block">封面图片URL</div>
  187. </li>
  188. <li class="blockListLast">
  189. <h4>messageUrl</h4>
  190. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> messageUrl</pre>
  191. <div class="block">消息跳转URL</div>
  192. </li>
  193. </ul>
  194. </li>
  195. </ul>
  196. </li>
  197. <li class="blockList"><a name="cn.snowheart.dingtalk.robot.starter.entity.MarkdownMessage">
  198. <!-- -->
  199. </a>
  200. <h3>类<a href="cn/snowheart/dingtalk/robot/starter/entity/MarkdownMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">cn.snowheart.dingtalk.robot.starter.entity.MarkdownMessage</a>扩展<a href="cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">BaseMessage</a>实现可序列化</h3>
  201. <ul class="blockList">
  202. <li class="blockList">
  203. <h3>序列化字段</h3>
  204. <ul class="blockList">
  205. <li class="blockList">
  206. <h4>text</h4>
  207. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> text</pre>
  208. <div class="block">消息简介</div>
  209. </li>
  210. <li class="blockList">
  211. <h4>title</h4>
  212. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> title</pre>
  213. <div class="block">消息标题</div>
  214. </li>
  215. <li class="blockList">
  216. <h4>atMobiles</h4>
  217. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>[] atMobiles</pre>
  218. <div class="block">可以通过群成员的绑定手机号来艾特具体的群成员</div>
  219. </li>
  220. <li class="blockListLast">
  221. <h4>isAtAll</h4>
  222. <pre>boolean isAtAll</pre>
  223. <div class="block">是否艾特所有人
  224. 也可以设置isAtAll=true来艾特所有人</div>
  225. </li>
  226. </ul>
  227. </li>
  228. </ul>
  229. </li>
  230. <li class="blockList"><a name="cn.snowheart.dingtalk.robot.starter.entity.TextMessage">
  231. <!-- -->
  232. </a>
  233. <h3>类<a href="cn/snowheart/dingtalk/robot/starter/entity/TextMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">cn.snowheart.dingtalk.robot.starter.entity.TextMessage</a>扩展<a href="cn/snowheart/dingtalk/robot/starter/entity/BaseMessage.html" title="cn.snowheart.dingtalk.robot.starter.entity中的类">BaseMessage</a>实现可序列化</h3>
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <h3>序列化字段</h3>
  237. <ul class="blockList">
  238. <li class="blockList">
  239. <h4>content</h4>
  240. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a> content</pre>
  241. <div class="block">文本消息的具体内容</div>
  242. </li>
  243. <li class="blockList">
  244. <h4>atMobiles</h4>
  245. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>[] atMobiles</pre>
  246. <div class="block">可以通过群成员的绑定手机号来艾特具体的群成员</div>
  247. </li>
  248. <li class="blockListLast">
  249. <h4>isAtAll</h4>
  250. <pre>boolean isAtAll</pre>
  251. <div class="block">是否艾特所有人
  252. 也可以设置isAtAll=true来艾特所有人</div>
  253. </li>
  254. </ul>
  255. </li>
  256. </ul>
  257. </li>
  258. </ul>
  259. </li>
  260. <li class="blockList">
  261. <h2 title="程序包">程序包&nbsp;cn.snowheart.dingtalk.robot.starter.exception</h2>
  262. <ul class="blockList">
  263. <li class="blockList"><a name="cn.snowheart.dingtalk.robot.starter.exception.DingTalkException">
  264. <!-- -->
  265. </a>
  266. <h3>类<a href="cn/snowheart/dingtalk/robot/starter/exception/DingTalkException.html" title="cn.snowheart.dingtalk.robot.starter.exception中的类">cn.snowheart.dingtalk.robot.starter.exception.DingTalkException</a>扩展<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="java.lang中的类或接口">RuntimeException</a>实现可序列化</h3>
  267. <ul class="blockList">
  268. <li class="blockList">
  269. <h3>序列化字段</h3>
  270. <ul class="blockList">
  271. <li class="blockListLast">
  272. <h4>errcode</h4>
  273. <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="java.lang中的类或接口">Integer</a> errcode</pre>
  274. <div class="block">错误码</div>
  275. </li>
  276. </ul>
  277. </li>
  278. </ul>
  279. </li>
  280. </ul>
  281. </li>
  282. </ul>
  283. </div>
  284. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  285. <div class="bottomNav"><a name="navbar.bottom">
  286. <!-- -->
  287. </a>
  288. <div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
  289. <a name="navbar.bottom.firstrow">
  290. <!-- -->
  291. </a>
  292. <ul class="navList" title="导航">
  293. <li><a href="overview-summary.html">概览</a></li>
  294. <li>程序包</li>
  295. <li>类</li>
  296. <li>使用</li>
  297. <li><a href="overview-tree.html">树</a></li>
  298. <li><a href="deprecated-list.html">已过时</a></li>
  299. <li><a href="index-all.html">索引</a></li>
  300. <li><a href="help-doc.html">帮助</a></li>
  301. </ul>
  302. </div>
  303. <div class="subNav">
  304. <ul class="navList">
  305. <li>上一个</li>
  306. <li>下一个</li>
  307. </ul>
  308. <ul class="navList">
  309. <li><a href="index.html?serialized-form.html" target="_top">框架</a></li>
  310. <li><a href="serialized-form.html" target="_top">无框架</a></li>
  311. </ul>
  312. <ul class="navList" id="allclasses_navbar_bottom">
  313. <li><a href="allclasses-noframe.html">所有类</a></li>
  314. </ul>
  315. <div>
  316. <script type="text/javascript"><!--
  317. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  318. if(window==top) {
  319. allClassesLink.style.display = "block";
  320. }
  321. else {
  322. allClassesLink.style.display = "none";
  323. }
  324. //-->
  325. </script>
  326. </div>
  327. <a name="skip.navbar.bottom">
  328. <!-- -->
  329. </a></div>
  330. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  331. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  332. </body>
  333. </html>