Module | Twitter::Client::Users |
In: |
lib/twitter/client/users.rb
|
Defines methods related to users
Returns an array of users that the specified user can contribute to
@see dev.twitter.com/docs/api/1/get/users/contributees @rate_limited Yes @requires_authentication No unless requesting it from a protected user
If getting this data of a protected user, you must authenticate (and be allowed to see that user).
@overload contributees(options={})
@param options [Hash] A customizable set of options. @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1. @option options [Boolean, String, Integer] :skip_status Do not include contributee's statuses when set to true, 't' or 1. @return [Array<Twitter::User>] @example Return the authenticated user's contributees Twitter.contributees @overload contributees(user, options={}) @param user [Integer, String] A Twitter user ID or screen name. @param options [Hash] A customizable set of options. @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1. @option options [Boolean, String, Integer] :skip_status Do not include contributee's statuses when set to true, 't' or 1. @return [Array<Twitter::User>] @example Return users @sferik can contribute to Twitter.contributees("sferik") Twitter.contributees(7505382) # Same as above
Returns an array of users who can contribute to the specified account
@see dev.twitter.com/docs/api/1/get/users/contributors @rate_limited Yes @requires_authentication No unless requesting it from a protected user
If getting this data of a protected user, you must authenticate (and be allowed to see that user).
@overload contributors(options={})
@param options [Hash] A customizable set of options. @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1. @option options [Boolean, String, Integer] :skip_status Do not include contributee's statuses when set to true, 't' or 1. @return [Array<Twitter::User>] @example Return the authenticated user's contributors Twitter.contributors @overload contributors(user, options={}) @param user [Integer, String] A Twitter user ID or screen name. @param options [Hash] A customizable set of options. @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1. @option options [Boolean, String, Integer] :skip_status Do not include contributee's statuses when set to true, 't' or 1. @return [Array<Twitter::User>] @example Return users who can contribute to @sferik's account Twitter.contributors("sferik") Twitter.contributors(7505382) # Same as above
Access the profile image in various sizes for the user with the indicated screen name
@see dev.twitter.com/docs/api/1/get/users/profile_image/:screen_name @rate_limited No @requires_authentication No @overload profile_image(screen_name, options={})
@param screen_name [String] The screen name of the user for whom to return results for. @param options [Hash] A customizable set of options. @option options [String] :size ('normal') Specifies the size of image to fetch. Valid options include: 'bigger' (73px by 73px), 'normal' (48px by 48px), and 'mini' (24px by 24px). @example Return the URL for the 24px by 24px version of @sferik's profile image Twitter.profile_image("sferik", :size => 'mini')
@return [String] The URL for the requested user‘s profile image.
Returns recommended users for the authenticated user
@note {dev.twitter.com/discussions/1120 Undocumented} @rate_limited Yes @requires_authentication Yes @param options [Hash] A customizable set of options. @option options [Integer] :limit (20) Specifies the number of records to retrieve. @option options [String] :excluded Comma-separated list of user IDs to exclude. @option options [String] :screen_name Find users similar to this screen_name @option options [Integer] :user_id Find users similar to this user ID. @return [Array<Twitter::User>] @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @example Return recommended users for the authenticated user
Twitter.recommendations
Returns extended information of a given user
@see dev.twitter.com/docs/api/1/get/users/show @rate_limited Yes @requires_authentication No @overload user(user, options={})
@param user [Integer, String] A Twitter user ID or screen name. @param options [Hash] A customizable set of options. @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1. @return [Twitter::User] The requested user. @example Return extended information for @sferik Twitter.user("sferik") Twitter.user(7505382) # Same as above
Returns true if the specified user exists
@param user [Integer, String] A Twitter user ID or screen name. @return [Boolean] true if the user exists, otherwise false. @example Return true if @sferik exists
Twitter.user?("sferik") Twitter.user?(7505382) # Same as above
@requires_authentication No @rate_limited Yes
Returns users that match the given query
@see dev.twitter.com/docs/api/1/get/users/search @rate_limited Yes @requires_authentication Yes @param query [String] The search query to run against people search. @param options [Hash] A customizable set of options. @option options [Integer] :per_page The number of people to retrieve. Maxiumum of 20 allowed per page. @option options [Integer] :page Specifies the page of results to retrieve. @option options [Boolean, String, Integer] :include_entities Include {dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, ‘t’ or 1. @return [Array<Twitter::User>] @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @example Return users that match "Erik Michaels-Ober"
Twitter.user_search("Erik Michaels-Ober")
Returns extended information for up to 100 users
@see dev.twitter.com/docs/api/1/get/users/lookup @rate_limited Yes @requires_authentication Yes @overload users(*users, options={})
@param users [Array<Integer, String>, Set<Integer, String>] Twitter user IDs or screen names. @param options [Hash] A customizable set of options. @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1. @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::User>] The requested users. @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @example Return extended information for @sferik and @pengwynn Twitter.users("sferik", "pengwynn") Twitter.users("sferik", 14100886) # Same as above Twitter.users(7505382, 14100886) # Same as above