Module | Twitter::Client::List |
In: |
lib/twitter/client/list.rb
|
Defines methods related to lists @see Twitter::Client::ListMembers @see Twitter::Client::ListSubscribers
Show the specified list
@see dev.twitter.com/docs/api/1/get/lists/show @note Private lists will only be shown if the authenticated user owns the specified list. @rate_limited Yes @requires_authentication Yes @response_format `json` @response_format `xml` @overload list(list, options={})
@param list [Integer, String] The list_id or slug of the list. @param options [Hash] A customizable set of options. @return [Hashie::Mash] The specified list. @example Show the authenticated user's "presidents" list Twitter.list("presidents") Twitter.list(8863586)
@overload list(user, list, options={})
@param user [Integer, String] A Twitter user ID or screen name. @param list [Integer, String] The list_id or slug of the list. @param options [Hash] A customizable set of options. @return [Hashie::Mash] The specified list. @example Show @sferik's "presidents" list Twitter.list("sferik", "presidents") Twitter.list("sferik", 8863586) Twitter.list(7505382, "presidents") Twitter.list(7505382, 8863586)
@return [Hashie::Mash] The specified list.
Creates a new list for the authenticated user
@see dev.twitter.com/docs/api/1/post/lists/create @note Accounts are limited to 20 lists. @rate_limited No @requires_authentication Yes @response_format `json` @response_format `xml` @overload list_create(screen_name, name, options={})
@deprecated Calling {Twitter::Client::List#list_create} with a screen_name is deprecated and will be removed in the next major version. Please omit the screen_name argument. @param screen_name [String] A Twitter user name. @param name [String] The name for the list. @param options [Hash] A customizable set of options. @option options [String] :mode ('public') Whether your list is public or private. Values can be 'public' or 'private'. @option options [String] :description The description to give the list. @example Create a list named "presidents" Twitter.list_create("sferik", "presidents")
@overload list_create(name, options={})
@param name [String] The name for the list. @param options [Hash] A customizable set of options. @option options [String] :mode ('public') Whether your list is public or private. Values can be 'public' or 'private'. @option options [String] :description The description to give the list. @example Create a list named "presidents" Twitter.list_create("presidents")
@return [Hashie::Mash] The created list.
Deletes the specified list
@see dev.twitter.com/docs/api/1/post/lists/destroy @note Must be owned by the authenticated user. @rate_limited No @requires_authentication Yes @response_format `json` @response_format `xml` @overload list_delete(list, options={})
@param list [Integer, String] The list_id or slug of the list. @param options [Hash] A customizable set of options. @return [Hashie::Mash] The deleted list. @example Delete the authenticated user's "presidents" list Twitter.list_delete("presidents") Twitter.list_delete(8863586)
@overload list_delete(user, list, options={})
@param user [Integer, String] A Twitter user ID or screen name. @param list [Integer, String] The list_id or slug of the list. @param options [Hash] A customizable set of options. @return [Hashie::Mash] The deleted list. @example Delete @sferik's "presidents" list Twitter.list_delete("sferik", "presidents") Twitter.list_delete("sferik", 8863586) Twitter.list_delete(7505382, "presidents") Twitter.list_delete(7505382, 8863586)
@return [Hashie::Mash] The deleted list.
Show tweet timeline for members of the specified list
@see dev.twitter.com/docs/api/1/get/lists/statuses @rate_limited Yes @requires_authentication No @response_format `json` @response_format `xml` @overload list_timeline(list, options={})
@param list [Integer, String] The list_id or slug of the list. @param options [Hash] A customizable set of options. @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID. @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID. @option options [Integer] :per_page The number of results to retrieve. @option options [Integer] :page Specifies the page of results to retrieve. @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] @example Show tweet timeline for members of the authenticated user's "presidents" list Twitter.list_timeline("presidents") Twitter.list_timeline(8863586)
@overload list_timeline(user, list, options={})
@param user [Integer, String] A Twitter user ID or screen name. @param list [Integer, String] The list_id or slug of the list. @param options [Hash] A customizable set of options. @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID. @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID. @option options [Integer] :per_page The number of results to retrieve. @option options [Integer] :page Specifies the page of results to retrieve. @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] @example Show tweet timeline for members of @sferik's "presidents" list Twitter.list_timeline("sferik", "presidents") Twitter.list_timeline("sferik", 8863586) Twitter.list_timeline(7505382, "presidents") Twitter.list_timeline(7505382, 8863586)
@return [Array]
Updates the specified list
@see dev.twitter.com/docs/api/1/post/lists/update @rate_limited No @requires_authentication Yes @response_format `json` @response_format `xml` @overload list_update(list, options={})
@param list [Integer, String] The list_id or slug for the list. @param options [Hash] A customizable set of options. @option options [String] :mode ('public') Whether your list is public or private. Values can be 'public' or 'private'. @option options [String] :description The description to give the list. @return [Hashie::Mash] The created list. @example Update the authenticated user's "presidents" list to have the description "Presidents of the United States of America" Twitter.list_update("presidents", :description => "Presidents of the United States of America") Twitter.list_update(8863586, :description => "Presidents of the United States of America")
@overload list_update(user, list, options={})
@param user [Integer, String] A Twitter user ID or screen name. @param list [Integer, String] The list_id or slug for the list. @param options [Hash] A customizable set of options. @option options [String] :mode ('public') Whether your list is public or private. Values can be 'public' or 'private'. @option options [String] :description The description to give the list. @return [Hashie::Mash] The created list. @example Update the @sferik's "presidents" list to have the description "Presidents of the United States of America" Twitter.list_update("sferik", "presidents", :description => "Presidents of the United States of America") Twitter.list_update(7505382, "presidents", :description => "Presidents of the United States of America") Twitter.list_update("sferik", 8863586, :description => "Presidents of the United States of America") Twitter.list_update(7505382, 8863586, :description => "Presidents of the United States of America")
@return [Hashie::Mash] The created list.
List the lists of the specified user
@see dev.twitter.com/docs/api/1/get/lists @note Private lists will be included if the authenticated user is the same as the user whose lists are being returned. @rate_limited Yes @requires_authentication Yes @response_format `json` @response_format `xml` @overload lists(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. @return [Hashie::Mash] @example List the authenticated user's lists Twitter.lists
@overload lists(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. @return [Hashie::Mash] @example List @sferik's lists Twitter.lists("sferik") Twitter.lists(7505382)
@return [Hashie::Mash]
List the lists the specified user has been added to
@see dev.twitter.com/docs/api/1/get/lists/memberships @rate_limited Yes @requires_authentication Yes @response_format `json` @response_format `xml` @overload memberships(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. @return [Array] @example List the lists the authenticated user has been added to Twitter.memberships
@overload memberships(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. @return [Array] @example List the lists that @sferik has been added to Twitter.memberships("sferik") Twitter.memberships(7505382)
@return [Array]
List the lists the specified user follows
@see dev.twitter.com/docs/api/1/get/lists/subscriptions @rate_limited Yes @requires_authentication Yes @response_format `json` @response_format `xml` @overload subscriptions(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. @return [Array] @example List the lists the authenticated user follows Twitter.subscriptions
@overload subscriptions(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. @return [Array] @example List the lists that @sferik follows Twitter.subscriptions("sferik") Twitter.subscriptions(7505382)
@return [Array]