SmsReceivedEventDetails SmsReceivedEventDetails SmsReceivedEventDetails SmsReceivedEventDetails Class

Definition

Presents the details of SMS message events to the background work item that handles messages while your app is suspended.

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 SmsReceivedEventDetails : ISmsReceivedEventDetails, ISmsReceivedEventDetails2public sealed class SmsReceivedEventDetails : ISmsReceivedEventDetails, ISmsReceivedEventDetails2Public NotInheritable Class SmsReceivedEventDetails Implements ISmsReceivedEventDetails, ISmsReceivedEventDetails2// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
sms cellularMessaging

Remarks

Windows extends battery life by suspending applications that are not in the foreground. If your application needs to handle new SMS messages even while it is suspended, it needs to create a background work item to handle this. When a new SMS message arrives, the background work item is activated.

Properties

BinaryMessage BinaryMessage BinaryMessage BinaryMessage

Gets the binary message object for the SMS message received by the background task.

public : SmsBinaryMessage BinaryMessage { get; }public SmsBinaryMessage BinaryMessage { get; }Public ReadOnly Property BinaryMessage As SmsBinaryMessage// You can use this property in JavaScript.
Value
SmsBinaryMessage SmsBinaryMessage SmsBinaryMessage SmsBinaryMessage

The binary message object for the SMS message received by the background task.

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

DeviceId DeviceId DeviceId DeviceId

Returns the DeviceInformation ID of the network interface that received the SMS message. This ID can be passed to SmsDevice.FromIdAsync to activate the device and retrieve additional message details.

public : PlatForm::String DeviceId { get; }public string DeviceId { get; }Public ReadOnly Property DeviceId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

A string containing the DeviceInformation ID of the SMS network interface (device). This value is typically used to retrieve details such as the sender and the body of the message. For example, you might use the ID to display a popup telling the user that a new message from a particular person has arrived. The combination of DeviceId and MessageIndex is sufficient to retrieve the new message from the SMS device.

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

MessageClass MessageClass MessageClass MessageClass

Gets the message class for the SMS message received by the background task.

public : SmsMessageClass MessageClass { get; }public SmsMessageClass MessageClass { get; }Public ReadOnly Property MessageClass As SmsMessageClass// You can use this property in JavaScript.
Value
SmsMessageClass SmsMessageClass SmsMessageClass SmsMessageClass

The message class for the SMS message received by the background task.

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

MessageIndex MessageIndex MessageIndex MessageIndex

Returns the index of the new message that raised the event. You can pass this to SmsDevice.GetMessageAsync to retrieve the new message itself.

public : unsigned int MessageIndex { get; }public uint MessageIndex { get; }Public ReadOnly Property MessageIndex As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

An integer index of the new message.

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