Module: Twitter::REST::SavedSearches

Includes:

Utils, Utils

Included in:

API

Defined in:

lib/twitter/rest/saved_searches.rb

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary

• #create_saved_search(query, options = {}) ⇒ Twitter::SavedSearch

  Creates a saved search for the authenticated user.

• #destroy_saved_search(*args) ⇒ Array<Twitter::SavedSearch>

  Destroys saved searches for the authenticated user.

• #saved_search(id, options = {}) ⇒ Twitter::SavedSearch

  Retrieve the data for saved searches owned by the authenticating user.

• #saved_searches(*args) ⇒ Array<Twitter::SavedSearch>

  The saved searches.

Methods included from Utils

flat_pmap, pmap

Instance Method Details

#create_saved_search(query, options = {}) ⇒ Twitter::SavedSearch

Creates a saved search for the authenticated user

Parameters:

• query (String) —

  The query of the search the user would like to save.

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Returns:

• (Twitter::SavedSearch) —

  The created saved search.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/post/saved_searches/create

Rate Limited?:

• No

Authentication:

• Requires user context

# File 'lib/twitter/rest/saved_searches.rb', line 65

def create_saved_search(query, options = {})
  perform_post_with_object("/1.1/saved_searches/create.json", options.merge(query:), Twitter::SavedSearch)
end

#destroy_saved_search(*ids) ⇒ Array<Twitter::SavedSearch> #destroy_saved_search(*ids, options) ⇒ Array<Twitter::SavedSearch>

Note:

The search specified by ID must be owned by the authenticating user.

Destroys saved searches for the authenticated user

Overloads:

• #destroy_saved_search(*ids) ⇒ Array<Twitter::SavedSearch>

  Parameters:

  • ids (Enumerable<Integer>) —

    A collection of saved search IDs.

• #destroy_saved_search(*ids, options) ⇒ Array<Twitter::SavedSearch>

  Parameters:

  • ids (Enumerable<Integer>) —

    A collection of saved search IDs.

  • options (Hash) —

    A customizable set of options.

Returns:

• (Array<Twitter::SavedSearch>) —

  The deleted saved searches.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/post/saved_searches/destroy/:id

Rate Limited?:

• No

Authentication:

• Requires user context

# File 'lib/twitter/rest/saved_searches.rb', line 82

def destroy_saved_search(*args)
  arguments = Twitter::Arguments.new(args)
  pmap(arguments) do |id|
    perform_post_with_object("/1.1/saved_searches/destroy/#{id}.json", arguments.options, Twitter::SavedSearch)
  end
end

#saved_search(id, options = {}) ⇒ Twitter::SavedSearch

Retrieve the data for saved searches owned by the authenticating user

Parameters:

• id (Integer) —

  The ID of the saved search.

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Returns:

• (Twitter::SavedSearch) —

  The saved searches.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/saved_searches/show/:id

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/twitter/rest/saved_searches.rb', line 52

def saved_search(id, options = {})
  perform_get_with_object("/1.1/saved_searches/show/#{id}.json", options, Twitter::SavedSearch)
end

#saved_search(options = {}) ⇒ Array<Twitter::SavedSearch> #saved_search(*ids) ⇒ Array<Twitter::SavedSearch> #saved_search(*ids, options) ⇒ Array<Twitter::SavedSearch>

Returns The saved searches.

Overloads:

• #saved_search(options = {}) ⇒ Array<Twitter::SavedSearch>

  Returns the authenticated user's saved search queries

  Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

  See Also:

  • https://dev.twitter.com/rest/reference/get/saved_searches/list
• #saved_search(*ids) ⇒ Array<Twitter::SavedSearch>

  Retrieve the data for saved searches owned by the authenticating user

  Parameters:

  • ids (Enumerable<Integer>) —

    A collection of saved search IDs.

  See Also:

  • https://dev.twitter.com/rest/reference/get/saved_searches/show/:id
• #saved_search(*ids, options) ⇒ Array<Twitter::SavedSearch>

  Retrieve the data for saved searches owned by the authenticating user

  Parameters:

  • ids (Enumerable<Integer>) —

    A collection of saved search IDs.

  • options (Hash) —

    A customizable set of options.

  See Also:

  • https://dev.twitter.com/rest/reference/get/saved_searches/show/:id

Returns:

• (Array<Twitter::SavedSearch>) —

  The saved searches.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/twitter/rest/saved_searches.rb', line 32

def saved_searches(*args)
  arguments = Twitter::Arguments.new(args)
  if arguments.empty?
    perform_get_with_objects("/1.1/saved_searches/list.json", arguments.options, Twitter::SavedSearch)
  else
    pmap(arguments) do |id|
      saved_search(id, arguments.options)
    end
  end
end