com.twilio.rest.wireless.v1

Class CommandCreator

java.lang.Object

com.twilio.base.Creator<Command>

com.twilio.rest.wireless.v1.CommandCreator

public class CommandCreator
extends Creator<Command>

Constructor Summary

Constructors

Constructor and Description
CommandCreator(String command) Construct a new CommandCreator.

Method Summary

Modifier and Type	Method and Description
Command	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
CommandCreator	setCallbackMethod(HttpMethod callbackMethod) The HTTP method we use to call `callback_url`.
CommandCreator	setCallbackUrl(String callbackUrl) The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed..
CommandCreator	setCallbackUrl(URI callbackUrl) The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed..
CommandCreator	setCommandMode(Command.CommandMode commandMode) The mode to use when sending the SMS message.
CommandCreator	setDeliveryReceiptRequested(Boolean deliveryReceiptRequested) Whether to request delivery receipt from the recipient.
CommandCreator	setIncludeSid(String includeSid) Whether to include the SID of the command in the message body.
CommandCreator	setSim(String sim) The `sid` or `unique_name` of the SIM to send the Command to..

Methods inherited from class com.twilio.base.Creator

create, createAsync, createAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandCreator

public CommandCreator(String command)

Construct a new CommandCreator.

Parameters:

command - The message body of the Command or a Base64 encoded byte string in binary mode

Method Detail

setSim

public CommandCreator setSim(String sim)

The `sid` or `unique_name` of the SIM to send the Command to..

Parameters:

sim - The sid or unique_name of the SIM to send the Command to

Returns:

this

setCallbackMethod

public CommandCreator setCallbackMethod(HttpMethod callbackMethod)

The HTTP method we use to call `callback_url`. Can be: `POST` or `GET`, and the default is `POST`..

Parameters:

callbackMethod - The HTTP method we use to call callback_url

Returns:

this

setCallbackUrl

public CommandCreator setCallbackUrl(URI callbackUrl)

The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed..

Parameters:

callbackUrl - he URL we call when the Command has finished sending

Returns:

this

setCallbackUrl

public CommandCreator setCallbackUrl(String callbackUrl)

The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed..

Parameters:

callbackUrl - he URL we call when the Command has finished sending

Returns:

this

setCommandMode

public CommandCreator setCommandMode(Command.CommandMode commandMode)

The mode to use when sending the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`..

Parameters:

commandMode - The mode to use when sending the SMS message

Returns:

this

setIncludeSid

public CommandCreator setIncludeSid(String includeSid)

Whether to include the SID of the command in the message body. Can be: `none`, `start`, or `end`, and the default behavior is `none`. When sending a Command to a SIM in text mode, we can automatically include the SID of the Command in the message body, which could be used to ensure that the device does not process the same Command more than once. A value of `start` will prepend the message with the Command SID, and `end` will append it to the end, separating the Command SID from the message body with a space. The length of the Command SID is included in the 160 character limit so the SMS body must be 128 characters or less before the Command SID is included..

Parameters:

includeSid - Whether to include the SID of the command in the message body

Returns:

this

setDeliveryReceiptRequested

public CommandCreator setDeliveryReceiptRequested(Boolean deliveryReceiptRequested)

Whether to request delivery receipt from the recipient. For Commands that request delivery receipt, the Command state transitions to 'delivered' once the server has received a delivery receipt from the device. The default value is `true`..

Parameters:

deliveryReceiptRequested - Whether to request delivery receipt from the recipient

Returns:

this

create

public Command create(TwilioRestClient client)

Make the request to the Twilio API to perform the create.

Specified by:

create in class Creator<Command>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Command