SavedSearchesResources.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  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>SavedSearchesResources (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="SavedSearchesResources (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/SavedSearchesResources.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/PlacesGeoResources.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  54. <li><a href="../../twitter4j/api/SearchResource.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/SavedSearchesResources.html" target="_top">Frames</a></li>
  58. <li><a href="SavedSearchesResources.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 SavedSearchesResources" class="title">Interface SavedSearchesResources</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">SavedSearchesResources</span></pre>
  110. <dl>
  111. <dt><span class="simpleTagLabel">Author:</span></dt>
  112. <dd>Joern Huxhorn - jhuxhorn at googlemail.com</dd>
  113. </dl>
  114. </li>
  115. </ul>
  116. </div>
  117. <div class="summary">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <!-- ========== METHOD SUMMARY =========== -->
  121. <ul class="blockList">
  122. <li class="blockList"><a name="method.summary">
  123. <!-- -->
  124. </a>
  125. <h3>Method Summary</h3>
  126. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  127. <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>
  128. <tr>
  129. <th class="colFirst" scope="col">Modifier and Type</th>
  130. <th class="colLast" scope="col">Method and Description</th>
  131. </tr>
  132. <tr id="i0" class="altColor">
  133. <td class="colFirst"><code><a href="../../twitter4j/SavedSearch.html" title="interface in twitter4j">SavedSearch</a></code></td>
  134. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/SavedSearchesResources.html#createSavedSearch-java.lang.String-">createSavedSearch</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;query)</code>
  135. <div class="block">Creates a saved search for the authenticated user.</div>
  136. </td>
  137. </tr>
  138. <tr id="i1" class="rowColor">
  139. <td class="colFirst"><code><a href="../../twitter4j/SavedSearch.html" title="interface in twitter4j">SavedSearch</a></code></td>
  140. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/SavedSearchesResources.html#destroySavedSearch-long-">destroySavedSearch</a></span>(long&nbsp;id)</code>
  141. <div class="block">Destroys a saved search for the authenticated user.</div>
  142. </td>
  143. </tr>
  144. <tr id="i2" class="altColor">
  145. <td class="colFirst"><code><a href="../../twitter4j/ResponseList.html" title="interface in twitter4j">ResponseList</a>&lt;<a href="../../twitter4j/SavedSearch.html" title="interface in twitter4j">SavedSearch</a>&gt;</code></td>
  146. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/SavedSearchesResources.html#getSavedSearches--">getSavedSearches</a></span>()</code>
  147. <div class="block">Returns the authenticated user's saved search queries.</div>
  148. </td>
  149. </tr>
  150. <tr id="i3" class="rowColor">
  151. <td class="colFirst"><code><a href="../../twitter4j/SavedSearch.html" title="interface in twitter4j">SavedSearch</a></code></td>
  152. <td class="colLast"><code><span class="memberNameLink"><a href="../../twitter4j/api/SavedSearchesResources.html#showSavedSearch-long-">showSavedSearch</a></span>(long&nbsp;id)</code>
  153. <div class="block">Retrieve the data for a saved search owned by the authenticating user specified by the given id.</div>
  154. </td>
  155. </tr>
  156. </table>
  157. </li>
  158. </ul>
  159. </li>
  160. </ul>
  161. </div>
  162. <div class="details">
  163. <ul class="blockList">
  164. <li class="blockList">
  165. <!-- ============ METHOD DETAIL ========== -->
  166. <ul class="blockList">
  167. <li class="blockList"><a name="method.detail">
  168. <!-- -->
  169. </a>
  170. <h3>Method Detail</h3>
  171. <a name="getSavedSearches--">
  172. <!-- -->
  173. </a>
  174. <ul class="blockList">
  175. <li class="blockList">
  176. <h4>getSavedSearches</h4>
  177. <pre><a href="../../twitter4j/ResponseList.html" title="interface in twitter4j">ResponseList</a>&lt;<a href="../../twitter4j/SavedSearch.html" title="interface in twitter4j">SavedSearch</a>&gt;&nbsp;getSavedSearches()
  178. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  179. <div class="block">Returns the authenticated user's saved search queries.
  180. <br>This method calls https://api.twitter.com/1.1/saved_searches.json</div>
  181. <dl>
  182. <dt><span class="returnLabel">Returns:</span></dt>
  183. <dd>Returns an array of numeric user ids the authenticating user is blocking.</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.0.8</dd>
  188. <dt><span class="seeLabel">See Also:</span></dt>
  189. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/saved_searches">GET saved_searches | Twitter Developers</a></dd>
  190. </dl>
  191. </li>
  192. </ul>
  193. <a name="showSavedSearch-long-">
  194. <!-- -->
  195. </a>
  196. <ul class="blockList">
  197. <li class="blockList">
  198. <h4>showSavedSearch</h4>
  199. <pre><a href="../../twitter4j/SavedSearch.html" title="interface in twitter4j">SavedSearch</a>&nbsp;showSavedSearch(long&nbsp;id)
  200. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  201. <div class="block">Retrieve the data for a saved search owned by the authenticating user specified by the given id.
  202. <br>This method calls https://api.twitter.com/1.1/saved_searches/show/:id.json</div>
  203. <dl>
  204. <dt><span class="paramLabel">Parameters:</span></dt>
  205. <dd><code>id</code> - The id of the saved search to be retrieved.</dd>
  206. <dt><span class="returnLabel">Returns:</span></dt>
  207. <dd>the data for a saved search</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</dd>
  210. <dt><span class="simpleTagLabel">Since:</span></dt>
  211. <dd>Twitter4J 2.0.8</dd>
  212. <dt><span class="seeLabel">See Also:</span></dt>
  213. <dd><a href="https://dev.twitter.com/docs/api/1.1/get/saved_searches/show/:id">GET saved_searches/show/:id | Twitter Developers</a></dd>
  214. </dl>
  215. </li>
  216. </ul>
  217. <a name="createSavedSearch-java.lang.String-">
  218. <!-- -->
  219. </a>
  220. <ul class="blockList">
  221. <li class="blockList">
  222. <h4>createSavedSearch</h4>
  223. <pre><a href="../../twitter4j/SavedSearch.html" title="interface in twitter4j">SavedSearch</a>&nbsp;createSavedSearch(<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;query)
  224. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  225. <div class="block">Creates a saved search for the authenticated user.
  226. <br>This method calls https://api.twitter.com/1.1/saved_searches/saved_searches/create.json</div>
  227. <dl>
  228. <dt><span class="paramLabel">Parameters:</span></dt>
  229. <dd><code>query</code> - the query string</dd>
  230. <dt><span class="returnLabel">Returns:</span></dt>
  231. <dd>the data for a created saved search</dd>
  232. <dt><span class="throwsLabel">Throws:</span></dt>
  233. <dd><code><a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when Twitter service or network is unavailable</dd>
  234. <dt><span class="simpleTagLabel">Since:</span></dt>
  235. <dd>Twitter4J 2.0.8</dd>
  236. <dt><span class="seeLabel">See Also:</span></dt>
  237. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/saved_searches/create">POST saved_searches/create | Twitter Developers</a></dd>
  238. </dl>
  239. </li>
  240. </ul>
  241. <a name="destroySavedSearch-long-">
  242. <!-- -->
  243. </a>
  244. <ul class="blockListLast">
  245. <li class="blockList">
  246. <h4>destroySavedSearch</h4>
  247. <pre><a href="../../twitter4j/SavedSearch.html" title="interface in twitter4j">SavedSearch</a>&nbsp;destroySavedSearch(long&nbsp;id)
  248. throws <a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></pre>
  249. <div class="block">Destroys a saved search for the authenticated user. The search specified by id must be owned by the authenticating user.
  250. <br>This method calls https://api.twitter.com/1.1/saved_searches/destroy/id.json</div>
  251. <dl>
  252. <dt><span class="paramLabel">Parameters:</span></dt>
  253. <dd><code>id</code> - The id of the saved search to be deleted.</dd>
  254. <dt><span class="returnLabel">Returns:</span></dt>
  255. <dd>the data for a destroyed saved search</dd>
  256. <dt><span class="throwsLabel">Throws:</span></dt>
  257. <dd><code><a href="../../twitter4j/TwitterException.html" title="class in twitter4j">TwitterException</a></code> - when Twitter service or network is unavailable</dd>
  258. <dt><span class="simpleTagLabel">Since:</span></dt>
  259. <dd>Twitter4J 2.0.8</dd>
  260. <dt><span class="seeLabel">See Also:</span></dt>
  261. <dd><a href="https://dev.twitter.com/docs/api/1.1/post/saved_searches/destroy/:id">POST saved_searches/destroy/:id | Twitter Developers</a></dd>
  262. </dl>
  263. </li>
  264. </ul>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. </div>
  270. </div>
  271. <!-- ========= END OF CLASS DATA ========= -->
  272. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  273. <div class="bottomNav"><a name="navbar.bottom">
  274. <!-- -->
  275. </a>
  276. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  277. <a name="navbar.bottom.firstrow">
  278. <!-- -->
  279. </a>
  280. <ul class="navList" title="Navigation">
  281. <li><a href="../../overview-summary.html">Overview</a></li>
  282. <li><a href="package-summary.html">Package</a></li>
  283. <li class="navBarCell1Rev">Class</li>
  284. <li><a href="class-use/SavedSearchesResources.html">Use</a></li>
  285. <li><a href="package-tree.html">Tree</a></li>
  286. <li><a href="../../deprecated-list.html">Deprecated</a></li>
  287. <li><a href="../../index-all.html">Index</a></li>
  288. <li><a href="../../help-doc.html">Help</a></li>
  289. </ul>
  290. </div>
  291. <div class="subNav">
  292. <ul class="navList">
  293. <li><a href="../../twitter4j/api/PlacesGeoResources.html" title="interface in twitter4j.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  294. <li><a href="../../twitter4j/api/SearchResource.html" title="interface in twitter4j.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  295. </ul>
  296. <ul class="navList">
  297. <li><a href="../../index.html?twitter4j/api/SavedSearchesResources.html" target="_top">Frames</a></li>
  298. <li><a href="SavedSearchesResources.html" target="_top">No&nbsp;Frames</a></li>
  299. </ul>
  300. <ul class="navList" id="allclasses_navbar_bottom">
  301. <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  302. </ul>
  303. <div>
  304. <script type="text/javascript"><!--
  305. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  306. if(window==top) {
  307. allClassesLink.style.display = "block";
  308. }
  309. else {
  310. allClassesLink.style.display = "none";
  311. }
  312. //-->
  313. </script>
  314. </div>
  315. <div>
  316. <ul class="subNavList">
  317. <li>Summary:&nbsp;</li>
  318. <li>Nested&nbsp;|&nbsp;</li>
  319. <li>Field&nbsp;|&nbsp;</li>
  320. <li>Constr&nbsp;|&nbsp;</li>
  321. <li><a href="#method.summary">Method</a></li>
  322. </ul>
  323. <ul class="subNavList">
  324. <li>Detail:&nbsp;</li>
  325. <li>Field&nbsp;|&nbsp;</li>
  326. <li>Constr&nbsp;|&nbsp;</li>
  327. <li><a href="#method.detail">Method</a></li>
  328. </ul>
  329. </div>
  330. <a name="skip.navbar.bottom">
  331. <!-- -->
  332. </a></div>
  333. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  334. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
  335. </body>
  336. </html>