public class DBCOutSMSPacket
extends java.lang.Object
Constructor and Description |
---|
DBCOutSMSPacket() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getContent()
The text content of the message to be sent.
|
I_GemOutSMSPacket |
getInternalData()
For internal use.
|
java.lang.String |
getLoggingComment()
Any comment regarding this message that should be put into the Sent Logs alongwith this message.
|
DBCMessageCategory |
getMessageCategory() |
java.lang.String |
getPhoneNo()
The destination phone number.
|
java.lang.String |
getPluginUserDefinedName()
The name of the plugin that generated this packet.
|
boolean |
getRequestReceipt()
This field should be set to true if you want the remote server to send back a status report
|
boolean |
getSendAsFlash()
This field should be set to true if you want the message to be sent as a 'flash' message
|
java.lang.String |
getSenderName()
The sendername or shortcode to be displayed as the 'From' of the message.
|
boolean |
getSenderNameIsAlpha()
Set this field should be true if an alphanumeric sendername is specified in the
setSenderName(java.lang.String) field. |
boolean |
getSuppressContentInLog() |
void |
setContent(java.lang.String val)
The text content of the message to be sent.
|
void |
setLoggingComment(java.lang.String val)
Any comment regarding this message that should be put into the Sent Logs alongwith this message.
|
void |
setMessageCategory(DBCMessageCategory val)
The category of this message.
|
void |
setPhoneNo(java.lang.String val)
The destination phone number.
|
void |
setPluginUserDefinedName(java.lang.String val)
The name of the plugin that generated this packet.
|
void |
setRequestReceipt(boolean val)
This field should be set to true if you want the remote server to send back a status report
|
void |
setSendAsFlash(boolean val)
This field should be set to true if you want the message to be sent as a 'flash' message
|
void |
setSenderName(java.lang.String val)
The sendername or shortcode to be displayed as the 'From' of the message.
|
void |
setSenderNameIsAlpha(boolean val)
Set this field should be true if an alphanumeric sendername is specified in the
setSenderName(java.lang.String) field. |
void |
setSuppressContentInLog(boolean val)
This field indicates whether the content of this message should be logged to
disk.
|
public I_GemOutSMSPacket getInternalData()
public java.lang.String getPhoneNo()
This field should include the country and network code, but without any leading 0s or '+' symbols. The string should also only include numbers.
public java.lang.String getContent()
public boolean getRequestReceipt()
public boolean getSendAsFlash()
public java.lang.String getSenderName()
setSenderNameIsAlpha(boolean)
public boolean getSenderNameIsAlpha()
setSenderName(java.lang.String)
field.
The value false means it is a shortcode. The SourceAddressTON and SourceAddressNPI of the packet are set based on this field.
public java.lang.String getPluginUserDefinedName()
Plugin developers do not need to set this value.
public java.lang.String getLoggingComment()
It is recommended that you not use the \" (double-quote) character in this field, as it may interfere with the CSV's file demarcation.
public boolean getSuppressContentInLog()
public DBCMessageCategory getMessageCategory()
public void setPhoneNo(java.lang.String val)
This field should include the country and network code, but without any leading 0s or '+' symbols. The string should also only include numbers.
public void setContent(java.lang.String val)
public void setRequestReceipt(boolean val)
public void setSendAsFlash(boolean val)
public void setSenderName(java.lang.String val)
setSenderNameIsAlpha(boolean)
public void setSenderNameIsAlpha(boolean val)
setSenderName(java.lang.String)
field.
The value false means it is a shortcode. The SourceAddressTON and SourceAddressNPI of the packet are set based on this field.
public void setPluginUserDefinedName(java.lang.String val)
Plugin developers do not need to set this value.
public void setLoggingComment(java.lang.String val)
It is recommended that you not use the \" (double-quote) character in this field, as it may interfere with the CSV's file demarcation.
public void setSuppressContentInLog(boolean val)
Setting it to true requests the engine to log a dummy content to disk for this message, typically the text '***Content Suppressed***'.
This feature is used for messages which contain important security information, for example, one-time-passwords.
By default, this field is false, ie, the message content will be logged to disk.
Note that the setting of this field does not in any way alter the message sent out to the gateway; it only affects the logging.
public void setMessageCategory(DBCMessageCategory val)
Set this field to indicate the content of this message as alert/promotional/notification.
Setting this field is optional. If not set, the system's default is used. You can explicitly pass val as null to denote that you wish to use the system default.
See DBCMessageCategory
.