trait TwitterDirectMessageClient extends AnyRef
Implements the available requests for the direct_messages
resource.
- Alphabetic
- By Inheritance
- TwitterDirectMessageClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
val
restClient: RestClient
- Attributes
- protected
Concrete 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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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.
-
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.
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): 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
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
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.
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'messageCreate' 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.
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'messageCreate' 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.
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'eventShow' instead.
-
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.
- 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.
- Annotations
- @deprecated
- Deprecated
(Since version twitter4s 6.0) Twitter endpoint deprecated from 17th Sep 2018. Please use 'eventsList' instead.