SmsMessageRegistration
SmsMessageRegistration
SmsMessageRegistration
SmsMessageRegistration
Class
Definition
Class used to represent registered message filters.
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.
public : sealed class SmsMessageRegistration : ISmsMessageRegistrationpublic sealed class SmsMessageRegistration : ISmsMessageRegistrationPublic NotInheritable Class SmsMessageRegistration Implements ISmsMessageRegistration// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
cellularMessaging
|
Remarks
Your code does not instantiate this class directly. A newly-created instance of the class is returned by the SmsMessageRegistration.Register method, and you can retrieve a collection of instances representing existing registrations using the static SmsMessageRegistration.AllRegistrations property.
Properties
AllRegistrations AllRegistrations AllRegistrations AllRegistrations
Static property that gets a list of currently registered message filters..
public : static IVectorView<SmsMessageRegistration> AllRegistrations { get; }public static IReadOnlyList<SmsMessageRegistration> AllRegistrations { get; }Public Static ReadOnly Property AllRegistrations As IReadOnlyList<SmsMessageRegistration>// You can use this property in JavaScript.
- Value
- IVectorView<SmsMessageRegistration> IReadOnlyList<SmsMessageRegistration> IReadOnlyList<SmsMessageRegistration> IReadOnlyList<SmsMessageRegistration>
A list of current registrations.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
cellularMessaging
|
Id Id Id Id
Gets an identifier for this registered message filter.
public : PlatForm::String Id { get; }public string Id { get; }Public ReadOnly Property Id As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The identifier specified at registration.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
cellularMessaging
|
Methods
Register(String, SmsFilterRules) Register(String, SmsFilterRules) Register(String, SmsFilterRules) Register(String, SmsFilterRules)
Registers a message filter.
public : static SmsMessageRegistration Register(PlatForm::String id, SmsFilterRules filterRules)public static SmsMessageRegistration Register(String id, SmsFilterRules filterRules)Public Static Function Register(id As String, filterRules As SmsFilterRules) As SmsMessageRegistration// You can use this method in JavaScript.
- id
- PlatForm::String String String String
Identifier used to describe this message filter.
- filterRules
- SmsFilterRules SmsFilterRules SmsFilterRules SmsFilterRules
An object that represents the filter rules to be used for this registered message filter.
On successful completion, the SmsMessageRegistration object that represents this registered message filter.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
cellularMessaging
|
Unregister() Unregister() Unregister() Unregister()
Unregisters a previously-registered message filter. The filter will no longer be applied to incoming messages.
public : void Unregister()public void Unregister()Public Function Unregister() As void// You can use this method in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
cellularMessaging
|
Events
MessageReceived MessageReceived MessageReceived MessageReceived
Event signaled when a message has been received that meets the filter criteria set in a registered message filter.
public : event TypedEventHandler MessageReceived<SmsMessageRegistration, SmsMessageReceivedTriggerDetails>public event TypedEventHandler MessageReceived<SmsMessageRegistration, SmsMessageReceivedTriggerDetails>Public Event MessageReceived<SmsMessageRegistration, SmsMessageReceivedTriggerDetails>// You can use this event in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
cellularMessaging
|