DingTalkRobotAutoConfiguration.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  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:20:59 CST 2018 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>DingTalkRobotAutoConfiguration (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="DingTalkRobotAutoConfiguration (spring-boot-dingtalk-robot-starter 1.0.0.RELEASE API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":10,"i1":10,"i2":10};
  23. var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],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/DingTalkRobotAutoConfiguration.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>上一个类</li>
  54. <li><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotProperties.html" title="cn.snowheart.dingtalk.robot.starter.autoconfiguration中的类"><span class="typeNameLink">下一个类</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../../../../../../index.html?cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotAutoConfiguration.html" target="_top">框架</a></li>
  58. <li><a href="DingTalkRobotAutoConfiguration.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>字段&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>字段&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.autoconfiguration</div>
  97. <h2 title="类 DingTalkRobotAutoConfiguration" class="title">类 DingTalkRobotAutoConfiguration</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.autoconfiguration.DingTalkRobotAutoConfiguration</li>
  105. </ul>
  106. </li>
  107. </ul>
  108. <div class="description">
  109. <ul class="blockList">
  110. <li class="blockList">
  111. <hr>
  112. <br>
  113. <pre>@Configuration
  114. public class <span class="typeNameLabel">DingTalkRobotAutoConfiguration</span>
  115. extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a></pre>
  116. <div class="block">DingTalk机器人的AutoConfiguration,默认自动化加载一些配置</div>
  117. <dl>
  118. <dt><span class="simpleTagLabel">版本:</span></dt>
  119. <dd>1.0.0</dd>
  120. <dt><span class="simpleTagLabel">作者:</span></dt>
  121. <dd>Wanxiang Liu</dd>
  122. </dl>
  123. </li>
  124. </ul>
  125. </div>
  126. <div class="summary">
  127. <ul class="blockList">
  128. <li class="blockList">
  129. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  130. <ul class="blockList">
  131. <li class="blockList"><a name="constructor.summary">
  132. <!-- -->
  133. </a>
  134. <h3>构造器概要</h3>
  135. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="构造器概要表, 列表构造器和解释">
  136. <caption><span>构造器</span><span class="tabEnd">&nbsp;</span></caption>
  137. <tr>
  138. <th class="colOne" scope="col">构造器和说明</th>
  139. </tr>
  140. <tr class="altColor">
  141. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotAutoConfiguration.html#DingTalkRobotAutoConfiguration--">DingTalkRobotAutoConfiguration</a></span>()</code>&nbsp;</td>
  142. </tr>
  143. </table>
  144. </li>
  145. </ul>
  146. <!-- ========== METHOD SUMMARY =========== -->
  147. <ul class="blockList">
  148. <li class="blockList"><a name="method.summary">
  149. <!-- -->
  150. </a>
  151. <h3>方法概要</h3>
  152. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
  153. <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="t4" class="tableTab"><span><a href="javascript:show(8);">具体方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  154. <tr>
  155. <th class="colFirst" scope="col">限定符和类型</th>
  156. <th class="colLast" scope="col">方法和说明</th>
  157. </tr>
  158. <tr id="i0" class="altColor">
  159. <td class="colFirst"><code><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/client/DingTalkRobotClient.html" title="cn.snowheart.dingtalk.robot.starter.client中的类">DingTalkRobotClient</a></code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotAutoConfiguration.html#dingTalkRobotClient--">dingTalkRobotClient</a></span>()</code>
  161. <div class="block">创建钉钉机器人本地调用客户端,并注册到Spring容器</div>
  162. </td>
  163. </tr>
  164. <tr id="i1" class="rowColor">
  165. <td class="colFirst"><code><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotProperties.html" title="cn.snowheart.dingtalk.robot.starter.autoconfiguration中的类">DingTalkRobotProperties</a></code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotAutoConfiguration.html#dingTalkRobotProperties--">dingTalkRobotProperties</a></span>()</code>
  167. <div class="block">创建DingTalkRobotProperties对象,读取application.yaml中配置,并注册到Spring容器</div>
  168. </td>
  169. </tr>
  170. <tr id="i2" class="altColor">
  171. <td class="colFirst"><code>org.springframework.web.client.RestTemplate</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotAutoConfiguration.html#dingTalkRobotRestTemplate--">dingTalkRobotRestTemplate</a></span>()</code>
  173. <div class="block">创建一个RestTemplate客户端,并注册到Spring容器,供后续程序调用</div>
  174. </td>
  175. </tr>
  176. </table>
  177. <ul class="blockList">
  178. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  179. <!-- -->
  180. </a>
  181. <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>
  182. <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>
  183. </ul>
  184. </li>
  185. </ul>
  186. </li>
  187. </ul>
  188. </div>
  189. <div class="details">
  190. <ul class="blockList">
  191. <li class="blockList">
  192. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  193. <ul class="blockList">
  194. <li class="blockList"><a name="constructor.detail">
  195. <!-- -->
  196. </a>
  197. <h3>构造器详细资料</h3>
  198. <a name="DingTalkRobotAutoConfiguration--">
  199. <!-- -->
  200. </a>
  201. <ul class="blockListLast">
  202. <li class="blockList">
  203. <h4>DingTalkRobotAutoConfiguration</h4>
  204. <pre>public&nbsp;DingTalkRobotAutoConfiguration()</pre>
  205. </li>
  206. </ul>
  207. </li>
  208. </ul>
  209. <!-- ============ METHOD DETAIL ========== -->
  210. <ul class="blockList">
  211. <li class="blockList"><a name="method.detail">
  212. <!-- -->
  213. </a>
  214. <h3>方法详细资料</h3>
  215. <a name="dingTalkRobotProperties--">
  216. <!-- -->
  217. </a>
  218. <ul class="blockList">
  219. <li class="blockList">
  220. <h4>dingTalkRobotProperties</h4>
  221. <pre>@Bean(name="dingTalkRobotProperties")
  222. @ConditionalOnMissingBean
  223. public&nbsp;<a href="../../../../../../cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotProperties.html" title="cn.snowheart.dingtalk.robot.starter.autoconfiguration中的类">DingTalkRobotProperties</a>&nbsp;dingTalkRobotProperties()</pre>
  224. <div class="block">创建DingTalkRobotProperties对象,读取application.yaml中配置,并注册到Spring容器</div>
  225. <dl>
  226. <dt><span class="returnLabel">返回:</span></dt>
  227. <dd>DingTalkRobot配置</dd>
  228. </dl>
  229. </li>
  230. </ul>
  231. <a name="dingTalkRobotRestTemplate--">
  232. <!-- -->
  233. </a>
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <h4>dingTalkRobotRestTemplate</h4>
  237. <pre>@Bean(name="dingTalkRobotRestTemplate")
  238. @ConditionalOnMissingBean
  239. public&nbsp;org.springframework.web.client.RestTemplate&nbsp;dingTalkRobotRestTemplate()</pre>
  240. <div class="block">创建一个RestTemplate客户端,并注册到Spring容器,供后续程序调用</div>
  241. <dl>
  242. <dt><span class="returnLabel">返回:</span></dt>
  243. <dd>RestTemplate客户端</dd>
  244. </dl>
  245. </li>
  246. </ul>
  247. <a name="dingTalkRobotClient--">
  248. <!-- -->
  249. </a>
  250. <ul class="blockListLast">
  251. <li class="blockList">
  252. <h4>dingTalkRobotClient</h4>
  253. <pre>@Bean
  254. @ConditionalOnMissingBean
  255. @ConditionalOnBean(name={"dingTalkRobotProperties","dingTalkRobotRestTemplate"})
  256. public&nbsp;<a href="../../../../../../cn/snowheart/dingtalk/robot/starter/client/DingTalkRobotClient.html" title="cn.snowheart.dingtalk.robot.starter.client中的类">DingTalkRobotClient</a>&nbsp;dingTalkRobotClient()</pre>
  257. <div class="block">创建钉钉机器人本地调用客户端,并注册到Spring容器</div>
  258. <dl>
  259. <dt><span class="returnLabel">返回:</span></dt>
  260. <dd>钉钉机器人本地调用客户端</dd>
  261. </dl>
  262. </li>
  263. </ul>
  264. </li>
  265. </ul>
  266. </li>
  267. </ul>
  268. </div>
  269. </div>
  270. <!-- ========= END OF CLASS DATA ========= -->
  271. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  272. <div class="bottomNav"><a name="navbar.bottom">
  273. <!-- -->
  274. </a>
  275. <div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
  276. <a name="navbar.bottom.firstrow">
  277. <!-- -->
  278. </a>
  279. <ul class="navList" title="导航">
  280. <li><a href="../../../../../../overview-summary.html">概览</a></li>
  281. <li><a href="package-summary.html">程序包</a></li>
  282. <li class="navBarCell1Rev">类</li>
  283. <li><a href="class-use/DingTalkRobotAutoConfiguration.html">使用</a></li>
  284. <li><a href="package-tree.html">树</a></li>
  285. <li><a href="../../../../../../deprecated-list.html">已过时</a></li>
  286. <li><a href="../../../../../../index-all.html">索引</a></li>
  287. <li><a href="../../../../../../help-doc.html">帮助</a></li>
  288. </ul>
  289. </div>
  290. <div class="subNav">
  291. <ul class="navList">
  292. <li>上一个类</li>
  293. <li><a href="../../../../../../cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotProperties.html" title="cn.snowheart.dingtalk.robot.starter.autoconfiguration中的类"><span class="typeNameLink">下一个类</span></a></li>
  294. </ul>
  295. <ul class="navList">
  296. <li><a href="../../../../../../index.html?cn/snowheart/dingtalk/robot/starter/autoconfiguration/DingTalkRobotAutoConfiguration.html" target="_top">框架</a></li>
  297. <li><a href="DingTalkRobotAutoConfiguration.html" target="_top">无框架</a></li>
  298. </ul>
  299. <ul class="navList" id="allclasses_navbar_bottom">
  300. <li><a href="../../../../../../allclasses-noframe.html">所有类</a></li>
  301. </ul>
  302. <div>
  303. <script type="text/javascript"><!--
  304. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  305. if(window==top) {
  306. allClassesLink.style.display = "block";
  307. }
  308. else {
  309. allClassesLink.style.display = "none";
  310. }
  311. //-->
  312. </script>
  313. </div>
  314. <div>
  315. <ul class="subNavList">
  316. <li>概要:&nbsp;</li>
  317. <li>嵌套&nbsp;|&nbsp;</li>
  318. <li>字段&nbsp;|&nbsp;</li>
  319. <li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
  320. <li><a href="#method.summary">方法</a></li>
  321. </ul>
  322. <ul class="subNavList">
  323. <li>详细资料:&nbsp;</li>
  324. <li>字段&nbsp;|&nbsp;</li>
  325. <li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
  326. <li><a href="#method.detail">方法</a></li>
  327. </ul>
  328. </div>
  329. <a name="skip.navbar.bottom">
  330. <!-- -->
  331. </a></div>
  332. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  333. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  334. </body>
  335. </html>