SmsTextMessage SmsTextMessage SmsTextMessage Class

Definition

Manages a decoded SMS text message, providing direct access to the plain text body of the message, as well as key header properties, such as time stamp.

Note

This functionality is only available to mobile operator apps and Windows Store app given privileged access by mobile network operators, mobile broadband adapter IHV, or OEM. For more information, see Mobile Broadband: device apps.

Note

Note that this class and its methods are supported for the maintenance of legacy desktop apps that used it in earlier versions of Windows; and if you do use this class, you must specify the Windows.Devices.Sms.LegacySmsApiContract in your app's manifest. Do not use this class if you are developing new apps for Windows 10. Instead, use the members of this namespace that do not require the Windows.Devices.Sms.LegacySmsApiContract.

public sealed class SmsTextMessage : ISmsMessage, ISmsTextMessagepublic sealed class SmsTextMessage : ISmsMessage, ISmsTextMessagePublic NotInheritable Class SmsTextMessage Implements ISmsMessage, ISmsTextMessage
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

Constructors

SmsTextMessage() SmsTextMessage() SmsTextMessage()

Creates an instance of the SmsTextMessage class.

public SmsTextMessage()public SmsTextMessage()Public Sub New()
Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

Properties

Body Body Body

Specifies the plain text body of the message.

public string Body { get; set; }public string Body { get; set; }Public ReadWrite Property Body As string
Value
string string string

A string representing the body of the text message. If there were decoding problems, some characters in the original message can be represented by a wildcard character, typically a question mark ('?').

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

Encoding Encoding Encoding

Specifies the encoding type that has been set to use when sending this message.

public SmsEncoding Encoding { get; set; }public SmsEncoding Encoding { get; set; }Public ReadWrite Property Encoding As SmsEncoding
Value
SmsEncoding SmsEncoding SmsEncoding

A value from the SmsEncoding enumeration.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

From From From

Specifies the phone number of the sender of the message.

public string From { get; set; }public string From { get; set; }Public ReadWrite Property From As string
Value
string string string

A string representation of the phone number of the sender of this message. It should be in the format preferred by the device and the network it is registered on.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

Id Id Id

Indicates the ID of the SMS text message.

public uint Id { get; }public uint Id { get; }Public ReadOnly Property Id As uint
Value
uint uint uint

An integer ID for the message.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

MessageClass MessageClass MessageClass

Specifies the message class of a message. This message class typically originates on the network, not the mobile device.

public SmsMessageClass MessageClass { get; }public SmsMessageClass MessageClass { get; }Public ReadOnly Property MessageClass As SmsMessageClass
Value
SmsMessageClass SmsMessageClass SmsMessageClass

A value from the SmsMessageClass enumeration.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

PartCount PartCount PartCount

Indicates the total number of parts in the original message if the message is part of a multi-part message.

public uint PartCount { get; }public uint PartCount { get; }Public ReadOnly Property PartCount As uint
Value
uint uint uint

An unsigned integer. If the message is standalone, the value is 1.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

PartNumber PartNumber PartNumber

Indicates the part number of a multi-part message if this message is part of a multi-part message. It can be used to reconstruct the original message by joining the parts together, in conjunction with the PartReferenceId and PartCount properties.

public uint PartNumber { get; }public uint PartNumber { get; }Public ReadOnly Property PartNumber As uint
Value
uint uint uint

An unsigned integer. It is one-based. It will not exceed PartCount + 1.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

PartReferenceId PartReferenceId PartReferenceId

Indicates a reference value that can be used if the message is part of a multi-part message. If this message belongs to a multi-part message, the PartNumber value can be used to reconstruct the full original message, and each part of that message will have the same value for PartReferenceId.

public uint PartReferenceId { get; }public uint PartReferenceId { get; }Public ReadOnly Property PartReferenceId As uint
Value
uint uint uint

An unsigned integer determined by the sending network; it cannot be manipulated through this interface. If the network has its own policy on the lifetime of a multi-part message, this reference number might not be valid indefinitely.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

Timestamp Timestamp Timestamp

Indicates the timestamp of the message. It is determined locally for a constructed message instance or from the service center timestamp of a received message.

public DateTime Timestamp { get; }public DateTimeOffset Timestamp { get; }Public ReadOnly Property Timestamp As DateTimeOffset
Value
DateTime DateTime DateTime

A value of the DateTime type.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

To To To

Indicates the recipient phone number of this message.

public string To { get; set; }public string To { get; set; }Public ReadWrite Property To As string
Value
string string string

A string representation of the phone number, formatted in the phone number format favored by the device and the network that the device is registered on.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

Methods

FromBinaryData(SmsDataFormat, Byte[]) FromBinaryData(SmsDataFormat, Byte[]) FromBinaryData(SmsDataFormat, Byte[])

Decodes a binary message and places the results in a new instance of a text message. This method represents the binary message as a reference to a buffer of bytes and a selection of how the buffer is encoded. Therefore, it can be used when the message did not originate directly from the device or as an instance of an SmsBinaryMessage class.

public static SmsTextMessage FromBinaryData(SmsDataFormat format, Byte[] value)public static SmsTextMessage FromBinaryData(SmsDataFormat format, Byte[] value)Public Static Function FromBinaryData(format As SmsDataFormat, value As Byte[]) As SmsTextMessage
Parameters
format
SmsDataFormat SmsDataFormat SmsDataFormat

An SmsDataFormat enumerated value that identifies the format of a particular protocol description unit (PDU) buffer.

value
System.Byte[] System.Byte[] System.Byte[]

An array of bytes containing the binary data to decode.

Returns

A new SmsTextMessage object if the decoding was successful.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

FromBinaryMessage(SmsBinaryMessage) FromBinaryMessage(SmsBinaryMessage) FromBinaryMessage(SmsBinaryMessage)

Reads a binary message and decodes it. The results are placed in a new instance of a text message.

public static SmsTextMessage FromBinaryMessage(SmsBinaryMessage binaryMessage)public static SmsTextMessage FromBinaryMessage(SmsBinaryMessage binaryMessage)Public Static Function FromBinaryMessage(binaryMessage As SmsBinaryMessage) As SmsTextMessage
Parameters
binaryMessage
SmsBinaryMessage SmsBinaryMessage SmsBinaryMessage

An instance of a binary message to decode.

Returns
Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

ToBinaryMessages(SmsDataFormat) ToBinaryMessages(SmsDataFormat) ToBinaryMessages(SmsDataFormat)

Reads a message in the specified format and places the results in a new instance of a binary message.

public IVectorView<ISmsBinaryMessage> ToBinaryMessages(SmsDataFormat format)public IVectorView<ISmsBinaryMessage> ToBinaryMessages(SmsDataFormat format)Public Function ToBinaryMessages(format As SmsDataFormat) As IVectorView( Of ISmsBinaryMessage )
Parameters
format
SmsDataFormat SmsDataFormat SmsDataFormat

A value from the SmsDataFormat enumeration.

Returns

The new binary message that holds the result of this method call.

Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms