Module Twitter::REST::SavedSearches
In: lib/twitter/rest/saved_searches.rb

Methods

Included Modules

Twitter::REST::Utils Twitter::Utils

Public Instance methods

Creates a saved search for the authenticated user

@see dev.twitter.com/rest/reference/post/saved_searches/create @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::SavedSearch] The created saved search. @param query [String] The query of the search the user would like to save. @param options [Hash] A customizable set of options.

Destroys saved searches for the authenticated user

@see dev.twitter.com/rest/reference/post/saved_searches/destroy/:id @note The search specified by ID must be owned by the authenticating user. @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::SavedSearch>] The deleted saved searches. @overload destroy_saved_search(*ids)

  @param ids [Enumerable<Integer>] A collection of saved search IDs.

@overload destroy_saved_search(*ids, options)

  @param ids [Enumerable<Integer>] A collection of saved search IDs.
  @param options [Hash] A customizable set of options.

Retrieve the data for saved searches owned by the authenticating user

@see dev.twitter.com/rest/reference/get/saved_searches/show/:id @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::SavedSearch] The saved searches. @param id [Integer] The ID of the saved search. @param options [Hash] A customizable set of options.

@rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::SavedSearch>] The saved searches. @overload saved_search(options = {})

  Returns the authenticated user's saved search queries

  @see https://dev.twitter.com/rest/reference/get/saved_searches/list
  @param options [Hash] A customizable set of options.

@overload saved_search(*ids)

  Retrieve the data for saved searches owned by the authenticating user

  @see https://dev.twitter.com/rest/reference/get/saved_searches/show/:id
  @param ids [Enumerable<Integer>] A collection of saved search IDs.

@overload saved_search(*ids, options)

  Retrieve the data for saved searches owned by the authenticating user

  @see https://dev.twitter.com/rest/reference/get/saved_searches/show/:id
  @param ids [Enumerable<Integer>] A collection of saved search IDs.
  @param options [Hash] A customizable set of options.

[Validate]