1464 lines
62 KiB
HTML
1464 lines
62 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
<head>
|
||
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
||
|
||
<title>Module: Twitter::REST::Lists</title>
|
||
|
||
<link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
|
||
|
||
<script src="../../js/jquery.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
|
||
<script src="../../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
|
||
|
||
</head>
|
||
<body id="top" class="module">
|
||
|
||
<div id="metadata">
|
||
<div id="home-metadata">
|
||
<div id="home-section" class="section">
|
||
<h3 class="section-header">
|
||
<a href="../../index.html">Home</a>
|
||
<a href="../../index.html#classes">Classes</a>
|
||
<a href="../../index.html#methods">Methods</a>
|
||
</h3>
|
||
</div>
|
||
</div>
|
||
|
||
<div id="file-metadata">
|
||
<div id="file-list-section" class="section">
|
||
<h3 class="section-header">In Files</h3>
|
||
<div class="section-body">
|
||
<ul>
|
||
|
||
<li><a href="../../lib/twitter/rest/lists_rb.html?TB_iframe=true&height=550&width=785"
|
||
class="thickbox" title="lib/twitter/rest/lists.rb">lib/twitter/rest/lists.rb</a></li>
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div id="class-metadata">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!-- Method Quickref -->
|
||
<div id="method-list-section" class="section">
|
||
<h3 class="section-header">Methods</h3>
|
||
<ul class="link-list">
|
||
|
||
<li><a href="#method-i-add_list_member">#add_list_member</a></li>
|
||
|
||
<li><a href="#method-i-add_list_members">#add_list_members</a></li>
|
||
|
||
<li><a href="#method-i-create_list">#create_list</a></li>
|
||
|
||
<li><a href="#method-i-destroy_list">#destroy_list</a></li>
|
||
|
||
<li><a href="#method-i-list">#list</a></li>
|
||
|
||
<li><a href="#method-i-list_member-3F">#list_member?</a></li>
|
||
|
||
<li><a href="#method-i-list_members">#list_members</a></li>
|
||
|
||
<li><a href="#method-i-list_subscribe">#list_subscribe</a></li>
|
||
|
||
<li><a href="#method-i-list_subscriber-3F">#list_subscriber?</a></li>
|
||
|
||
<li><a href="#method-i-list_subscribers">#list_subscribers</a></li>
|
||
|
||
<li><a href="#method-i-list_timeline">#list_timeline</a></li>
|
||
|
||
<li><a href="#method-i-list_unsubscribe">#list_unsubscribe</a></li>
|
||
|
||
<li><a href="#method-i-list_update">#list_update</a></li>
|
||
|
||
<li><a href="#method-i-lists">#lists</a></li>
|
||
|
||
<li><a href="#method-i-lists_subscribed_to">#lists_subscribed_to</a></li>
|
||
|
||
<li><a href="#method-i-memberships">#memberships</a></li>
|
||
|
||
<li><a href="#method-i-owned_lists">#owned_lists</a></li>
|
||
|
||
<li><a href="#method-i-remove_list_member">#remove_list_member</a></li>
|
||
|
||
<li><a href="#method-i-remove_list_members">#remove_list_members</a></li>
|
||
|
||
<li><a href="#method-i-subscriptions">#subscriptions</a></li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
<!-- Included Modules -->
|
||
<div id="includes-section" class="section">
|
||
<h3 class="section-header">Included Modules</h3>
|
||
<ul class="link-list">
|
||
|
||
|
||
<li><a class="include" href="Utils.html">Twitter::REST::Utils</a></li>
|
||
|
||
|
||
|
||
<li><a class="include" href="../Utils.html">Twitter::Utils</a></li>
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div id="project-metadata">
|
||
|
||
|
||
|
||
<div id="classindex-section" class="section project-section">
|
||
<h3 class="section-header">Class/Module Index
|
||
<span class="search-toggle"><img src="../../images/find.png"
|
||
height="16" width="16" alt="[+]"
|
||
title="show/hide quicksearch" /></span></h3>
|
||
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
||
<fieldset>
|
||
<legend>Quicksearch</legend>
|
||
<input type="text" name="quicksearch" value=""
|
||
class="quicksearch-field" />
|
||
</fieldset>
|
||
</form>
|
||
|
||
<ul class="link-list">
|
||
|
||
<li><a href="../../Twitter.html">Twitter</a></li>
|
||
|
||
<li><a href="../../Twitter/Arguments.html">Twitter::Arguments</a></li>
|
||
|
||
<li><a href="../../Twitter/Base.html">Twitter::Base</a></li>
|
||
|
||
<li><a href="../../Twitter/BasicUser.html">Twitter::BasicUser</a></li>
|
||
|
||
<li><a href="../../Twitter/Client.html">Twitter::Client</a></li>
|
||
|
||
<li><a href="../../Twitter/Configuration.html">Twitter::Configuration</a></li>
|
||
|
||
<li><a href="../../Twitter/Creatable.html">Twitter::Creatable</a></li>
|
||
|
||
<li><a href="../../Twitter/Cursor.html">Twitter::Cursor</a></li>
|
||
|
||
<li><a href="../../Twitter/DirectMessage.html">Twitter::DirectMessage</a></li>
|
||
|
||
<li><a href="../../Twitter/Entities.html">Twitter::Entities</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity.html">Twitter::Entity</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/Hashtag.html">Twitter::Entity::Hashtag</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/Symbol.html">Twitter::Entity::Symbol</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/URI.html">Twitter::Entity::URI</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/URI.html">Twitter::Entity::URL</a></li>
|
||
|
||
<li><a href="../../Twitter/Entity/UserMention.html">Twitter::Entity::UserMention</a></li>
|
||
|
||
<li><a href="../../Twitter/Enumerable.html">Twitter::Enumerable</a></li>
|
||
|
||
<li><a href="../../Twitter/Error.html">Twitter::Error</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/AlreadyFavorited.html">Twitter::Error::AlreadyFavorited</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/AlreadyRetweeted.html">Twitter::Error::AlreadyRetweeted</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/BadGateway.html">Twitter::Error::BadGateway</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/BadRequest.html">Twitter::Error::BadRequest</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/ClientError.html">Twitter::Error::ClientError</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/Code.html">Twitter::Error::Code</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/ConfigurationError.html">Twitter::Error::ConfigurationError</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/DuplicateStatus.html">Twitter::Error::DuplicateStatus</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/Forbidden.html">Twitter::Error::Forbidden</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/GatewayTimeout.html">Twitter::Error::GatewayTimeout</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/InternalServerError.html">Twitter::Error::InternalServerError</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/NotAcceptable.html">Twitter::Error::NotAcceptable</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/NotFound.html">Twitter::Error::NotFound</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/RequestTimeout.html">Twitter::Error::RequestTimeout</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/ServerError.html">Twitter::Error::ServerError</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/ServiceUnavailable.html">Twitter::Error::ServiceUnavailable</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/TooManyRequests.html">Twitter::Error::TooManyRequests</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/UnacceptableIO.html">Twitter::Error::UnacceptableIO</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/Unauthorized.html">Twitter::Error::Unauthorized</a></li>
|
||
|
||
<li><a href="../../Twitter/Error/UnprocessableEntity.html">Twitter::Error::UnprocessableEntity</a></li>
|
||
|
||
<li><a href="../../Twitter/Factory.html">Twitter::Factory</a></li>
|
||
|
||
<li><a href="../../Twitter/Geo.html">Twitter::Geo</a></li>
|
||
|
||
<li><a href="../../Twitter/Geo/Point.html">Twitter::Geo::Point</a></li>
|
||
|
||
<li><a href="../../Twitter/Geo/Polygon.html">Twitter::Geo::Polygon</a></li>
|
||
|
||
<li><a href="../../Twitter/GeoFactory.html">Twitter::GeoFactory</a></li>
|
||
|
||
<li><a href="../../Twitter/GeoResults.html">Twitter::GeoResults</a></li>
|
||
|
||
<li><a href="../../Twitter/Identity.html">Twitter::Identity</a></li>
|
||
|
||
<li><a href="../../Twitter/Language.html">Twitter::Language</a></li>
|
||
|
||
<li><a href="../../Twitter/List.html">Twitter::List</a></li>
|
||
|
||
<li><a href="../../Twitter/Media.html">Twitter::Media</a></li>
|
||
|
||
<li><a href="../../Twitter/Media/Photo.html">Twitter::Media::Photo</a></li>
|
||
|
||
<li><a href="../../Twitter/MediaFactory.html">Twitter::MediaFactory</a></li>
|
||
|
||
<li><a href="../../Twitter/Metadata.html">Twitter::Metadata</a></li>
|
||
|
||
<li><a href="../../Twitter/OEmbed.html">Twitter::OEmbed</a></li>
|
||
|
||
<li><a href="../../Twitter/Place.html">Twitter::Place</a></li>
|
||
|
||
<li><a href="../../Twitter/Profile.html">Twitter::Profile</a></li>
|
||
|
||
<li><a href="../../Twitter/ProfileBanner.html">Twitter::ProfileBanner</a></li>
|
||
|
||
<li><a href="../../Twitter/REST.html">Twitter::REST</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/API.html">Twitter::REST::API</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Client.html">Twitter::REST::Client</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/DirectMessages.html">Twitter::REST::DirectMessages</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Favorites.html">Twitter::REST::Favorites</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/FriendsAndFollowers.html">Twitter::REST::FriendsAndFollowers</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Help.html">Twitter::REST::Help</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Lists.html">Twitter::REST::Lists</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Media.html">Twitter::REST::Media</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/OAuth.html">Twitter::REST::OAuth</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/PlacesAndGeo.html">Twitter::REST::PlacesAndGeo</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Request.html">Twitter::REST::Request</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Request/MultipartWithFile.html">Twitter::REST::Request::MultipartWithFile</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Response.html">Twitter::REST::Response</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Response/ParseErrorJson.html">Twitter::REST::Response::ParseErrorJson</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Response/ParseJson.html">Twitter::REST::Response::ParseJson</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Response/RaiseError.html">Twitter::REST::Response::RaiseError</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/SavedSearches.html">Twitter::REST::SavedSearches</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Search.html">Twitter::REST::Search</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/SpamReporting.html">Twitter::REST::SpamReporting</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/SuggestedUsers.html">Twitter::REST::SuggestedUsers</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Timelines.html">Twitter::REST::Timelines</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Trends.html">Twitter::REST::Trends</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Tweets.html">Twitter::REST::Tweets</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Undocumented.html">Twitter::REST::Undocumented</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Users.html">Twitter::REST::Users</a></li>
|
||
|
||
<li><a href="../../Twitter/REST/Utils.html">Twitter::REST::Utils</a></li>
|
||
|
||
<li><a href="../../Twitter/RateLimit.html">Twitter::RateLimit</a></li>
|
||
|
||
<li><a href="../../Twitter/Relationship.html">Twitter::Relationship</a></li>
|
||
|
||
<li><a href="../../Twitter/Request.html">Twitter::Request</a></li>
|
||
|
||
<li><a href="../../Twitter/SavedSearch.html">Twitter::SavedSearch</a></li>
|
||
|
||
<li><a href="../../Twitter/SearchResults.html">Twitter::SearchResults</a></li>
|
||
|
||
<li><a href="../../Twitter/Settings.html">Twitter::Settings</a></li>
|
||
|
||
<li><a href="../../Twitter/Size.html">Twitter::Size</a></li>
|
||
|
||
<li><a href="../../Twitter/SourceUser.html">Twitter::SourceUser</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming.html">Twitter::Streaming</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/Client.html">Twitter::Streaming::Client</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/Connection.html">Twitter::Streaming::Connection</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/DeletedTweet.html">Twitter::Streaming::DeletedTweet</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/Event.html">Twitter::Streaming::Event</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/FriendList.html">Twitter::Streaming::FriendList</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/MessageParser.html">Twitter::Streaming::MessageParser</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/Response.html">Twitter::Streaming::Response</a></li>
|
||
|
||
<li><a href="../../Twitter/Streaming/StallWarning.html">Twitter::Streaming::StallWarning</a></li>
|
||
|
||
<li><a href="../../Twitter/Suggestion.html">Twitter::Suggestion</a></li>
|
||
|
||
<li><a href="../../Twitter/TargetUser.html">Twitter::TargetUser</a></li>
|
||
|
||
<li><a href="../../Twitter/Token.html">Twitter::Token</a></li>
|
||
|
||
<li><a href="../../Twitter/Trend.html">Twitter::Trend</a></li>
|
||
|
||
<li><a href="../../Twitter/TrendResults.html">Twitter::TrendResults</a></li>
|
||
|
||
<li><a href="../../Twitter/Tweet.html">Twitter::Tweet</a></li>
|
||
|
||
<li><a href="../../Twitter/User.html">Twitter::User</a></li>
|
||
|
||
<li><a href="../../Twitter/Utils.html">Twitter::Utils</a></li>
|
||
|
||
<li><a href="../../Twitter/Utils/ClassMethods.html">Twitter::Utils::ClassMethods</a></li>
|
||
|
||
<li><a href="../../Twitter/Version.html">Twitter::Version</a></li>
|
||
|
||
</ul>
|
||
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="documentation">
|
||
<h1 class="module">Twitter::REST::Lists</h1>
|
||
|
||
<div id="description" class="description">
|
||
|
||
</div><!-- description -->
|
||
|
||
|
||
|
||
|
||
<div id="5Buntitled-5D" class="documentation-section">
|
||
|
||
|
||
|
||
|
||
|
||
<!-- Constants -->
|
||
<div id="constants-list" class="section">
|
||
<h3 class="section-header">Constants</h3>
|
||
<dl>
|
||
|
||
<dt><a name="MAX_USERS_PER_REQUEST">MAX_USERS_PER_REQUEST</a></dt>
|
||
|
||
<dd class="description"></dd>
|
||
|
||
|
||
<dt><a name="URI_SUBSTRING">URI_SUBSTRING</a></dt>
|
||
|
||
<dd class="description"></dd>
|
||
|
||
|
||
</dl>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<!-- Methods -->
|
||
|
||
<div id="public-instance-method-details" class="method-section section">
|
||
<h3 class="section-header">Public Instance Methods</h3>
|
||
|
||
|
||
<div id="add_list_member-method" class="method-detail ">
|
||
<a name="method-i-add_list_member"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">add_list_member</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Add a member to a list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/members/create">dev.twitter.com/docs/api/1.1/post/lists/members/create</a>
|
||
@note <a href="Lists.html">Lists</a> are limited to having 500 members.
|
||
@rate_limited No @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::List] The
|
||
list. @overload <a
|
||
href="Lists.html#method-i-add_list_member">add_list_member</a>(list,
|
||
user_to_add, options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
<p>@overload <a
|
||
href="Lists.html#method-i-add_list_member">add_list_member</a>(user, list,
|
||
user_to_add, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="add_list_member-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 258</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_list_member</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response_with_user</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/members/create.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- add_list_member-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- add_list_member-method -->
|
||
|
||
|
||
<div id="add_list_members-method" class="method-detail ">
|
||
<a name="method-i-add_list_members"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">add_list_members</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Adds specified members to a list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/members/create_all">dev.twitter.com/docs/api/1.1/post/lists/members/create_all</a>
|
||
@note <a href="Lists.html">Lists</a> 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] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::List] The
|
||
list. @overload <a
|
||
href="Lists.html#method-i-add_list_members">add_list_members</a>(list,
|
||
users, options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload <a
|
||
href="Lists.html#method-i-add_list_members">add_list_members</a>(user,
|
||
list, users, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="add_list_members-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 198</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_list_members</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response_with_users</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/members/create_all.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- add_list_members-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- add_list_members-method -->
|
||
|
||
|
||
<div id="create_list-method" class="method-detail ">
|
||
<a name="method-i-create_list"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">create_list</span><span
|
||
class="method-args">(name, options = {})</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Creates a new list for the authenticated user</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/create">dev.twitter.com/docs/api/1.1/post/lists/create</a>
|
||
@note Accounts are limited to 20 lists. @rate_limited No @authentication
|
||
Requires user context @raise [Twitter::Error::Unauthorized] <a
|
||
href="../Error.html">Error</a> 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.</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="create_list-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 317</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_list</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
|
||
<span class="ruby-identifier">perform_with_object</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/create.json'</span>, <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>), <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">List</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- create_list-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- create_list-method -->
|
||
|
||
|
||
<div id="destroy_list-method" class="method-detail ">
|
||
<a name="method-i-destroy_list"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">destroy_list</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Deletes the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/destroy">dev.twitter.com/docs/api/1.1/post/lists/destroy</a>
|
||
@note Must be owned by the authenticated user. @rate_limited No
|
||
@authentication Requires user context @raise [Twitter::Error::Unauthorized]
|
||
<a href="../Error.html">Error</a> raised when supplied user credentials are
|
||
not valid. @return [Twitter::List] The deleted list. @overload <a
|
||
href="Lists.html#method-i-destroy_list">destroy_list</a>(list, options =
|
||
{})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload <a href="Lists.html#method-i-destroy_list">destroy_list</a>(user,
|
||
list, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="destroy_list-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 278</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy_list</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/destroy.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- destroy_list-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- destroy_list-method -->
|
||
|
||
|
||
<div id="list-method" class="method-detail ">
|
||
<a name="method-i-list"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Show the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/show">dev.twitter.com/docs/api/1.1/get/lists/show</a>
|
||
@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] <a href="../Error.html">Error</a>
|
||
raised when supplied user credentials are not valid. @return
|
||
[Twitter::List] The specified list. @overload list(list, options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload list(user, list, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 337</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/show.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list-method -->
|
||
|
||
|
||
<div id="list_member-3F-method" class="method-detail ">
|
||
<a name="method-i-list_member-3F"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list_member?</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Check if a user is a member of the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/members/show">dev.twitter.com/docs/api/1.1/get/lists/members/show</a>
|
||
@authentication Requires user context @rate_limited Yes @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> 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 = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
<p>@overload list_member?(user, list, user_to_check, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list_member-3F-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 219</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list_member?</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_user?</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/members/show.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list_member-3F-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list_member-3F-method -->
|
||
|
||
|
||
<div id="list_members-method" class="method-detail ">
|
||
<a name="method-i-list_members"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list_members</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the members of the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/members">dev.twitter.com/docs/api/1.1/get/lists/members</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::Cursor]
|
||
@overload <a href="Lists.html#method-i-list_members">list_members</a>(list,
|
||
options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload <a href="Lists.html#method-i-list_members">list_members</a>(user,
|
||
list, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list_members-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 237</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list_members</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">cursor_from_response_with_list</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/members.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list_members-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list_members-method -->
|
||
|
||
|
||
<div id="list_subscribe-method" class="method-detail ">
|
||
<a name="method-i-list_subscribe"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list_subscribe</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Make the authenticated user follow the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/subscribers/create">dev.twitter.com/docs/api/1.1/post/lists/subscribers/create</a>
|
||
@rate_limited No @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::List] The
|
||
specified list. @overload <a
|
||
href="Lists.html#method-i-list_subscribe">list_subscribe</a>(list, options
|
||
= {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload <a
|
||
href="Lists.html#method-i-list_subscribe">list_subscribe</a>(user, list,
|
||
options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list_subscribe-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 138</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list_subscribe</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/subscribers/create.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list_subscribe-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list_subscribe-method -->
|
||
|
||
|
||
<div id="list_subscriber-3F-method" class="method-detail ">
|
||
<a name="method-i-list_subscriber-3F"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list_subscriber?</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Check if a user is a subscriber of the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/subscribers/show">dev.twitter.com/docs/api/1.1/get/lists/subscribers/show</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> 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 = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param user_to_check [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload list_subscriber?(user, list, user_to_check, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param user_to_check [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@return [Boolean] true if user is a subscriber of the specified list,
|
||
otherwise false.</p>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list_subscriber-3F-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 159</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list_subscriber?</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_user?</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/subscribers/show.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list_subscriber-3F-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list_subscriber-3F-method -->
|
||
|
||
|
||
<div id="list_subscribers-method" class="method-detail ">
|
||
<a name="method-i-list_subscribers"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list_subscribers</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the subscribers of the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/subscribers">dev.twitter.com/docs/api/1.1/get/lists/subscribers</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::Cursor] The
|
||
subscribers of the specified list. @overload <a
|
||
href="Lists.html#method-i-list_subscribers">list_subscribers</a>(list,
|
||
options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload <a
|
||
href="Lists.html#method-i-list_subscribers">list_subscribers</a>(user,
|
||
list, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list_subscribers-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 120</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list_subscribers</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">cursor_from_response_with_list</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/subscribers.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list_subscribers-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list_subscribers-method -->
|
||
|
||
|
||
<div id="list_timeline-method" class="method-detail ">
|
||
<a name="method-i-list_timeline"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list_timeline</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Show tweet timeline for members of the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/statuses">dev.twitter.com/docs/api/1.1/get/lists/statuses</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return
|
||
[Array<Twitter::Tweet>] @overload <a
|
||
href="Lists.html#method-i-list_timeline">list_timeline</a>(list, options =
|
||
{})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
<p>@overload <a
|
||
href="Lists.html#method-i-list_timeline">list_timeline</a>(user, list,
|
||
options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list_timeline-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 58</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list_timeline</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">arguments</span> = <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Arguments</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">merge_list!</span>(<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">options</span>, <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">pop</span>)
|
||
<span class="ruby-identifier">merge_owner!</span>(<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">options</span>, <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">pop</span>)
|
||
<span class="ruby-identifier">perform_with_objects</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/statuses.json'</span>, <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">options</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">Tweet</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list_timeline-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list_timeline-method -->
|
||
|
||
|
||
<div id="list_unsubscribe-method" class="method-detail ">
|
||
<a name="method-i-list_unsubscribe"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list_unsubscribe</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Unsubscribes the authenticated user form the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/subscribers/destroy">dev.twitter.com/docs/api/1.1/post/lists/subscribers/destroy</a>
|
||
@rate_limited No @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::List] The
|
||
specified list. @overload <a
|
||
href="Lists.html#method-i-list_unsubscribe">list_unsubscribe</a>(list,
|
||
options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload <a
|
||
href="Lists.html#method-i-list_unsubscribe">list_unsubscribe</a>(user,
|
||
list, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list_unsubscribe-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 177</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list_unsubscribe</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/subscribers/destroy.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list_unsubscribe-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list_unsubscribe-method -->
|
||
|
||
|
||
<div id="list_update-method" class="method-detail ">
|
||
<a name="method-i-list_update"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">list_update</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Updates the specified list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/update">dev.twitter.com/docs/api/1.1/post/lists/update</a>
|
||
@rate_limited No @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::List] The
|
||
created list. @overload <a
|
||
href="Lists.html#method-i-list_update">list_update</a>(list, options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
<p>@overload <a href="Lists.html#method-i-list_update">list_update</a>(user,
|
||
list, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="list_update-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 301</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list_update</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/update.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- list_update-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- list_update-method -->
|
||
|
||
|
||
<div id="lists-method" class="method-detail ">
|
||
<a name="method-i-lists"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">lists</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns all lists the authenticating or specified user subscribes to,
|
||
including their own</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/list">dev.twitter.com/docs/api/1.1/get/lists/list</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return
|
||
[Array<Twitter::List>] @overload lists(options = {})</p>
|
||
|
||
<pre>@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.</pre>
|
||
|
||
<p>@overload lists(user, options = {})</p>
|
||
|
||
<pre>@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 [Boolean] :reverse Set this to true if you would like owned lists to be returned first.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="lists-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 33</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">lists</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">objects_from_response_with_user</span>(<span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">List</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/list.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- lists-source -->
|
||
|
||
</div>
|
||
|
||
|
||
<div class="aliases">
|
||
Also aliased as: <a href="Lists.html#method-i-lists_subscribed_to">lists_subscribed_to</a>
|
||
</div>
|
||
|
||
|
||
|
||
</div><!-- lists-method -->
|
||
|
||
|
||
<div id="lists_subscribed_to-method" class="method-detail method-alias">
|
||
<a name="method-i-lists_subscribed_to"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">lists_subscribed_to</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="aliases">
|
||
Alias for: <a href="Lists.html#method-i-lists">lists</a>
|
||
</div>
|
||
|
||
</div><!-- lists_subscribed_to-method -->
|
||
|
||
|
||
<div id="memberships-method" class="method-detail ">
|
||
<a name="method-i-memberships"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">memberships</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p><a href="../List.html">List</a> the lists the specified user has been added
|
||
to</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/memberships">dev.twitter.com/docs/api/1.1/get/lists/memberships</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::Cursor]
|
||
@overload memberships(options = {})</p>
|
||
|
||
<pre>@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.
|
||
@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.</pre>
|
||
|
||
<p>@overload memberships(user, options = {})</p>
|
||
|
||
<pre>@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 The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.
|
||
@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.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="memberships-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 102</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">memberships</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">cursor_from_response_with_user</span>(<span class="ruby-value">:lists</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">List</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/memberships.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- memberships-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- memberships-method -->
|
||
|
||
|
||
<div id="owned_lists-method" class="method-detail ">
|
||
<a name="method-i-owned_lists"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">owned_lists</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Returns the lists owned by the specified <a
|
||
href="../../Twitter.html">Twitter</a> user</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/ownerships">dev.twitter.com/docs/api/1.1/get/lists/ownerships</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return
|
||
[Array<Twitter::List>] @overload <a
|
||
href="Lists.html#method-i-owned_lists">owned_lists</a>(options = {})</p>
|
||
|
||
<pre>@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.</pre>
|
||
|
||
<p>@overload <a href="Lists.html#method-i-owned_lists">owned_lists</a>(user,
|
||
options = {})</p>
|
||
|
||
<pre>@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 The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="owned_lists-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 392</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">owned_lists</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">cursor_from_response_with_user</span>(<span class="ruby-value">:lists</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">List</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/ownerships.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- owned_lists-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- owned_lists-method -->
|
||
|
||
|
||
<div id="remove_list_member-method" class="method-detail ">
|
||
<a name="method-i-remove_list_member"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">remove_list_member</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Removes the specified member from the list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/members/destroy">dev.twitter.com/docs/api/1.1/post/lists/members/destroy</a>
|
||
@rate_limited No @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::List] The
|
||
list. @overload <a
|
||
href="Lists.html#method-i-remove_list_member">remove_list_member</a>(list,
|
||
user_to_remove, options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
<p>@overload <a
|
||
href="Lists.html#method-i-remove_list_member">remove_list_member</a>(user,
|
||
list, user_to_remove, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, 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.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="remove_list_member-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 81</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_list_member</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response_with_user</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/members/destroy.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- remove_list_member-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- remove_list_member-method -->
|
||
|
||
|
||
<div id="remove_list_members-method" class="method-detail ">
|
||
<a name="method-i-remove_list_members"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">remove_list_members</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p>Removes specified members from the list</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/post/lists/members/destroy_all">dev.twitter.com/docs/api/1.1/post/lists/members/destroy_all</a>
|
||
@rate_limited No @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::List] The
|
||
list. @overload <a
|
||
href="Lists.html#method-i-remove_list_members">remove_list_members</a>(list,
|
||
users, options = {})</p>
|
||
|
||
<pre>@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload <a
|
||
href="Lists.html#method-i-remove_list_members">remove_list_members</a>(user,
|
||
list, users, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
|
||
@param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="remove_list_members-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 373</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_list_members</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">list_from_response_with_users</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/1.1/lists/members/destroy_all.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- remove_list_members-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- remove_list_members-method -->
|
||
|
||
|
||
<div id="subscriptions-method" class="method-detail ">
|
||
<a name="method-i-subscriptions"></a>
|
||
|
||
|
||
<div class="method-heading">
|
||
<span class="method-name">subscriptions</span><span
|
||
class="method-args">(*args)</span>
|
||
<span class="method-click-advice">click to toggle source</span>
|
||
</div>
|
||
|
||
|
||
<div class="method-description">
|
||
|
||
<p><a href="../List.html">List</a> the lists the specified user follows</p>
|
||
|
||
<p>@see <a
|
||
href="https://dev.twitter.com/docs/api/1.1/get/lists/subscriptions">dev.twitter.com/docs/api/1.1/get/lists/subscriptions</a>
|
||
@rate_limited Yes @authentication Requires user context @raise
|
||
[Twitter::Error::Unauthorized] <a href="../Error.html">Error</a> raised
|
||
when supplied user credentials are not valid. @return [Twitter::Cursor]
|
||
@overload subscriptions(options = {})</p>
|
||
|
||
<pre>@param options [Hash] A customizable set of options.</pre>
|
||
|
||
<p>@overload subscriptions(user, options = {})</p>
|
||
|
||
<pre>@param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
|
||
@param options [Hash] A customizable set of options.</pre>
|
||
|
||
|
||
|
||
<div class="method-source-code" id="subscriptions-source">
|
||
<pre>
|
||
<span class="ruby-comment"># File lib/twitter/rest/lists.rb, line 353</span>
|
||
<span class="ruby-keyword">def</span> <span class="ruby-identifier">subscriptions</span>(*<span class="ruby-identifier">args</span>)
|
||
<span class="ruby-identifier">cursor_from_response_with_user</span>(<span class="ruby-value">:lists</span>, <span class="ruby-constant">Twitter</span><span class="ruby-operator">::</span><span class="ruby-constant">List</span>, <span class="ruby-value">:get</span>, <span class="ruby-string">'/1.1/lists/subscriptions.json'</span>, <span class="ruby-identifier">args</span>)
|
||
<span class="ruby-keyword">end</span></pre>
|
||
</div><!-- subscriptions-source -->
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div><!-- subscriptions-method -->
|
||
|
||
|
||
</div><!-- public-instance-method-details -->
|
||
|
||
</div><!-- 5Buntitled-5D -->
|
||
|
||
|
||
</div><!-- documentation -->
|
||
|
||
<div id="validator-badges">
|
||
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
||
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
||
Rdoc Generator</a> 2</small>.</p>
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|
||
|