com.directsms.s3.api
Class InboundSmsMessage

java.lang.Object
  |
  +--com.directsms.s3.api.axis.InboundSmsMessage
        |
        +--com.directsms.s3.api.InboundSmsMessage
All Implemented Interfaces:
java.io.Serializable

public class InboundSmsMessage
extends com.directsms.s3.api.axis.InboundSmsMessage

An InboundSmsMessage models an incoming SMS message to a specific inbound number leased by a client.

The InboundSmsMessage encapsulates the the message text, the mobile number of the person sending the message, the inbound number the message was received on and finally the time when this message was received. This time is supplied as the number of seconds between the time SmsConnection.getInboundMessages() was called and when the message was actually received by the directSMS gateway.

Version:
1.0
Author:
R.Zaki
See Also:
SmsConnection.getInboundMessages(java.lang.String, boolean), SmsConnection.getInboundMessages(java.lang.String), SmsConnection.getInboundMessages(boolean), SmsConnection.getInboundMessages(), Serialized Form

Constructor Summary
InboundSmsMessage(java.lang.String inboundNumber, java.lang.String message, java.lang.String mobile, long when)
          Construct a new Inbound SMS object from its underlying attributes.
 
Method Summary
 java.lang.String toString()
          Show the contents of this Inbound SMS message response object as 'inbound number' - 'message text' - 'mobile' - [when]
 
Methods inherited from class com.directsms.s3.api.axis.InboundSmsMessage
equals, getDeserializer, getInboundNumber, getMessage, getMobile, getSerializer, getTypeDesc, getWhen, hashCode, setInboundNumber, setMessage, setMobile, setWhen
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

InboundSmsMessage

public InboundSmsMessage(java.lang.String inboundNumber,
                         java.lang.String message,
                         java.lang.String mobile,
                         long when)
Construct a new Inbound SMS object from its underlying attributes.

Parameters:
inboundNumber - The number this message was received on. The number is in in the format "+61412345678". The "+" is present in order to insure the correct operation of the SmsGateway SOAP service with untyped clients i.e. PHP or PERL.
message - A String of the SMS message text making up this inbound message
mobile - A String representing the number of the mobile phone that sent the message in the format "+61412345678". The "+" is present in order to insure the correct operation of the SmsGateway SOAP service with untyped clients i.e. PHP or PERL.
when - The number of seconds since this message was received.
Method Detail

toString

public java.lang.String toString()
Show the contents of this Inbound SMS message response object as 'inbound number' - 'message text' - 'mobile' - [when]

Overrides:
toString in class java.lang.Object
Returns:
String The String representation of this message