程序包 ohos.telephony

类 ShortMessage

java.lang.Object

ohos.telephony.ShortMessage

public class ShortMessage
extends Object

Provides methods for obtaining Short Message Service (SMS) instances.

Applications can obtain details about an SMS message by calling the methods of this instance.

从以下版本开始:

1

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	ShortMessage.ShortMessageClass	Indicates the SMS type.

方法概要

限定符和类型	方法	说明
static Optional<ShortMessage>	createMessage(byte[] pdu, String specification)	Creates an SMS message instance based on the protocol data unit (PDU) and the specified SMS protocol.
ShortMessage.ShortMessageClass	getMessageClass()	Obtains the SMS type.
byte[]	getPdu()	Obtains Protocol Data Units (PDUs) from an SMS message.
int	getProtocolId()	Obtains the protocol identifier used for transmitting an SMS message.
String	getScAddress()	Obtains the short message service center (SMSC) address.
long	getScTimestamp()	Obtains the SMSC timestamp.
int	getStatus()	Obtains the SMS message status from the SMS-STATUS-REPORT message sent by the Short Message Service Center (SMSC).
byte[]	getUserRawData()	Obtains the user data excluding the data header.
String	getVisibleMessageBody()	Obtains the SMS message body.
String	getVisibleRawAddress()	Obtains the address of the sender, which is to be displayed on the UI.
boolean	hasReplyPath()	Checks whether the received SMS contains "TP-Reply-Path".
boolean	isReplaceMessage()	Checks whether the received SMS is a "replace short message".
boolean	isSmsStatusReportMessage()	Checks whether the current message is SMS-STATUS-REPORT.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

getProtocolId

public int getProtocolId()

Obtains the protocol identifier used for transmitting an SMS message.

返回:

Returns the protocol identifier.

getMessageClass

public ShortMessage.ShortMessageClass getMessageClass()

Obtains the SMS type.

返回:

Returns the SMS type. The values are as follows:

• ShortMessageClass#UNKNOWN - unknown type
• ShortMessageClass#INSTANT_MESSAGE - instant message
• ShortMessageClass#OPTIONAL_MESSAGE - SMS message to be stored on the device or SIM card
• ShortMessageClass#SIM_MESSAGE - SMS message to be stored in the SIM card
• ShortMessageClass#FORWARD_MESSAGE - SMS message to be forwarded to another device

createMessage

public static Optional<ShortMessage> createMessage(byte[] pdu,
                                                   String specification)

Creates an SMS message instance based on the protocol data unit (PDU) and the specified SMS protocol.

After receiving the original PDU data, the system creates an SMS message instance according to the specified SMS protocol.

参数:

pdu - Indicates the original data, which is obtained from the received SMS.

specification - Indicates the SMS protocol type. The value 3gpp indicates GSM/UMTS/LTE SMS, and the value 3gpp2 indicates CDMA/LTE SMS.

返回:

Returns an SMS message instance; returns null if pdu is empty or specification is not supported.

getVisibleMessageBody

public String getVisibleMessageBody()

Obtains the SMS message body.

返回:

Returns an email message body if the SMS is from an email gateway; returns an SMS message body if the SMS is not from an email gateway; returns null if the message body is invalid.

getVisibleRawAddress

public String getVisibleRawAddress()

Obtains the address of the sender, which is to be displayed on the UI.

返回:

Returns an email address if the SMS is from an email gateway; returns an SMS address if the SMS is not from an email gateway; returns null if the original address is invalid.

getScAddress

public String getScAddress()

Obtains the short message service center (SMSC) address.

返回:

Returns the SMSC address; returns null if the address does not exist.

getScTimestamp

public long getScTimestamp()

Obtains the SMSC timestamp.

返回:

Returns the SMSC timestamp.

getUserRawData

public byte[] getUserRawData()

Obtains the user data excluding the data header.

返回:

Returns the user data excluding the data header.

isReplaceMessage

public boolean isReplaceMessage()

Checks whether the received SMS is a "replace short message". For details, see 3GPP TS 23.040 9.2.3.9.

返回:

Returns true if the received SMS is a "replace short message"; returns false otherwise.

hasReplyPath

public boolean hasReplyPath()

Checks whether the received SMS contains "TP-Reply-Path".

返回:

Returns true if the received SMS contains "TP-Reply-Path"; returns false otherwise.

getStatus

public int getStatus()

Obtains the SMS message status from the SMS-STATUS-REPORT message sent by the Short Message Service Center (SMSC).

返回:

Returns 0 if the SMS message was received.

从以下版本开始:

5

getPdu

public byte[] getPdu()

Obtains Protocol Data Units (PDUs) from an SMS message.

返回:

Returns an array of PDUs.

从以下版本开始:

5

isSmsStatusReportMessage

public boolean isSmsStatusReportMessage()

Checks whether the current message is SMS-STATUS-REPORT.

返回:

Returns true if the current message is SMS-STATUS-REPORT; returns false otherwise.

从以下版本开始:

5