NetworkOperatorNotificationEventDetails NetworkOperatorNotificationEventDetails NetworkOperatorNotificationEventDetails NetworkOperatorNotificationEventDetails Class

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

Syntax

Declaration

public sealed class NetworkOperatorNotificationEventDetailspublic sealed class NetworkOperatorNotificationEventDetailsPublic NotInheritable Class NetworkOperatorNotificationEventDetailspublic sealed class NetworkOperatorNotificationEventDetails

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 summary

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

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

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

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

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

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

Methods summary

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

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 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 bytepublic byte EncodingType { get; }

    Property 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 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 string Message { get; }public string Message { get; }Public ReadOnly Property Message As stringpublic string Message { get; }

    Property Value

    • 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 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 string NetworkAccountId { get; }public string NetworkAccountId { get; }Public ReadOnly Property NetworkAccountId As stringpublic string NetworkAccountId { get; }

    Property Value

    • 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 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 NetworkOperatorEventMessageTypepublic NetworkOperatorEventMessageType NotificationType { get; }

    Property Value

  • 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 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 string RuleId { get; }public string RuleId { get; }Public ReadOnly Property RuleId As stringpublic string RuleId { get; }

    Property Value

    • 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 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 ISmsMessagepublic ISmsMessage SmsMessage { get; }

    Property Value

    • 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(Boolean allow, String entitlementFailureReason)public void AuthorizeTethering(Boolean allow, String entitlementFailureReason)Public Function AuthorizeTethering(allow As Boolean, entitlementFailureReason As String) As voidpublic void AuthorizeTethering(Boolean allow, String entitlementFailureReason)

    Parameters

    • allow
      System.Boolean
      System.Boolean
      System.Boolean
      System.Boolean

      true if tethering is permitted; otherwise, false.

    • entitlementFailureReason
      System.String
      System.String
      System.String
      System.String

      The reason tethering is not permitted.

Device family

Windows Desktop Extension SDK (introduced v10.0.10240.0)

API contract

Windows.Networking.NetworkOperators.LegacyNetworkOperatorsContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.Networking.NetworkOperators.dll