GetSmsMessagesOperation
GetSmsMessagesOperation
GetSmsMessagesOperation
GetSmsMessagesOperation
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// You can use this class in JavaScript.
- Attributes
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|
Properties
Completed Completed Completed Completed
Specifies whether the asynchronous message retrieval operation has completed or not.
public : AsyncOperationWithProgressCompletedHandler<IVectorView<ISmsMessage>, int> Completed { get; set; }public AsyncOperationWithProgressCompletedHandler<IReadOnlyList<ISmsMessage>, int> Completed { get; set; }Public ReadWrite Property Completed As AsyncOperationWithProgressCompletedHandler<IReadOnlyList<ISmsMessage>, int>// You can use this property in JavaScript.
- Value
- AsyncOperationWithProgressCompletedHandler<IVectorView<ISmsMessage>, int> AsyncOperationWithProgressCompletedHandler<IReadOnlyList<ISmsMessage>, int> AsyncOperationWithProgressCompletedHandler<IReadOnlyList<ISmsMessage>, int> AsyncOperationWithProgressCompletedHandler<IReadOnlyList<ISmsMessage>, int>
Specifies whether the asynchronous message operation has completed or not.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|
ErrorCode 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// You can use this property in JavaScript.
- Value
- HResult Exception Exception Exception
The result value of the asynchronous operation.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|
Id Id Id Id
Indicates the ID of the asynchronous message operation.
public : unsigned int Id { get; }public uint Id { get; }Public ReadOnly Property Id As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
An integer uniquely representing the asynchronous operation.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|
Progress Progress Progress Progress
Specifies the progress status of the asynchronous message operation.
public : AsyncOperationProgressHandler<IVectorView<ISmsMessage>, int> Progress { get; set; }public AsyncOperationProgressHandler<IReadOnlyList<ISmsMessage>, int> Progress { get; set; }Public ReadWrite Property Progress As AsyncOperationProgressHandler<IReadOnlyList<ISmsMessage>, int>// You can use this property in JavaScript.
- Value
- AsyncOperationProgressHandler<IVectorView<ISmsMessage>, int> AsyncOperationProgressHandler<IReadOnlyList<ISmsMessage>, int> AsyncOperationProgressHandler<IReadOnlyList<ISmsMessage>, int> AsyncOperationProgressHandler<IReadOnlyList<ISmsMessage>, int>
A handler for progress update events of an asynchronous operation.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|
Status 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// You can use this property in JavaScript.
An enumerated value representing the status of an asynchronous operation.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|
Methods
Cancel() Cancel() Cancel() Cancel()
Cancels the asynchronous operations.
public : void Cancel()public void Cancel()Public Function Cancel() As void// You can use this method in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|
Close() Close() Close() Close()
Closes the asynchronous operations.
public : void Close()public void Close()Public Function Close() As void// You can use this method in JavaScript.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|
GetResults() GetResults() GetResults() GetResults()
Retrieves the result of the asynchronous message retrieval operation.
public : IVectorView<ISmsMessage> GetResults()public IReadOnlyList<ISmsMessage> GetResults()Public Function GetResults() As IReadOnlyList( Of ISmsMessage )// You can use this method in JavaScript.
A reference to the SMS messages retrieved.
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.Devices.Sms.LegacySmsApiContract (introduced v1)
|
| Capabilities |
sms
cellularMessaging
|