SmsReceivedEventDetails 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 UWP apps 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, ISmsReceivedEventDetails2
struct winrt::Windows::Devices::Sms::SmsReceivedEventDetails : ISmsReceivedEventDetails, ISmsReceivedEventDetails2
public sealed class SmsReceivedEventDetails : ISmsReceivedEventDetails, ISmsReceivedEventDetails2
Public NotInheritable Class SmsReceivedEventDetails Implements ISmsReceivedEventDetails, ISmsReceivedEventDetails2
// This class does not provide a public constructor.
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 BinaryMessage

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

DeviceId 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.

MessageClass MessageClass MessageClass MessageClass MessageClass

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

MessageIndex 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.