GetSmsMessageOperation GetSmsMessageOperation GetSmsMessageOperation Class

Definition

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

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 GetSmsMessageOperation : IAsyncInfo, IAsyncOperationpublic sealed class GetSmsMessageOperation : IAsyncInfo, IAsyncOperationPublic NotInheritable Class GetSmsMessageOperation Implements IAsyncInfo, IAsyncOperation
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

A handler for the completed event of an asynchronous SMS message retrieval operation.

public AsyncOperationCompletedHandler<ISmsMessage> Completed { get; set; }public AsyncOperationCompletedHandler<ISmsMessage> Completed { get; set; }Public ReadWrite Property Completed As AsyncOperationCompletedHandler<ISmsMessage>
Value

A handler for the completed event of an asynchronous SMS message retrieval 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

ErrorCode ErrorCode ErrorCode

Specifies the error code for the asynchronous SMS message retrieval 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 SMS message retrieval 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

Specifies the ID of the asynchronous SMS message retrieval 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 SMS message retrieval 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 SMS message retrieval operation.

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 SMS message retrieval 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 SMS message retrieval operation.

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 SMS message retrieval operation.

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 SMS message retrieval operation.

public ISmsMessage GetResults()public ISmsMessage GetResults()Public Function GetResults() As ISmsMessage
Returns

An interface that accesses the retrieved message.

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