Show the specified list
@see dev.twitter.com/docs/api/1.1/get/lists/show @note Private lists will only be shown if the authenticated user owns the specified list. @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The specified list. @overload list(list, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param options [Hash] A customizable set of options. @example Show the authenticated user's "presidents" list Twitter.list('presidents') Twitter.list(8863586)
@overload list(user, list, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param options [Hash] A customizable set of options. @example Show @sferik's "presidents" list Twitter.list('sferik', 'presidents') Twitter.list('sferik', 8863586) Twitter.list(7505382, 'presidents') Twitter.list(7505382, 8863586)
# File lib/twitter/api/lists.rb, line 452 def list(*args) list_from_response(:get, "/1.1/lists/show.json", args) end
Add a member to a list
@see dev.twitter.com/docs/api/1.1/post/lists/members/create @note Lists are limited to having 500 members. @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The list. @overload list_add_member(list, user_to_add, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param user_to_add [Integer, String] The user id or screen name to add to the list. @param options [Hash] A customizable set of options. @example Add @BarackObama to the authenticated user's "presidents" list Twitter.list_add_member('presidents', 813286) Twitter.list_add_member(8863586, 813286)
@overload list_add_member(user, list, user_to_add, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param user_to_add [Integer, String] The user id or screen name to add to the list. @param options [Hash] A customizable set of options. @example Add @BarackObama to @sferik's "presidents" list Twitter.list_add_member('sferik', 'presidents', 813286) Twitter.list_add_member('sferik', 8863586, 813286) Twitter.list_add_member(7505382, 'presidents', 813286) Twitter.list_add_member(7505382, 8863586, 813286)
# File lib/twitter/api/lists.rb, line 350 def list_add_member(*args) list_from_response_with_user(:post, "/1.1/lists/members/create.json", args) end
Adds specified members to a list
@see dev.twitter.com/docs/api/1.1/post/lists/members/create_all @note Lists are limited to having 500 members, and you are limited to adding up to 100 members to a list at a time with this method. @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The list. @overload list_add_members(list, users, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @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. @example Add @BarackObama and @pengwynn to the authenticated user's "presidents" list Twitter.list_add_members('presidents', ['BarackObama', 'pengwynn']) Twitter.list_add_members('presidents', [813286, 18755393]) Twitter.list_add_members(8863586, ['BarackObama', 'pengwynn']) Twitter.list_add_members(8863586, [813286, 18755393])
@overload list_add_members(user, list, users, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @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. @example Add @BarackObama and @pengwynn to @sferik's "presidents" list Twitter.list_add_members('sferik', 'presidents', ['BarackObama', 'pengwynn']) Twitter.list_add_members('sferik', 'presidents', [813286, 18755393]) Twitter.list_add_members(7505382, 'presidents', ['BarackObama', 'pengwynn']) Twitter.list_add_members(7505382, 'presidents', [813286, 18755393]) Twitter.list_add_members(7505382, 8863586, ['BarackObama', 'pengwynn']) Twitter.list_add_members(7505382, 8863586, [813286, 18755393])
# File lib/twitter/api/lists.rb, line 266 def list_add_members(*args) list_from_response_with_users(:post, "/1.1/lists/members/create_all.json", args) end
Creates a new list for the authenticated user
@see dev.twitter.com/docs/api/1.1/post/lists/create @note Accounts are limited to 20 lists. @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The created list. @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')
# File lib/twitter/api/lists.rb, line 425 def list_create(name, options={}) object_from_response(Twitter::List, :post, "/1.1/lists/create.json", options.merge(:name => name)) end
Deletes the specified list
@see dev.twitter.com/docs/api/1.1/post/lists/destroy @note Must be owned by the authenticated user. @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The deleted list. @overload list_destroy(list, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param options [Hash] A customizable set of options. @example Delete the authenticated user's "presidents" list Twitter.list_destroy('presidents') Twitter.list_destroy(8863586)
@overload list_destroy(user, list, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param options [Hash] A customizable set of options. @example Delete @sferik's "presidents" list Twitter.list_destroy('sferik', 'presidents') Twitter.list_destroy('sferik', 8863586) Twitter.list_destroy(7505382, 'presidents') Twitter.list_destroy(7505382, 8863586)
# File lib/twitter/api/lists.rb, line 377 def list_destroy(*args) list_from_response(:post, "/1.1/lists/destroy.json", args) end
Check if a user is a member of the specified list
@see dev.twitter.com/docs/api/1.1/get/lists/members/show @authentication Requires user context @rate_limited Yes @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Boolean] true if user is a member of the specified list, otherwise false. @overload list_member?(list, user_to_check, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param user_to_check [Integer, String] The user ID or screen name of the list member. @param options [Hash] A customizable set of options. @example Check if @BarackObama is a member of the authenticated user's "presidents" list Twitter.list_member?('presidents', 813286) Twitter.list_member?(8863586, 'BarackObama')
@overload list_member?(user, list, user_to_check, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param user_to_check [Integer, String] The user ID or screen name of the list member. @param options [Hash] A customizable set of options. @example Check if @BarackObama is a member of @sferik's "presidents" list Twitter.list_member?('sferik', 'presidents', 813286) Twitter.list_member?('sferik', 8863586, 'BarackObama') Twitter.list_member?(7505382, 'presidents', 813286)
# File lib/twitter/api/lists.rb, line 293 def list_member?(*args) list_user?(:get, "/1.1/lists/members/show.json", args) end
Returns the members of the specified list
@see dev.twitter.com/docs/api/1.1/get/lists/members @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @overload list_members(list, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, 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 the members of the authenticated user's "presidents" list Twitter.list_members('presidents') Twitter.list_members(8863586)
@overload list_members(user, list, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, 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 the members of @sferik's "presidents" list Twitter.list_members('sferik', 'presidents') Twitter.list_members('sferik', 8863586) Twitter.list_members(7505382, 'presidents') Twitter.list_members(7505382, 8863586)
# File lib/twitter/api/lists.rb, line 321 def list_members(*args) cursor_from_response_with_list(:get, "/1.1/lists/members.json", args, :list_members) end
Removes the specified member from the list
@see dev.twitter.com/docs/api/1.1/post/lists/members/destroy @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The list. @overload list_remove_member(list, user_to_remove, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param user_to_remove [Integer, String] The user id or screen name of the list member to remove. @param options [Hash] A customizable set of options. @example Remove @BarackObama from the authenticated user's "presidents" list Twitter.list_remove_member('presidents', 813286) Twitter.list_remove_member('presidents', 'BarackObama') Twitter.list_remove_member(8863586, 'BarackObama')
@overload list_remove_member(user, list, user_to_remove, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param user_to_remove [Integer, String] The user id or screen name of the list member to remove. @param options [Hash] A customizable set of options. @example Remove @BarackObama from @sferik's "presidents" list Twitter.list_remove_member('sferik', 'presidents', 813286) Twitter.list_remove_member('sferik', 'presidents', 'BarackObama') Twitter.list_remove_member('sferik', 8863586, 'BarackObama') Twitter.list_remove_member(7505382, 'presidents', 813286)
# File lib/twitter/api/lists.rb, line 101 def list_remove_member(*args) list_from_response_with_user(:post, "/1.1/lists/members/destroy.json", args) end
Removes specified members from the list
@see dev.twitter.com/docs/api/1.1/post/lists/members/destroy_all @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The list. @overload list_remove_members(list, users, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @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. @example Remove @BarackObama and @pengwynn from the authenticated user's "presidents" list Twitter.list_remove_members('presidents', ['BarackObama', 'pengwynn']) Twitter.list_remove_members('presidents', [813286, 18755393]) Twitter.list_remove_members(8863586, ['BarackObama', 'pengwynn']) Twitter.list_remove_members(8863586, [813286, 18755393])
@overload list_remove_members(user, list, users, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @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. @example Remove @BarackObama and @pengwynn from @sferik's "presidents" list Twitter.list_remove_members('sferik', 'presidents', ['BarackObama', 'pengwynn']) Twitter.list_remove_members('sferik', 'presidents', [813286, 18755393]) Twitter.list_remove_members(7505382, 'presidents', ['BarackObama', 'pengwynn']) Twitter.list_remove_members(7505382, 'presidents', [813286, 18755393]) Twitter.list_remove_members(7505382, 8863586, ['BarackObama', 'pengwynn']) Twitter.list_remove_members(7505382, 8863586, [813286, 18755393])
# File lib/twitter/api/lists.rb, line 507 def list_remove_members(*args) list_from_response_with_users(:post, "/1.1/lists/members/destroy_all.json", args) end
Make the authenticated user follow the specified list
@see dev.twitter.com/docs/api/1.1/post/lists/subscribers/create @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The specified list. @overload list_subscribe(list, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param options [Hash] A customizable set of options. @example Subscribe to the authenticated user's "presidents" list Twitter.list_subscribe('presidents') Twitter.list_subscribe(8863586)
@overload list_subscribe(user, list, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param options [Hash] A customizable set of options. @example Subscribe to @sferik's "presidents" list Twitter.list_subscribe('sferik', 'presidents') Twitter.list_subscribe('sferik', 8863586) Twitter.list_subscribe(7505382, 'presidents')
# File lib/twitter/api/lists.rb, line 178 def list_subscribe(*args) list_from_response(:post, "/1.1/lists/subscribers/create.json", args) end
Check if a user is a subscriber of the specified list
@see dev.twitter.com/docs/api/1.1/get/lists/subscribers/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 is a subscriber of the specified list, otherwise false. @overload list_subscriber?(list, user_to_check, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param user_to_check [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param options [Hash] A customizable set of options. @example Check if @BarackObama is a subscriber of the authenticated user's "presidents" list Twitter.list_subscriber?('presidents', 813286) Twitter.list_subscriber?(8863586, 813286) Twitter.list_subscriber?('presidents', 'BarackObama')
@overload list_subscriber?(user, list, user_to_check, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param user_to_check [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param options [Hash] A customizable set of options. @example Check if @BarackObama is a subscriber of @sferik's "presidents" list Twitter.list_subscriber?('sferik', 'presidents', 813286) Twitter.list_subscriber?('sferik', 8863586, 813286) Twitter.list_subscriber?(7505382, 'presidents', 813286) Twitter.list_subscriber?('sferik', 'presidents', 'BarackObama')
@return [Boolean] true if user is a subscriber of the specified list, otherwise false.
# File lib/twitter/api/lists.rb, line 208 def list_subscriber?(*args) list_user?(:get, "/1.1/lists/subscribers/show.json", args) end
Returns the subscribers of the specified list
@see dev.twitter.com/docs/api/1.1/get/lists/subscribers @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] The subscribers of the specified list. @overload list_subscribers(list, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, 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 the subscribers of the authenticated user's "presidents" list Twitter.list_subscribers('presidents') Twitter.list_subscribers(8863586)
@overload list_subscribers(user, list, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, 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 the subscribers of @sferik's "presidents" list Twitter.list_subscribers('sferik', 'presidents') Twitter.list_subscribers('sferik', 8863586) Twitter.list_subscribers(7505382, 'presidents')
# File lib/twitter/api/lists.rb, line 153 def list_subscribers(*args) cursor_from_response_with_list(:get, "/1.1/lists/subscribers.json", args, :list_subscribers) end
Show tweet timeline for members of the specified list
@see dev.twitter.com/docs/api/1.1/get/lists/statuses @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::Tweet>] @overload list_timeline(list, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @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] :count The number of results to retrieve. @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, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @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] :count The number of results to retrieve. @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)
# File lib/twitter/api/lists.rb, line 69 def list_timeline(*args) arguments = Twitter::API::Arguments.new(args) merge_list!(arguments.options, arguments.pop) merge_owner!(arguments.options, arguments.pop) objects_from_response(Twitter::Tweet, :get, "/1.1/lists/statuses.json", arguments.options) end
Unsubscribes the authenticated user form the specified list
@see dev.twitter.com/docs/api/1.1/post/lists/subscribers/destroy @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The specified list. @overload list_unsubscribe(list, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param options [Hash] A customizable set of options. @example Unsubscribe from the authenticated user's "presidents" list Twitter.list_unsubscribe('presidents') Twitter.list_unsubscribe(8863586)
@overload list_unsubscribe(user, list, options={})
@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @param options [Hash] A customizable set of options. @example Unsubscribe from @sferik's "presidents" list Twitter.list_unsubscribe('sferik', 'presidents') Twitter.list_unsubscribe('sferik', 8863586) Twitter.list_unsubscribe(7505382, 'presidents')
# File lib/twitter/api/lists.rb, line 233 def list_unsubscribe(*args) list_from_response(:post, "/1.1/lists/subscribers/destroy.json", args) end
Updates the specified list
@see dev.twitter.com/docs/api/1.1/post/lists/update @rate_limited No @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::List] The created list. @overload list_update(list, options={})
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @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 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, Twitter::User] A Twitter user ID, screen name, or object. @param list [Integer, String, Twitter::List] A Twitter list ID, slug, or object. @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 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")
# File lib/twitter/api/lists.rb, line 407 def list_update(*args) list_from_response(:post, "/1.1/lists/update.json", args) end
Returns all lists the authenticating or specified user subscribes to, including their own
@see dev.twitter.com/docs/api/1.1/get/lists/list @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::List>] @overload lists(options={})
@param options [Hash] A customizable set of options. @option options [Boolean] :reverse Set this to true if you would like owned lists to be returned first. @example Return all lists the authenticating user subscribes to Twitter.lists
@overload lists(user, options={})
@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] :reverse Set this to true if you would like owned lists to be returned first. @example Return all lists that @sferik subscribes to Twitter.lists('sferik') Twitter.lists(7505382)
# File lib/twitter/api/lists.rb, line 36 def lists(*args) objects_from_response_with_user(Twitter::List, :get, "/1.1/lists/list.json", args) end
Returns the lists owned by the specified Twitter user
@see dev.twitter.com/docs/api/1.1/get/lists/ownerships @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::List>] @overload lists_owned(options={})
@param options [Hash] A customizable set of options. @option options [Integer] :count The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page. @example Return all lists the authenticating user owns Twitter.lists_owend
@overload lists_owned(user, options={})
@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 The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page. @example Return all lists that @sferik owns Twitter.lists_owned('sferik') Twitter.lists_owned(7505382)
# File lib/twitter/api/lists.rb, line 530 def lists_owned(*args) cursor_from_response_with_user(:lists, Twitter::List, :get, "/1.1/lists/ownerships.json", args, :lists_owned) end
List the lists the specified user has been added to
@see dev.twitter.com/docs/api/1.1/get/lists/memberships @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @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. @option options [Boolean, String, Integer] :filter_to_owned_lists When set to true, t or 1, will return just lists the authenticating user owns, and the user represented by user_id or screen_name is a member of. @example List the lists the authenticated user has been added to Twitter.memberships
@overload memberships(user, options={})
@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] :filter_to_owned_lists When set to true, t or 1, will return just lists the authenticating user owns, and the user represented by user_id or screen_name is a member of. @example List the lists that @sferik has been added to Twitter.memberships('sferik') Twitter.memberships(7505382)
# File lib/twitter/api/lists.rb, line 126 def memberships(*args) cursor_from_response_with_user(:lists, Twitter::List, :get, "/1.1/lists/memberships.json", args, :memberships) end
List the lists the specified user follows
@see dev.twitter.com/docs/api/1.1/get/lists/subscriptions @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Cursor] @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. @example List the lists the authenticated user follows Twitter.subscriptions
@overload subscriptions(user, options={})
@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 List the lists that @sferik follows Twitter.subscriptions('sferik') Twitter.subscriptions(7505382)
# File lib/twitter/api/lists.rb, line 475 def subscriptions(*args) cursor_from_response_with_user(:lists, Twitter::List, :get, "/1.1/lists/subscriptions.json", args, :subscriptions) end
Generated with the Darkfish Rdoc Generator 2.