XAuthAuthorization.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  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>XAuthAuthorization (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="XAuthAuthorization (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/XAuthAuthorization.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/Version.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li>Next&nbsp;Class</li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../index.html?twitter4j/XAuthAuthorization.html" target="_top">Frames</a></li>
  58. <li><a href="XAuthAuthorization.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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</div>
  97. <h2 title="Class XAuthAuthorization" class="title">Class XAuthAuthorization</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <ul class="inheritance">
  101. <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  102. <li>
  103. <ul class="inheritance">
  104. <li>twitter4j.XAuthAuthorization</li>
  105. </ul>
  106. </li>
  107. </ul>
  108. <div class="description">
  109. <ul class="blockList">
  110. <li class="blockList">
  111. <dl>
  112. <dt>All Implemented Interfaces:</dt>
  113. <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a></dd>
  114. </dl>
  115. <hr>
  116. <br>
  117. <pre>public class <span class="typeNameLabel">XAuthAuthorization</span>
  118. extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
  119. implements <a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
  120. <dl>
  121. <dt><span class="simpleTagLabel">Since:</span></dt>
  122. <dd>Twitter4J 2.1.3</dd>
  123. <dt><span class="simpleTagLabel">Author:</span></dt>
  124. <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
  125. <dt><span class="seeLabel">See Also:</span></dt>
  126. <dd><a href="../serialized-form.html#twitter4j.XAuthAuthorization">Serialized Form</a></dd>
  127. </dl>
  128. </li>
  129. </ul>
  130. </div>
  131. <div class="summary">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  135. <ul class="blockList">
  136. <li class="blockList"><a name="constructor.summary">
  137. <!-- -->
  138. </a>
  139. <h3>Constructor Summary</h3>
  140. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  141. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  142. <tr>
  143. <th class="colOne" scope="col">Constructor and Description</th>
  144. </tr>
  145. <tr class="altColor">
  146. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/XAuthAuthorization.html#XAuthAuthorization-twitter4j.auth.BasicAuthorization-">XAuthAuthorization</a></span>(<a href="../twitter4j/auth/BasicAuthorization.html" title="class in twitter4j.auth">BasicAuthorization</a>&nbsp;basic)</code>&nbsp;</td>
  147. </tr>
  148. </table>
  149. </li>
  150. </ul>
  151. <!-- ========== METHOD SUMMARY =========== -->
  152. <ul class="blockList">
  153. <li class="blockList"><a name="method.summary">
  154. <!-- -->
  155. </a>
  156. <h3>Method Summary</h3>
  157. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  158. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  159. <tr>
  160. <th class="colFirst" scope="col">Modifier and Type</th>
  161. <th class="colLast" scope="col">Method and Description</th>
  162. </tr>
  163. <tr id="i0" class="altColor">
  164. <td class="colFirst"><code><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></code></td>
  165. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/XAuthAuthorization.html#getAuthorizationHeader-twitter4j.HttpRequest-">getAuthorizationHeader</a></span>(<a href="../twitter4j/HttpRequest.html" title="class in twitter4j">HttpRequest</a>&nbsp;req)</code>&nbsp;</td>
  166. </tr>
  167. <tr id="i1" class="rowColor">
  168. <td class="colFirst"><code><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></code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/XAuthAuthorization.html#getConsumerKey--">getConsumerKey</a></span>()</code>&nbsp;</td>
  170. </tr>
  171. <tr id="i2" class="altColor">
  172. <td class="colFirst"><code><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></code></td>
  173. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/XAuthAuthorization.html#getConsumerSecret--">getConsumerSecret</a></span>()</code>&nbsp;</td>
  174. </tr>
  175. <tr id="i3" class="rowColor">
  176. <td class="colFirst"><code><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></code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/XAuthAuthorization.html#getPassword--">getPassword</a></span>()</code>&nbsp;</td>
  178. </tr>
  179. <tr id="i4" class="altColor">
  180. <td class="colFirst"><code><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></code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/XAuthAuthorization.html#getUserId--">getUserId</a></span>()</code>&nbsp;</td>
  182. </tr>
  183. <tr id="i5" class="rowColor">
  184. <td class="colFirst"><code>boolean</code></td>
  185. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/XAuthAuthorization.html#isEnabled--">isEnabled</a></span>()</code>
  186. <div class="block">Returns true if authorization credentials are set.</div>
  187. </td>
  188. </tr>
  189. <tr id="i6" class="altColor">
  190. <td class="colFirst"><code>void</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/XAuthAuthorization.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,
  192. <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>&nbsp;</td>
  193. </tr>
  194. </table>
  195. <ul class="blockList">
  196. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  197. <!-- -->
  198. </a>
  199. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  200. <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  201. </ul>
  202. </li>
  203. </ul>
  204. </li>
  205. </ul>
  206. </div>
  207. <div class="details">
  208. <ul class="blockList">
  209. <li class="blockList">
  210. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  211. <ul class="blockList">
  212. <li class="blockList"><a name="constructor.detail">
  213. <!-- -->
  214. </a>
  215. <h3>Constructor Detail</h3>
  216. <a name="XAuthAuthorization-twitter4j.auth.BasicAuthorization-">
  217. <!-- -->
  218. </a>
  219. <ul class="blockListLast">
  220. <li class="blockList">
  221. <h4>XAuthAuthorization</h4>
  222. <pre>public&nbsp;XAuthAuthorization(<a href="../twitter4j/auth/BasicAuthorization.html" title="class in twitter4j.auth">BasicAuthorization</a>&nbsp;basic)</pre>
  223. </li>
  224. </ul>
  225. </li>
  226. </ul>
  227. <!-- ============ METHOD DETAIL ========== -->
  228. <ul class="blockList">
  229. <li class="blockList"><a name="method.detail">
  230. <!-- -->
  231. </a>
  232. <h3>Method Detail</h3>
  233. <a name="getAuthorizationHeader-twitter4j.HttpRequest-">
  234. <!-- -->
  235. </a>
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <h4>getAuthorizationHeader</h4>
  239. <pre>public&nbsp;<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;getAuthorizationHeader(<a href="../twitter4j/HttpRequest.html" title="class in twitter4j">HttpRequest</a>&nbsp;req)</pre>
  240. <dl>
  241. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  242. <dd><code><a href="../twitter4j/auth/Authorization.html#getAuthorizationHeader-twitter4j.HttpRequest-">getAuthorizationHeader</a></code>&nbsp;in interface&nbsp;<code><a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a></code></dd>
  243. </dl>
  244. </li>
  245. </ul>
  246. <a name="getUserId--">
  247. <!-- -->
  248. </a>
  249. <ul class="blockList">
  250. <li class="blockList">
  251. <h4>getUserId</h4>
  252. <pre>public&nbsp;<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;getUserId()</pre>
  253. </li>
  254. </ul>
  255. <a name="getPassword--">
  256. <!-- -->
  257. </a>
  258. <ul class="blockList">
  259. <li class="blockList">
  260. <h4>getPassword</h4>
  261. <pre>public&nbsp;<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;getPassword()</pre>
  262. </li>
  263. </ul>
  264. <a name="getConsumerKey--">
  265. <!-- -->
  266. </a>
  267. <ul class="blockList">
  268. <li class="blockList">
  269. <h4>getConsumerKey</h4>
  270. <pre>public&nbsp;<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;getConsumerKey()</pre>
  271. </li>
  272. </ul>
  273. <a name="getConsumerSecret--">
  274. <!-- -->
  275. </a>
  276. <ul class="blockList">
  277. <li class="blockList">
  278. <h4>getConsumerSecret</h4>
  279. <pre>public&nbsp;<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;getConsumerSecret()</pre>
  280. </li>
  281. </ul>
  282. <a name="setOAuthConsumer-java.lang.String-java.lang.String-">
  283. <!-- -->
  284. </a>
  285. <ul class="blockList">
  286. <li class="blockList">
  287. <h4>setOAuthConsumer</h4>
  288. <pre>public&nbsp;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,
  289. <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>
  290. </li>
  291. </ul>
  292. <a name="isEnabled--">
  293. <!-- -->
  294. </a>
  295. <ul class="blockListLast">
  296. <li class="blockList">
  297. <h4>isEnabled</h4>
  298. <pre>public&nbsp;boolean&nbsp;isEnabled()</pre>
  299. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../twitter4j/auth/Authorization.html#isEnabled--">Authorization</a></code></span></div>
  300. <div class="block">Returns true if authorization credentials are set.</div>
  301. <dl>
  302. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  303. <dd><code><a href="../twitter4j/auth/Authorization.html#isEnabled--">isEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="../twitter4j/auth/Authorization.html" title="interface in twitter4j.auth">Authorization</a></code></dd>
  304. <dt><span class="returnLabel">Returns:</span></dt>
  305. <dd>true if authorization credentials are set</dd>
  306. </dl>
  307. </li>
  308. </ul>
  309. </li>
  310. </ul>
  311. </li>
  312. </ul>
  313. </div>
  314. </div>
  315. <!-- ========= END OF CLASS DATA ========= -->
  316. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  317. <div class="bottomNav"><a name="navbar.bottom">
  318. <!-- -->
  319. </a>
  320. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  321. <a name="navbar.bottom.firstrow">
  322. <!-- -->
  323. </a>
  324. <ul class="navList" title="Navigation">
  325. <li><a href="../overview-summary.html">Overview</a></li>
  326. <li><a href="package-summary.html">Package</a></li>
  327. <li class="navBarCell1Rev">Class</li>
  328. <li><a href="class-use/XAuthAuthorization.html">Use</a></li>
  329. <li><a href="package-tree.html">Tree</a></li>
  330. <li><a href="../deprecated-list.html">Deprecated</a></li>
  331. <li><a href="../index-all.html">Index</a></li>
  332. <li><a href="../help-doc.html">Help</a></li>
  333. </ul>
  334. </div>
  335. <div class="subNav">
  336. <ul class="navList">
  337. <li><a href="../twitter4j/Version.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  338. <li>Next&nbsp;Class</li>
  339. </ul>
  340. <ul class="navList">
  341. <li><a href="../index.html?twitter4j/XAuthAuthorization.html" target="_top">Frames</a></li>
  342. <li><a href="XAuthAuthorization.html" target="_top">No&nbsp;Frames</a></li>
  343. </ul>
  344. <ul class="navList" id="allclasses_navbar_bottom">
  345. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  346. </ul>
  347. <div>
  348. <script type="text/javascript"><!--
  349. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  350. if(window==top) {
  351. allClassesLink.style.display = "block";
  352. }
  353. else {
  354. allClassesLink.style.display = "none";
  355. }
  356. //-->
  357. </script>
  358. </div>
  359. <div>
  360. <ul class="subNavList">
  361. <li>Summary:&nbsp;</li>
  362. <li>Nested&nbsp;|&nbsp;</li>
  363. <li>Field&nbsp;|&nbsp;</li>
  364. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  365. <li><a href="#method.summary">Method</a></li>
  366. </ul>
  367. <ul class="subNavList">
  368. <li>Detail:&nbsp;</li>
  369. <li>Field&nbsp;|&nbsp;</li>
  370. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  371. <li><a href="#method.detail">Method</a></li>
  372. </ul>
  373. </div>
  374. <a name="skip.navbar.bottom">
  375. <!-- -->
  376. </a></div>
  377. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  378. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  379. </body>
  380. </html>