Network​Operator​Notification​Event​Details Network​Operator​Notification​Event​Details Network​Operator​Notification​Event​Details Class

Definition

Namespace:
Windows.Networking.NetworkOperators Windows.Networking.NetworkOperators Windows.Networking.NetworkOperators
Edit

Provides details for a network operator notification.

Note

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

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

public : sealed class NetworkOperatorNotificationEventDetails : INetworkOperatorNotificationEventDetails, INetworkOperatorTetheringEntitlementCheckpublic sealed class NetworkOperatorNotificationEventDetails : INetworkOperatorNotificationEventDetails, INetworkOperatorTetheringEntitlementCheckPublic NotInheritable Class NetworkOperatorNotificationEventDetails Implements INetworkOperatorNotificationEventDetails, INetworkOperatorTetheringEntitlementCheck
Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute
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

Edit

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

Note

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

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

public : byte EncodingType { get; }public byte EncodingType { get; }Public ReadOnly Property EncodingType As byte
Value
byte byte byte

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

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

Message Message Message

Edit

Gets the message for the network operator notification.

Note

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

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

public : PlatForm::String Message { get; }public string Message { get; }Public ReadOnly Property Message As string
Value
PlatForm::String string string

The message for the network operator notification.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

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

Edit

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 app given privileged access by mobile network operators.

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

public : PlatForm::String NetworkAccountId { get; }public string NetworkAccountId { get; }Public ReadOnly Property NetworkAccountId As string
Value
PlatForm::String string string

A unique identifier for a mobile broadband account.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

NotificationType NotificationType NotificationType

Edit

Gets the type of the network notification.

Note

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

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

public : NetworkOperatorEventMessageType NotificationType { get; }public NetworkOperatorEventMessageType NotificationType { get; }Public ReadOnly Property NotificationType As NetworkOperatorEventMessageType
Value
NetworkOperatorEventMessageType NetworkOperatorEventMessageType NetworkOperatorEventMessageType

The type of the network notification.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

RuleId RuleId RuleId

Edit

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 app given privileged access by mobile network operators.

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

public : PlatForm::String RuleId { get; }public string RuleId { get; }Public ReadOnly Property RuleId As string
Value
PlatForm::String string string

The provisioned rule identifier.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

SmsMessage SmsMessage SmsMessage

Edit

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 app given privileged access by mobile network operators.

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

public : ISmsMessage SmsMessage { get; }public ISmsMessage SmsMessage { get; }Public ReadOnly Property SmsMessage As ISmsMessage
Value
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.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

Methods

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

Edit

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
Parameters
allow
bool Boolean Boolean

true if tethering is permitted; otherwise, false.

entitlementFailureReason
PlatForm::String String String

The reason tethering is not permitted.

Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute