SmsReceivedEventDetails Class

Definition

Namespace:

Windows.Devices.Sms

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

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 ref class SmsReceivedEventDetails sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.Sms.LegacySmsApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Deprecated("SmsReceivedEventDetails may be altered or unavailable for releases after Windows 10. Instead, use SmsMessageReceivedTriggerDetails.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Devices.Sms.LegacySmsApiContract")]
class SmsReceivedEventDetails final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.Sms.LegacySmsApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Deprecated("SmsReceivedEventDetails may be altered or unavailable for releases after Windows 10. Instead, use SmsMessageReceivedTriggerDetails.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Devices.Sms.LegacySmsApiContract")]
public sealed class SmsReceivedEventDetails

Public NotInheritable Class SmsReceivedEventDetails

Inheritance

Object Platform::Object IInspectable SmsReceivedEventDetails

Attributes

ContractVersionAttribute DeprecatedAttribute MarshalingBehaviorAttribute

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

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	Gets the binary message object for the SMS message received by the background task.
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	Gets the message class for the SMS message received by the background task.
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.