|
SMSLib 3.5.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.smslib.Message
org.smslib.OutboundMessage
public class OutboundMessage
Class representing an outbound sms message.
Nested Class Summary | |
---|---|
static class |
OutboundMessage.FailureCauses
Enumeration representing the failure reasons of a failed outbound message. |
static class |
OutboundMessage.MessageStatuses
Class representing the status of an outbound message. |
Nested classes/interfaces inherited from class org.smslib.Message |
---|
Message.MessageClasses, Message.MessageEncodings, Message.MessageTypes |
Constructor Summary | |
---|---|
OutboundMessage()
Outbound message constructor. |
|
OutboundMessage(java.lang.String myRecipient,
java.lang.String text)
Outbound message constructor. |
Method Summary | |
---|---|
long |
getDeliveryDelay()
|
java.util.Date |
getDispatchDate()
Returns the dispatch date of this message. |
java.lang.String |
getErrorMessage()
Returns the error message associated with the failure of this outbound message to be sent out. |
OutboundMessage.FailureCauses |
getFailureCause()
|
boolean |
getFlashSms()
Returns true if this message is to be sent out as a flash SMS. |
java.lang.String |
getFrom()
Receives the custom originator string. |
OutboundMessage.MessageStatuses |
getMessageStatus()
Returns the message status. |
java.util.List<java.lang.String> |
getPdus(java.lang.String smscNumber,
int mpRefNo)
|
java.lang.String |
getPduUserData()
|
java.lang.String |
getPduUserDataHeader()
|
int |
getPriority()
Returns the priority of the message. |
java.lang.String |
getRecipient()
Returns the recipient of this outbound message. |
java.lang.String |
getRefNo()
Returns the message Reference Number. |
int |
getRetryCount()
Return value of internal sending retry counter. |
java.util.Date |
getScheduledDeliveryDate()
|
boolean |
getStatusReport()
Returns true if a status/delivery report will be asked for this message. |
int |
getValidityPeriod()
Returns the message validity period (in hours). |
void |
setDeliveryDelay(long deliveryDelay)
|
void |
setDispatchDate(java.util.Date myDispatchDate)
|
void |
setEncoding(Message.MessageEncodings encoding)
Sets the message encoding to the specified one. |
void |
setErrorMessage(java.lang.String errorMessage)
|
void |
setFailureCause(OutboundMessage.FailureCauses myFailureCause)
Mark message as failed and set cause of failure. |
void |
setFlashSms(boolean flashSms)
Set the flash message indication. |
void |
setFrom(java.lang.String myFrom)
Sets the custom originator string. |
void |
setMessageStatus(OutboundMessage.MessageStatuses myMessageStatus)
|
void |
setPriority(int myPriority)
Sets the priority of the message. |
void |
setRecipient(java.lang.String myRecipient)
Set the recipient of the message. |
void |
setRefNo(java.lang.String myRefNo)
|
void |
setRetryCount(int myRetryCount)
|
void |
setScheduledDeliveryDate(java.util.Date scheduledDeliveryDate)
|
void |
setStatusReport(boolean myStatusReport)
Sets the status report request. |
void |
setValidityPeriod(int myValidityPeriod)
Sets the message validity period. |
java.lang.String |
toString()
|
Methods inherited from class org.smslib.Message |
---|
addText, getDate, getDCSMessageClass, getDstPort, getEncoding, getGatewayId, getId, getMessageId, getSrcPort, getText, getType, getUuid, setDate, setDCSMessageClass, setDstPort, setGatewayId, setId, setSrcPort, setText |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public OutboundMessage()
OutboundMessage(String, String)
public OutboundMessage(java.lang.String myRecipient, java.lang.String text)
myRecipient
- The recipient of the message.text
- The text of the message.Method Detail |
---|
public java.lang.String getRecipient()
setRecipient(String)
public void setRecipient(java.lang.String myRecipient)
myRecipient
- The recipient of the message.getRecipient()
public java.util.Date getDispatchDate()
public void setDispatchDate(java.util.Date myDispatchDate)
public boolean getFlashSms()
setFlashSms(boolean)
public void setFlashSms(boolean flashSms)
The default is non-flash (false).
flashSms
- True for a flash sms.public boolean getStatusReport()
public void setStatusReport(boolean myStatusReport)
The default is (false).
myStatusReport
- The status report request status.public int getValidityPeriod()
setValidityPeriod(int)
public void setValidityPeriod(int myValidityPeriod)
myValidityPeriod
- The message validity period in hours.getValidityPeriod()
public java.lang.String getFrom()
setFrom(String)
public void setFrom(java.lang.String myFrom)
Note that this functionality is not supported on GSM modems / phones. It is supported on most bulk sms operators.
myFrom
- The custom originator string.getFrom()
public OutboundMessage.MessageStatuses getMessageStatus()
OutboundMessage.MessageStatuses
public void setMessageStatus(OutboundMessage.MessageStatuses myMessageStatus)
public OutboundMessage.FailureCauses getFailureCause()
public void setFailureCause(OutboundMessage.FailureCauses myFailureCause)
myFailureCause
- Cause of failurepublic int getRetryCount()
public void setRetryCount(int myRetryCount)
public int getPriority()
public void setPriority(int myPriority)
myPriority
- The new priority.public java.lang.String getRefNo()
public void setRefNo(java.lang.String myRefNo)
public java.lang.String getErrorMessage()
public void setErrorMessage(java.lang.String errorMessage)
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.List<java.lang.String> getPdus(java.lang.String smscNumber, int mpRefNo)
public java.lang.String getPduUserData()
getPduUserData
in class Message
public java.lang.String getPduUserDataHeader()
getPduUserDataHeader
in class Message
public void setEncoding(Message.MessageEncodings encoding)
Message
setEncoding
in class Message
encoding
- The message encoding.Message.getEncoding()
,
Message.MessageEncodings
public void setScheduledDeliveryDate(java.util.Date scheduledDeliveryDate)
public java.util.Date getScheduledDeliveryDate()
public long getDeliveryDelay()
public void setDeliveryDelay(long deliveryDelay)
|
SMSLib 3.5.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |