| java.lang.Object | |
| ↳ | android.telephony.SmsMessage |
A Short Message Service message.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| SmsMessage.MessageClass | SMS Class enumeration. | ||||||||||
| SmsMessage.SubmitPdu | |||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | ENCODING_16BIT | ||||||||||
| int | ENCODING_7BIT | ||||||||||
| int | ENCODING_8BIT | ||||||||||
| int | ENCODING_UNKNOWN | User data text encoding code unit size | |||||||||
| int | MAX_USER_DATA_BYTES | The maximum number of payload bytes per message | |||||||||
| int | MAX_USER_DATA_BYTES_WITH_HEADER | The maximum number of payload bytes per message if a user data header is present. | |||||||||
| int | MAX_USER_DATA_SEPTETS | The maximum number of payload septets per message | |||||||||
| int | MAX_USER_DATA_SEPTETS_WITH_HEADER | The maximum number of payload septets per message if a user data header is present. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Calculates the number of SMS's required to encode the message body and
the number of characters remaining until the next message.
| |||||||||||
Calculates the number of SMS's required to encode the message body and
the number of characters remaining until the next message, given the
current encoding.
| |||||||||||
Create an SmsMessage from a raw PDU.
| |||||||||||
Returns the message body, or email message body if this message was from
an email gateway.
| |||||||||||
Returns the originating address, or email from address if this message
was from an email gateway.
| |||||||||||
Returns the record index of the message on the ICC (1-based index).
| |||||||||||
This method was deprecated
in API level 4.
Use getIndexOnIcc instead.
| |||||||||||
Returns the message body as a String, if it exists and is text based.
| |||||||||||
Returns the class of this message.
| |||||||||||
Returns the originating address (sender) of this SMS message in String
form or null if unavailable
| |||||||||||
Returns the raw PDU for the message.
| |||||||||||
Get protocol identifier.
| |||||||||||
Unofficial convention of a subject line enclosed in parens empty string
if not present
| |||||||||||
Returns the address of the SMS service center that relayed this message
or null if there is none.
| |||||||||||
GSM:
For an SMS-STATUS-REPORT message, this returns the status field from
the status report.
| |||||||||||
Returns the status of the message on the ICC (read, unread, sent, unsent).
| |||||||||||
This method was deprecated
in API level 4.
Use getStatusOnIcc instead.
| |||||||||||
Get an SMS-SUBMIT PDU for a data message to a destination address & port.
| |||||||||||
Get an SMS-SUBMIT PDU for a destination address and a message.
| |||||||||||
Get the TP-Layer-Length for the given SMS-SUBMIT PDU Basically, the
length in bytes (not hex chars) less the SMSC header
FIXME: This method is only used by a CTS test case that isn't run on CDMA devices.
| |||||||||||
Returns the service centre timestamp in currentTimeMillis() format
| |||||||||||
returns the user data section minus the user data header if one was
present.
| |||||||||||
Returns true for CPHS MWI toggle message.
| |||||||||||
Returns true if message is an email.
| |||||||||||
returns true if this message is a CPHS voicemail / message waiting
indicator (MWI) clear message
| |||||||||||
returns true if this message is a CPHS voicemail / message waiting
indicator (MWI) set message
| |||||||||||
returns true if this message is a "Message Waiting Indication Group:
Discard Message" notification and should not be stored.
| |||||||||||
See TS 23.040 9.2.3.9 returns true if this is a "replace short message"
SMS
| |||||||||||
Returns true iff the
TP-Reply-Path bit is set in
this message. | |||||||||||
Return true iff the message is a SMS-STATUS-REPORT message.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
User data text encoding code unit size
The maximum number of payload bytes per message
The maximum number of payload bytes per message if a user data header is present. This assumes the header only contains the CONCATENATED_8_BIT_REFERENCE element.
The maximum number of payload septets per message
The maximum number of payload septets per message if a user data header is present. This assumes the header only contains the CONCATENATED_8_BIT_REFERENCE element.
Calculates the number of SMS's required to encode the message body and the number of characters remaining until the next message.
| msgBody | the message to encode |
|---|---|
| use7bitOnly | if true, characters that are not part of the radio-specific 7-bit encoding are counted as single space chars. If false, and if the messageBody contains non-7-bit encodable characters, length is calculated using a 16-bit encoding. |
Calculates the number of SMS's required to encode the message body and the number of characters remaining until the next message, given the current encoding.
| messageBody | the message to encode |
|---|---|
| use7bitOnly | if true, characters that are not part of the radio specific (GSM / CDMA) alphabet encoding are converted to as a single space characters. If false, a messageBody containing non-GSM or non-CDMA alphabet characters are encoded using 16-bit encoding. |
Create an SmsMessage from a raw PDU.
This method will soon be deprecated and all applications which handle
incoming SMS messages by processing the SMS_RECEIVED_ACTION broadcast
intent must now pass the new format String extra from the intent
into the new method createFromPdu(byte[], String) which takes an
extra format parameter. This is required in order to correctly decode the PDU on
devices that require support for both 3GPP and 3GPP2 formats at the same time,
such as dual-mode GSM/CDMA and CDMA/LTE phones.
Returns the message body, or email message body if this message was from an email gateway. Returns null if message body unavailable.
Returns the originating address, or email from address if this message was from an email gateway. Returns null if originating address unavailable.
Returns the record index of the message on the ICC (1-based index).
This method was deprecated
in API level 4.
Use getIndexOnIcc instead.
Returns the record index of the message on the SIM (1-based index).
Returns the message body as a String, if it exists and is text based.
Returns the class of this message.
Returns the originating address (sender) of this SMS message in String form or null if unavailable
Returns the raw PDU for the message.
Unofficial convention of a subject line enclosed in parens empty string if not present
Returns the address of the SMS service center that relayed this message or null if there is none.
GSM: For an SMS-STATUS-REPORT message, this returns the status field from the status report. This field indicates the status of a previously submitted SMS, if requested. See TS 23.040, 9.2.3.15 TP-Status for a description of values. CDMA: For not interfering with status codes from GSM, the value is shifted to the bits 31-16. The value is composed of an error class (bits 25-24) and a status code (bits 23-16). Possible codes are described in C.S0015-B, v2.0, 4.5.21.
Returns the status of the message on the ICC (read, unread, sent, unsent).
This method was deprecated
in API level 4.
Use getStatusOnIcc instead.
Returns the status of the message on the SIM (read, unread, sent, unsent).
Get an SMS-SUBMIT PDU for a data message to a destination address & port. This method will not attempt to use any GSM national language 7 bit encodings.
| scAddress | Service Centre address. null == use default |
|---|---|
| destinationAddress | the address of the destination for the message |
| destinationPort | the port to deliver the message to at the destination |
| data | the data for the message |
SubmitPdu containing the encoded SC
address, if applicable, and the encoded message.
Returns null on encode error.
Get an SMS-SUBMIT PDU for a destination address and a message. This method will not attempt to use any GSM national language 7 bit encodings.
| scAddress | Service Centre address. Null means use default. |
|---|
SubmitPdu containing the encoded SC
address, if applicable, and the encoded message.
Returns null on encode error.
Get the TP-Layer-Length for the given SMS-SUBMIT PDU Basically, the length in bytes (not hex chars) less the SMSC header FIXME: This method is only used by a CTS test case that isn't run on CDMA devices. We should probably deprecate it and remove the obsolete test case.
Returns the service centre timestamp in currentTimeMillis() format
returns the user data section minus the user data header if one was present.
Returns true for CPHS MWI toggle message.
Returns true if message is an email.
returns true if this message is a CPHS voicemail / message waiting indicator (MWI) clear message
returns true if this message is a CPHS voicemail / message waiting indicator (MWI) set message
returns true if this message is a "Message Waiting Indication Group: Discard Message" notification and should not be stored.
See TS 23.040 9.2.3.9 returns true if this is a "replace short message" SMS
Returns true iff the TP-Reply-Path bit is set in
this message.
Return true iff the message is a SMS-STATUS-REPORT message.