SuggestedUsersResources.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  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>SuggestedUsersResources (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="SuggestedUsersResources (twitter4j-core 4.0.7 API)";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":6,"i1":6,"i2":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/SuggestedUsersResources.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/api/SpamReportingResource.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../../twitter4j/api/TimelinesResources.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  55. </ul>
  56. <ul class="navList">
  57. <li><a href="../../index.html?twitter4j/api/SuggestedUsersResources.html" target="_top">Frames</a></li>
  58. <li><a href="SuggestedUsersResources.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.api</div>
  97. <h2 title="Interface SuggestedUsersResources" class="title">Interface SuggestedUsersResources</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. <hr>
  108. <br>
  109. <pre>public interface <span class="typeNameLabel">SuggestedUsersResources</span></pre>
  110. <dl>
  111. <dt><span class="simpleTagLabel">Since:</span></dt>
  112. <dd>Twitter4J 3.0.0</dd>
  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. <!-- ========== METHOD SUMMARY =========== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="method.summary">
  125. <!-- -->
  126. </a>
  127. <h3>Method Summary</h3>
  128. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  129. <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>
  130. <tr>
  131. <th class="colFirst" scope="col">Modifier and Type</th>
  132. <th class="colLast" scope="col">Method and Description</th>
  133. </tr>
  134. <tr id="i0" class="altColor">
  135. <td class="colFirst"><code><a href="../../twitter4j/ResponseList.html" title="interface in twitter4j">ResponseList</a>&lt;<a href="../../twitter4j/User.html" title="interface in twitter4j">User</a>&gt;</code></td>
  136. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/SuggestedUsersResources.html#getMemberSuggestions-java.lang.String-">getMemberSuggestions</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;categorySlug)</code>
  137. <div class="block">Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.</div>
  138. </td>
  139. </tr>
  140. <tr id="i1" class="rowColor">
  141. <td class="colFirst"><code><a href="../../twitter4j/ResponseList.html" title="interface in twitter4j">ResponseList</a>&lt;<a href="../../twitter4j/Category.html" title="interface in twitter4j">Category</a>&gt;</code></td>
  142. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/SuggestedUsersResources.html#getSuggestedUserCategories--">getSuggestedUserCategories</a></span>()</code>
  143. <div class="block">Access to Twitter's suggested user list.</div>
  144. </td>
  145. </tr>
  146. <tr id="i2" class="altColor">
  147. <td class="colFirst"><code><a href="../../twitter4j/ResponseList.html" title="interface in twitter4j">ResponseList</a>&lt;<a href="../../twitter4j/User.html" title="interface in twitter4j">User</a>&gt;</code></td>
  148. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/SuggestedUsersResources.html#getUserSuggestions-java.lang.String-">getUserSuggestions</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;categorySlug)</code>
  149. <div class="block">Access the users in a given category of the Twitter suggested user list.<br>
  150. It is recommended that end clients cache this data for no more than one hour.</div>
  151. </td>
  152. </tr>
  153. </table>
  154. </li>
  155. </ul>
  156. </li>
  157. </ul>
  158. </div>
  159. <div class="details">
  160. <ul class="blockList">
  161. <li class="blockList">
  162. <!-- ============ METHOD DETAIL ========== -->
  163. <ul class="blockList">
  164. <li class="blockList"><a name="method.detail">
  165. <!-- -->
  166. </a>
  167. <h3>Method Detail</h3>
  168. <a name="getUserSuggestions-java.lang.String-">
  169. <!-- -->
  170. </a>
  171. <ul class="blockList">
  172. <li class="blockList">
  173. <h4>getUserSuggestions</h4>
  174. <pre><a href="../../twitter4j/ResponseList.html" title="interface in twitter4j">ResponseList</a>&lt;<a href="../../twitter4j/User.html" title="interface in twitter4j">User</a>&gt;&nbsp;getUserSuggestions(<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;categorySlug)
  175. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  176. <div class="block">Access the users in a given category of the Twitter suggested user list.<br>
  177. It is recommended that end clients cache this data for no more than one hour.
  178. <br>This method calls https://api.twitter.com/1.1/users/suggestions/:slug.json</div>
  179. <dl>
  180. <dt><span class="paramLabel">Parameters:</span></dt>
  181. <dd><code>categorySlug</code> - slug</dd>
  182. <dt><span class="returnLabel">Returns:</span></dt>
  183. <dd>list of suggested users</dd>
  184. <dt><span class="throwsLabel">Throws:</span></dt>
  185. <dd><code><a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when Twitter service or network is unavailable</dd>
  186. <dt><span class="simpleTagLabel">Since:</span></dt>
  187. <dd>Twitter4J 2.1.1</dd>
  188. <dt><span class="seeLabel">See Also:</span></dt>
  189. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/users/suggestions/:slug">GET users/suggestions/:slug | Twitter Developers</a></dd>
  190. </dl>
  191. </li>
  192. </ul>
  193. <a name="getSuggestedUserCategories--">
  194. <!-- -->
  195. </a>
  196. <ul class="blockList">
  197. <li class="blockList">
  198. <h4>getSuggestedUserCategories</h4>
  199. <pre><a href="../../twitter4j/ResponseList.html" title="interface in twitter4j">ResponseList</a>&lt;<a href="../../twitter4j/Category.html" title="interface in twitter4j">Category</a>&gt;&nbsp;getSuggestedUserCategories()
  200. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  201. <div class="block">Access to Twitter's suggested user list. This returns the list of suggested user categories. The category can be used in the users/suggestions/category endpoint to get the users in that category.
  202. <br>This method calls https://api.twitter.com/1.1/users/suggestions</div>
  203. <dl>
  204. <dt><span class="returnLabel">Returns:</span></dt>
  205. <dd>list of suggested user categories.</dd>
  206. <dt><span class="throwsLabel">Throws:</span></dt>
  207. <dd><code><a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when Twitter service or network is unavailable</dd>
  208. <dt><span class="simpleTagLabel">Since:</span></dt>
  209. <dd>Twitter4J 2.1.1</dd>
  210. <dt><span class="seeLabel">See Also:</span></dt>
  211. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/users/suggestions">GET users/suggestions | Twitter Developers</a></dd>
  212. </dl>
  213. </li>
  214. </ul>
  215. <a name="getMemberSuggestions-java.lang.String-">
  216. <!-- -->
  217. </a>
  218. <ul class="blockListLast">
  219. <li class="blockList">
  220. <h4>getMemberSuggestions</h4>
  221. <pre><a href="../../twitter4j/ResponseList.html" title="interface in twitter4j">ResponseList</a>&lt;<a href="../../twitter4j/User.html" title="interface in twitter4j">User</a>&gt;&nbsp;getMemberSuggestions(<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;categorySlug)
  222. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  223. <div class="block">Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.
  224. <br>This method has not been finalized and the interface is subject to change in incompatible ways.
  225. <br>This method calls https://api.twitter.com/1.1/users/suggestions/:slug/members.json</div>
  226. <dl>
  227. <dt><span class="paramLabel">Parameters:</span></dt>
  228. <dd><code>categorySlug</code> - slug</dd>
  229. <dt><span class="returnLabel">Returns:</span></dt>
  230. <dd>list of suggested users</dd>
  231. <dt><span class="throwsLabel">Throws:</span></dt>
  232. <dd><code><a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when Twitter service or network is unavailable</dd>
  233. <dt><span class="simpleTagLabel">Since:</span></dt>
  234. <dd>Twitter4J 2.1.9</dd>
  235. <dt><span class="seeLabel">See Also:</span></dt>
  236. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/users/suggestions/%3Aslug/members">GET users/suggestions/:slug/members | Twitter Developers</a></dd>
  237. </dl>
  238. </li>
  239. </ul>
  240. </li>
  241. </ul>
  242. </li>
  243. </ul>
  244. </div>
  245. </div>
  246. <!-- ========= END OF CLASS DATA ========= -->
  247. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  248. <div class="bottomNav"><a name="navbar.bottom">
  249. <!-- -->
  250. </a>
  251. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  252. <a name="navbar.bottom.firstrow">
  253. <!-- -->
  254. </a>
  255. <ul class="navList" title="Navigation">
  256. <li><a href="../../overview-summary.html">Overview</a></li>
  257. <li><a href="package-summary.html">Package</a></li>
  258. <li class="navBarCell1Rev">Class</li>
  259. <li><a href="class-use/SuggestedUsersResources.html">Use</a></li>
  260. <li><a href="package-tree.html">Tree</a></li>
  261. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  262. <li><a href="../../index-all.html">Index</a></li>
  263. <li><a href="../../help-doc.html">Help</a></li>
  264. </ul>
  265. </div>
  266. <div class="subNav">
  267. <ul class="navList">
  268. <li><a href="../../twitter4j/api/SpamReportingResource.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  269. <li><a href="../../twitter4j/api/TimelinesResources.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  270. </ul>
  271. <ul class="navList">
  272. <li><a href="../../index.html?twitter4j/api/SuggestedUsersResources.html" target="_top">Frames</a></li>
  273. <li><a href="SuggestedUsersResources.html" target="_top">No&nbsp;Frames</a></li>
  274. </ul>
  275. <ul class="navList" id="allclasses_navbar_bottom">
  276. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  277. </ul>
  278. <div>
  279. <script type="text/javascript"><!--
  280. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  281. if(window==top) {
  282. allClassesLink.style.display = "block";
  283. }
  284. else {
  285. allClassesLink.style.display = "none";
  286. }
  287. //-->
  288. </script>
  289. </div>
  290. <div>
  291. <ul class="subNavList">
  292. <li>Summary:&nbsp;</li>
  293. <li>Nested&nbsp;|&nbsp;</li>
  294. <li>Field&nbsp;|&nbsp;</li>
  295. <li>Constr&nbsp;|&nbsp;</li>
  296. <li><a href="#method.summary">Method</a></li>
  297. </ul>
  298. <ul class="subNavList">
  299. <li>Detail:&nbsp;</li>
  300. <li>Field&nbsp;|&nbsp;</li>
  301. <li>Constr&nbsp;|&nbsp;</li>
  302. <li><a href="#method.detail">Method</a></li>
  303. </ul>
  304. </div>
  305. <a name="skip.navbar.bottom">
  306. <!-- -->
  307. </a></div>
  308. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  309. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  310. </body>
  311. </html>