org.apache.streams.twitter.api

Interface DirectMessages

All Known Implementing Classes:

Twitter

@Remoteable(path="https://api.twitter.com/1.1/direct_messages")
public interface DirectMessages

Interface for /direct_messages methods.

See Also:

https://dev.twitter.com/rest/reference

Method Summary

Modifier and Type	Method and Description
DirectMessage	destroy(Long id) Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.
List<DirectMessage>	list(DirectMessagesListRequest parameters) Returns the 20 most recent direct messages sent to the authenticating user.
EventsListResponse	listEvents(EventsListRequest parameters) Returns all Direct Message events (both sent and received) within the last 30 days.
DirectMessage	newDM(DirectMessageNewRequest parameters) Destroys the direct message specified in the required ID parameter.
DirectMessageEvent	newEvent(MessageCreateRequest event) Destroys the direct message specified in the required ID parameter.
List<DirectMessage>	sent(DirectMessagesSentRequest parameters) Returns the 20 most recent direct messages sent to the authenticating user.
DirectMessage	show(Long id) The ID of the direct message.
EventShowResponse	showEvent(Long id) Returns a single Direct Message event by the given id.

Method Detail

listEvents

@RemoteMethod(httpMethod="GET",
              path="/events/list.json")
EventsListResponse listEvents(@QueryIfNE
                                                                                                      EventsListRequest parameters)

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Parameters:

parameters - EventsListRequest

Returns:

EventsListResponse

See Also:

https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/list-events

showEvent

@RemoteMethod(httpMethod="GET",
              path="/events/show.json")
EventShowResponse showEvent(@Query(value="id")
                                                                                                    Long id)

Returns a single Direct Message event by the given id.

Returns:

EventShowResponse

See Also:

https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-event

newEvent

@RemoteMethod(httpMethod="POST",
              path="/events/new.json")
DirectMessageEvent newEvent(@Body
                                                                                                    MessageCreateRequest event)

Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.

Parameters:

event - MessageCreateRequest

Returns:

DirectMessageEvent

See Also:

https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event

destroy

@RemoteMethod(httpMethod="POST",
              path="/destroy.json")
DirectMessage destroy(@Query(value="id")
                                                                                           Long id)

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user. Returns an event in the requested format if successful.

Parameters:

id - The ID of the direct message to delete.

Returns:

DirectMessage

See Also:

https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event

show

@RemoteMethod(httpMethod="GET",
              path="/show.json")
DirectMessage show(@Query(value="id")
                                                                                    Long id)

The ID of the direct message.

Parameters:

id - The ID of the direct message to delete.

Returns:

DirectMessage

See Also:

https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event

list

@RemoteMethod(httpMethod="GET",
              path=".json")
List<DirectMessage> list(@QueryIfNE
                                                                                     DirectMessagesListRequest parameters)

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.

Parameters:

parameters - DirectMessagesListRequest

Returns:

List[DirectMessage]

See Also:

https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages

sent

@RemoteMethod(httpMethod="GET",
              path="/sent.json")
List<DirectMessage> sent(@QueryIfNE
                                                                                          DirectMessagesSentRequest parameters)

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.

Parameters:

parameters - DirectMessagesSentRequest

Returns:

List[DirectMessage]

See Also:

https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message

newDM

@RemoteMethod(httpMethod="POST",
              path="/new.json")
DirectMessage newDM(@Body
                                                                                     DirectMessageNewRequest parameters)

Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.

Parameters:

parameters - DirectMessageNewRequest

Returns:

DirectMessage

See Also:

https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-event