Packages

trait TwitterStatusClient extends StreamingClient with Configurations with ActorContextExtractor

Source
TwitterStatusClient.scala
Linear Supertypes
Configurations, StreamingClient, OAuthClient, RequestBuilding, TransformerPipelineSupport, TokenProvider, CommonClient, ActorContextExtractor, ActorSystemProvider, ExecutionContextProvider, JsonSupport, Json4sSupport, AnyRef, Any
Known Subclasses
StreamingClients, TwitterStreamingClient, TwitterStream
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwitterStatusClient
  2. Configurations
  3. StreamingClient
  4. OAuthClient
  5. RequestBuilding
  6. TransformerPipelineSupport
  7. TokenProvider
  8. CommonClient
  9. ActorContextExtractor
  10. ActorSystemProvider
  11. ExecutionContextProvider
  12. JsonSupport
  13. Json4sSupport
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Concrete Value Members

  1. def filterStatuses(follow: Seq[Long] = Seq.empty, track: Seq[String] = Seq.empty, locations: Seq[Double] = Seq.empty, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): 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 use 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 type CommonStreamingMessage and processed accordingly to the partial function f. All the messages that do not match f are automatically ignored. For more information see https://dev.twitter.com/streaming/reference/post/statuses/filter.

    follow

    : Empty by default. A comma separated list of user IDs, indicating the users to return statuses for in the stream. For more information https://dev.twitter.com/streaming/overview/request-parameters#follow

    track

    : Empty by default. Keywords to track. Phrases of keywords are specified by a comma-separated list. For more information https://dev.twitter.com/streaming/overview/request-parameters#track

    locations

    : Empty by default. Specifies a set of bounding boxes to track. For more information https://dev.twitter.com/streaming/overview/request-parameters#locations

    languages

    : Empty by default. A comma separated list of 'BCP 47' language identifiers. For more information https://dev.twitter.com/streaming/overview/request-parameters#language

    stall_warnings

    : Default to false. Specifies whether stall warnings (WarningMessage) should be delivered as part of the updates.

  2. def firehoseStatuses(count: Option[Int] = None, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): 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 use 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 type CommonStreamingMessage and processed accordingly to the partial function f. All the messages that do not match f are automatically ignored.

    languages

    : Empty by default. A comma separated list of 'BCP 47' language identifiers. For more information https://dev.twitter.com/streaming/overview/request-parameters#language

    stall_warnings

    : Default to false. Specifies whether stall warnings (WarningMessage) should be delivered as part of the updates.

  3. def sampleStatuses(languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): 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 use 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 type CommonStreamingMessage and processed accordingly to the partial function f. All the messages that do not match f are automatically ignored. For more information see https://dev.twitter.com/streaming/reference/get/statuses/sample.

    languages

    : Empty by default. A comma separated list of 'BCP 47' language identifiers. For more information https://dev.twitter.com/streaming/overview/request-parameters#language

    stall_warnings

    : Default to false. Specifies whether stall warnings (WarningMessage) should be delivered as part of the updates.

Deprecated Value Members

  1. def getStatusesFilter(follow: Seq[Long] = Seq.empty, track: Seq[String] = Seq.empty, locations: Seq[Double] = Seq.empty, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): Future[TwitterStream]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use filterStatuses instead

  2. def getStatusesFirehose(count: Option[Int] = None, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): Future[TwitterStream]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use firehoseStatuses instead

  3. def getStatusesSample(languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): Future[TwitterStream]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use sampleStatuses instead