Get​Sms​Messages​Operation Get​Sms​Messages​Operation Get​Sms​Messages​Operation Class

Definition

Supports the retrieval of messages.

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 GetSmsMessagesOperation : IAsyncInfo, IAsyncOperationWithProgresspublic sealed class GetSmsMessagesOperation : IAsyncInfo, IAsyncOperationWithProgressPublic NotInheritable Class GetSmsMessagesOperation Implements IAsyncInfo, IAsyncOperationWithProgress
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

Properties

Completed Completed Completed

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

public AsyncOperationWithProgressCompletedHandler<IVectorView<ISmsMessage>, int> Completed { get; set; }public AsyncOperationWithProgressCompletedHandler<IVectorView<ISmsMessage>, int> Completed { get; set; }Public ReadWrite Property Completed As AsyncOperationWithProgressCompletedHandler<IVectorView<ISmsMessage>, int>
Value

Specifies whether the asynchronous message operation has completed or not.

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

ErrorCode ErrorCode ErrorCode

Specifies the error code for the asynchronous message operation.

public HResult ErrorCode { get; }public Exception ErrorCode { get; }Public ReadOnly Property ErrorCode As Exception
Value
HResult HResult HResult

The result value of the asynchronous operation.

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

Id Id Id

Indicates the ID of the asynchronous message operation.

public uint Id { get; }public uint Id { get; }Public ReadOnly Property Id As uint
Value
uint uint uint

An integer uniquely representing the asynchronous operation.

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

Progress Progress Progress

Specifies the progress status of the asynchronous message operation.

public AsyncOperationProgressHandler<IVectorView<ISmsMessage>, int> Progress { get; set; }public AsyncOperationProgressHandler<IVectorView<ISmsMessage>, int> Progress { get; set; }Public ReadWrite Property Progress As AsyncOperationProgressHandler<IVectorView<ISmsMessage>, int>
Value

A handler for progress update events of an asynchronous operation.

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

Status Status Status

Specifies the status of the asynchronous message operations.

public AsyncStatus Status { get; }public AsyncStatus Status { get; }Public ReadOnly Property Status As AsyncStatus
Value
AsyncStatus AsyncStatus AsyncStatus

An enumerated value representing the status of an asynchronous operation.

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

Methods

Cancel() Cancel() Cancel()

Cancels the asynchronous operations.

public void Cancel()public void Cancel()Public Function Cancel() As void
Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

Close() Close() Close()

Closes the asynchronous operations.

public void Close()public void Close()Public Function Close() As void
Attributes
Additional features and requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
Capabilities
cellularMessaging sms

GetResults() GetResults() GetResults()

Retrieves the result of the asynchronous message retrieval operation.

public IVectorView<ISmsMessage> GetResults()public IVectorView<ISmsMessage> GetResults()Public Function GetResults() As IVectorView( Of ISmsMessage )
Returns

A reference to the SMS messages retrieved.

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