GetSmsMessageOperation Class

Definition

Namespace:

Windows.Devices.Sms

Supports the retrieval of a message from the SMS message store.

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 GetSmsMessageOperation sealed : IAsyncOperation<ISmsMessage ^>

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.Sms.LegacySmsApiContract, 65536)]
/// [Windows.Foundation.Metadata.Deprecated("GetSmsMessageOperation may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Devices.Sms.LegacySmsApiContract")]
class GetSmsMessageOperation final : IAsyncOperation<ISmsMessage>

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.Sms.LegacySmsApiContract), 65536)]
[Windows.Foundation.Metadata.Deprecated("GetSmsMessageOperation may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Devices.Sms.LegacySmsApiContract")]
public sealed class GetSmsMessageOperation : IAsyncOperation<ISmsMessage>

Public NotInheritable Class GetSmsMessageOperation
Implements IAsyncOperation(Of ISmsMessage)

Inheritance

Object Platform::Object IInspectable GetSmsMessageOperation

Attributes

ContractVersionAttribute DeprecatedAttribute

Implements

IAsyncInfo IAsyncOperation<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

Properties

Completed	A handler for the completed event of an asynchronous SMS message retrieval operation.
ErrorCode	Specifies the error code for the asynchronous SMS message retrieval operation.
Id	Specifies the ID of the asynchronous SMS message retrieval operation.
Status	Specifies the status of the asynchronous SMS message retrieval operation.

Methods

Cancel()	Cancels the asynchronous SMS message retrieval operation.
Close()	Closes the asynchronous SMS message retrieval operation.
GetResults()	Retrieves the result of the asynchronous SMS message retrieval operation.