DirectMessage.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  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>DirectMessage (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="DirectMessage (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":38,"i3":6,"i4":38,"i5":38,"i6":6,"i7":38,"i8":6};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/DirectMessage.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/CursorSupport.html" title="interface in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../twitter4j/DirectMessageList.html" title="interface in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../index.html?twitter4j/DirectMessage.html" target="_top">Frames</a></li>
  58. <li><a href="DirectMessage.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 DirectMessage" class="title">Interface DirectMessage</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="../twitter4j/EntitySupport.html" title="interface in twitter4j">EntitySupport</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>, <a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></dd>
  106. </dl>
  107. <hr>
  108. <br>
  109. <pre>public interface <span class="typeNameLabel">DirectMessage</span>
  110. extends <a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a>, <a href="../twitter4j/EntitySupport.html" title="interface in twitter4j">EntitySupport</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>
  111. <div class="block">A data interface representing sent/received direct message.</div>
  112. <dl>
  113. <dt><span class="simpleTagLabel">Author:</span></dt>
  114. <dd>Yusuke Yamamoto - yusuke at mac.com</dd>
  115. </dl>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- =========== FIELD SUMMARY =========== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="field.summary">
  125. <!-- -->
  126. </a>
  127. <h3>Field Summary</h3>
  128. <ul class="blockList">
  129. <li class="blockList"><a name="fields.inherited.from.class.twitter4j.TwitterResponse">
  130. <!-- -->
  131. </a>
  132. <h3>Fields inherited from interface&nbsp;twitter4j.<a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></h3>
  133. <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>
  134. </ul>
  135. </li>
  136. </ul>
  137. <!-- ========== METHOD SUMMARY =========== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="method.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Method Summary</h3>
  143. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  144. <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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  145. <tr>
  146. <th class="colFirst" scope="col">Modifier and Type</th>
  147. <th class="colLast" scope="col">Method and Description</th>
  148. </tr>
  149. <tr id="i0" class="altColor">
  150. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
  151. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getCreatedAt--">getCreatedAt</a></span>()</code>&nbsp;</td>
  152. </tr>
  153. <tr id="i1" class="rowColor">
  154. <td class="colFirst"><code>long</code></td>
  155. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getId--">getId</a></span>()</code>&nbsp;</td>
  156. </tr>
  157. <tr id="i2" class="altColor">
  158. <td class="colFirst"><code><a href="../twitter4j/User.html" title="interface in twitter4j">User</a></code></td>
  159. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getRecipient--">getRecipient</a></span>()</code>
  160. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  161. <div class="block"><span class="deprecationComment">use <a href="../twitter4j/DirectMessage.html#getRecipientId--"><code>getRecipientId()</code></a> instead</span></div>
  162. </div>
  163. </td>
  164. </tr>
  165. <tr id="i3" class="rowColor">
  166. <td class="colFirst"><code>long</code></td>
  167. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getRecipientId--">getRecipientId</a></span>()</code>&nbsp;</td>
  168. </tr>
  169. <tr id="i4" class="altColor">
  170. <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>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getRecipientScreenName--">getRecipientScreenName</a></span>()</code>
  172. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  173. <div class="block"><span class="deprecationComment">use <a href="../twitter4j/DirectMessage.html#getRecipientId--"><code>getRecipientId()</code></a> instead</span></div>
  174. </div>
  175. </td>
  176. </tr>
  177. <tr id="i5" class="rowColor">
  178. <td class="colFirst"><code><a href="../twitter4j/User.html" title="interface in twitter4j">User</a></code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getSender--">getSender</a></span>()</code>
  180. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  181. <div class="block"><span class="deprecationComment">use <a href="../twitter4j/DirectMessage.html#getSenderId--"><code>getSenderId()</code></a> instead</span></div>
  182. </div>
  183. </td>
  184. </tr>
  185. <tr id="i6" class="altColor">
  186. <td class="colFirst"><code>long</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getSenderId--">getSenderId</a></span>()</code>&nbsp;</td>
  188. </tr>
  189. <tr id="i7" class="rowColor">
  190. <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>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getSenderScreenName--">getSenderScreenName</a></span>()</code>
  192. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  193. <div class="block"><span class="deprecationComment">use <a href="../twitter4j/DirectMessage.html#getSenderId--"><code>getSenderId()</code></a> instead</span></div>
  194. </div>
  195. </td>
  196. </tr>
  197. <tr id="i8" class="altColor">
  198. <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>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/DirectMessage.html#getText--">getText</a></span>()</code>&nbsp;</td>
  200. </tr>
  201. </table>
  202. <ul class="blockList">
  203. <li class="blockList"><a name="methods.inherited.from.class.twitter4j.TwitterResponse">
  204. <!-- -->
  205. </a>
  206. <h3>Methods inherited from interface&nbsp;twitter4j.<a href="../twitter4j/TwitterResponse.html" title="interface in twitter4j">TwitterResponse</a></h3>
  207. <code><a href="../twitter4j/TwitterResponse.html#getAccessLevel--">getAccessLevel</a>, <a href="../twitter4j/TwitterResponse.html#getRateLimitStatus--">getRateLimitStatus</a></code></li>
  208. </ul>
  209. <ul class="blockList">
  210. <li class="blockList"><a name="methods.inherited.from.class.twitter4j.EntitySupport">
  211. <!-- -->
  212. </a>
  213. <h3>Methods inherited from interface&nbsp;twitter4j.<a href="../twitter4j/EntitySupport.html" title="interface in twitter4j">EntitySupport</a></h3>
  214. <code><a href="../twitter4j/EntitySupport.html#getHashtagEntities--">getHashtagEntities</a>, <a href="../twitter4j/EntitySupport.html#getMediaEntities--">getMediaEntities</a>, <a href="../twitter4j/EntitySupport.html#getSymbolEntities--">getSymbolEntities</a>, <a href="../twitter4j/EntitySupport.html#getURLEntities--">getURLEntities</a>, <a href="../twitter4j/EntitySupport.html#getUserMentionEntities--">getUserMentionEntities</a></code></li>
  215. </ul>
  216. </li>
  217. </ul>
  218. </li>
  219. </ul>
  220. </div>
  221. <div class="details">
  222. <ul class="blockList">
  223. <li class="blockList">
  224. <!-- ============ METHOD DETAIL ========== -->
  225. <ul class="blockList">
  226. <li class="blockList"><a name="method.detail">
  227. <!-- -->
  228. </a>
  229. <h3>Method Detail</h3>
  230. <a name="getId--">
  231. <!-- -->
  232. </a>
  233. <ul class="blockList">
  234. <li class="blockList">
  235. <h4>getId</h4>
  236. <pre>long&nbsp;getId()</pre>
  237. </li>
  238. </ul>
  239. <a name="getText--">
  240. <!-- -->
  241. </a>
  242. <ul class="blockList">
  243. <li class="blockList">
  244. <h4>getText</h4>
  245. <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;getText()</pre>
  246. </li>
  247. </ul>
  248. <a name="getSenderId--">
  249. <!-- -->
  250. </a>
  251. <ul class="blockList">
  252. <li class="blockList">
  253. <h4>getSenderId</h4>
  254. <pre>long&nbsp;getSenderId()</pre>
  255. </li>
  256. </ul>
  257. <a name="getRecipientId--">
  258. <!-- -->
  259. </a>
  260. <ul class="blockList">
  261. <li class="blockList">
  262. <h4>getRecipientId</h4>
  263. <pre>long&nbsp;getRecipientId()</pre>
  264. </li>
  265. </ul>
  266. <a name="getCreatedAt--">
  267. <!-- -->
  268. </a>
  269. <ul class="blockList">
  270. <li class="blockList">
  271. <h4>getCreatedAt</h4>
  272. <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;getCreatedAt()</pre>
  273. <dl>
  274. <dt><span class="returnLabel">Returns:</span></dt>
  275. <dd>created_at</dd>
  276. <dt><span class="simpleTagLabel">Since:</span></dt>
  277. <dd>Twitter4J 1.1.0</dd>
  278. </dl>
  279. </li>
  280. </ul>
  281. <a name="getSenderScreenName--">
  282. <!-- -->
  283. </a>
  284. <ul class="blockList">
  285. <li class="blockList">
  286. <h4>getSenderScreenName</h4>
  287. <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;getSenderScreenName()</pre>
  288. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../twitter4j/DirectMessage.html#getSenderId--"><code>getSenderId()</code></a> instead</span></div>
  289. <dl>
  290. <dt><span class="returnLabel">Returns:</span></dt>
  291. <dd>sender screen name</dd>
  292. </dl>
  293. </li>
  294. </ul>
  295. <a name="getRecipientScreenName--">
  296. <!-- -->
  297. </a>
  298. <ul class="blockList">
  299. <li class="blockList">
  300. <h4>getRecipientScreenName</h4>
  301. <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;getRecipientScreenName()</pre>
  302. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../twitter4j/DirectMessage.html#getRecipientId--"><code>getRecipientId()</code></a> instead</span></div>
  303. <dl>
  304. <dt><span class="returnLabel">Returns:</span></dt>
  305. <dd>recipient screen name</dd>
  306. </dl>
  307. </li>
  308. </ul>
  309. <a name="getSender--">
  310. <!-- -->
  311. </a>
  312. <ul class="blockList">
  313. <li class="blockList">
  314. <h4>getSender</h4>
  315. <pre><a href="../twitter4j/User.html" title="interface in twitter4j">User</a>&nbsp;getSender()</pre>
  316. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../twitter4j/DirectMessage.html#getSenderId--"><code>getSenderId()</code></a> instead</span></div>
  317. <dl>
  318. <dt><span class="returnLabel">Returns:</span></dt>
  319. <dd>sender user</dd>
  320. </dl>
  321. </li>
  322. </ul>
  323. <a name="getRecipient--">
  324. <!-- -->
  325. </a>
  326. <ul class="blockListLast">
  327. <li class="blockList">
  328. <h4>getRecipient</h4>
  329. <pre><a href="../twitter4j/User.html" title="interface in twitter4j">User</a>&nbsp;getRecipient()</pre>
  330. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../twitter4j/DirectMessage.html#getRecipientId--"><code>getRecipientId()</code></a> instead</span></div>
  331. <dl>
  332. <dt><span class="returnLabel">Returns:</span></dt>
  333. <dd>sender recipient</dd>
  334. </dl>
  335. </li>
  336. </ul>
  337. </li>
  338. </ul>
  339. </li>
  340. </ul>
  341. </div>
  342. </div>
  343. <!-- ========= END OF CLASS DATA ========= -->
  344. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  345. <div class="bottomNav"><a name="navbar.bottom">
  346. <!-- -->
  347. </a>
  348. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  349. <a name="navbar.bottom.firstrow">
  350. <!-- -->
  351. </a>
  352. <ul class="navList" title="Navigation">
  353. <li><a href="../overview-summary.html">Overview</a></li>
  354. <li><a href="package-summary.html">Package</a></li>
  355. <li class="navBarCell1Rev">Class</li>
  356. <li><a href="class-use/DirectMessage.html">Use</a></li>
  357. <li><a href="package-tree.html">Tree</a></li>
  358. <li><a href="../deprecated-list.html">Deprecated</a></li>
  359. <li><a href="../index-all.html">Index</a></li>
  360. <li><a href="../help-doc.html">Help</a></li>
  361. </ul>
  362. </div>
  363. <div class="subNav">
  364. <ul class="navList">
  365. <li><a href="../twitter4j/CursorSupport.html" title="interface in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  366. <li><a href="../twitter4j/DirectMessageList.html" title="interface in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  367. </ul>
  368. <ul class="navList">
  369. <li><a href="../index.html?twitter4j/DirectMessage.html" target="_top">Frames</a></li>
  370. <li><a href="DirectMessage.html" target="_top">No&nbsp;Frames</a></li>
  371. </ul>
  372. <ul class="navList" id="allclasses_navbar_bottom">
  373. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  374. </ul>
  375. <div>
  376. <script type="text/javascript"><!--
  377. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  378. if(window==top) {
  379. allClassesLink.style.display = "block";
  380. }
  381. else {
  382. allClassesLink.style.display = "none";
  383. }
  384. //-->
  385. </script>
  386. </div>
  387. <div>
  388. <ul class="subNavList">
  389. <li>Summary:&nbsp;</li>
  390. <li>Nested&nbsp;|&nbsp;</li>
  391. <li>Field&nbsp;|&nbsp;</li>
  392. <li>Constr&nbsp;|&nbsp;</li>
  393. <li><a href="#method.summary">Method</a></li>
  394. </ul>
  395. <ul class="subNavList">
  396. <li>Detail:&nbsp;</li>
  397. <li>Field&nbsp;|&nbsp;</li>
  398. <li>Constr&nbsp;|&nbsp;</li>
  399. <li><a href="#method.detail">Method</a></li>
  400. </ul>
  401. </div>
  402. <a name="skip.navbar.bottom">
  403. <!-- -->
  404. </a></div>
  405. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  406. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  407. </body>
  408. </html>