Module | Twitter::Client::User |
In: |
lib/twitter/client/user.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).
@response_format `json` @response_format `xml` @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] @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] @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).
@response_format `json` @response_format `xml` @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] @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] @example Return users who can contribute to @sferik's account Twitter.contributors("sferik") Twitter.contributors(7505382) # Same as above
@see dev.twitter.com/docs/api/1/get/statuses/followers @deprecated {Twitter::Client::User#followers} is deprecated as it will only return information about users who have Tweeted recently. It is not a functional way to retrieve all of a users followers. Instead of using this method use a combination of {Twitter::Client::FriendsAndFollowers#follower_ids} and {Twitter::Client::User#users}. @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).
@response_format `json` @response_format `xml` @overload followers(options={})
@param options [Hash] A customizable set of options. @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response object's next_cursor and previous_cursor attributes to page back and forth in the list. @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 [Hashie::Mash] @example Return the authenticated user's followers Twitter.followers
@overload followers(user, options={})
@param user [Integer, String] A Twitter user ID or screen name. @param options [Hash] A customizable set of options. @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list. @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 [Hashie::Mash] @example Return @sferik's followers Twitter.followers("sferik") Twitter.followers(7505382) # Same as above
@see dev.twitter.com/docs/api/1/get/statuses/friends @deprecated {Twitter::Client::User#friends} is deprecated as it will only return information about users who have Tweeted recently. It is not a functional way to retrieve all of a users followers. Instead of using this method use a combination of {Twitter::Client::FriendsAndFollowers#friend_ids} and {Twitter::Client::User#users}. @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).
@response_format `json` @response_format `xml` @overload friends(options={})
@param options [Hash] A customizable set of options. @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list. @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 [Hashie::Mash] @example Return the authenticated user's friends Twitter.friends
@overload friends(user, options={})
@param user [Integer, String] A Twitter user ID or screen name. @param options [Hash] A customizable set of options. @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list. @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 [Hashie::Mash] @example Return @sferik's friends Twitter.friends("sferik") Twitter.friends(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 @response_format `json` @response_format `xml` @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 @response_format `json` @response_format `xml` @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. @return [Array] @example Return recommended users for the authenticated user
Twitter.recommendations
Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user
@see dev.twitter.com/docs/api/1/get/users/suggestions/:slug/members @rate_limited Yes @requires_authentication No @response_format `json` @response_format `xml` @param slug [String] The short name of list or a category. @param options [Hash] A customizable set of options. @return [Array] @example Return the users in the Art & Design category and their most recent status if they are not a protected user
Twitter.suggest_users("art-design")
@overload suggestions(options={})
Returns the list of suggested user categories @see https://dev.twitter.com/docs/api/1/get/users/suggestions @rate_limited Yes @requires_authentication No @response_format `json` @response_format `xml` @param options [Hash] A customizable set of options. @return [Array] @example Return the list of suggested user categories Twitter.suggestions
@overload suggestions(slug, options={})
Returns the users in a given category @see https://dev.twitter.com/docs/api/1/get/users/suggestions/:slug @rate_limited Yes @requires_authentication No @response_format `json` @response_format `xml` @param slug [String] The short name of list or a category. @param options [Hash] A customizable set of options. @return [Array] @example Return the users in the Art & Design category Twitter.suggestions("art-design")
Returns extended information of a given user
@see dev.twitter.com/docs/api/1/get/users/show @rate_limited Yes @requires_authentication No @response_format `json` @response_format `xml` @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 [Hashie::Mash] 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 @response_format `json` @response_format `xml` @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] @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 @response_format `json` @response_format `xml` @overload users(*users, options={})
@param users [Integer, String] Twitter users ID 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.
@return [Array] The requested users. @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