Module: Twitter::REST::SavedSearches

Includes:
Utils, Utils
Included in:
API
Defined in:
lib/twitter/rest/saved_searches.rb

Overview

Methods for working with saved searches

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary collapse

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

Examples:

client.create_saved_search('twitter')

Parameters:

  • query (String) —

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

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

    A customizable set of options.

Returns:

Raises:

See Also:



77
78
79
 
# File 'lib/twitter/rest/saved_searches.rb', line 77

def create_saved_search(query, options = {})
  perform_post_with_object("/1.1/saved_searches/create.json", options.merge(query:), 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

Examples:

client.destroy_saved_search(16129012)

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:

Raises:

See Also:



97
98
99
100
101
102
 
# File 'lib/twitter/rest/saved_searches.rb', line 97

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

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

Retrieves a saved search by ID

Examples:

client.saved_search(16129012)

Parameters:

  • id (Integer) —

    The ID of the saved search.

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

    A customizable set of options.

Returns:

Raises:

See Also:



61
62
63
 
# File 'lib/twitter/rest/saved_searches.rb', line 61

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

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

Returns the authenticated user’s saved search queries

Examples:

client.saved_searches

Overloads:

Returns:

Raises:



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/twitter/rest/saved_searches.rb', line 38

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