Favorites the specified Tweets as the authenticating user
@see dev.twitter.com/docs/api/1.1/post/favorites/create @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::Tweet>] The favorited Tweets. @overload favorite(*ids)
@param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs. @example Favorite the Tweet with the ID 25938088801 Twitter.favorite(25938088801)
@overload favorite(*ids, options)
@param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs. @param options [Hash] A customizable set of options.
# File lib/twitter/api/favorites.rb, line 79 def favorite(*args) arguments = Twitter::API::Arguments.new(args) arguments.flatten.threaded_map do |id| begin object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", arguments.options.merge(:id => id)) rescue Twitter::Error::Forbidden => error raise unless error.message == Twitter::Error::AlreadyFavorited::MESSAGE end end.compact end
Favorites the specified Tweets as the authenticating user and raises an error if one has already been favorited
@see dev.twitter.com/docs/api/1.1/post/favorites/create @rate_limited No @authentication Requires user context @raise [Twitter::Error::AlreadyFavorited] Error raised when tweet has already been favorited. @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::Tweet>] The favorited Tweets. @overload favorite(*ids)
@param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs. @example Favorite the Tweet with the ID 25938088801 Twitter.favorite(25938088801)
@overload favorite(*ids, options)
@param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs. @param options [Hash] A customizable set of options.
# File lib/twitter/api/favorites.rb, line 109 def favorite!(*args) arguments = Twitter::API::Arguments.new(args) arguments.flatten.threaded_map do |id| begin object_from_response(Twitter::Tweet, :post, "/1.1/favorites/create.json", arguments.options.merge(:id => id)) rescue Twitter::Error::Forbidden => error handle_forbidden_error(Twitter::Error::AlreadyFavorited, error) end end end
@see dev.twitter.com/docs/api/1.1/get/favorites/list @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::Tweet>] favorite Tweets. @overload favorites(options={})
Returns the 20 most recent favorite Tweets for the authenticating user @param options [Hash] A customizable set of options. @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100. @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID. @example Return the 20 most recent favorite Tweets for the authenticating user Twitter.favorites
@overload favorites(user, options={})
Returns the 20 most recent favorite Tweets for 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] :count Specifies the number of records to retrieve. Must be less than or equal to 100. @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID. @example Return the 20 most recent favorite Tweets for @sferik Twitter.favorites('sferik')
# File lib/twitter/api/favorites.rb, line 35 def favorites(*args) arguments = Twitter::API::Arguments.new(args) if user = arguments.pop merge_user!(arguments.options, user) end objects_from_response(Twitter::Tweet, :get, "/1.1/favorites/list.json", arguments.options) end
Un-favorites the specified Tweets as the authenticating user
@see dev.twitter.com/docs/api/1.1/post/favorites/destroy @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::Tweet>] The un-favorited Tweets. @overload unfavorite(*ids)
@param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs. @example Un-favorite the tweet with the ID 25938088801 Twitter.unfavorite(25938088801)
@overload unfavorite(*ids, options)
@param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs. @param options [Hash] A customizable set of options.
# File lib/twitter/api/favorites.rb, line 58 def unfavorite(*args) threaded_object_from_response(Twitter::Tweet, :post, "/1.1/favorites/destroy.json", args) end
Generated with the Darkfish Rdoc Generator 2.