class TwitterStreamingClient extends StreamingClients with SystemShutdown
Represents the functionalities offered by the Twitter Streaming API
- Alphabetic
- By Inheritance
- TwitterStreamingClient
- SystemShutdown
- StreamingClients
- TwitterSiteClient
- TwitterUserClient
- TwitterStatusClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val accessToken: AccessToken
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val consumerToken: ConsumerToken
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def filterStatuses(follow: Seq[Long] = Seq.empty, tracks: Seq[String] = Seq.empty, locations: Seq[GeoBoundingBox] = Seq.empty, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false, filter_level: FilterLevel = FilterLevel.None)(f: PartialFunction[CommonStreamingMessage, Unit], errorHandler: PartialFunction[Throwable, Unit] = ErrorHandler.ignore): Future[TwitterStream]
Starts a streaming connection from Twitter's public API, filtered with the 'follow', 'track' and 'location' parameters.
Starts a streaming connection from Twitter's public API, filtered with the 'follow', 'track' and 'location' parameters. Although all of those three params are optional, at least one must be specified. The track, follow, and locations fields should be considered to be combined with an OR operator. The function returns a future of a
TwitterStream
that can be used to close or replace the stream when needed. If there are failures in establishing the initial connection, the Future returned will be completed with a failure. Since it's an asynchronous event stream, all the events will be parsed as entities of typeCommonStreamingMessage
and processed accordingly to the partial functionf
. All the messages that do not matchf
are automatically ignored. For more information see https://developer.twitter.com/en/docs/tweets/filter-realtime/api-reference/post-statuses-filter.html.- follow
: Empty by default. List of user IDs, indicating the users whose Tweets should be delivered on the stream. For more information https://developer.twitter.com/en/docs/tweets/filter-realtime/api-reference/post-statuses-filter.html
- tracks
: Empty by default. List of phrases which will be used to determine what Tweets will be delivered on the stream. Each phrase must be between 1 and 60 bytes, inclusive. For more information https://developer.twitter.com/en/docs/tweets/filter-realtime/api-reference/post-statuses-filter.html
- locations
: Empty by default. Specifies a set of bounding boxes to track. For more information https://developer.twitter.com/en/docs/tweets/filter-realtime/api-reference/post-statuses-filter.html
- languages
: Empty by default. List of 'BCP 47' language identifiers. For more information https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters
- stall_warnings
: Default to false. Specifies whether stall warnings (
WarningMessage
) should be delivered as part of the updates.- filter_level
: Default value is none, which includes all available Tweets. Set the minimum value of the filter_level Tweet attribute required to be included in the stream.
- f
: Function that defines how to process the received messages.
- Definition Classes
- TwitterStatusClient
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def firehoseStatuses(count: Option[Int] = None, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit], errorHandler: PartialFunction[Throwable, Unit] = ErrorHandler.ignore): Future[TwitterStream]
Starts a streaming connection from Twitter's firehose API of all public statuses.
Starts a streaming connection from Twitter's firehose API of all public statuses. Few applications require this level of access. Creative use of a combination of other resources and various access levels can satisfy nearly every application use case. For more information see https://dev.twitter.com/streaming/reference/get/statuses/firehose. The function returns a future of a
TwitterStream
that can be used to close or replace the stream when needed. If there are failures in establishing the initial connection, the Future returned will be completed with a failure. Since it's an asynchronous event stream, all the events will be parsed as entities of typeCommonStreamingMessage
and processed accordingly to the partial functionf
. All the messages that do not matchf
are automatically ignored.- count
: Optional. The number of messages to backfill. For more information see https://dev.twitter.com/streaming/overview/request-parameters#count
- languages
: Empty by default. List of 'BCP 47' language identifiers. For more information https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters
- stall_warnings
: Default to false. Specifies whether stall warnings (
WarningMessage
) should be delivered as part of the updates.- f
: Function that defines how to process the received messages.
- Definition Classes
- TwitterStatusClient
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def sampleStatuses(languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false, tracks: Seq[String] = Seq.empty, filter_level: FilterLevel = FilterLevel.None)(f: PartialFunction[CommonStreamingMessage, Unit], errorHandler: PartialFunction[Throwable, Unit] = ErrorHandler.ignore): Future[TwitterStream]
Starts a streaming connection from Twitter's public API, which is a a small random sample of all public statuses.
Starts a streaming connection from Twitter's public API, which is a a small random sample of all public statuses. The Tweets returned by the default access level are the same, so if two different clients connect to this endpoint, they will see the same Tweets. The function returns a future of a
TwitterStream
that can be used to close or replace the stream when needed. If there are failures in establishing the initial connection, the Future returned will be completed with a failure. Since it's an asynchronous event stream, all the events will be parsed as entities of typeCommonStreamingMessage
and processed accordingly to the partial functionf
. All the messages that do not matchf
are automatically ignored. For more information see https://developer.twitter.com/en/docs/tweets/sample-realtime/overview/GET_statuse_sample.- languages
: Empty by default. List of 'BCP 47' language identifiers. For more information https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters
- stall_warnings
: Default to false. Specifies whether stall warnings (
WarningMessage
) should be delivered as part of the updates.- tracks
: Empty by default. List of phrases which will be used to determine what Tweets will be delivered on the stream. Each phrase must be between 1 and 60 bytes, inclusive. For more information https://developer.twitter.com/en/docs/tweets/filter-realtime/api-reference/post-statuses-filter.html
- filter_level
: Default value is none, which includes all available Tweets. Set the minimum value of the filter_level Tweet attribute required to be included in the stream.
- f
: Function that defines how to process the received messages.
- Definition Classes
- TwitterStatusClient
- def shutdown(): Future[Unit]
Shutdown of the actor system associated to the client
Shutdown of the actor system associated to the client
- Definition Classes
- SystemShutdown
- def siteEvents(follow: Seq[Long] = Seq.empty, with: WithFilter = WithFilter.User, replies: Option[Boolean] = None, stringify_friend_ids: Boolean = false, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[SiteStreamingMessage, Unit], errorHandler: PartialFunction[Throwable, Unit] = ErrorHandler.ignore): Future[TwitterStream]
Starts a streaming connection from Twitter's site API.
Starts a streaming connection from Twitter's site API. Streams messages for a set of users, as described in Site streams. The function returns a future of a
TwitterStream
that can be used to close or replace the stream when needed. If there are failures in establishing the initial connection, the Future returned will be completed with a failure. Since it's an asynchronous event stream, all the events will be parsed as entities of typeSiteStreamingMessage
and processed accordingly to the partial functionf
. All the messages that do not matchf
are automatically ignored. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/site-stream.- follow
: Empty by default. List of user IDs, indicating the users whose Tweets should be delivered on the stream. For more information https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/site-stream
- with
:
User
by default. Specifies whether to return information for just the users specified in the follow parameter, or include messages from accounts they follow. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/site-stream- replies
: Optional. By default @replies are only sent if the current user follows both the sender and receiver of the reply. To receive all the replies, set the argument to
true
. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/site-stream- stringify_friend_ids
: Optional. Specifies whether to send the Friend List preamble as an array of integers or an array of strings. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/site-stream
- languages
: Empty by default. List of 'BCP 47' language identifiers. For more information https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters
- stall_warnings
: Default to false. Specifies whether stall warnings (
WarningMessage
) should be delivered as part of the updates.- f
: Function that defines how to process the received messages.
- Definition Classes
- TwitterSiteClient
- val streamingClient: StreamingClient
- Attributes
- protected
- Definition Classes
- TwitterStreamingClient → TwitterSiteClient → TwitterUserClient → TwitterStatusClient
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val system: ActorSystem
- Attributes
- protected
- Definition Classes
- TwitterStreamingClient → SystemShutdown
- def toString(): String
- Definition Classes
- AnyRef → Any
- def userEvents(with: WithFilter = WithFilter.Followings, replies: Option[Boolean] = None, tracks: Seq[String] = Seq.empty, locations: Seq[GeoBoundingBox] = Seq.empty, stringify_friend_ids: Boolean = false, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false, filter_level: FilterLevel = FilterLevel.None)(f: PartialFunction[UserStreamingMessage, Unit], errorHandler: PartialFunction[Throwable, Unit] = ErrorHandler.ignore): Future[TwitterStream]
Starts a streaming connection from Twitter's user API.
Starts a streaming connection from Twitter's user API. Streams messages for a single user as described in User streams. The function returns a future of a
TwitterStream
that can be used to close or replace the stream when needed. If there are failures in establishing the initial connection, the Future returned will be completed with a failure. Since it's an asynchronous event stream, all the events will be parsed as entities of typeUserStreamingMessage
and processed accordingly to the partial functionf
. All the messages that do not matchf
are automatically ignored. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/user-stream.- with
:
Followings
by default. Specifies whether to return information for just the authenticating user, or include messages from accounts the user follows. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/user-stream- tracks
: Empty by default. List of phrases which will be used to determine what Tweets will be delivered on the stream. Each phrase must be between 1 and 60 bytes, inclusive. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/user-stream
- locations
: Empty by default. Specifies a set of bounding boxes to track. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/user-stream
- languages
: Empty by default. List of 'BCP 47' language identifiers. For more information https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/user-stream
- stall_warnings
: Default to false. Specifies whether stall warnings (
WarningMessage
) should be delivered as part of the updates.- f
: Function that defines how to process the received messages.
- Definition Classes
- TwitterUserClient
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()