class TwitterRestClient extends RestClients with SystemShutdown
Represents the functionalities offered by the Twitter REST API
- Source
- TwitterRestClient.scala
- Alphabetic
- By Inheritance
- TwitterRestClient
- SystemShutdown
- RestClients
- TwitterUserClient
- TwitterTrendClient
- TwitterSuggestionClient
- TwitterStatusClient
- TwitterSearchClient
- TwitterSavedSearchClient
- TwitterMuteClient
- TwitterMediaClient
- TwitterListClient
- TwitterHelpClient
- TwitterGeoClient
- TwitterFriendshipClient
- TwitterFriendClient
- TwitterFollowerClient
- TwitterFavoriteClient
- TwitterDirectMessageClient
- TwitterBlockClient
- TwitterApplicationClient
- TwitterAccountActivityClient
- TwitterAccountClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TwitterRestClient(consumerToken: ConsumerToken, accessToken: AccessToken)(implicit _system: ActorSystem = ActorSystem("twitter4s-rest"))
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
- def addListMemberByListId(list_id: Long, screen_name: String): Future[Unit]
Add a member to a list.
Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists cannot have more than 5,000 members. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create.
- list_id
: The numerical id of the list.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- Definition Classes
- TwitterListClient
- def addListMemberBySlugAndOwnerId(slug: String, owner_id: Long, screen_name: String): Future[Unit]
Add a member to a list.
Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists cannot have more than 5,000 members. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- Definition Classes
- TwitterListClient
- def addListMemberBySlugAndOwnerName(slug: String, owner_screen_name: String, screen_name: String): Future[Unit]
Add a member to a list.
Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists cannot have more than 5,000 members. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- Definition Classes
- TwitterListClient
- def addListMemberIdByListId(list_id: Long, user_id: Long): Future[Unit]
Add a member to a list.
Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists cannot have more than 5,000 members. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create.
- list_id
: The numerical id of the list.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- Definition Classes
- TwitterListClient
- def addListMemberIdBySlugAndOwnerId(slug: String, owner_id: Long, user_id: Long): Future[Unit]
Add a member to a list.
Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists cannot have more than 5,000 members. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- Definition Classes
- TwitterListClient
- def addListMemberIdBySlugAndOwnerName(slug: String, owner_screen_name: String, user_id: Long): Future[Unit]
Add a member to a list.
Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists cannot have more than 5,000 members. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- Definition Classes
- TwitterListClient
- def addListMemberIdsByListId(list_id: Long, user_ids: Seq[Long]): Future[Unit]
Adds multiple members to a list.
Adds multiple members to a list. The authenticated user must own the list to be able to add members to it. Note that lists can’t have more than 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all.
- list_id
: The numerical id of the list.
- user_ids
: The list of user IDs to add, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def addListMemberIdsBySlugAndOwnerId(slug: String, owner_id: Long, user_ids: Seq[Long]): Future[Unit]
Adds multiple members to a list.
Adds multiple members to a list. The authenticated user must own the list to be able to add members to it. Note that lists can’t have more than 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- user_ids
: The list of user IDs to add, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def addListMemberIdsBySlugAndOwnerName(slug: String, owner_screen_name: String, user_ids: Seq[Long]): Future[Unit]
Adds multiple members to a list.
Adds multiple members to a list. The authenticated user must own the list to be able to add members to it. Note that lists can’t have more than 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- user_ids
: The list of user IDs to add, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def addListMembersByListId(list_id: Long, screen_names: Seq[String]): Future[Unit]
Adds multiple members to a list.
Adds multiple members to a list. The authenticated user must own the list to be able to add members to it. Note that lists can’t have more than 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all.
- list_id
: The numerical id of the list.
- screen_names
: The list of user screen names to add, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def addListMembersBySlugAndOwnerId(slug: String, owner_id: Long, screen_names: Seq[String]): Future[Unit]
Adds multiple members to a list.
Adds multiple members to a list. The authenticated user must own the list to be able to add members to it. Note that lists can’t have more than 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- screen_names
: The list of user screen names to add, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def addListMembersBySlugAndOwnerName(slug: String, owner_screen_name: String, screen_names: Seq[String]): Future[Unit]
Adds multiple members to a list.
Adds multiple members to a list. The authenticated user must own the list to be able to add members to it. Note that lists can’t have more than 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create_all.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- screen_names
: The list of user screen names to add, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def advancedSearchGeoPlace(latitude: Option[Double] = None, longitude: Option[Double] = None, query: Option[String] = None, ip: Option[String] = None, granularity: Option[Granularity] = None, accuracy: Option[Accuracy] = None, max_results: Option[Int] = None, contained_within: Option[String] = None, street_address: Option[String] = None, callback: Option[String] = None): Future[RatedData[GeoSearch]]
Advanced search for places that can be attached to a statuses/update.
Advanced search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status. For more information see https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search.
- latitude
: Optional, by default it is
None
. The latitude to search around. 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 correspondinglongitude
parameter.- longitude
: Optional, by default it is
None
. The longitude to search around. 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 geo_enabled is disabled, or if there not a correspondinglatitude
parameter.- query
: Optional, by default it is
None
. Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.- ip
: Optional, by default it is
None
. An IP address. Used when attempting to fix geolocation based off of the user’s IP address.- granularity
: By default it is
Neighborhood
This is the minimal granularity of place types to return.- max_results
: Optional, by default it is
None
. A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many “nearby” results to return. Ideally, only pass in the number of places you intend to display to the user here.- contained_within
: Optional, by default it is
None
. This is the place id which you would like to restrict the search results to. Setting this value means only places within the given place id will be found.- street_address
: Optional, by default it is
None
. This parameter searches for places which have this given street address. There are other well-known, and application specific attributes available. Custom attributes are also permitted.- callback
: Optional, by default it is
None
. If supplied, the response will use the JSONP format with a callback of the given name.- returns
: The geo search result.
- Definition Classes
- TwitterGeoClient
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def blockUser(screen_name: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Blocks the specified user from following the authenticating user.
Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-blocks-create.
- screen_name
: The screen name of the potentially blocked user. Helpful for disambiguating when a valid user ID is also a valid screen name.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The representation of the blocked user.
- Definition Classes
- TwitterBlockClient
- def blockUserId(user_id: Long, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Blocks the specified user id from following the authenticating user.
Blocks the specified user id from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-blocks-create.
- user_id
: The ID of the potentially blocked user. Helpful for disambiguating when a valid user ID is also a valid screen name.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The representation of the blocked user.
- Definition Classes
- TwitterBlockClient
- def blockedUserIds(cursor: Long = -1): Future[RatedData[UserIds]]
Returns an array of user ids the authenticating user is blocking.
Returns an array of user ids the authenticating user is blocking. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-ids.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried.- returns
: The cursored representation of user ids.
- Definition Classes
- TwitterBlockClient
- def blockedUserStringifiedIds(cursor: Long = -1): Future[RatedData[UserStringifiedIds]]
Returns an array of user stringified ids the authenticating user is blocking.
Returns an array of user stringified ids the authenticating user is blocking. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-ids.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried.- returns
: The cursored representation of user stringified ids with cursors.
- Definition Classes
- TwitterBlockClient
- def blockedUsers(include_entities: Boolean = true, skip_status: Boolean = false, cursor: Long = -1): Future[RatedData[Users]]
Returns the users that the authenticating user is blocking.
Returns the users that the authenticating user is blocking. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried.- returns
: The cursored representation of blocked users.
- Definition Classes
- TwitterBlockClient
- def checkListMemberByUserAndListId(list_id: Long, screen_name: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[User]]
Check if the specified user is a member of the specified list.
Check if the specified user is a member of the specified list. If the user is a member of the specified list, his user representation is returned. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show.
- list_id
: The numerical id of the list.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The user representation if the specified user is a member of the specified list, it throws an
TwitterException
instead.
- Definition Classes
- TwitterListClient
- def checkListMemberByUserIdAndListId(list_id: Long, user_id: Long, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[User]]
Check if the specified user is a member of the specified list.
Check if the specified user is a member of the specified list. If the user is a member of the specified list, his user representation is returned. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show.
- list_id
: The numerical id of the list.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The user representation if the specified user is a member of the specified list, it throws an
TwitterException
instead.
- Definition Classes
- TwitterListClient
- def checkListMemberByUserIdSlugAndOwnerId(slug: String, owner_id: Long, user_id: Long, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[User]]
Check if the specified user is a member of the specified list.
Check if the specified user is a member of the specified list. If the user is a member of the specified list, his user representation is returned. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The user representation if the specified user is a member of the specified list, it throws an
TwitterException
instead.
- Definition Classes
- TwitterListClient
- def checkListMemberByUserIdSlugAndOwnerName(slug: String, owner_screen_name: String, user_id: Long, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[User]]
Check if the specified user is a member of the specified list.
Check if the specified user is a member of the specified list. If the user is a member of the specified list, his user representation is returned. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The user representation if the specified user is a member of the specified list, it throws an
TwitterException
instead.
- Definition Classes
- TwitterListClient
- def checkListMemberByUserSlugAndOwnerId(slug: String, owner_id: Long, screen_name: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[User]]
Check if the specified user is a member of the specified list.
Check if the specified user is a member of the specified list. If the user is a member of the specified list, his user representation is returned. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The user representation if the specified user is a member of the specified list, it throws an
TwitterException
instead.
- Definition Classes
- TwitterListClient
- def checkListMemberByUserSlugAndOwnerName(slug: String, owner_screen_name: String, screen_name: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[User]]
Check if the specified user is a member of the specified list.
Check if the specified user is a member of the specified list. If the user is a member of the specified list, his user representation is returned. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The user representation if the specified user is a member of the specified list, it throws an
TwitterException
instead.
- Definition Classes
- TwitterListClient
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def closestLocationTrends(latitude: Double, longitude: Double): Future[RatedData[Seq[Location]]]
Returns the locations that Twitter has trending topic information for, closest to a specified location.
Returns the locations that Twitter has trending topic information for, closest to a specified location. The response is an array of “locations” that encode the location’s WOEID and some other human-readable information such as a canonical name and country the location belongs in. A WOEID is a Yahoo! Where On Earth ID. For more information see https://developer.twitter.com/en/docs/trends/locations-with-trending-topics/api-reference/get-trends-closest.
- latitude
: If provided with a
longitude
parameter the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.- longitude
: If provided with a
latitude
parameter the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.- returns
: The sequence of locations that Twitter has trending topic information for.
- Definition Classes
- TwitterTrendClient
- def configuration(): Future[RatedData[Configuration]]
Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co shortened URL length.
Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co shortened URL length. For more information see https://developer.twitter.com/en/docs/developer-utilities/configuration/api-reference/get-help-configuration.
- returns
: The current Twitter configuration.
- Definition Classes
- TwitterHelpClient
- val consumerToken: ConsumerToken
- 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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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 totrue
.- 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 correspondinglongitude
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 correspondinglatitude
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 totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
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.
- Definition Classes
- TwitterStatusClient
- def createDirectMessageEvent(user_id: Long, text: String): Future[Event]
Sends a new direct message to the specified user from the authenticating user.
Sends a new direct message to the specified user from the authenticating user. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event.
- user_id
: The ID of the user who should receive the direct message. Note: this must be the user id, not its screen name.
- text
: The text of your direct message.
- returns
: The sent message.
- Definition Classes
- TwitterDirectMessageClient
- def createList(name: String, mode: Mode = Mode.Public, description: Option[String] = None): Future[TwitterList]
Creates a new list for the authenticated user.
Creates a new list for the authenticated user. Note that you can create up to 1000 lists per account. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create.
- name
: The name for the list. A list’s name must start with a letter and can consist only of 25 or fewer letters, numbers, “-“, or “_” characters.
- mode
: By default it is
Public
. Whether your list is public or private.- description
: Optional, by default it is
None
. The description to give the list.- returns
: The new created Twitter list.
- Definition Classes
- TwitterListClient
- def createMediaDescription(media_id: Long, description: String): Future[Unit]
This endpoint can be used to provide additional information about the uploaded media_id.
This endpoint can be used to provide additional information about the uploaded media_id. This feature is currently only supported for images and GIFs. For more information see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-metadata-create.
- media_id
: The id of the media.
- description
: The description of the media
- Definition Classes
- TwitterMediaClient
- 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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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 totrue
.- 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 correspondinglongitude
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 correspondinglatitude
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 totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
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.
- Definition Classes
- TwitterStatusClient
- def deleteDirectMessage(id: Long, include_entities: Boolean = true): Future[DirectMessage]
Destroys the direct message specified in the required ID parameter.
Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message.
- id
: The ID of the direct message to delete.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- returns
: The deleted direct message.
- Definition Classes
- TwitterDirectMessageClient
- def deleteListById(list_id: Long): Future[TwitterList]
Deletes the specified list.
Deletes the specified list. The authenticated user must own the list to be able to destroy it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy.
- list_id
: The numerical id of the list.
- returns
: The representation of the deleted twitter list
- Definition Classes
- TwitterListClient
- def deleteListBySlugAndOwnerId(slug: String, owner_id: Long): Future[TwitterList]
Deletes the specified list.
Deletes the specified list. The authenticated user must own the list to be able to destroy it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- returns
: The representation of the deleted twitter list
- Definition Classes
- TwitterListClient
- def deleteListBySlugAndOwnerName(slug: String, owner_screen_name: String): Future[TwitterList]
Deletes the specified list.
Deletes the specified list. The authenticated user must own the list to be able to destroy it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- returns
: The representation of the deleted twitter list
- Definition Classes
- TwitterListClient
- def deleteSavedSearch(id: Long): Future[SavedSearch]
Destroys a saved search for the authenticating user.
Destroys a saved search for the authenticating user. The authenticating user must be the owner of saved search id being destroyed. For more information see https://developer.twitter.com/en/docs/tweets/search/api-reference/post-saved_searches-destroy-id.
- returns
: The deleted search representation.
- Definition Classes
- TwitterSavedSearchClient
- def deleteTweet(id: Long, trim_user: Boolean = false, tweet_mode: TweetMode = TweetMode.Classic): 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://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id.
- id
: The numerical ID of the desired status.
- trim_user
: By default it is
false
. When set totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
to receive the complete user object.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The representation of the deleted tweet.
- Definition Classes
- TwitterStatusClient
- def directMessageEvent(id: String): Future[Event]
Returns Direct Message event (both sent and received) by Id.
Returns Direct Message event (both sent and received) by Id. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-event.
- id
: The id of event to return.
- returns
: the requested event
- Definition Classes
- TwitterDirectMessageClient
- def disableDeviceNotificationsForUser(screen_name: String): Future[Relationship]
Allows one to disable device notifications from the specified user.
Allows one to disable device notifications from the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.
- screen_name
: The screen name of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def disableDeviceNotificationsForUserId(user_id: Long): Future[Relationship]
Allows one to disable device notifications from the specified user id.
Allows one to disable device notifications from the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.
- user_id
: The ID of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def disableRetweetsNotificationsForUser(screen_name: String): Future[Relationship]
Allows one to disable retweets from the specified user.
Allows one to disable retweets from the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.
- screen_name
: The screen name of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def disableRetweetsNotificationsForUserId(user_id: Long): Future[Relationship]
Allows one to disable retweets from the specified user id.
Allows one to disable retweets from the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.
- user_id
: The ID of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def enableDeviceNotificationsForUser(screen_name: String): Future[Relationship]
Allows one to enable device notifications from the specified user.
Allows one to enable device notifications from the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.
- screen_name
: The screen name of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def enableDeviceNotificationsForUserId(user_id: Long): Future[Relationship]
Allows one to enable device notifications from the specified user id.
Allows one to enable device notifications from the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.
- user_id
: The ID of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def enableRetweetsNotificationsForUser(screen_name: String): Future[Relationship]
Allows one to enable retweets from the specified user.
Allows one to enable retweets from the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.
- screen_name
: The screen name of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def enableRetweetsNotificationsForUserId(user_id: Long): Future[Relationship]
Allows one to enable retweets from the specified user id.
Allows one to enable retweets from the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.
- user_id
: The ID of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def eventsList(count: Int = 20, cursor: Option[String] = None): Future[DirectMessageEventList]
Returns all Direct Message events (both sent and received) within the last 30 days, sorted in reverse-chronological order.
Returns all Direct Message events (both sent and received) within the last 30 days, sorted in reverse-chronological order. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events.
- count
: Optional parameter. Max number of events to be returned. 20 default. 50 max.
- cursor
: Optional parameter. For paging through result sets greater than 1 page, use the “next_cursor” property from the previous request.
- returns
: list of events
- Definition Classes
- TwitterDirectMessageClient
- def favoriteStatus(id: Long, include_entities: Boolean = true): Future[Tweet]
Likes the status specified in the ID parameter as the authenticating user.
Likes the status specified in the ID parameter as the authenticating user. Note: the like action was known as favorite before November 3, 2015; the historical naming remains in API methods and object properties. For more information see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-favorites-create.
- id
: The numerical ID of the desired status.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- returns
: The liked status.
- Definition Classes
- TwitterFavoriteClient
- def favoriteStatusesForUser(screen_name: String, count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, include_entities: Boolean = true): Future[RatedData[Seq[Tweet]]]
Returns the 20 most recent Tweets liked by the specified user.
Returns the 20 most recent Tweets liked by the specified user. For more information see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-favorites-list.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- count
: By default it is
200
. Specifies the number of records to retrieve. Must be less than or equal to 200; defaults to 20. 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 occurred 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.- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- returns
: The sequence of favorite statuses.
- Definition Classes
- TwitterFavoriteClient
- def favoriteStatusesForUserId(user_id: Long, count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, include_entities: Boolean = true): Future[RatedData[Seq[Tweet]]]
Returns the 20 most recent Tweets liked by the specified user id.
Returns the 20 most recent Tweets liked by the specified user id. For more information see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-favorites-list.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- count
: By default it is
200
. Specifies the number of records to retrieve. Must be less than or equal to 200; defaults to 20. 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.- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- returns
: The sequence of favorite statuses.
- Definition Classes
- TwitterFavoriteClient
- def followUser(screen_name: String, notify: Boolean = true): Future[User]
Allows the authenticating users to follow the specified user.
Allows the authenticating users to follow the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create.
- screen_name
: The screen name of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- notify
: By default it is
true
. Enable notifications for the target user.- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def followUserId(user_id: Long, notify: Boolean = true): Future[User]
Allows the authenticating users to follow the specified user id.
Allows the authenticating users to follow the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create.
- user_id
: The ID of the user for whom to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
- notify
: By default it is
true
. Enable notifications for the target user.- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def followerIdsForUser(screen_name: String, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserIds]]
Returns a cursored collection of user IDs for every user following the specified user.
Returns a cursored collection of user IDs for every user following the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
5000
. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.- returns
: The cursored representation of the users ids following the specified user.
- Definition Classes
- TwitterFollowerClient
- def followerIdsForUserId(user_id: Long, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserIds]]
Returns a cursored collection of user IDs for every user following the specified user id.
Returns a cursored collection of user IDs for every user following the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
5000
. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.- returns
: The cursored representation of the users ids following the specified user.
- Definition Classes
- TwitterFollowerClient
- def followerStringifiedIdsForUserId(user_id: Long, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserStringifiedIds]]
Returns a cursored collection of user stringified IDs for every user following the specified user id.
Returns a cursored collection of user stringified IDs for every user following the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
5000
. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.- returns
: The cursored representation of the users stringified ids following the specified user.
- Definition Classes
- TwitterFollowerClient
- def followersForUser(screen_name: String, cursor: Long = -1, count: Int = 20, skip_status: Boolean = false, include_user_entities: Boolean = true): Future[RatedData[Users]]
Returns a cursored collection of user objects for users following the specified user.
Returns a cursored collection of user objects for users following the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-list.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
20
. The number of users to return per page, up to a maximum of 200.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user objects.- include_user_entities
: By default it is
true
. The user object parameters node will not be included when set to false.- returns
: The cursored representation of the users following the specified user.
- Definition Classes
- TwitterFollowerClient
- def followersForUserId(user_id: Long, cursor: Long = -1, count: Int = 20, skip_status: Boolean = false, include_user_entities: Boolean = true): Future[RatedData[Users]]
Returns a cursored collection of user objects for users following the specified user id.
Returns a cursored collection of user objects for users following the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-list.
- user_id
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
20
. The number of users to return per page, up to a maximum of 200.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user objects.- include_user_entities
: By default it is
true
. The user object parameters node will not be included when set to false.- returns
: The cursored representation of the users following the specified user.
- Definition Classes
- TwitterFollowerClient
- def followersStringifiedIdsForUser(screen_name: String, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserStringifiedIds]]
Returns a cursored collection of user stringified IDs for every user following the specified user.
Returns a cursored collection of user stringified IDs for every user following the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
5000
. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.- returns
: The cursored representation of the users stringified ids following the specified user.
- Definition Classes
- TwitterFollowerClient
- def friendIdsForUser(screen_name: String, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserIds]]
Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their “friends”).
Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it isNone
. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
5000
. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.- returns
: The cursored representation of the user ids the specified user is following.
- Definition Classes
- TwitterFriendClient
- def friendIdsForUserId(user_id: Long, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserIds]]
Returns a cursored collection of user IDs for every user the specified user id is following (otherwise known as their “friends”).
Returns a cursored collection of user IDs for every user the specified user id is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it isNone
. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
5000
. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.- returns
: The cursored representation of the user ids the specified user id is following.
- Definition Classes
- TwitterFriendClient
- def friendStringifiedIdsForUser(screen_name: String, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserStringifiedIds]]
Returns a cursored collection of user stringified IDs for every user the specified user is following (otherwise known as their “friends”).
Returns a cursored collection of user stringified IDs for every user the specified user is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it isNone
. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
5000
. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.- returns
: The cursored representation of the user stringified ids the specified user is following.
- Definition Classes
- TwitterFriendClient
- def friendStringifiedIdsForUserId(user_id: Long, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserStringifiedIds]]
Returns a cursored collection of user stringified IDs for every user the specified user id is following (otherwise known as their “friends”).
Returns a cursored collection of user stringified IDs for every user the specified user id is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it isNone
. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
5000
. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.- returns
: The cursored representation of the user stringified ids the specified user id is following.
- Definition Classes
- TwitterFriendClient
- def friendsForUser(screen_name: String, cursor: Long = -1, count: Int = 20, skip_status: Boolean = false, include_user_entities: Boolean = true): Future[RatedData[Users]]
Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their “friends”).
Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-list.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it isNone
. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
20
. The number of users to return per page, up to a maximum of 200.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user objects.- include_user_entities
: By default it is
true
. The user object parameters node will not be included when set to false.- returns
: The cursored representation of the users the specified user is following.
- Definition Classes
- TwitterFriendClient
- def friendsForUserId(user_id: Long, cursor: Long = -1, count: Int = 20, skip_status: Boolean = false, include_user_entities: Boolean = true): Future[RatedData[Users]]
Returns a cursored collection of user objects for every user the specified user id is following (otherwise known as their “friends”).
Returns a cursored collection of user objects for every user the specified user id is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-list.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it isNone
. Returns results with an ID less than (that is, older than) or equal to the specified ID.- count
: By default it is
20
. The number of users to return per page, up to a maximum of 200.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user objects.- include_user_entities
: By default it is
true
. The user object parameters node will not be included when set to false.- returns
: The cursored representation of the users the specified user id is following.
- Definition Classes
- TwitterFriendClient
- def geoPlace(place_id: String): Future[RatedData[GeoPlace]]
Returns all the information about a known place.
Returns all the information about a known place. For more information see https://developer.twitter.com/en/docs/geo/place-information/api-reference/get-geo-id-place_id.
- place_id
: A place id in the world.
- returns
: A set of information about place.
- Definition Classes
- TwitterGeoClient
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getTweet(id: Long, trim_user: Boolean = false, include_my_retweet: Boolean = false, include_entities: Boolean = true, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id.
- id
: The numerical ID of the desired status.
- trim_user
: By default it is
false
. When set totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
to receive the complete user object.- include_my_retweet
: By default it is
false
. When set totrue
, any Tweets returned that have been retweeted by the authenticating user will include an additionalcurrent_user_retweet
node, containing the ID of the source status for the retweet.- include_entities
: By default it is
true
. When set tofalse
, The parameters node will be disincluded when set to false.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The representation of the tweet.
- Definition Classes
- TwitterStatusClient
- def globalTrends(exclude_hashtags: Boolean = false): Future[RatedData[Seq[LocationTrends]]]
Returns the top 10 global trending topics.
Returns the top 10 global trending topics. The response is an array of “trend” objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Twitter Search, and the Twitter Search URL. This information is cached for 5 minutes. Requesting more frequently than that will not return any more data, and will count against your rate limit usage. For more information see https://developer.twitter.com/en/docs/trends/trends-for-location/api-reference/get-trends-place.
- exclude_hashtags
: By default it is
false
. Setting this totrue
will remove all hashtags from the trends list.- returns
: The representation of the location trends.
- Definition Classes
- TwitterTrendClient
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[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://developer.twitter.com/en/docs/tweets/timelines/api-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 thesince_id
, thesince_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 totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
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 totrue
, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set tofalse
, only the user_id of the contributor is included.- include_entities
: By default it is
true
. When set tofalse
, The parameters node will be disincluded when set to false.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets.
- Definition Classes
- TwitterStatusClient
- def incomingFriendshipIds(cursor: Long = -1): Future[RatedData[UserIds]]
Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.
Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried.- returns
: The sequence of the user ids that have a pending request to follow the authenticating user.
- Definition Classes
- TwitterFriendshipClient
- def incomingFriendshipStringifiedIds(cursor: Long = -1): Future[RatedData[UserStringifiedIds]]
Returns a collection of numeric stringified IDs for every user who has a pending request to follow the authenticating user.
Returns a collection of numeric stringified IDs for every user who has a pending request to follow the authenticating user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried.- returns
: The sequence of the user stringified ids that have a pending request to follow the authenticating user.
- Definition Classes
- TwitterFriendshipClient
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isUserSubscribed(env_name: String): Future[Unit]
Provides a way to determine if a webhook configuration is subscribed to the provided user’s events.
Provides a way to determine if a webhook configuration is subscribed to the provided user’s events. If the provided user context has an active subscription with provided application, returns 204 OK. If the response code is not 204, then the user does not have an active subscription. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#get-account-activity-all-env-name-subscriptions.
- env_name
: The environment name is the name of the App that provide the access to the Account Activity API.
- Definition Classes
- TwitterAccountActivityClient
- def listById(list_id: Long): Future[RatedData[TwitterList]]
Returns the specified list.
Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-show.
- list_id
: The numerical id of the list.
- returns
: The Twitter list.
- Definition Classes
- TwitterListClient
- def listBySlugAndOwnerId(slug: String, owner_id: Long): Future[RatedData[TwitterList]]
Returns the specified list.
Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-show.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- returns
: The Twitter list.
- Definition Classes
- TwitterListClient
- def listBySlugAndOwnerName(slug: String, owner_screen_name: String): Future[RatedData[TwitterList]]
Returns the specified list.
Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-show.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- returns
: The Twitter list.
- Definition Classes
- TwitterListClient
- def listMembersByListId(list_id: Long, count: Int = 20, cursor: Long = -1, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[Users]]
Returns the members of the specified list.
Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members.
- list_id
: The numerical id of the list.
- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The users representation of the members of the list.
- Definition Classes
- TwitterListClient
- def listMembersBySlugAndOwnerId(slug: String, owner_id: Long, count: Int = 20, cursor: Long = -1, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[Users]]
Returns the members of the specified list.
Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The users representation of the members of the list.
- Definition Classes
- TwitterListClient
- def listMembersBySlugAndOwnerName(slug: String, owner_screen_name: String, count: Int = 20, cursor: Long = -1, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[Users]]
Returns the members of the specified list.
Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-members.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The users representation of the members of the list.
- Definition Classes
- TwitterListClient
- def listMembershipsForUser(screen_name: String, count: Int = 20, cursor: Long = -1, filter_to_owned_lists: Boolean = false): Future[RatedData[TwitterLists]]
Returns the twitter lists the specified user has been added to.
Returns the twitter lists the specified user has been added to. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- filter_to_owned_lists
: By default it is
false
. When set totrue
, will return just lists the authenticating user owns, and the user represented by user_id or screen_name is a member of.- returns
: The twitter lists the specified user has been added to.
- Definition Classes
- TwitterListClient
- def listMembershipsForUserId(user_id: Long, count: Int = 20, cursor: Long = -1, filter_to_owned_lists: Boolean = false): Future[RatedData[TwitterLists]]
Returns the twitter lists the specified user has been added to.
Returns the twitter lists the specified user has been added to. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-memberships.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- filter_to_owned_lists
: By default it is
false
. When set totrue
, will return just lists the authenticating user owns, and the user represented by user_id or screen_name is a member of.- returns
: The twitter lists the specified user has been added to.
- Definition Classes
- TwitterListClient
- def listOwnerships(screen_name: String, count: Int = 20, cursor: Long = -1): Future[RatedData[TwitterLists]]
Returns the lists owned by the specified Twitter user.
Returns the lists owned by the specified Twitter user. Private lists will only be shown if the authenticated user is also the owner of the lists. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- returns
: The Twitter lists owned by the specified user.
- Definition Classes
- TwitterListClient
- def listOwnershipsForUserId(user_id: Long, count: Int = 20, cursor: Long = -1): Future[RatedData[TwitterLists]]
Returns the lists owned by the specified Twitter user.
Returns the lists owned by the specified Twitter user. Private lists will only be shown if the authenticated user is also the owner of the lists. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships.
- user_id
: The ID of the user for whom to return results for.
- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- returns
: The Twitter lists owned by the specified user.
- Definition Classes
- TwitterListClient
- def listSubscriptions(screen_name: String, count: Int = 20, cursor: Long = -1): Future[RatedData[TwitterLists]]
Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default.
Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user’s own lists. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-subscriptions.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.
- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- returns
: The Twitter lists the specified user is subscribed to.
- Definition Classes
- TwitterListClient
- def listSubscriptionsByUserId(user_id: Long, count: Int = 20, cursor: Long = -1): Future[RatedData[TwitterLists]]
Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default.
Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user’s own lists. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-subscriptions.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- count
: By default it is
20
. The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.- cursor
: By default it is
-1
, which is the first “page”. Breaks the results into pages. Provide values as returned in the response body’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- returns
: The Twitter lists the specified user is subscribed to.
- Definition Classes
- TwitterListClient
- def listTimelineByListId(list_id: Long, count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, include_entities: Boolean = true, include_rts: Boolean = false, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[Seq[Tweet]]]
Returns a timeline of tweets authored by members of the specified list.
Returns a timeline of tweets authored by members of the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses.
- list_id
: The numerical id of the list.
- count
: By default it is
20
. Specifies the number of results to retrieve per "page".- 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 thesince_id
, thesince_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.- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- include_rts
: By default it is
false
. When set totrue
, the list timeline will contain native retweets (if they exist) in addition to the standard stream of tweets.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets for the specified list.
- Definition Classes
- TwitterListClient
- def listTimelineBySlugAndOwnerId(slug: String, owner_id: Long, count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, include_entities: Boolean = true, include_rts: Boolean = false, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[Seq[Tweet]]]
Returns a timeline of tweets authored by members of the specified list.
Returns a timeline of tweets authored by members of the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- count
: By default it is
20
. Specifies the number of results to retrieve per "page".- 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 thesince_id
, thesince_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.- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- include_rts
: By default it is
false
. When set totrue
, the list timeline will contain native retweets (if they exist) in addition to the standard stream of tweets.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets for the specified list.
- Definition Classes
- TwitterListClient
- def listTimelineBySlugAndOwnerName(slug: String, owner_screen_name: String, count: Int = 20, since_id: Option[Long] = None, max_id: Option[Long] = None, include_entities: Boolean = true, include_rts: Boolean = false, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[Seq[Tweet]]]
Returns a timeline of tweets authored by members of the specified list.
Returns a timeline of tweets authored by members of the specified list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: TThe screen name of the user who owns the list being requested by a
slug
.- count
: By default it is
20
. Specifies the number of results to retrieve per "page".- 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 thesince_id
, thesince_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.- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- include_rts
: By default it is
false
. When set totrue
, the list timeline will contain native retweets (if they exist) in addition to the standard stream of tweets.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets for the specified list.
- Definition Classes
- TwitterListClient
- def listsForUser(screen_name: String, reverse: Boolean = false): Future[RatedData[Seq[TwitterList]]]
Returns all lists the specified user subscribes to, including their own.
Returns all lists the specified user subscribes to, including their own. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list.
- screen_name
: The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- reverse
: By default it is
false
. Set this to true if you would like owned lists to be returned first.- returns
: The sequence of all lists the specified user subscribes to.
- Definition Classes
- TwitterListClient
- def listsForUserId(user_id: Long, reverse: Boolean = false): Future[RatedData[Seq[TwitterList]]]
Returns all lists the specified user subscribes to, including their own.
Returns all lists the specified user subscribes to, including their own. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list.
- user_id
: The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.
- reverse
: By default it is
false
. Set this to true if you would like owned lists to be returned first.- returns
: The sequence of all lists the specified user subscribes to.
- Definition Classes
- TwitterListClient
- def locationTrends(): Future[RatedData[Seq[Location]]]
Returns the locations that Twitter has trending topic information for.
Returns the locations that Twitter has trending topic information for. The response is an array of “locations” that encode the location’s WOEID and some other human-readable information such as a canonical name and country the location belongs in. A WOEID is a Yahoo! Where On Earth ID. For more information see https://developer.twitter.com/en/docs/trends/locations-with-trending-topics/api-reference/get-trends-available.
- returns
: The sequence of locations that Twitter has trending topic information for.
- Definition Classes
- TwitterTrendClient
- 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, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[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://developer.twitter.com/en/docs/tweets/timelines/api-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 thesince_id
, thesince_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 totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
to receive the complete user object.- contributor_details
: By default it is
false
. When set totrue
, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set tofalse
, only the user_id of the contributor is included.- include_entities
: By default it is
true
. The parameters node will be disincluded when set tofalse
.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets.
- Definition Classes
- TwitterStatusClient
- def muteUser(screen_name: String): Future[User]
Mutes the user specified for the authenticating user.
Mutes the user specified for the authenticating user. Actions taken in this method are asynchronous and changes will be eventually consistent. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create.
- screen_name
: The screen name of the potentially muted user. Helpful for disambiguating when a valid screen name is also a user ID.
- returns
: The muted user representation.
- Definition Classes
- TwitterMuteClient
- def muteUserId(user_id: Long): Future[User]
Mutes the user ID specified for the authenticating user.
Mutes the user ID specified for the authenticating user. Actions taken in this method are asynchronous and changes will be eventually consistent. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-create.
- user_id
: The ID of the potentially muted user. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The muted user representation.
- Definition Classes
- TwitterMuteClient
- def mutedUserIds(cursor: Long = -1): Future[RatedData[UserIds]]
Returns an array of numeric user ids the authenticating user has muted.
Returns an array of numeric user ids the authenticating user has muted. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-ids.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See [node:10362, title=”Using cursors to navigate collections”] for more information.- returns
: The representation of the muted user ids.
- Definition Classes
- TwitterMuteClient
- def mutedUsers(cursor: Long = -1, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[Users]]
Returns the users representation that the authenticating user has muted.
Returns the users representation that the authenticating user has muted. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-mutes-users-list.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See [node:10362, title=”Using cursors to navigate collections”] for more information.- include_entities
: By default it is
true
. his node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. You can omit parameters from the result by settinginclude_entities
tofalse
.- skip_status
: By default it is
false
. When set to eithertrue
, statuses will not be included in the returned user objects.- returns
: The representation of the muted users.
- Definition Classes
- TwitterMuteClient
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noRetweetsUserIds(): Future[RatedData[Seq[Long]]]
Returns a collection of user ids that the currently authenticated user does not want to receive retweets from.
Returns a collection of user ids that the currently authenticated user does not want to receive retweets from. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids.
- returns
: The sequence of user ids the currently authenticated user does not want to receive retweets from.
- Definition Classes
- TwitterFriendshipClient
- def noRetweetsUserStringifiedIds(): Future[RatedData[Seq[String]]]
Returns a collection of user stringified ids that the currently authenticated user does not want to receive retweets from.
Returns a collection of user stringified ids that the currently authenticated user does not want to receive retweets from. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids.
- returns
: The sequence of the user stringified ids the currently authenticated user does not want to receive retweets from.
- Definition Classes
- TwitterFriendshipClient
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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 totrue
, links in a Tweet are not expanded to photo, video, or link previews.- hide_thread
: By default, it is
false
. When set totrue
, 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 totrue
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 totrue
, 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 tovideo
to return a Twitter Video embed for the given Tweet.- returns
: The representation of embedded tweet.
- Definition Classes
- TwitterStatusClient
- 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[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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 totrue
, links in a Tweet are not expanded to photo, video, or link previews.- hide_thread
: By default, it is
false
. When set totrue
, 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 totrue
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 totrue
, 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 tovideo
to return a Twitter Video embed for the given Tweet.- returns
: The representation of embedded tweet.
- Definition Classes
- TwitterStatusClient
- def outgoingFriendshipIds(cursor: Long = -1): Future[RatedData[UserIds]]
Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried.- returns
: The sequence of the user ids that have a pending follow request from the authenticating user.
- Definition Classes
- TwitterFriendshipClient
- def outgoingFriendshipStringifiedIds(cursor: Long = -1): Future[RatedData[UserStringifiedIds]]
Returns a collection of numeric stringified IDs for every protected user for whom the authenticating user has a pending follow request.
Returns a collection of numeric stringified IDs for every protected user for whom the authenticating user has a pending follow request. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing.
- cursor
: By default it is
-1
, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried.- returns
: The sequence of the user stringified ids that have a pending follow request from the authenticating user.
- Definition Classes
- TwitterFriendshipClient
- def privacyPolicy(): Future[RatedData[PrivacyPolicy]]
Returns Twitter’s Privacy Policy.
Returns Twitter’s Privacy Policy. For more information see https://developer.twitter.com/en/docs/developer-utilities/privacy-policy/api-reference/get-help-privacy.
- returns
: The Twitter's Privacy Policy.
- Definition Classes
- TwitterHelpClient
- def profileBannersForUser(screen_name: String): Future[RatedData[Banners]]
Returns a map of the available size variations of the specified user’s profile banner.
Returns a map of the available size variations of the specified user’s profile banner. If the user has not uploaded a profile banner, a
TwitterException
will be thrown instead. This method can be used instead of string manipulation on the profile_banner_url returned in user objects as described in Profile Images and Banners. The profile banner data available at each size variant’s URL is in PNG format. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner.- screen_name
: The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.
- returns
: The banners representation.
- Definition Classes
- TwitterUserClient
- def profileBannersForUserId(user_id: Long): Future[RatedData[Banners]]
Returns a map of the available size variations of the specified user’s profile banner.
Returns a map of the available size variations of the specified user’s profile banner. If the user has not uploaded a profile banner, a
TwitterException
will be thrown instead. This method can be used instead of string manipulation on the profile_banner_url returned in user objects as described in Profile Images and Banners. The profile banner data available at each size variant’s URL is in PNG format. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner.- user_id
: The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The banners representation.
- Definition Classes
- TwitterUserClient
- def rateLimits(resources: Resource*): Future[RatedData[RateLimits]]
Returns the current rate limits for methods belonging to the specified resource families.
Returns the current rate limits for methods belonging to the specified resource families. For more information see https://developer.twitter.com/en/docs/developer-utilities/rate-limit-status/api-reference/get-application-rate_limit_status.
- resources
: A comma-separated list of resource families you want to know the current rate limit disposition for. If no resources are specified, all the resources are considered.
- returns
: The current rate limits for methods belonging to the specified resource families.
- Definition Classes
- TwitterApplicationClient
- def reenableWebhook(env_name: String, webhookId: String): Future[Unit]
Reenables the webhook by setting its status to valid.
Reenables the webhook by setting its status to valid. It triggers the challenge response check (CRC) for the given enviroments webhook for all activites. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#put-account-activity-all-env-name-webhooks-webhook-id.
- env_name
: The environment name is the name of the App that provide the access to the Account Activity API.
- webhookId
: The id of the webhook that you want to remove.
- Definition Classes
- TwitterAccountActivityClient
- def registerWebhook(env_name: String, url: String): Future[Webhook]
Registers a webhook URL for your environment.
Registers a webhook URL for your environment. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#post-account-activity-all-env-name-webhooks.
- env_name
: The environment name is the name of the App that provide the access to the Account Activity API.
- url
: The encoded URL for the webhook callback endpoint.
- returns
: The webhook representation.
- Definition Classes
- TwitterAccountActivityClient
- def relationshipBetweenUserIds(source_id: Long, target_id: Long): Future[RatedData[Relationship]]
Returns detailed information about the relationship between two arbitrary users ids.
Returns detailed information about the relationship between two arbitrary users ids. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show.
- source_id
: The user id of the subject user.
- target_id
: The user id of the target user.
- returns
: The representation of the relationship between the two users.
- Definition Classes
- TwitterFriendshipClient
- def relationshipBetweenUsers(source_screen_name: String, target_screen_name: String): Future[RatedData[Relationship]]
Returns detailed information about the relationship between two arbitrary users.
Returns detailed information about the relationship between two arbitrary users. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show.
- source_screen_name
: The screen name of the subject user.
- target_screen_name
: The screen name of the target user.
- returns
: The representation of the relationship between the two users.
- Definition Classes
- TwitterFriendshipClient
- def relationshipsWithUserIds(user_ids: Long*): Future[RatedData[Seq[LookupRelationship]]]
Returns the relationships of the authenticating user of up to 100 user ids.
Returns the relationships of the authenticating user of up to 100 user ids. Values for connections can be:
following
,following_requested
,followed_by
,none
,blocking
,muting
. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup.- user_ids
: The list of user ids. At least 1 user id needs to be provided. Up to 100 are allowed in a single request. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The sequence of the lookup relationships.
- Definition Classes
- TwitterFriendshipClient
- def relationshipsWithUsers(screen_names: String*): Future[RatedData[Seq[LookupRelationship]]]
Returns the relationships of the authenticating user of up to 100 user screen names.
Returns the relationships of the authenticating user of up to 100 user screen names. Values for connections can be:
following
,following_requested
,followed_by
,none
,blocking
,muting
. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup.- screen_names
: The list of screen names. At least 1 screen name needs to be provided. Up to 100 are allowed in a single request. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The sequence of the lookup relationships.
- Definition Classes
- TwitterFriendshipClient
- def removeListMemberByListId(list_id: Long, member_screen_name: String): Future[Unit]
Removes the specified member from the list.
Removes the specified member from the list. The authenticated user must be the list’s owner to remove members from the list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy.
- list_id
: The numerical id of the list.
- member_screen_name
: The screen name of the user for whom to remove from the list. Helpful for disambiguating when a valid screen name is also a user ID.
- Definition Classes
- TwitterListClient
- def removeListMemberBySlugAndOwnerId(slug: String, owner_id: Long, member_screen_name: String): Future[Unit]
Removes the specified member from the list.
Removes the specified member from the list. The authenticated user must be the list’s owner to remove members from the list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- member_screen_name
: The screen name of the user for whom to remove from the list. Helpful for disambiguating when a valid screen name is also a user ID.
- Definition Classes
- TwitterListClient
- def removeListMemberBySlugAndOwnerName(slug: String, owner_screen_name: String, member_screen_name: String): Future[Unit]
Removes the specified member from the list.
Removes the specified member from the list. The authenticated user must be the list’s owner to remove members from the list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- member_screen_name
: The screen name of the user for whom to remove from the list. Helpful for disambiguating when a valid screen name is also a user ID.
- Definition Classes
- TwitterListClient
- def removeListMemberIdByListId(list_id: Long, member_id: Long): Future[Unit]
Removes the specified member from the list.
Removes the specified member from the list. The authenticated user must be the list’s owner to remove members from the list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy.
- list_id
: The numerical id of the list.
- member_id
: The ID of the user to remove from the list. Helpful for disambiguating when a valid user ID is also a valid screen name.
- Definition Classes
- TwitterListClient
- def removeListMemberIdBySlugAndOwnerId(slug: String, owner_id: Long, member_id: Long): Future[Unit]
Removes the specified member from the list.
Removes the specified member from the list. The authenticated user must be the list’s owner to remove members from the list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- member_id
: The ID of the user to remove from the list. Helpful for disambiguating when a valid user ID is also a valid screen name.
- Definition Classes
- TwitterListClient
- def removeListMemberIdBySlugAndOwnerName(slug: String, owner_screen_name: String, member_id: Long): Future[Unit]
Removes the specified member from the list.
Removes the specified member from the list. The authenticated user must be the list’s owner to remove members from the list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- member_id
: The ID of the user to remove from the list. Helpful for disambiguating when a valid user ID is also a valid screen name.
- Definition Classes
- TwitterListClient
- def removeListMembers(list_id: Long, members_screen_names: Seq[String]): Future[Unit]
Removes multiple members from a list.
Removes multiple members from a list. The authenticated user must own the list to be able to remove members from it. Note that lists can’t have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all.
- list_id
: The numerical id of the list.
- members_screen_names
: A sequence of screen names to remove from the list, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def removeListMembersBySlugAndOwnerId(slug: String, owner_id: Long, members_screen_names: Seq[String]): Future[Unit]
Removes multiple members from a list.
Removes multiple members from a list. The authenticated user must own the list to be able to remove members from it. Note that lists can’t have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- members_screen_names
: A sequence of screen names to remove from the list, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def removeListMembersBySlugAndOwnerName(slug: String, owner_screen_name: String, members_screen_names: Seq[String]): Future[Unit]
Removes multiple members from a list.
Removes multiple members from a list. The authenticated user must own the list to be able to remove members from it. Note that lists can’t have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- members_screen_names
: A sequence of screen names to remove from the list, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def removeListMembersIds(list_id: Long, members_ids: Seq[Long]): Future[Unit]
Removes multiple members from a list.
Removes multiple members from a list. The authenticated user must own the list to be able to remove members from it. Note that lists can’t have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all.
- list_id
: The numerical id of the list.
- members_ids
: A sequence of user ids to remove from the list, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def removeListMembersIdsBySlugAndOwnerId(slug: String, owner_id: Long, members_ids: Seq[Long]): Future[Unit]
Removes multiple members from a list.
Removes multiple members from a list. The authenticated user must own the list to be able to remove members from it. Note that lists can’t have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- members_ids
: A sequence of user ids to remove from the list, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def removeListMembersIdsBySlugAndOwnerName(slug: String, owner_screen_name: String, members_ids: Seq[Long]): Future[Unit]
Removes multiple members from a list.
Removes multiple members from a list. The authenticated user must own the list to be able to remove members from it. Note that lists can’t have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method. Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-members-destroy_all.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- members_ids
: A sequence of user ids to remove from the list, up to 100 are allowed in a single request.
- Definition Classes
- TwitterListClient
- def removeProfileBanner(): Future[Unit]
Removes the uploaded profile banner for the authenticating user.
Removes the uploaded profile banner for the authenticating user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-remove_profile_banner.
- Definition Classes
- TwitterAccountClient
- def removeWebhook(env_name: String, webhookId: String): Future[Unit]
Removes the webhook from the provided application.
Removes the webhook from the provided application. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#delete-account-activity-all-env-name-webhooks-webhook-id.
- env_name
: The environment name is the name of the App that provide the access to the Account Activity API.
- webhookId
: The id of the webhook that you want to remove.
- Definition Classes
- TwitterAccountActivityClient
- val restClient: RestClient
- Attributes
- protected
- Definition Classes
- TwitterRestClient → TwitterUserClient → TwitterTrendClient → TwitterSuggestionClient → TwitterStatusClient → TwitterSearchClient → TwitterSavedSearchClient → TwitterMuteClient → TwitterMediaClient → TwitterListClient → TwitterHelpClient → TwitterGeoClient → TwitterFriendshipClient → TwitterFriendClient → TwitterFollowerClient → TwitterFavoriteClient → TwitterDirectMessageClient → TwitterBlockClient → TwitterApplicationClient → TwitterAccountActivityClient → TwitterAccountClient
- def retweet(id: Long, trim_user: Boolean = false, tweet_mode: TweetMode = TweetMode.Classic): Future[Tweet]
Retweets a tweet.
Retweets a tweet. Returns the original tweet with retweet details embedded. For more information see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-retweets-id.
- id
: The numerical ID of the desired status.
- trim_user
: By default it is
false
. When set totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
to receive the complete user object.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The representation of the original tweet with retweet details embedded.
- Definition Classes
- TwitterStatusClient
- def retweeterIds(id: Long, count: Int = 100, cursor: Long = -1): Future[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- returns
: The representation of the retweeter ids.
- Definition Classes
- TwitterStatusClient
- def retweeterStringifiedIds(id: Long, count: Int = 100, cursor: Long = -1): Future[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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’snext_cursor
andprevious_cursor
attributes to page back and forth in the list.- returns
: The representation of the retweeter stringified ids.
- Definition Classes
- TwitterStatusClient
- def retweets(id: Long, count: Int = 100, trim_user: Boolean = false, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-retweets-id.
- 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 totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
to receive the complete user object.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets.
- Definition Classes
- TwitterStatusClient
- 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, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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 thesince_id
, thesince_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 totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
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 totrue
, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set tofalse
, only the user_id of the contributor is included.- include_entities
: By default it is
true
. When set tofalse
, The parameters node will be disincluded when set to false.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets.
- Definition Classes
- TwitterStatusClient
- def reverseGeocode(latitude: Double, longitude: Double, accuracy: Accuracy = Accuracy.Default, granularity: Granularity = Granularity.Neighborhood, max_results: Option[Int] = None, callback: Option[String] = None): Future[RatedData[GeoSearch]]
Given a latitude and a longitude, searches for up to 20 places that can be used as a place id when updating a status.
Given a latitude and a longitude, searches for up to 20 places that can be used as a place id when updating a status. For more information see https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-reverse_geocode.
- latitude
: The latitude to search around. 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 long parameter.
- longitude
: The longitude to search around. 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 lat parameter.
- accuracy
: By default it is
Default
, which is 0 meters. A hint on the “region” in which to search.- granularity
: By default it is
Neighborhood
This is the minimal granularity of place types to return.- max_results
: Optional, by default it is
None
. A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many “nearby” results to return. Ideally, only pass in the number of places you intend to display to the user here.- callback
: Optional, by default it is
None
. If supplied, the response will use the JSONP format with a callback of the given name.- returns
: The geo search result.
- Definition Classes
- TwitterGeoClient
- def saveSearch(query: String): Future[SavedSearch]
Create a new saved search for the authenticated user.
Create a new saved search for the authenticated user. A user may only have 25 saved searches. For more information see https://developer.twitter.com/en/docs/tweets/search/api-reference/post-saved_searches-create.
- query
: The query of the search the user would like to save.
- returns
: The saved search representation.
- Definition Classes
- TwitterSavedSearchClient
- def savedSearch(id: Long): Future[RatedData[SavedSearch]]
Retrieve the information for the saved search represented by the given id.
Retrieve the information for the saved search represented by the given id. The authenticating user must be the owner of saved search ID being requested. For more information see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-saved_searches-show-id.
- returns
: The saved search representation.
- Definition Classes
- TwitterSavedSearchClient
- def savedSearches(): Future[RatedData[Seq[SavedSearch]]]
Returns the authenticated user’s saved search queries.
Returns the authenticated user’s saved search queries. For more information see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-saved_searches-list.
- returns
: The sequence of saved searches.
- Definition Classes
- TwitterSavedSearchClient
- def searchForUser(query: String, page: Int = -1, count: Int = 20, include_entities: Boolean = true): Future[RatedData[Seq[User]]]
Provides a simple, relevance-based search interface to public user accounts on Twitter.
Provides a simple, relevance-based search interface to public user accounts on Twitter. Try querying by topical interest, full name, company name, location, or other criteria. Exact match searches are not supported. Only the first 1,000 matching results are available. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search.
- query
: The search query to run against people search.
- page
: By default it is
-1
, which is the first "page". Specifies the page of results to retrieve.- count
: By default it is
20
. The number of potential user results to retrieve per page. This value has a maximum of 20.- include_entities
: By default it is
true
. The parameters node that may appear within embedded statuses will be disincluded when set tofalse
.- returns
: The sequence of users.
- Definition Classes
- TwitterUserClient
- def searchGeoPlace(query: String): Future[RatedData[GeoSearch]]
Search for places that can be attached to a statuses/update.
Search for places that can be attached to a statuses/update. For more information see https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search.
- query
: Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.
- returns
: The geo search result.
- Definition Classes
- TwitterGeoClient
- def searchTweet(query: String, count: Int = 15, include_entities: Boolean = true, result_type: ResultType = ResultType.Mixed, geocode: Option[GeoCode] = None, language: Option[Language] = None, locale: Option[String] = None, until: Option[LocalDate] = None, since_id: Option[Long] = None, max_id: Option[Long] = None, callback: Option[String] = None, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[StatusSearch]]
Returns a collection of relevant Tweets matching a specified query.
Returns a collection of relevant Tweets matching a specified query. For more information see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets.
- query
: The search query of 500 characters maximum, including operators. Queries may additionally be limited by complexity.
- count
: By default it is
15
. The number of tweets to return per page, up to a maximum of 100.- include_entities
: By default it is
true
. The parameters node will be disincluded when set tofalse
.- result_type
: By default it is
Mixed
. Specifies what type of search results you would prefer to receive. Valid values include:Mixed
: Include both popular and real time results in the response.Recent
: return only the most recent results in the responsePopular
: return only the most popular results in the response.
- geocode
: Optional, by default it is
None
. Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly. A maximum of 1,000 distinct “sub-regions” will be considered when using the radius modifier.- language
: Optional, by default it is
None
. Restricts tweets to the given language. Language detection is best-effort.- locale
: Optional, by default it is
None
. Specify the language of the query you are sending (onlyja
is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases.- until
: Optional, by default it is
None
. Returns tweets created before the given date. Keep in mind that the search index has a 7-day limit. In other words, no tweets will be found for a date older than one week.- 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.- callback
: Optional, by default it is
None
. If supplied, the response will use the JSONP format with a callback of the given name. The usefulness of this parameter is somewhat diminished by the requirement of authentication for requests to this endpoint.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The representation of the search results.
- Definition Classes
- TwitterSearchClient
- def settings(): Future[RatedData[Settings]]
Returns settings (including current trend, geo and sleep time information) for the authenticating user.
Returns settings (including current trend, geo and sleep time information) for the authenticating user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-settings.
- returns
: The account settings for the authenticating user.
- Definition Classes
- TwitterAccountClient
- 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 statusMedia(media_id: Long): Future[MediaDetails]
Returns the status of a media upload for pulling purposes.
Returns the status of a media upload for pulling purposes. For more information see https://developer.twitter.com/en/docs/media/upload-media/api-reference/get-media-upload-status.
- media_id
: The id of the media.
- returns
: The media details
- Definition Classes
- TwitterMediaClient
- def subscribeAll(env_name: String): Future[Unit]
Subscribes the provided application to all events for the provided environment for all message types.
Subscribes the provided application to all events for the provided environment for all message types. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#post-account-activity-all-env-name-subscriptions.
- env_name
: The environment name is the name of the App that provide the access to the Account Activity API.
- Definition Classes
- TwitterAccountActivityClient
- def suggestedCategories(language: Language = Language.English): Future[RatedData[Seq[Category]]]
Access to Twitter’s suggested user list.
Access to Twitter’s suggested user list. This returns the list of suggested user categories. It is recommended that applications cache this data for no more than one hour. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions.
- language
: By default it is
English
. Restricts the suggested categories to the requested language.- returns
: The representation of the category suggestions.
- Definition Classes
- TwitterSuggestionClient
- def suggestions(slug: String, language: Language = Language.English): Future[RatedData[Suggestions]]
Access the users in a given category of the Twitter suggested user list.
Access the users in a given category of the Twitter suggested user list. It is recommended that applications cache this data for no more than one hour. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions-slug.
- slug
: The short name of list or a category.
- language
: By default it is
English
. Restricts the suggested categories to the requested language.- returns
: The representation of the user suggestions.
- Definition Classes
- TwitterSuggestionClient
- def suggestionsMembers(slug: String): Future[RatedData[Seq[User]]]
Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.
Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-suggestions-slug-members.
- slug
: The short name of list or a category.
- returns
: The representation of the suggested users.
- Definition Classes
- TwitterSuggestionClient
- def supportedLanguages(): Future[RatedData[Seq[LanguageDetails]]]
Returns the list of languages supported by Twitter along with the language code supported by Twitter.
Returns the list of languages supported by Twitter along with the language code supported by Twitter. For more information see https://developer.twitter.com/en/docs/developer-utilities/supported-languages/api-reference/get-help-languages.
- returns
: The list of languages supported by Twitter.
- Definition Classes
- TwitterHelpClient
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val system: ActorSystem
- Attributes
- protected
- Definition Classes
- TwitterRestClient → SystemShutdown
- def termsOfService(): Future[RatedData[TermsOfService]]
Returns the Twitter Terms of Service.
Returns the Twitter Terms of Service. Note: these are not the same as the Developer Policy. For more information see https://developer.twitter.com/en/docs/developer-utilities/terms-of-service/api-reference/get-help-tos.
- returns
: the Twitter Terms of Service.
- Definition Classes
- TwitterHelpClient
- def toString(): String
- Definition Classes
- AnyRef → Any
- def trends(woeid: Long, exclude_hashtags: Boolean = false): Future[RatedData[Seq[LocationTrends]]]
Returns the top 10 trending topics for a specific WOEID, if trending information is available for it.
Returns the top 10 trending topics for a specific WOEID, if trending information is available for it. The response is an array of “trend” objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Twitter Search, and the Twitter Search URL. This information is cached for 5 minutes. Requesting more frequently than that will not return any more data, and will count against your rate limit usage. For more information see https://developer.twitter.com/en/docs/trends/trends-for-location/api-reference/get-trends-place.
- woeid
: The Yahoo! Where On Earth ID of the location to return trending information for. Global information is available by using 1 as the WOEID.
- exclude_hashtags
: By default it is
false
. Setting this totrue
will remove all hashtags from the trends list.- returns
: The representation of the location trends.
- Definition Classes
- TwitterTrendClient
- def tweetLookup(ids: Seq[Long], include_entities: Boolean = true, trim_user: Boolean = false, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[Seq[Tweet]]]
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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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 tofalse
.- trim_user
: By default it is
false
. When set totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
to receive the complete user object.- returns
: The representation of the lookup tweets.
- Definition Classes
- TwitterStatusClient
- def tweetLookup(ids: Long*): Future[RatedData[Seq[Tweet]]]
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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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.
- Definition Classes
- TwitterStatusClient
- def tweetLookupMapped(ids: Seq[Long], include_entities: Boolean = true, trim_user: Boolean = false, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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 tofalse
.- trim_user
: By default it is
false
. When set totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
to receive the complete user object.- returns
: The representation of the lookup tweets mapped by id.
- Definition Classes
- TwitterStatusClient
- def tweetLookupMapped(ids: Long*): Future[RatedData[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://developer.twitter.com/en/docs/tweets/post-and-engage/api-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.
- Definition Classes
- TwitterStatusClient
- def unblockUser(screen_name: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Un-blocks the user for the authenticating user.
Un-blocks the user for the authenticating user. Returns the un-blocked user in the requested format when successful. If relationships existed before the block was instated, they will not be restored. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-blocks-destroy.
- screen_name
: The screen name of the potentially blocked user. Helpful for disambiguating when a valid user ID is also a valid screen name.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The representation of the unblocked user.
- Definition Classes
- TwitterBlockClient
- def unblockUserId(user_id: Long, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Un-blocks the user specified id for the authenticating user.
Un-blocks the user specified id for the authenticating user. Returns the un-blocked user in the requested format when successful. If relationships existed before the block was instated, they will not be restored. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-blocks-destroy.
- user_id
: The ID of the potentially blocked user. Helpful for disambiguating when a valid user ID is also a valid screen name.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The representation of the unblocked user.
- Definition Classes
- TwitterBlockClient
- def unfavoriteStatus(id: Long, include_entities: Boolean = true): Future[Tweet]
Un-likes the status specified in the ID parameter as the authenticating user.
Un-likes the status specified in the ID parameter as the authenticating user. Note: the like action was known as favorite before November 3, 2015; the historical naming remains in API methods and object properties. For more information see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-favorites-destroy.
- id
: The numerical ID of the desired status.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- returns
: The un-liked status.
- Definition Classes
- TwitterFavoriteClient
- def unfollowUser(screen_name: String): Future[User]
Allows the authenticating users to unfollow the specified user.
Allows the authenticating users to unfollow the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.
- screen_name
: The screen name of the user for whom to unfollow. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def unfollowUserId(user_id: Long): Future[User]
Allows the authenticating users to unfollow the specified user id.
Allows the authenticating users to unfollow the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.
- user_id
: The ID of the user for whom to unfollow. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The user representation of the target user.
- Definition Classes
- TwitterFriendshipClient
- def unmuteUser(screen_name: String): Future[User]
Un-mutes the user specified for the authenticating user.
Un-mutes the user specified for the authenticating user. Actions taken in this method are asynchronous and changes will be eventually consistent. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-destroy.
- screen_name
: The screen name of the potentially muted user. Helpful for disambiguating when a valid screen name is also a user ID.
- returns
: The un-muted user representation.
- Definition Classes
- TwitterMuteClient
- def unmuteUserId(user_id: Long): Future[User]
Un-mutes the user ID specified for the authenticating user.
Un-mutes the user ID specified for the authenticating user. Actions taken in this method are asynchronous and changes will be eventually consistent. For more information see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/post-mutes-users-destroy.
- user_id
: The ID of the potentially muted user. Helpful for disambiguating when a valid user ID is also a valid screen name.
- returns
: The un-muted user representation.
- Definition Classes
- TwitterMuteClient
- def unsubscribeAll(env_name: String): Future[Unit]
Deactivates subscription(s) for the provided user context and application for all activities.
Deactivates subscription(s) for the provided user context and application for all activities. For more information see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#delete-account-activity-all-env-name-subscriptions-deprecated-.
- env_name
: The environment name is the name of the App that provide the access to the Account Activity API.
- Definition Classes
- TwitterAccountActivityClient
- def updateList(list_id: Long, update: TwitterListUpdate): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- list_id
: The numerical id of the list.
- update
: The updates to perform on the list.
- Definition Classes
- TwitterListClient
- def updateListBySlugAndOwnerId(slug: String, owner_id: Long, update: TwitterListUpdate): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- update
: The updates to perform on the list.
- Definition Classes
- TwitterListClient
- def updateListBySlugAndOwnerName(slug: String, owner_screen_name: String, update: TwitterListUpdate): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- update
: The updates to perform on the list.
- Definition Classes
- TwitterListClient
- def updateListDescription(list_id: Long, description: String): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- list_id
: The numerical id of the list.
- description
: The description to give the list.
- Definition Classes
- TwitterListClient
- def updateListDescriptionBySlugAndOwnerId(slug: String, owner_id: Long, description: String): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- description
: The description to give the list.
- Definition Classes
- TwitterListClient
- def updateListDescriptionBySlugAndOwnerName(slug: String, owner_screen_name: String, description: String): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- description
: The description to give the list.
- Definition Classes
- TwitterListClient
- def updateListMode(list_id: Long, mode: Mode): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- list_id
: The numerical id of the list.
- mode
: Whether your list is public or private.
- Definition Classes
- TwitterListClient
- def updateListModeBySlugAndOwnerId(slug: String, owner_id: Long, mode: Mode): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- mode
: Whether your list is public or private.
- Definition Classes
- TwitterListClient
- def updateListModeBySlugAndOwnerName(slug: String, owner_screen_name: String, mode: Mode): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- mode
: Whether your list is public or private.
- Definition Classes
- TwitterListClient
- def updateListName(list_id: Long, name: String): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- list_id
: The numerical id of the list.
- name
: The name for the list.
- Definition Classes
- TwitterListClient
- def updateListNameBySlugAndOwnerId(slug: String, owner_id: Long, name: String): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_id
: The user ID of the user who owns the list being requested by a
slug
.- name
: The name for the list.
- Definition Classes
- TwitterListClient
- def updateListNameBySlugAndOwnerName(slug: String, owner_screen_name: String, name: String): Future[Unit]
Updates the specified list.
Updates the specified list. The authenticated user must own the list to be able to update it. For more information see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update.
- slug
: You can identify a list by its slug instead of its numerical id.
- owner_screen_name
: The screen name of the user who owns the list being requested by a
slug
.- name
: The name for the list.
- Definition Classes
- TwitterListClient
- def updateProfile(update: ProfileUpdate): Future[User]
Sets some values that users are able to set under the “Account” tab of their settings page.
Sets some values that users are able to set under the “Account” tab of their settings page. Only the parameters specified will be updated. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile.
- update
: The profile values to update.
- returns
: The user representation.
- Definition Classes
- TwitterAccountClient
- def updateProfileDescription(description: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Sets the description that users are able to set under the “Account” tab of their settings page.
Sets the description that users are able to set under the “Account” tab of their settings page. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile.
- description
: A description of the user owning the account. Maximum of 160 characters.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The user representation.
- Definition Classes
- TwitterAccountClient
- def updateProfileLinkColor(link_color: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Sets the link color that users are able to set under the “Account” tab of their settings page.
Sets the link color that users are able to set under the “Account” tab of their settings page. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile.
- link_color
: Sets a hex value that controls the color scheme of links used on the authenticating user’s profile page on twitter.com. This must be a valid hexadecimal value, and may be either three or six characters (ex: F00 or FF0000).
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The user representation.
- Definition Classes
- TwitterAccountClient
- def updateProfileLocation(location: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Sets the location that users are able to set under the “Account” tab of their settings page.
Sets the location that users are able to set under the “Account” tab of their settings page. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile.
- location
: The city or country describing where the user of the account is located. The contents are not normalized or geocoded in any way. Maximum of 30 characters.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The user representation.
- Definition Classes
- TwitterAccountClient
- def updateProfileName(name: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Sets the name that users are able to set under the “Account” tab of their settings page.
Sets the name that users are able to set under the “Account” tab of their settings page. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile.
- name
: Full name associated with the profile. Maximum of 20 characters.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The user representation.
- Definition Classes
- TwitterAccountClient
- def updateProfileUrl(url: String, include_entities: Boolean = true, skip_status: Boolean = false): Future[User]
Sets the url that users are able to set under the “Account” tab of their settings page.
Sets the url that users are able to set under the “Account” tab of their settings page. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile.
- url
: URL associated with the profile. Will be prepended with “http://” if not present. Maximum of 100 characters.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The user representation.
- Definition Classes
- TwitterAccountClient
- def updateSettings(settings_options: SettingsOptions): Future[Settings]
Updates the authenticating user’s settings.
Updates the authenticating user’s settings. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-remove_profile_banner.
- settings_options
: The setting options to update. Only the parameters specified will be updated.
- returns
: The updated settings.
- Definition Classes
- TwitterAccountClient
- def updateSettings(allow_contributor_request: Option[ContributorType] = None, sleep_time_enabled: Option[Boolean] = None, start_sleep_time: Option[Hour] = None, end_sleep_time: Option[Hour] = None, lang: Option[Language] = None, time_zone: Option[TimeZone] = None, trend_location_woeid: Option[Long] = None): Future[Settings]
Updates the authenticating user’s settings.
Updates the authenticating user’s settings. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-remove_profile_banner.
- allow_contributor_request
: Optional, by default it is
None
. Whether to allow others to include user as contributor. Possible values includeAll
(anyone can include user),Following
(only followers can include user) orNone
.- sleep_time_enabled
: Optional, by default it is
None
. When set totrue
, will enable sleep time for the user. Sleep time is the time when push or SMS notifications should not be sent to the user.- start_sleep_time
: Optional, by default it is
None
. The hour that sleep time should begin if it is enabled. The time is considered to be in the same timezone as the user’s time_zone setting.- end_sleep_time
: Optional, by default it is
None
. The hour that sleep time should end if it is enabled. The time is considered to be in the same timezone as the user’s time_zone setting.- lang
: Optional, by default it is
None
. The language which Twitter should render in for this user.- time_zone
: Optional, by default it is
None
. The timezone dates and times should be displayed in for the user.- trend_location_woeid
: Optional, by default it is
None
. The Yahoo! Where On Earth ID to use as the user’s default trend location. Global information is available by using 1 as the WOEID. The woeid must be one of the locations returned by [node:59].- returns
: The updated settings.
- Definition Classes
- TwitterAccountClient
- def uploadMediaFromFile(file: File, additional_owners: Seq[Long] = Seq.empty): Future[MediaDetails]
Uploads media asynchronously from a file.
Uploads media asynchronously from a file. For more information see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload.
- file
: the file to upload.
- additional_owners
: By default is empty. A comma-separated list of user IDs to set as additional owners allowed to use the returned media_id in Tweets or Cards. Up to 100 additional owners may be specified.
- returns
: The media details
- Definition Classes
- TwitterMediaClient
- def uploadMediaFromInputStream(inputStream: InputStream, size: Long, media_type: MediaType, filename: Option[String] = None, additional_owners: Seq[Long] = Seq.empty): Future[MediaDetails]
Uploads media asynchronously from an input stream.
Uploads media asynchronously from an input stream. For more information see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload.
- inputStream
: the input stream to upload.
- size
: the size of the data to upload.
- media_type
: the type of the media to upload.
- filename
: By default is
None
. The filename used when uploading the media.- additional_owners
: By default is empty. A comma-separated list of user IDs to set as additional owners allowed to use the returned media_id in Tweets or Cards. Up to 100 additional owners may be specified.
- returns
: The media details
- Definition Classes
- TwitterMediaClient
- def uploadMediaFromPath(filePath: String, additional_owners: Seq[Long] = Seq.empty): Future[MediaDetails]
Uploads media asynchronously from an absolute file path.
Uploads media asynchronously from an absolute file path. For more information see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload.
- filePath
: the absolute path of the file to upload.
- additional_owners
: By default is empty. A comma-separated list of user IDs to set as additional owners allowed to use the returned media_id in Tweets or Cards. Up to 100 additional owners may be specified.
- returns
: The media details
- Definition Classes
- TwitterMediaClient
- def user(screen_name: String, include_entities: Boolean = true): Future[RatedData[User]]
Returns a variety of information about the user specified by the required screen name parameter.
Returns a variety of information about the user specified by the required screen name parameter. The author’s most recent Tweet will be returned inline when possible. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show.
- screen_name
: The screen name of the user for whom to return results for.
- include_entities
: By default it is
true
. The parameters node that may appear within embedded statuses will be disincluded when set tofalse
.- returns
: The sequence of user representations.
- Definition Classes
- TwitterUserClient
- def userById(id: Long, include_entities: Boolean = true): Future[RatedData[User]]
Returns a variety of information about the user specified by the required screen name parameter.
Returns a variety of information about the user specified by the required screen name parameter. The author’s most recent Tweet will be returned inline when possible. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show.
- id
: The ID of the user for whom to return results for.
- include_entities
: By default it is
true
. The parameters node that may appear within embedded statuses will be disincluded when set tofalse
.- returns
: The sequence of user representations.
- Definition Classes
- TwitterUserClient
- 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, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[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://developer.twitter.com/en/docs/tweets/timelines/api-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 thesince_id
, thesince_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 ifinclude_rts
is not supplied. It is recommended you always sendinclude_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 totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
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 totrue
, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set tofalse
, only the user_id of the contributor is included.- include_rts
: By default it is
true
. When set tofalse
, 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 thetrim_user
parameter in conjunction withinclude_rts
, the retweets will still contain a full user object.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets.
- Definition Classes
- TwitterStatusClient
- 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, tweet_mode: TweetMode = TweetMode.Classic): Future[RatedData[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://developer.twitter.com/en/docs/tweets/timelines/api-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 thesince_id
, thesince_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 ifinclude_rts
is not supplied. It is recommended you always sendinclude_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 totrue
, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Set this parameter tofalse
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 totrue
, this parameter enhances the contributors element of the status response to include the screen_name of the contributor. When set tofalse
, only the user_id of the contributor is included.- include_rts
: By default it is
true
. When set tofalse
, 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 thetrim_user
parameter in conjunction withinclude_rts
, the retweets will still contain a full user object.- tweet_mode
: Optional, by default it is
Classic
. When set toExtended
prevents tweet text truncating, see https://developer.twitter.com/en/docs/tweets/tweet-updates- returns
: The sequence of tweets.
- Definition Classes
- TwitterStatusClient
- def users(screen_names: Seq[String], include_entities: Boolean = true): Future[RatedData[Seq[User]]]
Returns fully-hydrated user objects for up to 100 users per request, as specified by the sequence of screen name parameters.
Returns fully-hydrated user objects for up to 100 users per request, as specified by the sequence of screen name parameters. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup.
- screen_names
: A sequence of screen names, up to 100 are allowed in a single request.
- include_entities
: By default it is
true
. The parameters node that may appear within embedded statuses will be disincluded when set tofalse
.- returns
: The sequence of user representations.
- Definition Classes
- TwitterUserClient
- def users(screen_names: String*): Future[RatedData[Seq[User]]]
Returns fully-hydrated user objects for up to 100 users per request, as specified by the sequence of screen name parameters.
Returns fully-hydrated user objects for up to 100 users per request, as specified by the sequence of screen name parameters. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup.
- screen_names
: A sequence of screen names, up to 100 are allowed in a single request.
- returns
: The sequence of user representations.
- Definition Classes
- TwitterUserClient
- def usersByIds(ids: Seq[Long], include_entities: Boolean = true): Future[RatedData[Seq[User]]]
Returns fully-hydrated user objects for up to 100 users per request, as specified by the sequence of user id parameters.
Returns fully-hydrated user objects for up to 100 users per request, as specified by the sequence of user id parameters. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup.
- ids
: A sequence of user ids, up to 100 are allowed in a single request.
- include_entities
: By default it is
true
. The parameters node that may appear within embedded statuses will be disincluded when set tofalse
.- returns
: The sequence of user representations.
- Definition Classes
- TwitterUserClient
- def usersByIds(ids: Long*): Future[RatedData[Seq[User]]]
Returns fully-hydrated user objects for up to 100 users per request, as specified by the sequence of user id parameters.
Returns fully-hydrated user objects for up to 100 users per request, as specified by the sequence of user id parameters. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup.
- ids
: A sequence of user ids, up to 100 are allowed in a single request.
- returns
: The sequence of user representations.
- Definition Classes
- TwitterUserClient
- def verifyCredentials(include_entities: Boolean = true, skip_status: Boolean = false, include_email: Boolean = false): Future[RatedData[User]]
Returns a representation of the requesting user if authentication was successful; it throws a com.danielasfregola.twitter4s.exceptions.TwitterException if not.
Returns a representation of the requesting user if authentication was successful; it throws a com.danielasfregola.twitter4s.exceptions.TwitterException if not. Use this method to test if supplied user credentials are valid. For more information see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- include_email
: By default it is
false
. When set totrue
email will be returned in the user objects. If the user does not have an email address on their account, or if the email address is un-verified, null will be returned.- returns
: The user representation.
- Definition Classes
- TwitterAccountClient
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def createDirectMessage(screen_name: String, text: String): Future[DirectMessage]
Sends a new direct message to the specified user from the authenticating user.
Sends a new direct message to the specified user from the authenticating user. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message.
- screen_name
: The screen name of the user who should receive the direct message. Helpful for disambiguating when a valid user ID is also a valid screen name.
- text
: The text of your direct message. Be sure to URL encode as necessary, and keep the message under 140 characters.
- returns
: The sent direct message.
- Definition Classes
- TwitterDirectMessageClient
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'createDirectMessageEvent' instead.
- def createDirectMessage(user_id: Long, text: String): Future[DirectMessage]
Sends a new direct message to the specified user from the authenticating user.
Sends a new direct message to the specified user from the authenticating user. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message.
- user_id
: The ID of the user who should receive the direct message. Helpful for disambiguating when a valid user ID is also a valid screen name.
- text
: The text of your direct message. Be sure to URL encode as necessary, and keep the message under 140 characters.
- returns
: The sent direct message.
- Definition Classes
- TwitterDirectMessageClient
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'createDirectMessageEvent' instead.
- def directMessage(id: Long): Future[RatedData[DirectMessage]]
Returns a single direct message, specified by an id parameter.
Returns a single direct message, specified by an id parameter. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-message.
- id
: The ID of the direct message.
- returns
: The direct message.
- Definition Classes
- TwitterDirectMessageClient
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'eventShow' instead.
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def receivedDirectMessages(since_id: Option[Long] = None, max_id: Option[Long] = None, count: Int = 200, include_entities: Boolean = true, skip_status: Boolean = false): Future[RatedData[Seq[DirectMessage]]]
Returns the 20 most recent direct messages sent to the authenticating user.
Returns the 20 most recent direct messages sent to the authenticating user. Includes detailed information about the sender and recipient user. You can request up to 200 direct messages per call, and only the most recent 200 DMs will be available using this endpoint. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages.
- 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.- count
: By default it is 200. Specifies the number of direct messages 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.
- include_entities
: By default it is
true
. The parameters node will not be included when set to false.- skip_status
: By default it is
false
. When set to eithertrue
statuses will not be included in the returned user object.- returns
: The sequence of received direct messages.
- Definition Classes
- TwitterDirectMessageClient
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'eventsList' instead.
- def sentDirectMessages(since_id: Option[Long] = None, max_id: Option[Long] = None, count: Int = 200, include_entities: Boolean = true, page: Int = -1): Future[RatedData[Seq[DirectMessage]]]
Returns the 20 most recent direct messages sent by the authenticating user.
Returns the 20 most recent direct messages sent by the authenticating user. Includes detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 outgoing DMs. For more information see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message.
- 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.- count
: By default it is 200. Specifies the number of records to retrieve. Must be less than or equal to 200.
- returns
: The sequence of sent direct messages.
- Definition Classes
- TwitterDirectMessageClient
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'eventsList' instead.