OEmbed.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391
  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:13 JST 2018 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>OEmbed (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="OEmbed (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/OEmbed.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/MediaEntityJSONImpl.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../twitter4j/OEmbedJSONImpl.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../index.html?twitter4j/OEmbed.html" target="_top">Frames</a></li>
  58. <li><a href="OEmbed.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</div>
  97. <h2 title="Interface OEmbed" class="title">Interface OEmbed</h2>
  98. </div>
  99. <div class="contentContainer">
  100. <div class="description">
  101. <ul class="blockList">
  102. <li class="blockList">
  103. <dl>
  104. <dt>All Superinterfaces:</dt>
  105. <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/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></dd>
  106. </dl>
  107. <dl>
  108. <dt>All Known Implementing Classes:</dt>
  109. <dd><a href="../twitter4j/OEmbedJSONImpl.html" title="class in twitter4j">OEmbedJSONImpl</a></dd>
  110. </dl>
  111. <hr>
  112. <br>
  113. <pre>public interface <span class="typeNameLabel">OEmbed</span>
  114. extends <a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</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>
  115. <dl>
  116. <dt><span class="simpleTagLabel">Since:</span></dt>
  117. <dd>Twitter4J 3.0.2</dd>
  118. <dt><span class="simpleTagLabel">Author:</span></dt>
  119. <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
  120. <dt><span class="seeLabel">See Also:</span></dt>
  121. <dd><a href="http://oembed.com">oEmded</a></dd>
  122. </dl>
  123. </li>
  124. </ul>
  125. </div>
  126. <div class="summary">
  127. <ul class="blockList">
  128. <li class="blockList">
  129. <!-- =========== FIELD SUMMARY =========== -->
  130. <ul class="blockList">
  131. <li class="blockList"><a name="field.summary">
  132. <!-- -->
  133. </a>
  134. <h3>Field Summary</h3>
  135. <ul class="blockList">
  136. <li class="blockList"><a name="fields.inherited.from.class.twitter4j.TwitterResponse">
  137. <!-- -->
  138. </a>
  139. <h3>Fields inherited from interface&nbsp;twitter4j.<a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></h3>
  140. <code><a href="../twitter4j/TwitterResponse.html#NONE">NONE</a>, <a href="../twitter4j/TwitterResponse.html#READ">READ</a>, <a href="../twitter4j/TwitterResponse.html#READ_WRITE">READ_WRITE</a>, <a href="../twitter4j/TwitterResponse.html#READ_WRITE_DIRECTMESSAGES">READ_WRITE_DIRECTMESSAGES</a></code></li>
  141. </ul>
  142. </li>
  143. </ul>
  144. <!-- ========== METHOD SUMMARY =========== -->
  145. <ul class="blockList">
  146. <li class="blockList"><a name="method.summary">
  147. <!-- -->
  148. </a>
  149. <h3>Method Summary</h3>
  150. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  151. <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>
  152. <tr>
  153. <th class="colFirst" scope="col">Modifier and Type</th>
  154. <th class="colLast" scope="col">Method and Description</th>
  155. </tr>
  156. <tr id="i0" class="altColor">
  157. <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>
  158. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/OEmbed.html#getAuthorName--">getAuthorName</a></span>()</code>
  159. <div class="block">The name of the author/owner of the resource.</div>
  160. </td>
  161. </tr>
  162. <tr id="i1" class="rowColor">
  163. <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>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/OEmbed.html#getAuthorURL--">getAuthorURL</a></span>()</code>
  165. <div class="block">A URL for the author/owner of the resource.</div>
  166. </td>
  167. </tr>
  168. <tr id="i2" class="altColor">
  169. <td class="colFirst"><code>long</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/OEmbed.html#getCacheAge--">getCacheAge</a></span>()</code>
  171. <div class="block">The suggested cache lifetime for this resource, in seconds.</div>
  172. </td>
  173. </tr>
  174. <tr id="i3" class="rowColor">
  175. <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>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/OEmbed.html#getHtml--">getHtml</a></span>()</code>
  177. <div class="block">The HTML required to display the resource.</div>
  178. </td>
  179. </tr>
  180. <tr id="i4" class="altColor">
  181. <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>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/OEmbed.html#getURL--">getURL</a></span>()</code>
  183. <div class="block">The url of the resource provider.<br>
  184. The source URL of the image.</div>
  185. </td>
  186. </tr>
  187. <tr id="i5" class="rowColor">
  188. <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>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/OEmbed.html#getVersion--">getVersion</a></span>()</code>
  190. <div class="block">The oEmbed version number.</div>
  191. </td>
  192. </tr>
  193. <tr id="i6" class="altColor">
  194. <td class="colFirst"><code>int</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/OEmbed.html#getWidth--">getWidth</a></span>()</code>
  196. <div class="block">The width in pixels of the image specified in the url parameter.</div>
  197. </td>
  198. </tr>
  199. </table>
  200. <ul class="blockList">
  201. <li class="blockList"><a name="methods.inherited.from.class.twitter4j.TwitterResponse">
  202. <!-- -->
  203. </a>
  204. <h3>Methods inherited from interface&nbsp;twitter4j.<a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></h3>
  205. <code><a href="../twitter4j/TwitterResponse.html#getAccessLevel--">getAccessLevel</a>, <a href="../twitter4j/TwitterResponse.html#getRateLimitStatus--">getRateLimitStatus</a></code></li>
  206. </ul>
  207. </li>
  208. </ul>
  209. </li>
  210. </ul>
  211. </div>
  212. <div class="details">
  213. <ul class="blockList">
  214. <li class="blockList">
  215. <!-- ============ METHOD DETAIL ========== -->
  216. <ul class="blockList">
  217. <li class="blockList"><a name="method.detail">
  218. <!-- -->
  219. </a>
  220. <h3>Method Detail</h3>
  221. <a name="getHtml--">
  222. <!-- -->
  223. </a>
  224. <ul class="blockList">
  225. <li class="blockList">
  226. <h4>getHtml</h4>
  227. <pre><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;getHtml()</pre>
  228. <div class="block">The HTML required to display the resource. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. The markup should be valid XHTML 1.0 Basic.</div>
  229. <dl>
  230. <dt><span class="returnLabel">Returns:</span></dt>
  231. <dd>The HTML required to display the resource.</dd>
  232. </dl>
  233. </li>
  234. </ul>
  235. <a name="getAuthorName--">
  236. <!-- -->
  237. </a>
  238. <ul class="blockList">
  239. <li class="blockList">
  240. <h4>getAuthorName</h4>
  241. <pre><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;getAuthorName()</pre>
  242. <div class="block">The name of the author/owner of the resource.</div>
  243. <dl>
  244. <dt><span class="returnLabel">Returns:</span></dt>
  245. <dd>The name of the author/owner of the resource.</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. <a name="getURL--">
  250. <!-- -->
  251. </a>
  252. <ul class="blockList">
  253. <li class="blockList">
  254. <h4>getURL</h4>
  255. <pre><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;getURL()</pre>
  256. <div class="block">The url of the resource provider.<br>
  257. The source URL of the image. Consumers should be able to insert this URL into an &lt;img&gt; element. Only HTTP and HTTPS URLs are valid.</div>
  258. <dl>
  259. <dt><span class="returnLabel">Returns:</span></dt>
  260. <dd>The url of the resource provider.</dd>
  261. </dl>
  262. </li>
  263. </ul>
  264. <a name="getVersion--">
  265. <!-- -->
  266. </a>
  267. <ul class="blockList">
  268. <li class="blockList">
  269. <h4>getVersion</h4>
  270. <pre><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;getVersion()</pre>
  271. <div class="block">The oEmbed version number.</div>
  272. <dl>
  273. <dt><span class="returnLabel">Returns:</span></dt>
  274. <dd>The oEmbed version number.</dd>
  275. </dl>
  276. </li>
  277. </ul>
  278. <a name="getCacheAge--">
  279. <!-- -->
  280. </a>
  281. <ul class="blockList">
  282. <li class="blockList">
  283. <h4>getCacheAge</h4>
  284. <pre>long&nbsp;getCacheAge()</pre>
  285. <div class="block">The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.</div>
  286. <dl>
  287. <dt><span class="returnLabel">Returns:</span></dt>
  288. <dd>The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.</dd>
  289. </dl>
  290. </li>
  291. </ul>
  292. <a name="getAuthorURL--">
  293. <!-- -->
  294. </a>
  295. <ul class="blockList">
  296. <li class="blockList">
  297. <h4>getAuthorURL</h4>
  298. <pre><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;getAuthorURL()</pre>
  299. <div class="block">A URL for the author/owner of the resource.</div>
  300. <dl>
  301. <dt><span class="returnLabel">Returns:</span></dt>
  302. <dd>A URL for the author/owner of the resource.</dd>
  303. </dl>
  304. </li>
  305. </ul>
  306. <a name="getWidth--">
  307. <!-- -->
  308. </a>
  309. <ul class="blockListLast">
  310. <li class="blockList">
  311. <h4>getWidth</h4>
  312. <pre>int&nbsp;getWidth()</pre>
  313. <div class="block">The width in pixels of the image specified in the url parameter.</div>
  314. <dl>
  315. <dt><span class="returnLabel">Returns:</span></dt>
  316. <dd>The width in pixels of the image specified in the url parameter.</dd>
  317. </dl>
  318. </li>
  319. </ul>
  320. </li>
  321. </ul>
  322. </li>
  323. </ul>
  324. </div>
  325. </div>
  326. <!-- ========= END OF CLASS DATA ========= -->
  327. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  328. <div class="bottomNav"><a name="navbar.bottom">
  329. <!-- -->
  330. </a>
  331. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  332. <a name="navbar.bottom.firstrow">
  333. <!-- -->
  334. </a>
  335. <ul class="navList" title="Navigation">
  336. <li><a href="../overview-summary.html">Overview</a></li>
  337. <li><a href="package-summary.html">Package</a></li>
  338. <li class="navBarCell1Rev">Class</li>
  339. <li><a href="class-use/OEmbed.html">Use</a></li>
  340. <li><a href="package-tree.html">Tree</a></li>
  341. <li><a href="../deprecated-list.html">Deprecated</a></li>
  342. <li><a href="../index-all.html">Index</a></li>
  343. <li><a href="../help-doc.html">Help</a></li>
  344. </ul>
  345. </div>
  346. <div class="subNav">
  347. <ul class="navList">
  348. <li><a href="../twitter4j/MediaEntityJSONImpl.html" title="class in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  349. <li><a href="../twitter4j/OEmbedJSONImpl.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  350. </ul>
  351. <ul class="navList">
  352. <li><a href="../index.html?twitter4j/OEmbed.html" target="_top">Frames</a></li>
  353. <li><a href="OEmbed.html" target="_top">No&nbsp;Frames</a></li>
  354. </ul>
  355. <ul class="navList" id="allclasses_navbar_bottom">
  356. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  357. </ul>
  358. <div>
  359. <script type="text/javascript"><!--
  360. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  361. if(window==top) {
  362. allClassesLink.style.display = "block";
  363. }
  364. else {
  365. allClassesLink.style.display = "none";
  366. }
  367. //-->
  368. </script>
  369. </div>
  370. <div>
  371. <ul class="subNavList">
  372. <li>Summary:&nbsp;</li>
  373. <li>Nested&nbsp;|&nbsp;</li>
  374. <li>Field&nbsp;|&nbsp;</li>
  375. <li>Constr&nbsp;|&nbsp;</li>
  376. <li><a href="#method.summary">Method</a></li>
  377. </ul>
  378. <ul class="subNavList">
  379. <li>Detail:&nbsp;</li>
  380. <li>Field&nbsp;|&nbsp;</li>
  381. <li>Constr&nbsp;|&nbsp;</li>
  382. <li><a href="#method.detail">Method</a></li>
  383. </ul>
  384. </div>
  385. <a name="skip.navbar.bottom">
  386. <!-- -->
  387. </a></div>
  388. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  389. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  390. </body>
  391. </html>