Sha256: 6f49d92e88543f7c3dd7334c1a497078d0f763d9ee33f19c1b93ebdb254cdb4e
Contents?: true
Size: 2 KB
Versions: 7
Compression:
Stored size: 2 KB
Contents
require 'twitter/arguments'
require 'twitter/request'
require 'twitter/rest/utils'
require 'twitter/suggestion'
require 'twitter/user'
module Twitter
module REST
module SuggestedUsers
include Twitter::REST::Utils
# @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.
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
# 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 https://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>]
def suggest_users(slug, options = {})
perform_with_objects(:get, "/1.1/users/suggestions/#{slug}/members.json", options, Twitter::User)
end
end
end
end
Version data entries
7 entries across 7 versions & 1 rubygems