Class/Object

com.danielasfregola.twitter4s

TwitterStreamingClient

Related Docs: object TwitterStreamingClient | package twitter4s

Permalink

class TwitterStreamingClient extends StreamingClients

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

Instance Constructors

  1. new TwitterStreamingClient(consumerToken: ConsumerToken, accessToken: AccessToken)(implicit system: ActorSystem = ActorSystem("twitter4s-streaming"))

    Permalink

Type Members

  1. class OAuthRequestBuilder extends http.clients.OAuthClient.RequestBuilder with BodyEncoder

    Permalink
    Definition Classes
    OAuthClient
  2. class RequestBuilder extends AnyRef

    Permalink
    Definition Classes
    RequestBuilding
  3. type RequestTransformer = (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    RequestBuilding
  4. implicit class WithTransformation[A] extends AnyRef

    Permalink
    Definition Classes
    TransformerPipelineSupport
  5. implicit class WithTransformerConcatenation[A, B] extends (A) ⇒ B

    Permalink
    Definition Classes
    TransformerPipelineSupport

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val Delete: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  5. val Get: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  6. val Head: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  7. val Options: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  8. val Patch: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  9. val Post: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  10. val Put: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  11. val accessToken: AccessToken

    Permalink
    Definition Classes
    TwitterStreamingClientTokenProvider
  12. lazy val accessTokenKey: String

    Permalink
    Definition Classes
    Configurations
  13. lazy val accessTokenSecret: String

    Permalink
    Definition Classes
    Configurations
  14. def addCredentials(credentials: HttpCredentials): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  15. def addHeader(headerName: String, headerValue: String): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  16. def addHeader(header: HttpHeader): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  17. def addHeaders(first: HttpHeader, more: HttpHeader*): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  18. val apiTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  19. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def connection(implicit request: HttpRequest): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Permalink
    Attributes
    protected
    Definition Classes
    CommonClient
  22. val consumerToken: ConsumerToken

    Permalink
    Definition Classes
    TwitterStreamingClientTokenProvider
  23. lazy val consumerTokenKey: String

    Permalink
    Definition Classes
    Configurations
  24. lazy val consumerTokenSecret: String

    Permalink
    Definition Classes
    Configurations
  25. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  27. implicit val executionContext: ExecutionContext

    Permalink
    Definition Classes
    ActorContextExtractor → ExecutionContextProvider
  28. 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]

    Permalink

    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.

    Definition Classes
    TwitterStatusClient
  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def firehoseStatuses(count: Option[Int] = None, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): Future[TwitterStream]

    Permalink

    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.

    Definition Classes
    TwitterStatusClient
  31. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  32. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  33. implicit def header2AddHeader(header: HttpHeader): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  34. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  35. implicit lazy val json4sFormats: Formats

    Permalink
    Definition Classes
    JsonSupport
  36. implicit def json4sMarshaller[A <: AnyRef](implicit serialization: Serialization, formats: Formats, shouldWritePretty: ShouldWritePretty): ToEntityMarshaller[A]

    Permalink
    Definition Classes
    Json4sSupport
  37. implicit def json4sUnmarshaller[A](implicit arg0: Manifest[A], serialization: Serialization, formats: Formats): FromEntityUnmarshaller[A]

    Permalink
    Definition Classes
    Json4sSupport
  38. implicit val log: Logger

    Permalink
    Definition Classes
    ActorContextExtractor
  39. def logRequest(logFun: (HttpRequest) ⇒ Unit): (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    RequestBuilding
  40. def logRequest(log: LoggingAdapter, level: LogLevel): (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    RequestBuilding
  41. def logRequest(implicit request: HttpRequest): HttpRequest

    Permalink
    Definition Classes
    CommonClient
  42. def logRequestResponse(requestStartTime: Long)(implicit request: HttpRequest): (HttpResponse) ⇒ HttpResponse

    Permalink
    Definition Classes
    CommonClient
  43. def logValue[T](logFun: (T) ⇒ Unit): (T) ⇒ T

    Permalink
    Definition Classes
    TransformerPipelineSupport
  44. def logValue[T](log: LoggingAdapter, level: LogLevel): (T) ⇒ T

    Permalink
    Definition Classes
    TransformerPipelineSupport
  45. def mapHeaders(f: (Seq[HttpHeader]) ⇒ Seq[HttpHeader]): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  46. implicit val materializer: ActorMaterializer

    Permalink
    Definition Classes
    ActorSystemProvider
  47. val mediaTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  48. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  49. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  50. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  51. lazy val oauthProvider: OAuth2Provider

    Permalink
    Attributes
    protected
    Definition Classes
    OAuthClient
  52. def parseFailedResponse(response: HttpResponse): Future[TwitterException]

    Permalink
    Attributes
    protected
    Definition Classes
    CommonClient
  53. def preProcessing(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    StreamingClient
  54. def processBody[T](response: HttpResponse, killSwitch: SharedKillSwitch)(f: PartialFunction[T, Unit])(implicit arg0: Manifest[T], request: HttpRequest): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    StreamingClient
  55. def processStreamRequest[T <: StreamingMessage](request: HttpRequest, killSwitch: SharedKillSwitch)(f: PartialFunction[T, Unit])(implicit arg0: Manifest[T]): Future[SharedKillSwitch]

    Permalink
    Attributes
    protected
    Definition Classes
    StreamingClient
  56. def removeHeader(clazz: Class[_]): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  57. def removeHeader[T <: HttpHeader](implicit arg0: ClassTag[T]): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  58. def removeHeader(headerName: String): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  59. def removeHeaders(names: String*): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  60. def sampleStatuses(languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): Future[TwitterStream]

    Permalink

    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.

    Definition Classes
    TwitterStatusClient
  61. implicit val serialization: Serialization.type

    Permalink
    Definition Classes
    JsonSupport
  62. 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]): Future[TwitterStream]

    Permalink

    Starts a streaming connection from Twitter's site API.

    Starts a streaming connection from Twitter's site API. SStreams messages for a set of users, as described in Site streams. 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 SiteStreamingMessage 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/site.

    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

    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.

    Definition Classes
    TwitterSiteClient
  63. val siteStreamingTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  64. val statusStreamingTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  65. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  66. implicit val system: ActorSystem

    Permalink
    Definition Classes
    TwitterStreamingClient → ActorSystemProvider
  67. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  68. val twitterVersion: String

    Permalink
    Definition Classes
    Configurations
  69. def unmarshal[T](requestStartTime: Long, f: (HttpResponse) ⇒ Future[T])(implicit request: HttpRequest, response: HttpResponse): Future[T]

    Permalink
    Attributes
    protected
    Definition Classes
    CommonClient
  70. def userEvents(with: WithFilter = WithFilter.Followings, replies: Option[Boolean] = None, track: Seq[String] = Seq.empty, locations: Seq[Double] = Seq.empty, stringify_friend_ids: Boolean = false, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[UserStreamingMessage, Unit]): Future[TwitterStream]

    Permalink

    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 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 UserStreamingMessage 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.

    track

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

    locations

    : Empty by default. Specifies a set of bounding boxes to track. For more information see 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.

    Definition Classes
    TwitterUserClient
  71. val userStreamingTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  72. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. val withLogRequest: Boolean

    Permalink
    Definition Classes
    StreamingClientCommonClient
  76. val withLogRequestResponse: Boolean

    Permalink
    Definition Classes
    StreamingClientCommonClient
  77. def withOAuthHeader: (HttpRequest) ⇒ Future[HttpRequest]

    Permalink
    Definition Classes
    OAuthClient
  78. def withSimpleOAuthHeader: (HttpRequest) ⇒ Future[HttpRequest]

    Permalink
    Definition Classes
    OAuthClient

Deprecated Value Members

  1. def getSiteEvents(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]): Future[TwitterStream]

    Permalink
    Definition Classes
    TwitterSiteClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use siteEvents instead

  2. 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]

    Permalink
    Definition Classes
    TwitterStatusClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use filterStatuses instead

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

    Permalink
    Definition Classes
    TwitterStatusClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use firehoseStatuses instead

  4. def getStatusesSample(languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[CommonStreamingMessage, Unit]): Future[TwitterStream]

    Permalink
    Definition Classes
    TwitterStatusClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use sampleStatuses instead

  5. def getUserEvents(with: WithFilter = WithFilter.Followings, replies: Option[Boolean] = None, track: Seq[String] = Seq.empty, locations: Seq[Double] = Seq.empty, stringify_friend_ids: Boolean = false, languages: Seq[Language] = Seq.empty, stall_warnings: Boolean = false)(f: PartialFunction[UserStreamingMessage, Unit]): Future[TwitterStream]

    Permalink
    Definition Classes
    TwitterUserClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use userEvents instead

Inherited from StreamingClients

Inherited from TwitterSiteClient

Inherited from TwitterUserClient

Inherited from TwitterStatusClient

Inherited from Configurations

Inherited from StreamingClient

Inherited from OAuthClient

Inherited from RequestBuilding

Inherited from TransformerPipelineSupport

Inherited from TokenProvider

Inherited from CommonClient

Inherited from ActorContextExtractor

Inherited from ActorSystemProvider

Inherited from ExecutionContextProvider

Inherited from JsonSupport

Inherited from Json4sSupport

Inherited from AnyRef

Inherited from Any

Ungrouped