com.avaya.collaboration.sms

Interface SmsRequest

public interface SmsRequest

Represents an SmsRequest object which can be used to send a text messages to one or more destinations. The optional setters return the modified object. This allows for chaining, for instance: sms.setSender("17205551212").setMessage("This is a test");

Method Summary

Methods

Modifier and Type	Method and Description
SmsRequest	addRecipient(String address) Add another recipient to the existing set of recipients for this message.
String	getAccountId() Get the account ID.
SmsListener	getListener() Get the listener that was previously assigned using SmsRequest.setListener(SmsListener).
String	getPassword() Get the password
List	getRecipients() Get the list of recipients for this request.
String	getSender() Get the sender (e.g., "13035551234")
String	getText() Get the text body
String	getUserName() Get the user name.
void	send() Send the message.
SmsRequest	setAccountId(String accountId) Set the account ID.
SmsRequest	setListener(SmsListener smsListener) Responses to a SmsRequest.send() request arrive asynchronously.
SmsRequest	setPassword(String password) Set the password.
SmsRequest	setSender(String sender) Set the sender.
SmsRequest	setText(String text) Set the text message body
SmsRequest	setUserName(String userName) Set the user name.

Method Detail

addRecipient

SmsRequest addRecipient(String address)

Add another recipient to the existing set of recipients for this message.

Parameters:

address - the address (e.g., mobile number) of the recipient

Returns:

The modified SmsRequest object reflecting the message changes

getRecipients

List getRecipients()

Get the list of recipients for this request. Each destination is a telephone number (e.g., "17205551212").

Returns:

the list of destinations for the message

setText

SmsRequest setText(String text)

Set the text message body

Parameters:

text - A text message up to 160 bytes in length.

Returns:

The modified SmsRequest object reflecting the message changes

Throws:

SmsBodyTooLargeException

getText

String getText()

Get the text body

Returns:

The text body

setSender

SmsRequest setSender(String sender)

Set the sender.

Parameters:

sender - The sender of this message (e.g., "13035551234")

Returns:

The modified SmsRequest object reflecting the sender changes

getSender

String getSender()

Get the sender (e.g., "13035551234")

Returns:

The sender

setUserName

SmsRequest setUserName(String userName)

Set the user name. This is typically used in conjunction with setting the password (SmsRequest#setPassword(String).

Parameters:

userName - The user name

Returns:

The modified SmsRequest object reflecting the user name changes

getUserName

String getUserName()

Get the user name.

Returns:

The user name

setPassword

SmsRequest setPassword(String password)

Set the password. This is typically used in conjunction with setting the user name (SmsRequest#setUserName(String).

Parameters:

password - The credentials associated with this account

Returns:

The modified SmsRequest object reflecting the password changes

getPassword

String getPassword()

Get the password

Returns:

The password

setAccountId

SmsRequest setAccountId(String accountId)

Set the account ID. Not all SMS service providers require an account ID, but this value would likely be provided by the SMS service provider when an account is created.

Parameters:

accountId - the account ID, likely from the SMS service provider

Returns:

The modified SmsRequest object reflecting the password changes

getAccountId

String getAccountId()

Get the account ID.

Returns:

the account ID

setListener

SmsRequest setListener(SmsListener smsListener)

Responses to a SmsRequest.send() request arrive asynchronously. There may be more than one response for each send request. The client service will not be notified when the listener is set to null (the default value). By setting the listener, the responses for any send will be presented to the listener. Changing the listener will not affect any responses to requests already made. It will only affect where responses are notified to any subsequent send.

Parameters:

smsListener - The listener which will be invoked upon receiving a response to the SmsRequest.send()

Returns:

The smsListener

getListener

SmsListener getListener()

Get the listener that was previously assigned using SmsRequest.setListener(SmsListener).

Returns:

The listener, or null if not assigned

send

void send()
          throws CollaborationBusException

Send the message. This is a non blocking call. Services interested in responses should call SmsRequest.setListener(SmsListener)

Throws:

CollaborationBusException