com.bt.sdk.capabilities.messaging.inbound
Class MessagingInboundManager

java.lang.Object
  extended by com.bt.sdk.capabilities.messaging.inbound.MessagingInboundManager

public class MessagingInboundManager
extends java.lang.Object

This service requires sign-up. This service allows you to send an SMS to a GSM device and gather information about its delivery. It also stores and allows the application to retrieve SMS replies/messages sent to the application


Constructor Summary
MessagingInboundManager()
           
 
Method Summary
 int clearReceivedMessages(java.util.Collection<java.lang.String> msgIds)
          Delete all stored SMS messages which have been sent to this application
 int clearReceivedMessages(java.lang.String msgId)
          Delete all stored SMS messages which have been sent to this application
 com.bt.sdk.capabilities.messaging.inbound.MessageDeliveryStatuses getMessageDeliveryStatuses(java.lang.String messageId)
          Returns the status of a sent SMS message
 java.util.Collection<com.bt.sdk.capabilities.messaging.inbound.Message> getReceivedMessages()
          Get all stored SMS messages which have been sent to this application
 java.util.Collection<com.bt.sdk.capabilities.messaging.inbound.Message> getReceivedMessages(java.lang.String keyword)
          Get all stored SMS messages which have been sent to this application
 OutboundMessage sendMessage(java.util.Collection<java.lang.String> recipients, java.lang.String messageText)
          Sends an SMS message to a GSM device
 OutboundMessage sendMessage(OutboundMessage message)
          Sends an SMS message to a GSM device
 OutboundMessage sendMessage(java.lang.String recipient, java.lang.String messageText)
          Sends an SMS message to a GSM device
 OutboundMessage sendMessageWithEventing(java.util.Collection<java.lang.String> recipients, java.lang.String messageText, java.lang.String url)
          Sends an SMS message to a GSM device and sends event updates to url entered
 OutboundMessage sendMessageWithEventing(java.lang.String recipient, java.lang.String messageText, java.lang.String url)
          Sends an SMS message to a GSM device and sends event updates to url entered
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessagingInboundManager

public MessagingInboundManager()
Method Detail

sendMessage

public OutboundMessage sendMessage(java.util.Collection<java.lang.String> recipients,
                                   java.lang.String messageText)
Sends an SMS message to a GSM device

Parameters:
recipients - An array of uris where the message is to be sent. At the time of release, uris should start with 'tel:' but are subject to change. Eg: 'tel:447700900123'
messageText - The message text to send.
Returns:
OutboundMessage The Message that was sent.

sendMessage

public OutboundMessage sendMessage(OutboundMessage message)
Sends an SMS message to a GSM device

Parameters:
message - A Message object.
Returns:
OutboundMessage The Message that was sent.

sendMessage

public OutboundMessage sendMessage(java.lang.String recipient,
                                   java.lang.String messageText)
Sends an SMS message to a GSM device

Parameters:
recipient - A uri where the message is to be sent. At the time of release, uris should start with 'tel:' but are subject to change. Eg: 'tel:447700900123'
messageText - The message text to send.
Returns:
OutboundMessage The Message that was sent.

sendMessageWithEventing

public OutboundMessage sendMessageWithEventing(java.util.Collection<java.lang.String> recipients,
                                               java.lang.String messageText,
                                               java.lang.String url)
Sends an SMS message to a GSM device and sends event updates to url entered

Parameters:
recipients - An array of uris where the message is to be sent. At the time of release, uris should start with 'tel:' but are subject to change. Eg: 'tel:447700900123'
messageText - The message text to send.
url - A url to receive postback messages for the status of the message sent.
Returns:
OutboundMessage The Message that was sent.

sendMessageWithEventing

public OutboundMessage sendMessageWithEventing(java.lang.String recipient,
                                               java.lang.String messageText,
                                               java.lang.String url)
Sends an SMS message to a GSM device and sends event updates to url entered

Parameters:
recipient - A uri where the message is to be sent. At the time of release, uris should start with 'tel:' but are subject to change. Eg: 'tel:447700900123'
messageText - The message text to send.
url - A url to receive postback messages for the status of the message sent.
Returns:
OutboundMessage The Message that was sent.

getMessageDeliveryStatuses

public com.bt.sdk.capabilities.messaging.inbound.MessageDeliveryStatuses getMessageDeliveryStatuses(java.lang.String messageId)
Returns the status of a sent SMS message

Parameters:
messageId - The message identifier.
Returns:
MessageDeliveryStatuses The delivery statuses of the Message.

getReceivedMessages

public java.util.Collection<com.bt.sdk.capabilities.messaging.inbound.Message> getReceivedMessages()
Get all stored SMS messages which have been sent to this application

Returns:
messages The inbound messages received from the service.

getReceivedMessages

public java.util.Collection<com.bt.sdk.capabilities.messaging.inbound.Message> getReceivedMessages(java.lang.String keyword)
Get all stored SMS messages which have been sent to this application

Parameters:
keyword - Keyword.
Returns:
messages The inbound messages received from the service.

clearReceivedMessages

public int clearReceivedMessages(java.util.Collection<java.lang.String> msgIds)
Delete all stored SMS messages which have been sent to this application

Parameters:
msgIds - An array of message identifiers.
Returns:
clearedCount The number of messages cleared from the service.

clearReceivedMessages

public int clearReceivedMessages(java.lang.String msgId)
Delete all stored SMS messages which have been sent to this application

Parameters:
msgId - The message identifier.
Returns:
clearedCount The number of messages cleared from the service.