Module Twitter::REST::Favorites
In: lib/twitter/rest/favorites.rb

Methods

Included Modules

Twitter::REST::Utils Twitter::Utils

Public Instance methods

create_favorite!(*args)

Alias for favorite!

destroy_favorite(*args)

Alias for unfavorite

fav(*args)

Alias for favorite

fav!(*args)

Alias for favorite!

fave(*args)

Alias for favorite

fave!(*args)

Alias for favorite!

Favorites the specified Tweets as the authenticating user

@see dev.twitter.com/rest/reference/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(*tweets)

  @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.

@overload favorite(*tweets, options)

  @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
  @param options [Hash] A customizable set of options.

Favorites the specified Tweets as the authenticating user and raises an error if one has already been favorited

@see dev.twitter.com/rest/reference/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::NotFound] Error raised when tweet does not exist or has been deleted. @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::Tweet>] The favorited Tweets. @overload favorite!(*tweets)

  @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.

@overload favorite!(*tweets, options)

  @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
  @param options [Hash] A customizable set of options.

@see dev.twitter.com/rest/reference/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.

@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, URI, 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.

Un-favorites the specified Tweets as the authenticating user

@see dev.twitter.com/rest/reference/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(*tweets)

  @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.

@overload unfavorite(*tweets, options)

  @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
  @param options [Hash] A customizable set of options.

[Validate]