OAuth2Support.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_161) on Thu Aug 16 18:54:14 JST 2018 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>OAuth2Support (twitter4j-core 4.0.7 API)</title>
  8. <meta name="date" content="2018-08-16">
  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="OAuth2Support (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>JavaScript is disabled on your browser.</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="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../../overview-summary.html">Overview</a></li>
  42. <li><a href="package-summary.html">Package</a></li>
  43. <li class="navBarCell1Rev">Class</li>
  44. <li><a href="class-use/OAuth2Support.html">Use</a></li>
  45. <li><a href="package-tree.html">Tree</a></li>
  46. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  47. <li><a href="../../index-all.html">Index</a></li>
  48. <li><a href="../../help-doc.html">Help</a></li>
  49. </ul>
  50. </div>
  51. <div class="subNav">
  52. <ul class="navList">
  53. <li><a href="../../twitter4j/auth/OAuth2Authorization.html" title="class in twitter4j.auth"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../../twitter4j/auth/OAuth2Token.html" title="class in twitter4j.auth"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../../index.html?twitter4j/auth/OAuth2Support.html" target="_top">Frames</a></li>
  58. <li><a href="OAuth2Support.html" target="_top">No&nbsp;Frames</a></li>
  59. </ul>
  60. <ul class="navList" id="allclasses_navbar_top">
  61. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</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>Summary:&nbsp;</li>
  78. <li>Nested&nbsp;|&nbsp;</li>
  79. <li>Field&nbsp;|&nbsp;</li>
  80. <li>Constr&nbsp;|&nbsp;</li>
  81. <li><a href="#method.summary">Method</a></li>
  82. </ul>
  83. <ul class="subNavList">
  84. <li>Detail:&nbsp;</li>
  85. <li>Field&nbsp;|&nbsp;</li>
  86. <li>Constr&nbsp;|&nbsp;</li>
  87. <li><a href="#method.detail">Method</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">twitter4j.auth</div>
  97. <h2 title="Interface OAuth2Support" class="title">Interface OAuth2Support</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <div class="description">
  101. <ul class="blockList">
  102. <li class="blockList">
  103. <dl>
  104. <dt>All Known Subinterfaces:</dt>
  105. <dd><a href="../../twitter4j/Twitter.html" title="interface in twitter4j">Twitter</a></dd>
  106. </dl>
  107. <dl>
  108. <dt>All Known Implementing Classes:</dt>
  109. <dd><a href="../../twitter4j/auth/OAuth2Authorization.html" title="class in twitter4j.auth">OAuth2Authorization</a></dd>
  110. </dl>
  111. <hr>
  112. <br>
  113. <pre>public interface <span class="typeNameLabel">OAuth2Support</span></pre>
  114. <dl>
  115. <dt><span class="simpleTagLabel">Author:</span></dt>
  116. <dd>KOMIYA Atsushi - komiya.atsushi at gmail.com</dd>
  117. <dt><span class="seeLabel">See Also:</span></dt>
  118. <dd><a href="https://dev.twitter.com/docs/auth/application-only-auth">Application-only authentication | Twitter Developers</a></dd>
  119. </dl>
  120. </li>
  121. </ul>
  122. </div>
  123. <div class="summary">
  124. <ul class="blockList">
  125. <li class="blockList">
  126. <!-- ========== METHOD SUMMARY =========== -->
  127. <ul class="blockList">
  128. <li class="blockList"><a name="method.summary">
  129. <!-- -->
  130. </a>
  131. <h3>Method Summary</h3>
  132. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  133. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  134. <tr>
  135. <th class="colFirst" scope="col">Modifier and Type</th>
  136. <th class="colLast" scope="col">Method and Description</th>
  137. </tr>
  138. <tr id="i0" class="altColor">
  139. <td class="colFirst"><code><a href="../../twitter4j/auth/OAuth2Token.html" title="class in twitter4j.auth">OAuth2Token</a></code></td>
  140. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/auth/OAuth2Support.html#getOAuth2Token--">getOAuth2Token</a></span>()</code>
  141. <div class="block">Obtains an OAuth 2 Bearer token.</div>
  142. </td>
  143. </tr>
  144. <tr id="i1" class="rowColor">
  145. <td class="colFirst"><code>void</code></td>
  146. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/auth/OAuth2Support.html#invalidateOAuth2Token--">invalidateOAuth2Token</a></span>()</code>
  147. <div class="block">Revokes an issued OAuth 2 Bearer Token.</div>
  148. </td>
  149. </tr>
  150. <tr id="i2" class="altColor">
  151. <td class="colFirst"><code>void</code></td>
  152. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/auth/OAuth2Support.html#setOAuth2Token-twitter4j.auth.OAuth2Token-">setOAuth2Token</a></span>(<a href="../../twitter4j/auth/OAuth2Token.html" title="class in twitter4j.auth">OAuth2Token</a>&nbsp;oauth2Token)</code>
  153. <div class="block">Sets the OAuth 2 Bearer token.</div>
  154. </td>
  155. </tr>
  156. <tr id="i3" class="rowColor">
  157. <td class="colFirst"><code>void</code></td>
  158. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/auth/OAuth2Support.html#setOAuthConsumer-java.lang.String-java.lang.String-">setOAuthConsumer</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;consumerKey,
  159. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;consumerSecret)</code>
  160. <div class="block">Sets the OAuth consumer key and consumer secret.</div>
  161. </td>
  162. </tr>
  163. </table>
  164. </li>
  165. </ul>
  166. </li>
  167. </ul>
  168. </div>
  169. <div class="details">
  170. <ul class="blockList">
  171. <li class="blockList">
  172. <!-- ============ METHOD DETAIL ========== -->
  173. <ul class="blockList">
  174. <li class="blockList"><a name="method.detail">
  175. <!-- -->
  176. </a>
  177. <h3>Method Detail</h3>
  178. <a name="setOAuthConsumer-java.lang.String-java.lang.String-">
  179. <!-- -->
  180. </a>
  181. <ul class="blockList">
  182. <li class="blockList">
  183. <h4>setOAuthConsumer</h4>
  184. <pre>void&nbsp;setOAuthConsumer(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;consumerKey,
  185. <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;consumerSecret)</pre>
  186. <div class="block">Sets the OAuth consumer key and consumer secret.</div>
  187. <dl>
  188. <dt><span class="paramLabel">Parameters:</span></dt>
  189. <dd><code>consumerKey</code> - OAuth consumer key</dd>
  190. <dd><code>consumerSecret</code> - OAuth consumer secret</dd>
  191. <dt><span class="throwsLabel">Throws:</span></dt>
  192. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - when OAuth consumer has already been set, or the instance is using basic authorization.</dd>
  193. </dl>
  194. </li>
  195. </ul>
  196. <a name="getOAuth2Token--">
  197. <!-- -->
  198. </a>
  199. <ul class="blockList">
  200. <li class="blockList">
  201. <h4>getOAuth2Token</h4>
  202. <pre><a href="../../twitter4j/auth/OAuth2Token.html" title="class in twitter4j.auth">OAuth2Token</a>&nbsp;getOAuth2Token()
  203. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  204. <div class="block">Obtains an OAuth 2 Bearer token.</div>
  205. <dl>
  206. <dt><span class="returnLabel">Returns:</span></dt>
  207. <dd>OAuth 2 Bearer token</dd>
  208. <dt><span class="throwsLabel">Throws:</span></dt>
  209. <dd><code><a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when Twitter service or network is unavailable, or connecting non-SSL endpoints.</dd>
  210. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - when Bearer token is already available, or OAuth consumer is not available.</dd>
  211. <dt><span class="seeLabel">See Also:</span></dt>
  212. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/oauth2/token">POST oauth2/token | Twitter Developers</a></dd>
  213. </dl>
  214. </li>
  215. </ul>
  216. <a name="setOAuth2Token-twitter4j.auth.OAuth2Token-">
  217. <!-- -->
  218. </a>
  219. <ul class="blockList">
  220. <li class="blockList">
  221. <h4>setOAuth2Token</h4>
  222. <pre>void&nbsp;setOAuth2Token(<a href="../../twitter4j/auth/OAuth2Token.html" title="class in twitter4j.auth">OAuth2Token</a>&nbsp;oauth2Token)</pre>
  223. <div class="block">Sets the OAuth 2 Bearer token.</div>
  224. <dl>
  225. <dt><span class="paramLabel">Parameters:</span></dt>
  226. <dd><code>oauth2Token</code> - OAuth 2 Bearer token</dd>
  227. </dl>
  228. </li>
  229. </ul>
  230. <a name="invalidateOAuth2Token--">
  231. <!-- -->
  232. </a>
  233. <ul class="blockListLast">
  234. <li class="blockList">
  235. <h4>invalidateOAuth2Token</h4>
  236. <pre>void&nbsp;invalidateOAuth2Token()
  237. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  238. <div class="block">Revokes an issued OAuth 2 Bearer Token.</div>
  239. <dl>
  240. <dt><span class="throwsLabel">Throws:</span></dt>
  241. <dd><code><a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when Twitter service or network is unavailable, or connecting non-SSL endpoints.</dd>
  242. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - when Bearer token is not available.</dd>
  243. </dl>
  244. </li>
  245. </ul>
  246. </li>
  247. </ul>
  248. </li>
  249. </ul>
  250. </div>
  251. </div>
  252. <!-- ========= END OF CLASS DATA ========= -->
  253. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  254. <div class="bottomNav"><a name="navbar.bottom">
  255. <!-- -->
  256. </a>
  257. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  258. <a name="navbar.bottom.firstrow">
  259. <!-- -->
  260. </a>
  261. <ul class="navList" title="Navigation">
  262. <li><a href="../../overview-summary.html">Overview</a></li>
  263. <li><a href="package-summary.html">Package</a></li>
  264. <li class="navBarCell1Rev">Class</li>
  265. <li><a href="class-use/OAuth2Support.html">Use</a></li>
  266. <li><a href="package-tree.html">Tree</a></li>
  267. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  268. <li><a href="../../index-all.html">Index</a></li>
  269. <li><a href="../../help-doc.html">Help</a></li>
  270. </ul>
  271. </div>
  272. <div class="subNav">
  273. <ul class="navList">
  274. <li><a href="../../twitter4j/auth/OAuth2Authorization.html" title="class in twitter4j.auth"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  275. <li><a href="../../twitter4j/auth/OAuth2Token.html" title="class in twitter4j.auth"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  276. </ul>
  277. <ul class="navList">
  278. <li><a href="../../index.html?twitter4j/auth/OAuth2Support.html" target="_top">Frames</a></li>
  279. <li><a href="OAuth2Support.html" target="_top">No&nbsp;Frames</a></li>
  280. </ul>
  281. <ul class="navList" id="allclasses_navbar_bottom">
  282. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  283. </ul>
  284. <div>
  285. <script type="text/javascript"><!--
  286. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  287. if(window==top) {
  288. allClassesLink.style.display = "block";
  289. }
  290. else {
  291. allClassesLink.style.display = "none";
  292. }
  293. //-->
  294. </script>
  295. </div>
  296. <div>
  297. <ul class="subNavList">
  298. <li>Summary:&nbsp;</li>
  299. <li>Nested&nbsp;|&nbsp;</li>
  300. <li>Field&nbsp;|&nbsp;</li>
  301. <li>Constr&nbsp;|&nbsp;</li>
  302. <li><a href="#method.summary">Method</a></li>
  303. </ul>
  304. <ul class="subNavList">
  305. <li>Detail:&nbsp;</li>
  306. <li>Field&nbsp;|&nbsp;</li>
  307. <li>Constr&nbsp;|&nbsp;</li>
  308. <li><a href="#method.detail">Method</a></li>
  309. </ul>
  310. </div>
  311. <a name="skip.navbar.bottom">
  312. <!-- -->
  313. </a></div>
  314. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  315. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  316. </body>
  317. </html>