com.bt.sdk.capabilities.messaging.oneway
Class Message

java.lang.Object
  extended by com.bt.sdk.capabilities.messaging.oneway.Message

public class Message
extends java.lang.Object

Data representing a message that is to be or has been sent.


Constructor Summary
Message()
          Default Constructor
Message(java.util.Collection<java.lang.String> recipientUris, java.lang.String messageText)
           
Message(java.util.Collection<java.lang.String> recipientUris, java.lang.String messageText, java.lang.String from)
          Creates a new Message object.
Message(java.lang.String messageText)
          Creates a new Message object.
Message(java.lang.String uri, java.lang.String messageText)
          Creates a new Message object.
Message(java.lang.String uri, java.lang.String from, java.lang.String messageText)
          Creates a new Message object.
 
Method Summary
 java.lang.String getFrom()
           
 java.util.Collection<com.bt.sdk.capabilities.messaging.oneway.MessageDeliveryStatus> getMessageDeliveryStatuses()
           
 java.lang.String getMessageId()
           
 java.lang.String getMessageText()
           
 java.util.Collection<java.lang.String> getRecipientUris()
           
 java.lang.String getUrl()
           
 void setFrom(java.lang.String newValue)
           
 void setMessageDeliveryStatuses(java.util.Collection<com.bt.sdk.capabilities.messaging.oneway.MessageDeliveryStatus> newValue)
           
 void setMessageId(java.lang.String newValue)
           
 void setMessageText(java.lang.String newValue)
           
 void setRecipientUris(java.util.Collection<java.lang.String> newValue)
           
 void setUrl(java.lang.String newValue)
           
 void updateStatus()
          Updates the status of the message object from the service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Message

public Message()
Default Constructor


Message

public Message(java.lang.String uri,
               java.lang.String from,
               java.lang.String messageText)
Creates a new Message object.

Parameters:
uri - A uri where the message is to be sent. At the time of release, uris should start with 'tel:', 'sip:' or 'mailto:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com', 'mailto:user@domain.com'
from - The subject of the message or email sent.
messageText - The message text to send.

Message

public Message(java.lang.String messageText)
Creates a new Message object.

Parameters:
messageText - The message text to send.

Message

public Message(java.lang.String uri,
               java.lang.String messageText)
Creates a new Message object.

Parameters:
uri - A uri where the message is to be sent. At the time of release, uris should start with 'tel:', 'sip:' or 'mailto:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com', 'mailto:user@domain.com'
messageText - The message text to send.

Message

public Message(java.util.Collection<java.lang.String> recipientUris,
               java.lang.String messageText)
Parameters:
recipientUris - An array of uris where the message is to be sent. At the time of release, uris should start with 'tel:', 'sip:' or 'mailto:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com', 'mailto:user@domain.com'
messageText - The message text to send.

Message

public Message(java.util.Collection<java.lang.String> recipientUris,
               java.lang.String messageText,
               java.lang.String from)
Creates a new Message object. NOTE: This constructor is not valid for sending messages via the MessagingInbound service

Parameters:
recipientUris - An array of uris where the message is to be sent. At the time of release, uris should start with 'tel:', 'sip:' or 'mailto:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com', 'mailto:user@domain.com'
messageText - The message text to send.
from - The subject of the message or email sent.
Method Detail

getRecipientUris

public java.util.Collection<java.lang.String> getRecipientUris()
Returns:
recipientUris An array of uris where the message is to be sent. At the time of release, uris should start with 'tel:', 'sip:' or 'mailto:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com', 'mailto:user@domain.com'

setRecipientUris

public void setRecipientUris(java.util.Collection<java.lang.String> newValue)
Parameters:
recipientUris - An array of uris where the message is to be sent. At the time of release, uris should start with 'tel:', 'sip:' or 'mailto:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com', 'mailto:user@domain.com'

getMessageId

public java.lang.String getMessageId()
Returns:
messageId The message identifier.

setMessageId

public void setMessageId(java.lang.String newValue)
Parameters:
messageId - The message identifier.

getFrom

public java.lang.String getFrom()
Returns:
from The subject of the message or email sent.

setFrom

public void setFrom(java.lang.String newValue)
Parameters:
from - The subject of the message or email sent.

getMessageDeliveryStatuses

public java.util.Collection<com.bt.sdk.capabilities.messaging.oneway.MessageDeliveryStatus> getMessageDeliveryStatuses()
Returns:
messageDeliveryStatuses The delivery statuses of the Message.

setMessageDeliveryStatuses

public void setMessageDeliveryStatuses(java.util.Collection<com.bt.sdk.capabilities.messaging.oneway.MessageDeliveryStatus> newValue)
Parameters:
messageDeliveryStatuses - The delivery statuses of the Message.

getMessageText

public java.lang.String getMessageText()
Returns:
messageText The message text to send.

setMessageText

public void setMessageText(java.lang.String newValue)
Parameters:
messageText - The message text to send.

getUrl

public java.lang.String getUrl()
Returns:
url A url to receive postback messages for the status of the message sent.

setUrl

public void setUrl(java.lang.String newValue)
Parameters:
url - A url to receive postback messages for the status of the message sent.

updateStatus

public void updateStatus()
Updates the status of the message object from the service.