org.apache.streams.twitter.api

Interface WelcomeMessageRules

All Known Implementing Classes:

Twitter

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

Interface for /direct_messages/welcome_messages/rules methods.

See Also:

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

Method Summary

Modifier and Type	Method and Description
void	destroyWelcomeMessageRule(Long id) Deletes a Welcome Message Rule by the given id.
WelcomeMessageRulesListResponse	listWelcomeMessageRules(WelcomeMessageRulesListRequest parameters) Returns a list of Welcome Message Rules.
WelcomeMessageRule	newWelcomeMessageRule(WelcomeMessageNewRuleRequest body) Creates a new Welcome Message Rule that determines which Welcome Message will be shown in a given conversation.
WelcomeMessageRule	showWelcomeMessageRule(Long id) Returns a Welcome Message Rule by the given id.

Method Detail

listWelcomeMessageRules

@RemoteMethod(httpMethod="GET",
              path="/list.json")
WelcomeMessageRulesListResponse listWelcomeMessageRules(@QueryIfNE
                                                                                                                         WelcomeMessageRulesListRequest parameters)

Returns a list of Welcome Message Rules.

Returns:

WelcomeMessageRulesListResponse

See Also:

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

showWelcomeMessageRule

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

Returns a Welcome Message Rule by the given id.

Returns:

WelcomeMessageRule

See Also:

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

newWelcomeMessageRule

@RemoteMethod(httpMethod="POST",
              path="/new.json")
WelcomeMessageRule newWelcomeMessageRule(@Body
                                                                                                          WelcomeMessageNewRuleRequest body)

Creates a new Welcome Message Rule that determines which Welcome Message will be shown in a given conversation. Returns the created rule if successful. Requires a JSON POST body and Content-Type header to be set to application/json. Setting Content-Length may also be required if it is not automatically. Additional rule configurations are forthcoming. For the initial beta release, the most recently created Rule will always take precedence, and the assigned Welcome Message will be displayed in the conversation.

Returns:

WelcomeMessageRule

See Also:

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

destroyWelcomeMessageRule

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

Deletes a Welcome Message Rule by the given id.

See Also:

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