org.apache.streams.twitter.api

Interface WelcomeMessages

All Known Implementing Classes:

Twitter

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

Interface for /direct_messages/welcome_messages methods.

See Also:

https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference

Method Summary

Modifier and Type	Method and Description
void	destroyWelcomeMessage(Long id) Deletes a Welcome Message by the given id.
WelcomeMessagesListResponse	listWelcomeMessages(WelcomeMessagesListRequest parameters) Returns a list of Welcome Messages.
WelcomeMessageNewResponse	newWelcomeMessage(WelcomeMessageNewRequest messageNewRequest) Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.
WelcomeMessage	showWelcomeMessage(Long id) Returns a Welcome Message by the given id.

Method Detail

listWelcomeMessages

@RemoteMethod(httpMethod="GET",
              path="/list.json")
WelcomeMessagesListResponse listWelcomeMessages(@QueryIfNE(value="*")
                                                                                                                 WelcomeMessagesListRequest parameters)

Returns a list of Welcome Messages.

Returns:

WelcomeMessagesListResponse

See Also:

https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/list-welcome-messages

showWelcomeMessage

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

Returns a Welcome Message by the given id.

Returns:

WelcomeMessage

See Also:

https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/get-welcome-message

newWelcomeMessage

@RemoteMethod(httpMethod="POST",
              path="/new.json")
WelcomeMessageNewResponse newWelcomeMessage(@Body
                                                                                                             WelcomeMessageNewRequest messageNewRequest)

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances. Returns the message template in the requested format if successful. Supports publishing with the same elements as Direct Messages (e.g. Quick Replies, media attachments).

Returns:

WelcomeMessage

See Also:

https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/new-welcome-message

destroyWelcomeMessage

@RemoteMethod(httpMethod="DELETE",
              path="/destroy.json")
void destroyWelcomeMessage(@Query(value="id")
                                                                                                  Long id)

Deletes a Welcome Message by the given id.

See Also:

https://developer.twitter.com/en/docs/direct-messages/welcome-messages/api-reference/delete-welcome-message