Method: Twitter::REST::Lists#list

Defined in:

lib/twitter/rest/lists.rb

#list(list, options = {}) ⇒ Twitter::List #list(user, list, options = {}) ⇒ Twitter::List

Note:

Private lists are only shown if the authenticated user owns them.

Shows the specified list

Examples:

client.list('twitter-engineering')

Overloads:

• #list(list, options = {}) ⇒ Twitter::List

  Parameters:

  • list (Integer, String, Twitter::List) —

    A Twitter list ID, slug, URI, or object.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

• #list(user, list, options = {}) ⇒ Twitter::List

  Parameters:

  • user (Integer, String, Twitter::User) —

    A Twitter user ID, screen name, URI, or object.

  • list (Integer, String, Twitter::List) —

    A Twitter list ID, slug, URI, or object.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Returns:

• (Twitter::List) —

  The specified list.

Raises:

• (Twitter::Error::NotFound) —

  Error raised when supplied list is not found.

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/lists/show

# File 'lib/twitter/rest/lists.rb', line 400

def list(*args)
  list_from_response(:get, "/1.1/lists/show.json", args)
end