781 lines
32 KiB
HTML
781 lines
32 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>Class: Twitter::Streaming::Client</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="class">
|
|
|
|
<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/streaming/client_rb.html?TB_iframe=true&height=550&width=785"
|
|
class="thickbox" title="lib/twitter/streaming/client.rb">lib/twitter/streaming/client.rb</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="class-metadata">
|
|
|
|
<!-- Parent Class -->
|
|
<div id="parent-class-section" class="section">
|
|
<h3 class="section-header">Parent</h3>
|
|
|
|
<p class="link"><a href="../Client.html">Twitter::Client</a></p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="section">
|
|
<h3 class="section-header">Methods</h3>
|
|
<ul class="link-list">
|
|
|
|
<li><a href="#method-c-new">::new</a></li>
|
|
|
|
<li><a href="#method-i-before_request">#before_request</a></li>
|
|
|
|
<li><a href="#method-i-filter">#filter</a></li>
|
|
|
|
<li><a href="#method-i-firehose">#firehose</a></li>
|
|
|
|
<li><a href="#method-i-sample">#sample</a></li>
|
|
|
|
<li><a href="#method-i-site">#site</a></li>
|
|
|
|
<li><a href="#method-i-user">#user</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="class">Twitter::Streaming::Client</h1>
|
|
|
|
<div id="description" class="description">
|
|
|
|
</div><!-- description -->
|
|
|
|
|
|
|
|
|
|
<div id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Attributes -->
|
|
<div id="attribute-method-details" class="method-section section">
|
|
<h3 class="section-header">Attributes</h3>
|
|
|
|
|
|
<div id="connection-attribute-method" class="method-detail">
|
|
<a name="connection"></a>
|
|
|
|
<a name="connection="></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">connection</span><span
|
|
class="attribute-access-type">[W]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="ssl_socket_class-attribute-method" class="method-detail">
|
|
<a name="ssl_socket_class"></a>
|
|
|
|
<a name="ssl_socket_class="></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">ssl_socket_class</span><span
|
|
class="attribute-access-type">[RW]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="tcp_socket_class-attribute-method" class="method-detail">
|
|
<a name="tcp_socket_class"></a>
|
|
|
|
<a name="tcp_socket_class="></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">tcp_socket_class</span><span
|
|
class="attribute-access-type">[RW]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- attribute-method-details -->
|
|
|
|
|
|
<!-- Methods -->
|
|
|
|
<div id="public-class-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Class Methods</h3>
|
|
|
|
|
|
<div id="new-method" class="method-detail ">
|
|
<a name="method-c-new"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">new</span><span
|
|
class="method-args">(options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Initializes a new <a href="Client.html">Client</a> object</p>
|
|
|
|
<p>@param options [Hash] A customizable set of options. @option options
|
|
[String] :<a
|
|
href="Client.html#attribute-i-tcp_socket_class">tcp_socket_class</a> A
|
|
class that <a href="Connection.html">Connection</a> will use to create a
|
|
new TCP socket. @option options [String] :<a
|
|
href="Client.html#attribute-i-ssl_socket_class">ssl_socket_class</a> A
|
|
class that <a href="Connection.html">Connection</a> will use to create a
|
|
new SSL socket. @return [Twitter::Streaming::Client]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="new-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/streaming/client.rb, line 20</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-keyword">super</span>
|
|
<span class="ruby-ivar">@connection</span> = <span class="ruby-constant">Streaming</span><span class="ruby-operator">::</span><span class="ruby-constant">Connection</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- new-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- new-method -->
|
|
|
|
|
|
</div><!-- public-class-method-details -->
|
|
|
|
<div id="public-instance-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Instance Methods</h3>
|
|
|
|
|
|
<div id="before_request-method" class="method-detail ">
|
|
<a name="method-i-before_request"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">before_request</span><span
|
|
class="method-args">(&block)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Set a Proc to be run when connection established.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="before_request-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/streaming/client.rb, line 94</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">before_request</span>(&<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
<span class="ruby-ivar">@before_request</span> = <span class="ruby-identifier">block</span>
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@before_request</span>)
|
|
<span class="ruby-ivar">@before_request</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">proc</span> {}
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- before_request-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- before_request-method -->
|
|
|
|
|
|
<div id="filter-method" class="method-detail ">
|
|
<a name="method-i-filter"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">filter</span><span
|
|
class="method-args">(options = {}, &block)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns public statuses that match one or more filter predicates</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/post/statuses/filter">dev.twitter.com/docs/api/1.1/post/statuses/filter</a>
|
|
@see <a
|
|
href="https://dev.twitter.com/docs/streaming-apis/parameters">dev.twitter.com/docs/streaming-apis/parameters</a>
|
|
@note At least one predicate parameter (follow, locations, or track) must
|
|
be specified. @param options [Hash] A customizable set of options. @option
|
|
options [String] :follow A comma separated list of user IDs, indicating the
|
|
users to return statuses for in the stream. @option options [String] :track
|
|
Includes additional Tweets matching the specified keywords. Phrases of
|
|
keywords are specified by a comma-separated list. @option options [String]
|
|
:locations Includes additional Tweets falling within the specified bounding
|
|
boxes. @yield [<a href="../Tweet.html">Twitter::Tweet</a>, <a
|
|
href="Event.html">Twitter::Streaming::Event</a>, <a
|
|
href="../DirectMessage.html">Twitter::DirectMessage</a>, <a
|
|
href="FriendList.html">Twitter::Streaming::FriendList</a>, <a
|
|
href="DeletedTweet.html">Twitter::Streaming::DeletedTweet</a>,
|
|
Twitter::Streaming::StallWarning] A stream of <a
|
|
href="../../Twitter.html">Twitter</a> objects.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="filter-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/streaming/client.rb, line 35</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">filter</span>(<span class="ruby-identifier">options</span> = {}, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-identifier">request</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'https://stream.twitter.com:443/1.1/statuses/filter.json'</span>, <span class="ruby-identifier">options</span>, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- filter-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- filter-method -->
|
|
|
|
|
|
<div id="firehose-method" class="method-detail ">
|
|
<a name="method-i-firehose"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">firehose</span><span
|
|
class="method-args">(options = {}, &block)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns all public statuses</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/statuses/firehose">dev.twitter.com/docs/api/1.1/get/statuses/firehose</a>
|
|
@see <a
|
|
href="https://dev.twitter.com/docs/streaming-apis/parameters">dev.twitter.com/docs/streaming-apis/parameters</a>
|
|
@note This endpoint requires special permission to access. @param options
|
|
[Hash] A customizable set of options. @option options [Integer] :count The
|
|
number of messages to backfill. @yield [<a
|
|
href="../Tweet.html">Twitter::Tweet</a>, <a
|
|
href="Event.html">Twitter::Streaming::Event</a>, <a
|
|
href="../DirectMessage.html">Twitter::DirectMessage</a>, <a
|
|
href="FriendList.html">Twitter::Streaming::FriendList</a>, <a
|
|
href="DeletedTweet.html">Twitter::Streaming::DeletedTweet</a>,
|
|
Twitter::Streaming::StallWarning] A stream of <a
|
|
href="../../Twitter.html">Twitter</a> objects.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="firehose-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/streaming/client.rb, line 47</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">firehose</span>(<span class="ruby-identifier">options</span> = {}, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-identifier">request</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'https://stream.twitter.com:443/1.1/statuses/firehose.json'</span>, <span class="ruby-identifier">options</span>, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- firehose-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- firehose-method -->
|
|
|
|
|
|
<div id="sample-method" class="method-detail ">
|
|
<a name="method-i-sample"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">sample</span><span
|
|
class="method-args">(options = {}, &block)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Returns a small random sample of all public statuses</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/statuses/sample">dev.twitter.com/docs/api/1.1/get/statuses/sample</a>
|
|
@see <a
|
|
href="https://dev.twitter.com/docs/streaming-apis/parameters">dev.twitter.com/docs/streaming-apis/parameters</a>
|
|
@yield [<a href="../Tweet.html">Twitter::Tweet</a>, <a
|
|
href="Event.html">Twitter::Streaming::Event</a>, <a
|
|
href="../DirectMessage.html">Twitter::DirectMessage</a>, <a
|
|
href="FriendList.html">Twitter::Streaming::FriendList</a>, <a
|
|
href="DeletedTweet.html">Twitter::Streaming::DeletedTweet</a>,
|
|
Twitter::Streaming::StallWarning] A stream of <a
|
|
href="../../Twitter.html">Twitter</a> objects.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="sample-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/streaming/client.rb, line 56</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">sample</span>(<span class="ruby-identifier">options</span> = {}, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-identifier">request</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'https://stream.twitter.com:443/1.1/statuses/sample.json'</span>, <span class="ruby-identifier">options</span>, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- sample-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- sample-method -->
|
|
|
|
|
|
<div id="site-method" class="method-detail ">
|
|
<a name="method-i-site"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">site</span><span
|
|
class="method-args">(*args, &block)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Streams messages for a set of user</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/site">dev.twitter.com/docs/api/1.1/get/site</a>
|
|
@see <a
|
|
href="https://dev.twitter.com/docs/streaming-apis/streams/site">dev.twitter.com/docs/streaming-apis/streams/site</a>
|
|
@see <a
|
|
href="https://dev.twitter.com/docs/streaming-apis/parameters">dev.twitter.com/docs/streaming-apis/parameters</a>
|
|
@note Site Streams is currently in a limited beta. Access is restricted to
|
|
whitelisted accounts. @param follow [<a
|
|
href="../Enumerable.html">Enumerable</a><Integer, String,
|
|
Twitter::User>] A list of user IDs, indicating the users to return
|
|
statuses for in the stream. @param options [Hash] A customizable set of
|
|
options. @option options [String] :with Specifies whether to return
|
|
information for just the users specified in the follow parameter, or
|
|
include messages from accounts they follow. @option options [String]
|
|
:replies Specifies whether stall warnings should be delivered. @yield [<a
|
|
href="../Tweet.html">Twitter::Tweet</a>, <a
|
|
href="Event.html">Twitter::Streaming::Event</a>, <a
|
|
href="../DirectMessage.html">Twitter::DirectMessage</a>, <a
|
|
href="FriendList.html">Twitter::Streaming::FriendList</a>, <a
|
|
href="DeletedTweet.html">Twitter::Streaming::DeletedTweet</a>,
|
|
Twitter::Streaming::StallWarning] A stream of <a
|
|
href="../../Twitter.html">Twitter</a> objects.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="site-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/streaming/client.rb, line 71</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">site</span>(*<span class="ruby-identifier">args</span>, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-identifier">arguments</span> = <span class="ruby-constant">Arguments</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">user_ids</span> = <span class="ruby-identifier">collect_user_ids</span>(<span class="ruby-identifier">arguments</span>)
|
|
<span class="ruby-identifier">request</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'https://sitestream.twitter.com:443/1.1/site.json'</span>, <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">:follow</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">user_ids</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">','</span>)), &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- site-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- site-method -->
|
|
|
|
|
|
<div id="user-method" class="method-detail ">
|
|
<a name="method-i-user"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">user</span><span
|
|
class="method-args">(options = {}, &block)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Streams messages for a single user</p>
|
|
|
|
<p>@see <a
|
|
href="https://dev.twitter.com/docs/api/1.1/get/user">dev.twitter.com/docs/api/1.1/get/user</a>
|
|
@see <a
|
|
href="https://dev.twitter.com/docs/streaming-apis/streams/user">dev.twitter.com/docs/streaming-apis/streams/user</a>
|
|
@see <a
|
|
href="https://dev.twitter.com/docs/streaming-apis/parameters">dev.twitter.com/docs/streaming-apis/parameters</a>
|
|
@param options [Hash] A customizable set of options. @option options
|
|
[String] :with Specifies whether to return information for just the users
|
|
specified in the follow parameter, or include messages from accounts they
|
|
follow. @option options [String] :replies Specifies whether to return
|
|
additional @replies. @option options [String] :stall_warnings Specifies
|
|
whether stall warnings should be delivered. @option options [String] :track
|
|
Includes additional Tweets matching the specified keywords. Phrases of
|
|
keywords are specified by a comma-separated list. @option options [String]
|
|
:locations Includes additional Tweets falling within the specified bounding
|
|
boxes. @yield [<a href="../Tweet.html">Twitter::Tweet</a>, <a
|
|
href="Event.html">Twitter::Streaming::Event</a>, <a
|
|
href="../DirectMessage.html">Twitter::DirectMessage</a>, <a
|
|
href="FriendList.html">Twitter::Streaming::FriendList</a>, <a
|
|
href="DeletedTweet.html">Twitter::Streaming::DeletedTweet</a>,
|
|
Twitter::Streaming::StallWarning] A stream of <a
|
|
href="../../Twitter.html">Twitter</a> objects.</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="user-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/twitter/streaming/client.rb, line 89</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">user</span>(<span class="ruby-identifier">options</span> = {}, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-identifier">request</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'https://userstream.twitter.com:443/1.1/user.json'</span>, <span class="ruby-identifier">options</span>, &<span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- user-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- user-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>
|
|
|