Allows the authenticating user to follow the specified users, unless they are already followed
@see dev.twitter.com/docs/api/1.1/post/friendships/create @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::User>] The followed users. @overload follow(*users)
@param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects. @example Follow @sferik Twitter.follow('sferik')
@overload follow(*users, options)
@param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects. @param options [Hash] A customizable set of options. @option options [Boolean] :follow (false) Enable notifications for the target user.
# File lib/twitter/api/friends_and_followers.rb, line 130 def follow(*args) arguments = Twitter::API::Arguments.new(args) # Twitter always turns on notifications if the "follow" option is present, even if it's set to false # so only send follow if it's true arguments.options[:follow] = true if !!arguments.options.delete(:follow) existing_friends = Thread.new do friend_ids.ids end new_friends = Thread.new do users(args).map(&:id) end follow!(new_friends.value - existing_friends.value, arguments.options) end
Allows the authenticating user to follow the specified users
@see dev.twitter.com/docs/api/1.1/post/friendships/create @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::User>] The followed users. @overload follow!(*users)
@param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects. @example Follow @sferik Twitter.follow!('sferik')
@overload follow!(*users, options)
@param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects. @param options [Hash] A customizable set of options. @option options [Boolean] :follow (false) Enable notifications for the target user.
# File lib/twitter/api/friends_and_followers.rb, line 160 def follow!(*args) arguments = Twitter::API::Arguments.new(args) # Twitter always turns on notifications if the "follow" option is present, even if it's set to false # so only send follow if it's true arguments.options[:follow] = true if !!arguments.options.delete(:follow) arguments.flatten.threaded_map do |user| begin object_from_response(Twitter::User, :post, "/1.1/friendships/create.json", merge_user(arguments.options, user)) rescue Twitter::Error::Forbidden # This error will be raised if the user doesn't have permission to # follow list_member, for whatever reason. end end.compact end
@see dev.twitter.com/docs/api/1.1/get/followers/ids @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @overload follower_ids(options={})
Returns an array of numeric IDs for every user following the authenticated user @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. @example Return the authenticated user's followers' IDs Twitter.follower_ids
@overload follower_ids(user, options={})
Returns an array of numeric IDs for every user following the specified user @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param options [Hash] A customizable set of options. @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. @example Return @sferik's followers' IDs Twitter.follower_ids('sferik') Twitter.follower_ids(7505382) # Same as above
# File lib/twitter/api/friends_and_followers.rb, line 59 def follower_ids(*args) cursor_from_response_with_user(:ids, nil, :get, "/1.1/followers/ids.json", args, :follower_ids) end
Returns a cursored collection of user objects for users following the specified user.
@see dev.twitter.com/docs/api/1.1/get/followers/list @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @overload followers(options={})
Returns a cursored collection of user objects for users following the authenticated user. @param options [Hash] A customizable set of options. @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1. @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false. @example Return the authenticated user's friends' IDs Twitter.followers
@overload followers(user, options={})
Returns a cursored collection of user objects for users following the specified user. @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @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] :skip_status Do not include contributee's Tweets when set to true, 't' or 1. @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
@example Return the cursored collection of users following @sferik
Twitter.followers('sferik') Twitter.followers(7505382) # Same as above
# File lib/twitter/api/friends_and_followers.rb, line 282 def followers(*args) cursor_from_response_with_user(:users, Twitter::User, :get, "/1.1/followers/list.json", args, :followers) end
@see dev.twitter.com/docs/api/1.1/get/friends/ids @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @overload friend_ids(options={})
Returns an array of numeric IDs for every user the authenticated user is following @param options [Hash] A customizable set of options. @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. @example Return the authenticated user's friends' IDs Twitter.friend_ids
@overload friend_ids(user, options={})
Returns an array of numeric IDs for every user the specified user is following @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @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. @example Return @sferik's friends' IDs Twitter.friend_ids('sferik') Twitter.friend_ids(7505382) # Same as above
# File lib/twitter/api/friends_and_followers.rb, line 34 def friend_ids(*args) cursor_from_response_with_user(:ids, nil, :get, "/1.1/friends/ids.json", args, :friend_ids) end
Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their “friends”).
@see dev.twitter.com/docs/api/1.1/get/friendships/show @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @overload friends(options={})
Returns a cursored collection of user objects for every user the authenticated user is following (otherwise known as their "friends"). @param options [Hash] A customizable set of options. @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1. @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false. @example Return the authenticated user's friends' IDs Twitter.friends
@overload friends(user, options={})
Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends"). @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @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] :skip_status Do not include contributee's Tweets when set to true, 't' or 1. @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
@example Return the cursored collection of users @sferik is following
Twitter.friends('sferik') Twitter.friends(7505382) # Same as above
# File lib/twitter/api/friends_and_followers.rb, line 313 def friends(*args) cursor_from_response_with_user(:users, Twitter::User, :get, "/1.1/friends/list.json", args, :friends) end
Returns detailed information about the relationship between two users
@see dev.twitter.com/docs/api/1.1/get/friendships/show @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Relationship] @param source [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the source user. @param target [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the target user. @param options [Hash] A customizable set of options. @example Return the relationship between @sferik and @pengwynn
Twitter.friendship('sferik', 'pengwynn') Twitter.friendship('sferik', 14100886) # Same as above Twitter.friendship(7505382, 14100886) # Same as above
# File lib/twitter/api/friends_and_followers.rb, line 227 def friendship(source, target, options={}) merge_user!(options, source, "source") options[:source_id] = options.delete(:source_user_id) unless options[:source_user_id].nil? merge_user!(options, target, "target") options[:target_id] = options.delete(:target_user_id) unless options[:target_user_id].nil? object_from_response(Twitter::Relationship, :get, "/1.1/friendships/show.json", options) end
Test for the existence of friendship between two users
@see dev.twitter.com/docs/api/1.1/get/friendships/show @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Boolean] true if user_a follows user_b, otherwise false. @param source [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the source user. @param target [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the target user. @param options [Hash] A customizable set of options. @example Return true if @sferik follows @pengwynn
Twitter.friendship?('sferik', 'pengwynn') Twitter.friendship?('sferik', 14100886) # Same as above Twitter.friendship?(7505382, 14100886) # Same as above
# File lib/twitter/api/friends_and_followers.rb, line 251 def friendship?(source, target, options={}) friendship(source, target, options).source.following? end
Allows one to enable or disable retweets and device notifications from the specified user.
@see dev.twitter.com/docs/api/1.1/post/friendships/update @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Relationship] @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param options [Hash] A customizable set of options. @option options [Boolean] :device Enable/disable device notifications from the target user. @option options [Boolean] :retweets Enable/disable retweets from the target user. @example Enable rewteets and devise notifications for @sferik
Twitter.friendship_update('sferik', :device => true, :retweets => true)
# File lib/twitter/api/friends_and_followers.rb, line 208 def friendship_update(user, options={}) merge_user!(options, user) object_from_response(Twitter::Relationship, :post, "/1.1/friendships/update.json", options) end
Returns the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.
@see dev.twitter.com/docs/api/1.1/get/friendships/lookup @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::User>] The requested users. @overload friendships(*users)
@param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects. @example Return extended information for @sferik and @pengwynn Twitter.friendships('sferik', 'pengwynn') Twitter.friendships('sferik', 14100886) # Same as above Twitter.friendships(7505382, 14100886) # Same as above
@overload friendships(*users, options)
@param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects. @param options [Hash] A customizable set of options.
# File lib/twitter/api/friends_and_followers.rb, line 79 def friendships(*args) arguments = Twitter::API::Arguments.new(args) merge_users!(arguments.options, arguments) objects_from_response(Twitter::User, :get, "/1.1/friendships/lookup.json", arguments.options) end
Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user
@see dev.twitter.com/docs/api/1.1/get/friendships/incoming @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @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. @example Return an array of numeric IDs for every user who has a pending request to follow the authenticating user
Twitter.friendships_incoming
# File lib/twitter/api/friends_and_followers.rb, line 96 def friendships_incoming(options={}) cursor_from_response(:ids, nil, :get, "/1.1/friendships/incoming.json", options, :friendships_incoming) end
Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request
@see dev.twitter.com/docs/api/1.1/get/friendships/outgoing @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @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. @example Return an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request
Twitter.friendships_outgoing
# File lib/twitter/api/friends_and_followers.rb, line 111 def friendships_outgoing(options={}) cursor_from_response(:ids, nil, :get, "/1.1/friendships/outgoing.json", options, :friendships_outgoing) end
Returns a collection of user IDs that the currently authenticated user does not want to receive retweets from. @see dev.twitter.com/docs/api/1.1/get/friendships/no_retweets/ids @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Integer>] @param options [Hash] A customizable set of options. @example Return a collection of user IDs that the currently authenticated user does not want to receive retweets from
Twitter.no_retweet_ids
# File lib/twitter/api/friends_and_followers.rb, line 327 def no_retweet_ids(options={}) get("/1.1/friendships/no_retweets/ids.json", options)[:body].map(&:to_i) end
Allows the authenticating user to unfollow the specified users
@see dev.twitter.com/docs/api/1.1/post/friendships/destroy @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::User>] The unfollowed users. @overload unfollow(*users)
@param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects. @example Unfollow @sferik Twitter.unfollow('sferik')
@overload unfollow(*users, options)
@param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects. @param options [Hash] A customizable set of options.
# File lib/twitter/api/friends_and_followers.rb, line 190 def unfollow(*args) threaded_user_objects_from_response(:post, "/1.1/friendships/destroy.json", args) end
Generated with the Darkfish Rdoc Generator 2.