Module | Twitter::Client::SavedSearches |
In: |
lib/twitter/client/saved_searches.rb
|
Defines methods related to saved searches
Retrieve the data for a saved search owned by the authenticating user specified by the given ID
@see dev.twitter.com/docs/api/1/get/saved_searches/show/:id @rate_limited Yes @requires_authentication Yes @param id [Integer] The ID of the saved search. @param options [Hash] A customizable set of options. @return [Twitter::SavedSearch] The saved search. @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @example Retrieve the data for a saved search owned by the authenticating user with the ID 16129012
Twitter.saved_search(16129012)
Creates a saved search for the authenticated user
@see dev.twitter.com/docs/api/1/post/saved_searches/create @rate_limited No @requires_authentication Yes @param query [String] The query of the search the user would like to save. @param options [Hash] A customizable set of options. @return [Twitter::SavedSearch] The created saved search. @example Create a saved search for the authenticated user with the query "twitter"
Twitter.saved_search_create("twitter")
Destroys a saved search for the authenticated user
@see dev.twitter.com/docs/api/1/post/saved_searches/destroy/:id @note The search specified by ID must be owned by the authenticating user. @rate_limited No @requires_authentication Yes @param id [Integer] The ID of the saved search. @param options [Hash] A customizable set of options. @return [Twitter::SavedSearch] The deleted saved search. @example Destroys a saved search for the authenticated user with the ID 16129012
Twitter.saved_search_destroy(16129012)
Returns the authenticated user‘s saved search queries
@see dev.twitter.com/docs/api/1/get/saved_searches @rate_limited Yes @requires_authentication Yes @param options [Hash] A customizable set of options. @return [Array<Twitter::SavedSearch>] Saved search queries. @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @example Return the authenticated user‘s saved search queries
Twitter.saved_searches