GetSmsMessagesOperation Class

  • Reference

Definition

Namespace:
Windows.Devices.Sms
Edit

Supports the retrieval of messages.

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 GetSmsMessagesOperation sealed : IAsyncOperationWithProgress<IVectorView<ISmsMessage ^> ^, int>
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.Sms.LegacySmsApiContract, 65536)]
/// [Windows.Foundation.Metadata.Deprecated("GetSmsMessagesOperation may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, Windows.Devices.Sms.LegacySmsApiContract)]
class GetSmsMessagesOperation final : IAsyncOperationWithProgress<IVectorView<ISmsMessage>, int>
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.Sms.LegacySmsApiContract, 65536)]
/// [Windows.Foundation.Metadata.Deprecated("GetSmsMessagesOperation may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Devices.Sms.LegacySmsApiContract")]
class GetSmsMessagesOperation final : IAsyncOperationWithProgress<IVectorView<ISmsMessage>, int>
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.Sms.LegacySmsApiContract), 65536)]
[Windows.Foundation.Metadata.Deprecated("GetSmsMessagesOperation may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, typeof(Windows.Devices.Sms.LegacySmsApiContract))]
public sealed class GetSmsMessagesOperation : IAsyncOperationWithProgress<IReadOnlyList<ISmsMessage>,int>
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.Sms.LegacySmsApiContract), 65536)]
[Windows.Foundation.Metadata.Deprecated("GetSmsMessagesOperation may be altered or unavailable for releases after Windows 10.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 65536, "Windows.Devices.Sms.LegacySmsApiContract")]
public sealed class GetSmsMessagesOperation : IAsyncOperationWithProgress<IReadOnlyList<ISmsMessage>,int>
Public NotInheritable Class GetSmsMessagesOperation
Implements IAsyncOperationWithProgress(Of IReadOnlyList(Of ISmsMessage), Integer)
Inheritance
Object Platform::Object IInspectable GetSmsMessagesOperation
Attributes
ContractVersionAttribute DeprecatedAttribute
Implements
IAsyncInfo IAsyncOperationWithProgress<IReadOnlyList<ISmsMessage>,Int32> IAsyncOperationWithProgress<IVectorView<ISmsMessage>,int>

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

Specifies whether the asynchronous message retrieval operation has completed or not.
ErrorCode

Specifies the error code for the asynchronous message operation.
Id

Indicates the ID of the asynchronous message operation.
Progress

Specifies the progress status of the asynchronous message operation.
Status

Specifies the status of the asynchronous message operations.

Methods

Cancel()

Cancels the asynchronous operations.
Close()

Closes the asynchronous operations.
GetResults()

Retrieves the result of the asynchronous message retrieval operation.

Applies to