NetworkOperatorNotificationEventDetails NetworkOperatorNotificationEventDetails NetworkOperatorNotificationEventDetails NetworkOperatorNotificationEventDetails Class

Definition

Provides details for a network operator notification.

Note

This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : sealed class NetworkOperatorNotificationEventDetails : INetworkOperatorNotificationEventDetails, INetworkOperatorTetheringEntitlementCheckpublic sealed class NetworkOperatorNotificationEventDetails : INetworkOperatorNotificationEventDetails, INetworkOperatorTetheringEntitlementCheckPublic NotInheritable Class NetworkOperatorNotificationEventDetails Implements INetworkOperatorNotificationEventDetails, INetworkOperatorTetheringEntitlementCheck// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows Desktop Extension SDK (introduced v10.0.10240.0)
API contract
Windows.Networking.NetworkOperators.LegacyNetworkOperatorsContract (introduced v1)

Remarks

The operating system extends battery life by suspending applications that are not in the foreground. If your application must handle new custom network operator messages even while suspended, you must create a background work item to handle the messages. When a new operator message arrives, the background work item will be activated. The NetworkOperatorNotificationEventDetails class provides the details of the event to your background work item code.

Properties

EncodingType EncodingType EncodingType EncodingType

Gets the data-coding scheme (DCS) of the received message.

Note

This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : byte EncodingType { get; }public byte EncodingType { get; }Public ReadOnly Property EncodingType As byte// You can use this property in JavaScript.
Value
byte byte byte byte

The data-coding scheme (DCS) of the received message.

Message Message Message Message

Gets the message for the network operator notification.

Note

This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : PlatForm::String Message { get; }public string Message { get; }Public ReadOnly Property Message As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The message for the network operator notification.

Remarks

If the data-coding scheme is Unicode, the message is a plaintext string that has already been decoded. If it is an operator-defined scheme, the message is a hex-encoded string representing an array of bytes.

NetworkAccountId NetworkAccountId NetworkAccountId NetworkAccountId

Gets a unique identifier for the mobile broadband account that received the notification.

Note

This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : PlatForm::String NetworkAccountId { get; }public string NetworkAccountId { get; }Public ReadOnly Property NetworkAccountId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

A unique identifier for a mobile broadband account.

NotificationType NotificationType NotificationType NotificationType

Gets the type of the network notification.

Note

This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : NetworkOperatorEventMessageType NotificationType { get; }public NetworkOperatorEventMessageType NotificationType { get; }Public ReadOnly Property NotificationType As NetworkOperatorEventMessageType// You can use this property in JavaScript.

RuleId RuleId RuleId RuleId

Gets the identifier of the provisioned rule that matched and triggered the notification.

Note

This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : PlatForm::String RuleId { get; }public string RuleId { get; }Public ReadOnly Property RuleId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The provisioned rule identifier.

SmsMessage SmsMessage SmsMessage SmsMessage

Gets an SMS message for the mobile broadband account that received the notification.

Note

This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : ISmsMessage SmsMessage { get; }public ISmsMessage SmsMessage { get; }Public ReadOnly Property SmsMessage As ISmsMessage// You can use this property in JavaScript.
Value
ISmsMessage ISmsMessage ISmsMessage ISmsMessage

If the network operator notification is triggered by a new mobile network operator SMS, it contains the SMS message object for the network operator notification. NULL if no SMS message was received as part of the notification.

Methods

AuthorizeTethering(Boolean, String) AuthorizeTethering(Boolean, String) AuthorizeTethering(Boolean, String) AuthorizeTethering(Boolean, String)

Used to indicate if tethering is permitted for a device. If it is not, a reason can be provided.

public : void AuthorizeTethering(bool allow, PlatForm::String entitlementFailureReason)public void AuthorizeTethering(Boolean allow, String entitlementFailureReason)Public Function AuthorizeTethering(allow As Boolean, entitlementFailureReason As String) As void// You can use this method in JavaScript.
Parameters
allow
bool Boolean Boolean Boolean

true if tethering is permitted; otherwise, false.

entitlementFailureReason
PlatForm::String String String String

The reason tethering is not permitted.