Packages

trait TwitterStatusClient extends RestClient with Configurations

Implements the available requests for the statuses resource.

Source
TwitterStatusClient.scala
Linear Supertypes
Configurations, RestClient, OAuthClient, RequestBuilding, TransformerPipelineSupport, TokenProvider, CommonClient, ActorContextExtractor, ActorSystemProvider, ExecutionContextProvider, JsonSupport, Json4sSupport, AnyRef, Any
Known Subclasses
RestClients, TwitterRestClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwitterStatusClient
  2. Configurations
  3. RestClient
  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

Type Members

  1. class OAuthRequestBuilder extends OAuthClient.RequestBuilder with BodyEncoder
    Definition Classes
    OAuthClient
  2. class RequestBuilder extends AnyRef
    Definition Classes
    RequestBuilding
  3. type RequestTransformer = (HttpRequest) ⇒ HttpRequest
    Definition Classes
    RequestBuilding
  4. implicit class WithTransformation[A] extends AnyRef
    Definition Classes
    TransformerPipelineSupport
  5. implicit class WithTransformerConcatenation[A, B] extends (A) ⇒ B
    Definition Classes
    TransformerPipelineSupport

Abstract Value Members

  1. abstract val accessToken: AccessToken
    Definition Classes
    TokenProvider
  2. abstract val consumerToken: ConsumerToken
    Definition Classes
    TokenProvider
  3. implicit abstract def system: ActorSystem
    Definition Classes
    ActorSystemProvider

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val Delete: OAuthRequestBuilder
    Definition Classes
    OAuthClient → RequestBuilding
  5. val Get: OAuthRequestBuilder
    Definition Classes
    OAuthClient → RequestBuilding
  6. val Head: OAuthRequestBuilder
    Definition Classes
    OAuthClient → RequestBuilding
  7. val Options: OAuthRequestBuilder
    Definition Classes
    OAuthClient → RequestBuilding
  8. val Patch: OAuthRequestBuilder
    Definition Classes
    OAuthClient → RequestBuilding
  9. val Post: OAuthRequestBuilder
    Definition Classes
    OAuthClient → RequestBuilding
  10. val Put: OAuthRequestBuilder
    Definition Classes
    OAuthClient → RequestBuilding
  11. lazy val accessTokenKey: String
    Definition Classes
    Configurations
  12. lazy val accessTokenSecret: String
    Definition Classes
    Configurations
  13. def addCredentials(credentials: HttpCredentials): RequestTransformer
    Definition Classes
    RequestBuilding
  14. def addHeader(headerName: String, headerValue: String): RequestTransformer
    Definition Classes
    RequestBuilding
  15. def addHeader(header: HttpHeader): RequestTransformer
    Definition Classes
    RequestBuilding
  16. def addHeaders(first: HttpHeader, more: HttpHeader*): RequestTransformer
    Definition Classes
    RequestBuilding
  17. val apiTwitterUrl: String
    Definition Classes
    Configurations
  18. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  19. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def connection(implicit request: HttpRequest): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]
    Attributes
    protected
    Definition Classes
    CommonClient
  21. lazy val consumerTokenKey: String
    Definition Classes
    Configurations
  22. lazy val consumerTokenSecret: String
    Definition Classes
    Configurations
  23. def createDirectMessageAsTweet(message: String, screen_name: String, in_reply_to_status_id: Option[Long] = None, possibly_sensitive: Boolean = false, latitude: Option[Long] = None, longitude: Option[Long] = None, place_id: Option[String] = None, display_coordinates: Boolean = false, trim_user: Boolean = false, media_ids: Seq[Long] = Seq.empty): Future[Tweet]

    Sends a direct message to a specified user.

    Sends a direct message to a specified user. For more information see https://dev.twitter.com/rest/reference/post/statuses/update.

    message

    : The text of your direct message.

    screen_name

    : : The screen name of the user that should receive the message. Helpful for disambiguating when a valid screen name is also a user ID.

    in_reply_to_status_id

    : Optional, by default it is None. The ID of an existing status that the update is in reply to. Note that this parameter will be ignored unless the author of the tweet this parameter references is mentioned within the status text. Therefore, you must include @username, where username is the author of the referenced tweet, within the update.

    possibly_sensitive

    : By default it is false. If you upload Tweet media that might be considered sensitive content such as nudity, violence, or medical procedures, you should set this value to true.

    latitude

    : Optional, by default it is None. The latitude of the location this tweet refers to. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn’t a corresponding longitude parameter.

    longitude

    : Optional, by default is None. The longitude of the location this tweet refers to. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding latitude parameter.

    place_id

    : Optional, by default it is None. A place in the world identified by an id.

    display_coordinates

    : By default it is false. Whether or not to put a pin on the exact coordinates a tweet has been sent from.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    media_ids

    : By default it is an empty sequence. A list of media_ids to associate with the Tweet. You may include up to 4 photos or 1 animated GIF or 1 video in a Tweet.

    returns

    : The representation of the created direct message.

  24. def createTweet(status: String, in_reply_to_status_id: Option[Long] = None, possibly_sensitive: Boolean = false, latitude: Option[Long] = None, longitude: Option[Long] = None, place_id: Option[String] = None, display_coordinates: Boolean = false, trim_user: Boolean = false, media_ids: Seq[Long] = Seq.empty): Future[Tweet]

    Updates the authenticating user’s current status, also known as Tweeting.

    Updates the authenticating user’s current status, also known as Tweeting. For each update attempt, the update text is compared with the authenticating user’s recent Tweets. Any attempt that would result in duplication will be blocked, resulting in a TwitterException error. Therefore, a user cannot submit the same status twice in a row. For more information see https://dev.twitter.com/rest/reference/post/statuses/update.

    status

    : The text of your status update, typically up to 140 characters.

    in_reply_to_status_id

    : Optional, by default it is None. The ID of an existing status that the update is in reply to. Note that this parameter will be ignored unless the author of the tweet this parameter references is mentioned within the status text. Therefore, you must include @username, where username is the author of the referenced tweet, within the update.

    possibly_sensitive

    : By default it is false. If you upload Tweet media that might be considered sensitive content such as nudity, violence, or medical procedures, you should set this value to true.

    latitude

    : Optional, by default it is None. The latitude of the location this tweet refers to. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn’t a corresponding longitude parameter.

    longitude

    : Optional, by default is None. The longitude of the location this tweet refers to. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding latitude parameter.

    place_id

    : Optional, by default it is None. A place in the world identified by an id.

    display_coordinates

    : By default it is false. Whether or not to put a pin on the exact coordinates a tweet has been sent from.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    media_ids

    : By default it is an empty sequence. A list of media_ids to associate with the Tweet. You may include up to 4 photos or 1 animated GIF or 1 video in a Tweet.

    returns

    : The representation of the created tweet.

  25. def deleteTweet(id: Long, trim_user: Boolean = false): Future[Tweet]

    Destroys the status specified by the required ID parameter.

    Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status. Returns the destroyed status if successful. For more information see https://dev.twitter.com/rest/reference/post/statuses/destroy/%3Aid.

    id

    : The numerical ID of the desired status.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    returns

    : The representation of the deleted tweet.

  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  28. implicit val executionContext: ExecutionContext
    Definition Classes
    ActorContextExtractor → ExecutionContextProvider
  29. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  31. def getTweet(id: Long, trim_user: Boolean = false, include_my_retweet: Boolean = false, include_entities: Boolean = true): Future[Tweet]

    Returns a single Tweet, specified by the id parameter.

    Returns a single Tweet, specified by the id parameter. The Tweet’s author will also be embedded within the tweet. For more information see https://dev.twitter.com/rest/reference/get/statuses/show/%3Aid.

    id

    : The numerical ID of the desired status.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    include_my_retweet

    : By default it is false. When set to true, any Tweets returned that have been retweeted by the authenticating user will include an additional current_user_retweet node, containing the ID of the source status for the retweet.

    include_entities

    : By default it is true. When set to false, The parameters node will be disincluded when set to false.

    returns

    : The representation of the tweet.

  32. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  33. implicit def header2AddHeader(header: HttpHeader): RequestTransformer
    Definition Classes
    RequestBuilding
  34. def homeTimeline(count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, trim_user: Boolean = false, exclude_replies: Boolean = false, contributor_details: Boolean = false, include_entities: Boolean = true): Future[Seq[Tweet]]

    Returns a collection of the most recent Tweets and retweets posted by the authenticating user and the users they follow.

    Returns a collection of the most recent Tweets and retweets posted by the authenticating user and the users they follow. The home timeline is central to how most users interact with the Twitter service. Up to 800 Tweets are obtainable on the home timeline. It is more volatile for users that follow many users or follow users who tweet frequently. For more information see https://dev.twitter.com/rest/reference/get/statuses/home_timeline.

    count

    : By default it is 20. Specifies the number of records to retrieve. Must be less than or equal to 200. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied.

    since_id

    : Optional, by default it is None. Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.

    max_id

    : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    exclude_replies

    : By default it is false. This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets — this is because the count parameter retrieves that many tweets before filtering out retweets and replies.

    contributor_details

    : By default it is false. When set to true, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set to false, only the user_id of the contributor is included.

    include_entities

    : By default it is true. When set to false, The parameters node will be disincluded when set to false.

    returns

    : The sequence of tweets.

  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. implicit lazy val json4sFormats: Formats
    Definition Classes
    JsonSupport
  37. implicit def json4sMarshaller[A <: AnyRef](implicit serialization: Serialization, formats: Formats, shouldWritePretty: ShouldWritePretty): ToEntityMarshaller[A]
    Definition Classes
    Json4sSupport
  38. implicit def json4sUnmarshaller[A](implicit arg0: Manifest[A], serialization: Serialization, formats: Formats): FromEntityUnmarshaller[A]
    Definition Classes
    Json4sSupport
  39. implicit val log: Logger
    Definition Classes
    ActorContextExtractor
  40. def logRequest(logFun: (HttpRequest) ⇒ Unit): (HttpRequest) ⇒ HttpRequest
    Definition Classes
    RequestBuilding
  41. def logRequest(log: LoggingAdapter, level: LogLevel): (HttpRequest) ⇒ HttpRequest
    Definition Classes
    RequestBuilding
  42. def logRequest(implicit request: HttpRequest): HttpRequest
    Definition Classes
    CommonClient
  43. def logRequestResponse(requestStartTime: Long)(implicit request: HttpRequest): (HttpResponse) ⇒ HttpResponse
    Definition Classes
    CommonClient
  44. def logValue[T](logFun: (T) ⇒ Unit): (T) ⇒ T
    Definition Classes
    TransformerPipelineSupport
  45. def logValue[T](log: LoggingAdapter, level: LogLevel): (T) ⇒ T
    Definition Classes
    TransformerPipelineSupport
  46. def mapHeaders(f: (Seq[HttpHeader]) ⇒ Seq[HttpHeader]): RequestTransformer
    Definition Classes
    RequestBuilding
  47. implicit val materializer: ActorMaterializer
    Definition Classes
    ActorSystemProvider
  48. val mediaTwitterUrl: String
    Definition Classes
    Configurations
  49. def mentionsTimeline(count: Int = 200, since_id: Option[Long] = None, max_id: Option[Long] = None, trim_user: Boolean = false, contributor_details: Boolean = false, include_entities: Boolean = true): Future[Seq[Tweet]]

    Returns the 20 most recent mentions (tweets containing a users’s @screen_name) for the authenticating user.

    Returns the 20 most recent mentions (tweets containing a users’s @screen_name) for the authenticating user. The timeline returned is the equivalent of the one seen when you view your mentions on twitter.com. This method can only return up to 800 tweets. For more information see https://dev.twitter.com/rest/reference/get/statuses/mentions_timeline.

    count

    : By default it is 200. Specifies the number of tweets to try and retrieve, up to a maximum of 200. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied.

    since_id

    : Optional, by default it is None. Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.

    max_id

    : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    contributor_details

    : By default it is false. When set to true, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set to false, only the user_id of the contributor is included.

    include_entities

    : By default it is true. The parameters node will be disincluded when set to false.

    returns

    : The sequence of tweets.

  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. final def notify(): Unit
    Definition Classes
    AnyRef
  52. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  53. lazy val oauthProvider: OAuth2Provider
    Attributes
    protected
    Definition Classes
    OAuthClient
  54. def oembedTweetById(id: Long, max_width: Option[Int] = None, hide_media: Boolean = false, hide_thread: Boolean = false, hide_tweet: Boolean = false, omit_script: Boolean = false, alignment: Alignment = Alignment.None, related: Seq[String] = Seq.empty, language: Language = Language.English, widget_type: Option[WidgetType] = None): Future[OEmbedTweet]

    Returns a single Tweet, specified by the Tweet ID, in an oEmbed-compatible format.

    Returns a single Tweet, specified by the Tweet ID, in an oEmbed-compatible format. The returned HTML snippet will be automatically recognized as an Embedded Tweet when Twitter’s widget JavaScript is included on the page. The oEmbed endpoint allows customization of the final appearance of an Embedded Tweet by setting the corresponding properties in HTML markup to be interpreted by Twitter’s JavaScript bundled with the HTML response by default. The format of the returned markup may change over time as Twitter adds new features or adjusts its Tweet representation. The Tweet fallback markup is meant to be cached on your servers for up to the suggested cache lifetime specified in the cache_age. For more information see https://dev.twitter.com/rest/reference/get/statuses/oembed.

    id

    : The numerical ID of the desired status.

    max_width

    : Optional, by default it is None. The maximum width of a rendered Tweet in whole pixels. This value must be between 220 and 550 inclusive. A supplied value under or over the allowed range will be returned as the minimum or maximum supported width respectively; the reset width value will be reflected in the returned width property. Note that Twitter does not support the oEmbed max_height parameter. Tweets are fundamentally text, and are therefore of unpredictable height that cannot be scaled like an image or video. Relatedly, the oEmbed response will not provide a value for height. Implementations that need consistent heights for Tweets should refer to the hide_thread and hide_media parameters below.

    hide_media

    : By default, it is false. When set to true, links in a Tweet are not expanded to photo, video, or link previews.

    hide_thread

    : By default, it is false. When set to true, a collapsed version of the previous Tweet in a conversation thread will not be displayed when the requested Tweet is in reply to another Tweet.

    hide_tweet

    : By default, it is false. Applies to video type only. Set to true to link directly to the Tweet URL instead of displaying a Tweet overlay when a viewer clicks on the Twitter bird logo.

    omit_script

    : By default, it is false. When set to true, the <script> responsible for loading widgets.js will not be returned. Your webpages should include their own reference to widgets.js for use across all Twitter widgets including Embedded Tweets.

    alignment

    : By default it is None, meaning no alignment styles are specified for the Tweet. Specifies whether the embedded Tweet should be floated left, right, or center in the page relative to the parent element.

    related

    : By default it is an empty sequence. A sequence of Twitter usernames related to your content. This value will be forwarded to Tweet action intents if a viewer chooses to reply, favorite, or retweet the embedded Tweet.

    language

    : By default it is English. Request returned HTML and a rendered Tweet in the specified Twitter language supported by embedded Tweets.

    widget_type

    : Optional, by default it is None. Set to video to return a Twitter Video embed for the given Tweet.

    returns

    : The representation of embedded tweet.

  55. def oembedTweetByUrl(url: String, max_width: Option[Int] = None, hide_media: Boolean = false, hide_thread: Boolean = false, hide_tweet: Boolean = false, omit_script: Boolean = false, alignment: Alignment = Alignment.None, related: Seq[String] = Seq.empty, language: Language = Language.English, widget_type: Option[WidgetType] = None): Future[OEmbedTweet]

    Returns a single Tweet, specified by a Tweet web URL, in an oEmbed-compatible format.

    Returns a single Tweet, specified by a Tweet web URL, in an oEmbed-compatible format. The returned HTML snippet will be automatically recognized as an Embedded Tweet when Twitter’s widget JavaScript is included on the page. The oEmbed endpoint allows customization of the final appearance of an Embedded Tweet by setting the corresponding properties in HTML markup to be interpreted by Twitter’s JavaScript bundled with the HTML response by default. The format of the returned markup may change over time as Twitter adds new features or adjusts its Tweet representation. The Tweet fallback markup is meant to be cached on your servers for up to the suggested cache lifetime specified in the cache_age. For more information see https://dev.twitter.com/rest/reference/get/statuses/oembed.

    url

    : The URL of the Tweet to be embedded.

    max_width

    : Optional, by default it is None. The maximum width of a rendered Tweet in whole pixels. This value must be between 220 and 550 inclusive. A supplied value under or over the allowed range will be returned as the minimum or maximum supported width respectively; the reset width value will be reflected in the returned width property. Note that Twitter does not support the oEmbed max_height parameter. Tweets are fundamentally text, and are therefore of unpredictable height that cannot be scaled like an image or video. Relatedly, the oEmbed response will not provide a value for height. Implementations that need consistent heights for Tweets should refer to the hide_thread and hide_media parameters below.

    hide_media

    : By default, it is false. When set to true, links in a Tweet are not expanded to photo, video, or link previews.

    hide_thread

    : By default, it is false. When set to true, a collapsed version of the previous Tweet in a conversation thread will not be displayed when the requested Tweet is in reply to another Tweet.

    hide_tweet

    : By default, it is false. Applies to video type only. Set to true to link directly to the Tweet URL instead of displaying a Tweet overlay when a viewer clicks on the Twitter bird logo.

    omit_script

    : By default, it is false. When set to true, the <script> responsible for loading widgets.js will not be returned. Your webpages should include their own reference to widgets.js for use across all Twitter widgets including Embedded Tweets.

    alignment

    : By default it is None, meaning no alignment styles are specified for the Tweet. Specifies whether the embedded Tweet should be floated left, right, or center in the page relative to the parent element.

    related

    : By default it is an empty sequence. A sequence of Twitter usernames related to your content. This value will be forwarded to Tweet action intents if a viewer chooses to reply, favorite, or retweet the embedded Tweet.

    language

    : By default it is English. Request returned HTML and a rendered Tweet in the specified Twitter language supported by embedded Tweets.

    widget_type

    : Optional, by default it is None. Set to video to return a Twitter Video embed for the given Tweet.

    returns

    : The representation of embedded tweet.

  56. def parseFailedResponse(response: HttpResponse): Future[TwitterException]
    Attributes
    protected
    Definition Classes
    CommonClient
  57. def removeHeader(clazz: Class[_]): RequestTransformer
    Definition Classes
    RequestBuilding
  58. def removeHeader[T <: HttpHeader](implicit arg0: ClassTag[T]): RequestTransformer
    Definition Classes
    RequestBuilding
  59. def removeHeader(headerName: String): RequestTransformer
    Definition Classes
    RequestBuilding
  60. def removeHeaders(names: String*): RequestTransformer
    Definition Classes
    RequestBuilding
  61. def retweet(id: Long, trim_user: Boolean = false): Future[Tweet]

    Retweets a tweet.

    Retweets a tweet. Returns the original tweet with retweet details embedded. For more information see https://dev.twitter.com/rest/reference/post/statuses/retweet/%3Aid.

    id

    : The numerical ID of the desired status.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    returns

    : The representation of the original tweet with retweet details embedded.

  62. def retweeterIds(id: Long, count: Int = 100, cursor: Long = 1): Future[UserIds]

    Returns a collection of up to 100 user IDs belonging to users who have retweeted the tweet specified by the id parameter.

    Returns a collection of up to 100 user IDs belonging to users who have retweeted the tweet specified by the id parameter. For more information see https://dev.twitter.com/rest/reference/get/statuses/retweeters/ids.

    id

    : The numerical ID of the desired status.

    count

    : By default, it is 100. Specifies the number of ids to retrieve. Must be less than or equal to 100.

    cursor

    : By default it is -1, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.

    returns

    : The representation of the retweeter ids.

  63. def retweeterStringifiedIds(id: Long, count: Int = 100, cursor: Long = 1): Future[UserStringifiedIds]

    Returns a collection of up to 100 user stringified IDs belonging to users who have retweeted the tweet specified by the id parameter.

    Returns a collection of up to 100 user stringified IDs belonging to users who have retweeted the tweet specified by the id parameter. For more information see https://dev.twitter.com/rest/reference/get/statuses/retweeters/ids.

    id

    : The numerical ID of the desired status.

    count

    : By default, it is 100. Specifies the number of ids to retrieve. Must be less than or equal to 100.

    cursor

    : By default it is -1, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’s next_cursor and previous_cursor attributes to page back and forth in the list.

    returns

    : The representation of the retweeter stringified ids.

  64. def retweets(id: Long, count: Int = 100, trim_user: Boolean = false): Future[Seq[Tweet]]

    Returns a collection of the 100 most recent retweets of the tweet specified by the id parameter.

    Returns a collection of the 100 most recent retweets of the tweet specified by the id parameter. For more information see https://dev.twitter.com/rest/reference/get/statuses/retweets/%3Aid.

    id

    : The numerical ID of the desired status.

    count

    : By default it is 100. Specifies the number of records to retrieve. Must be less than or equal to 100.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    returns

    : The sequence of tweets.

  65. def retweetsOfMe(count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, trim_user: Boolean = false, exclude_replies: Boolean = false, contributor_details: Boolean = false, include_entities: Boolean = true): Future[Seq[Tweet]]

    Returns the most recent tweets authored by the authenticating user that have been retweeted by others.

    Returns the most recent tweets authored by the authenticating user that have been retweeted by others. For more information see https://dev.twitter.com/rest/reference/get/statuses/retweets_of_me.

    count

    : By default it is 20. Specifies the number of records to retrieve. Must be less than or equal to 100.

    since_id

    : Optional, by default it is None. Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.

    max_id

    : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    exclude_replies

    : By default it is false. This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets — this is because the count parameter retrieves that many tweets before filtering out retweets and replies.

    contributor_details

    : By default it is false. When set to true, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set to false, only the user_id of the contributor is included.

    include_entities

    : By default it is true. When set to false, The parameters node will be disincluded when set to false.

    returns

    : The sequence of tweets.

  66. def sendAndReceive[T](request: HttpRequest, f: (HttpResponse) ⇒ Future[T]): Future[T]
    Attributes
    protected
    Definition Classes
    RestClient
  67. def sendReceiveAs[T](httpRequest: HttpRequest)(implicit arg0: Manifest[T]): Future[T]
    Definition Classes
    RestClient
  68. implicit val serialization: Serialization.type
    Definition Classes
    JsonSupport
  69. val siteStreamingTwitterUrl: String
    Definition Classes
    Configurations
  70. val statusStreamingTwitterUrl: String
    Definition Classes
    Configurations
  71. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  72. def toString(): String
    Definition Classes
    AnyRef → Any
  73. def tweetLookup(ids: Seq[Long], include_entities: Boolean = true, trim_user: Boolean = false): Future[Seq[LookupTweet]]

    Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by sequence of values passed to the id parameter.

    Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by sequence of values passed to the id parameter. This method is especially useful to get the details (hydrate) a collection of Tweet IDs. Tweets that do not exist or cannot be viewed by the current user will not be returned. For more information see https://dev.twitter.com/rest/reference/get/statuses/lookup.

    ids

    : A sequence of tweet IDs, up to 100 are allowed in a single request.

    include_entities

    : By default it is true. The parameters node will be disincluded when set to false.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    returns

    : The representation of the lookup tweets.

  74. def tweetLookup(ids: Long*): Future[Seq[LookupTweet]]

    Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by sequence of values passed to the id parameter.

    Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by sequence of values passed to the id parameter. This method is especially useful to get the details (hydrate) a collection of Tweet IDs. Tweets that do not exist or cannot be viewed by the current user will not be returned. For more information see https://dev.twitter.com/rest/reference/get/statuses/lookup.

    ids

    : A sequence of tweet IDs, up to 100 are allowed in a single request.

    returns

    : The representation of the lookup tweets.

  75. def tweetLookupMapped(ids: Seq[Long], include_entities: Boolean = true, trim_user: Boolean = false): Future[LookupMapped]

    Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by sequence of values passed to the id parameter.

    Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by sequence of values passed to the id parameter. This method is especially useful to get the details (hydrate) a collection of Tweet IDs. Tweets ids will be used to create a map using the tweet id as key and tweet as corresponding body. For more information see https://dev.twitter.com/rest/reference/get/statuses/lookup.

    ids

    : A sequence of tweet IDs, up to 100 are allowed in a single request.

    include_entities

    : By default it is true. The parameters node will be disincluded when set to false.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    returns

    : The representation of the lookup tweets mapped by id.

  76. def tweetLookupMapped(ids: Long*): Future[LookupMapped]

    Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by sequence of values passed to the id parameter.

    Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by sequence of values passed to the id parameter. This method is especially useful to get the details (hydrate) a collection of Tweet IDs. Tweets ids will be used to create a map using the tweet id as key and tweet as corresponding body. For more information see https://dev.twitter.com/rest/reference/get/statuses/lookup.

    ids

    : A sequence of tweet IDs, up to 100 are allowed in a single request.

    returns

    : The representation of the lookup tweets mapped by id.

  77. val twitterVersion: String
    Definition Classes
    Configurations
  78. def unmarshal[T](requestStartTime: Long, f: (HttpResponse) ⇒ Future[T])(implicit request: HttpRequest, response: HttpResponse): Future[T]
    Attributes
    protected
    Definition Classes
    CommonClient
  79. val userStreamingTwitterUrl: String
    Definition Classes
    Configurations
  80. def userTimelineForUser(screen_name: String, since_id: Option[Long] = None, count: Int = 200, max_id: Option[Long] = None, trim_user: Boolean = false, exclude_replies: Boolean = false, contributor_details: Boolean = false, include_rts: Boolean = true): Future[Seq[Tweet]]

    Returns a collection of the most recent Tweets posted by the user indicated.

    Returns a collection of the most recent Tweets posted by the user indicated. User timelines belonging to protected users may only be requested when the authenticated user either “owns” the timeline or is an approved follower of the owner. The timeline returned is the equivalent of the one seen when you view a user’s profile on twitter.com. This method can only return up to 3,200 of a user’s most recent Tweets. Native retweets of other statuses by the user is included in this total, regardless of whether include_rts is set to false when requesting this resource. For more information see https://dev.twitter.com/rest/reference/get/statuses/user_timeline.

    screen_name

    : The screen name of the user for whom to return results for.

    since_id

    : Optional, by default it is None. Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.

    count

    : By default it is 200. Specifies the number of tweets to try and retrieve, up to a maximum of 200. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied. We include retweets in the count, even if include_rts is not supplied. It is recommended you always send include_rts=true when using this API method.

    max_id

    : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    exclude_replies

    : By default it is false. This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets — this is because the count parameter retrieves that many tweets before filtering out retweets and replies.

    contributor_details

    : By default it is false. When set to true, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set to false, only the user_id of the contributor is included.

    include_rts

    : By default it is true. When set to false, the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter). Note: If you’re using the trim_user parameter in conjunction with include_rts, the retweets will still contain a full user object.

    returns

    : The sequence of tweets.

  81. def userTimelineForUserId(user_id: Long, since_id: Option[Long] = None, count: Int = 200, max_id: Option[Long] = None, trim_user: Boolean = false, exclude_replies: Boolean = false, contributor_details: Boolean = false, include_rts: Boolean = true): Future[Seq[Tweet]]

    Returns a collection of the most recent Tweets posted by the user id indicated.

    Returns a collection of the most recent Tweets posted by the user id indicated. User timelines belonging to protected users may only be requested when the authenticated user either “owns” the timeline or is an approved follower of the owner. The timeline returned is the equivalent of the one seen when you view a user’s profile on twitter.com. This method can only return up to 3,200 of a user’s most recent Tweets. Native retweets of other statuses by the user is included in this total, regardless of whether include_rts is set to false when requesting this resource. For more information see https://dev.twitter.com/rest/reference/get/statuses/user_timeline.

    user_id

    : The ID of the user for whom to return results for.

    since_id

    : Optional, by default it is None. Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.

    count

    : By default it is 200. Specifies the number of tweets to try and retrieve, up to a maximum of 200. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied. We include retweets in the count, even if include_rts is not supplied. It is recommended you always send include_rts=true when using this API method.

    max_id

    : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    trim_user

    : By default it is false. When set to true, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter to false to receive the complete user object.

    exclude_replies

    : By default it is false. This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets — this is because the count parameter retrieves that many tweets before filtering out retweets and replies.

    contributor_details

    : By default it is false. When set to true, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set to false, only the user_id of the contributor is included.

    include_rts

    : By default it is true. When set to false, the timeline will strip any native retweets (though they will still count toward both the maximal length of the timeline and the slice selected by the count parameter). Note: If you’re using the trim_user parameter in conjunction with include_rts, the retweets will still contain a full user object.

    returns

    : The sequence of tweets.

  82. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. val withLogRequest: Boolean
    Definition Classes
    RestClient → CommonClient
  86. val withLogRequestResponse: Boolean
    Definition Classes
    RestClient → CommonClient
  87. def withOAuthHeader: (HttpRequest) ⇒ Future[HttpRequest]
    Definition Classes
    OAuthClient
  88. def withSimpleOAuthHeader: (HttpRequest) ⇒ Future[HttpRequest]
    Definition Classes
    OAuthClient

Deprecated Value Members

  1. def getHomeTimeline(count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, trim_user: Boolean = false, exclude_replies: Boolean = false, contributor_details: Boolean = false, include_entities: Boolean = true): Future[Seq[Tweet]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use homeTimeline instead

  2. def getMentionsTimeline(count: Int = 200, since_id: Option[Long] = None, max_id: Option[Long] = None, trim_user: Boolean = false, contributor_details: Boolean = false, include_entities: Boolean = true): Future[Seq[Tweet]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use mentionsTimeline instead

  3. def getOembedTweetById(id: Long, max_width: Option[Int] = None, hide_media: Boolean = false, hide_thread: Boolean = false, hide_tweet: Boolean = false, omit_script: Boolean = false, alignment: Alignment = Alignment.None, related: Seq[String] = Seq.empty, language: Language = Language.English, widget_type: Option[WidgetType] = None): Future[OEmbedTweet]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use oembedTweetById instead

  4. def getOembedTweetByUrl(url: String, max_width: Option[Int] = None, hide_media: Boolean = false, hide_thread: Boolean = false, hide_tweet: Boolean = false, omit_script: Boolean = false, alignment: Alignment = Alignment.None, related: Seq[String] = Seq.empty, language: Language = Language.English, widget_type: Option[WidgetType] = None): Future[OEmbedTweet]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use oembedTweetByUrl instead

  5. def getRetweeterIds(id: Long, count: Int = 100, cursor: Long = 1): Future[UserIds]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use retweeterIds instead

  6. def getRetweeterStringifiedIds(id: Long, count: Int = 100, cursor: Long = 1): Future[UserStringifiedIds]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use retweeterStringifiedIds instead

  7. def getRetweets(id: Long, count: Int = 100, trim_user: Boolean = false): Future[Seq[Tweet]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use retweets instead

  8. def getRetweetsOfMe(count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, trim_user: Boolean = false, exclude_replies: Boolean = false, contributor_details: Boolean = false, include_entities: Boolean = true): Future[Seq[Tweet]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use retweetsOfMe instead

  9. def getTweetLookup(ids: Seq[Long], include_entities: Boolean = true, trim_user: Boolean = false): Future[Seq[LookupTweet]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use tweetLookup instead

  10. def getTweetLookup(ids: Long*): Future[Seq[LookupTweet]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use tweetLookup instead

  11. def getTweetLookupMapped(ids: Seq[Long], include_entities: Boolean = true, trim_user: Boolean = false): Future[LookupMapped]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use tweetLookupMapped instead

  12. def getTweetLookupMapped(ids: Long*): Future[LookupMapped]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use tweetLookupMapped instead

  13. def getUserTimelineForUser(screen_name: String, since_id: Option[Long] = None, count: Int = 200, max_id: Option[Long] = None, trim_user: Boolean = false, exclude_replies: Boolean = false, contributor_details: Boolean = false, include_rts: Boolean = true): Future[Seq[Tweet]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use userTimelineForUser instead

  14. def getUserTimelineForUserId(user_id: Long, since_id: Option[Long] = None, count: Int = 200, max_id: Option[Long] = None, trim_user: Boolean = false, exclude_replies: Boolean = false, contributor_details: Boolean = false, include_rts: Boolean = true): Future[Seq[Tweet]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use userTimelineForUserId instead

  15. def tweet(status: String, in_reply_to_status_id: Option[Long] = None, possibly_sensitive: Boolean = false, latitude: Option[Long] = None, longitude: Option[Long] = None, place_id: Option[String] = None, display_coordinates: Boolean = false, trim_user: Boolean = false, media_ids: Seq[Long] = Seq.empty): Future[Tweet]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use createTweet instead

Inherited from Configurations

Inherited from RestClient

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