Included Modules

Class/Module Index [+]

Quicksearch

Twitter::REST::SuggestedUsers

Public Instance Methods

suggest_users(slug, options = {}) click to toggle source

Access the users in a given category of the Twitter suggested user list and return their most recent Tweet if they are not a protected user

@see dev.twitter.com/docs/api/1.1/get/users/suggestions/:slug/members @rate_limited Yes @authentication Requires user context @param slug [String] The short name of list or a category. @param options [Hash] A customizable set of options. @return [Array<Twitter::User>]

# File lib/twitter/rest/suggested_users.rb, line 44
def suggest_users(slug, options = {})
  perform_with_objects(:get, "/1.1/users/suggestions/#{slug}/members.json", options, Twitter::User)
end
suggestions(*args) click to toggle source

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

Returns the list of suggested user categories

@see https://dev.twitter.com/docs/api/1.1/get/users/suggestions
@param options [Hash] A customizable set of options.

@overload suggestions(slug, options = {})

Returns the users in a given category

@see https://dev.twitter.com/docs/api/1.1/get/users/suggestions/:slug
@param slug [String] The short name of list or a category.
@param options [Hash] A customizable set of options.
# File lib/twitter/rest/suggested_users.rb, line 27
def suggestions(*args)
  arguments = Twitter::Arguments.new(args)
  if arguments.last
    perform_with_object(:get, "/1.1/users/suggestions/#{arguments.pop}.json", arguments.options, Twitter::Suggestion)
  else
    perform_with_objects(:get, '/1.1/users/suggestions.json', arguments.options, Twitter::Suggestion)
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.