ISmsTextMessage Interface

  • Reference

Definition

Namespace:
Windows.Devices.Sms
Edit

This interface manipulates a decoded SMS text message. It provides direct access to the plain text body of the message, as well as key header properties, such as time stamp.

Note

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

Note

This class and its methods are supported for the maintenance of legacy desktop apps that used it in earlier versions of Windows. If you do use this class, then you must specify the Windows.Devices.Sms.LegacySmsApiContract in your app's manifest. Don't use this class if you're developing a new app for Windows. Instead, use the APIs in this namespace that don't require the Windows.Devices.Sms.LegacySmsApiContract.

public interface class ISmsTextMessage : ISmsMessage
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.Sms.LegacySmsApiContract, 65536)]
/// [Windows.Foundation.Metadata.Deprecated("SmsTextMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsTextMessage2.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, Windows.Devices.Sms.LegacySmsApiContract)]
/// [Windows.Foundation.Metadata.Guid(3592196172, 42133, 18559, 154, 111, 151, 21, 72, 197, 188, 159)]
struct ISmsTextMessage : ISmsMessage
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.Sms.LegacySmsApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(3592196172, 42133, 18559, 154, 111, 151, 21, 72, 197, 188, 159)]
/// [Windows.Foundation.Metadata.Deprecated("SmsTextMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsTextMessage2.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Devices.Sms.LegacySmsApiContract")]
struct ISmsTextMessage : ISmsMessage
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.Sms.LegacySmsApiContract), 65536)]
[Windows.Foundation.Metadata.Deprecated("SmsTextMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsTextMessage2.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.Devices.Sms.LegacySmsApiContract))]
[Windows.Foundation.Metadata.Guid(3592196172, 42133, 18559, 154, 111, 151, 21, 72, 197, 188, 159)]
public interface ISmsTextMessage : ISmsMessage
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.Sms.LegacySmsApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(3592196172, 42133, 18559, 154, 111, 151, 21, 72, 197, 188, 159)]
[Windows.Foundation.Metadata.Deprecated("SmsTextMessage may be altered or unavailable for releases after Windows 10. Instead, use SmsTextMessage2.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Devices.Sms.LegacySmsApiContract")]
public interface ISmsTextMessage : ISmsMessage
Public Interface ISmsTextMessage
Implements ISmsMessage
Derived
Attributes
ContractVersionAttribute DeprecatedAttribute GuidAttribute
Implements
ISmsMessage

Windows requirements

Device family
Windows Desktop Extension SDK (introduced in 10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced in v1.0)
App capabilities
cellularMessaging sms

Remarks

Interface inheritance

ISmsTextMessage inherits ISmsMessage. Types that implement ISmsTextMessage also implement the interface members of ISmsMessage.

Properties

Body

Specifies the plain text body of the message.
Encoding

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

Specifies the phone number of the sender of the message.
Id

Retrieves an ID for the message, which can later be specified in calling message store methods in order to get or delete the message.

(Inherited from ISmsMessage)
MessageClass

Returns the message class, as determined by the operator's message network. The two most common classes are None (normal message) or Class0 (special operator message, such as a roaming warning that must be shown immediately to the user). A typical client for end-user messages ignores Class0 messages.

(Inherited from ISmsMessage)
PartCount

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

Retrieves 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.
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.
Timestamp

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

Specifies the recipient phone number of this message.

Methods

ToBinaryMessages(SmsDataFormat)

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

Applies to

See also