UssdMessage UssdMessage UssdMessage UssdMessage Class

Represents a USSD message that is used for sending messages to and receiving messages from the network.

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 UssdMessagepublic sealed class UssdMessagePublic NotInheritable Class UssdMessagepublic sealed class UssdMessage

Constructors summary

Creates a new instance of a @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String) and encodes the supplied string into the message payload.

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

Properties summary

Gets or sets the encoding scheme of the payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

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 or sets the payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String) as text.

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

Gets the raw payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

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

Sets the raw payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

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

Constructors

  • UssdMessage(String)
    UssdMessage(String)
    UssdMessage(String)
    UssdMessage(String)

    Creates a new instance of a @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String) and encodes the supplied string into the message payload.

    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 UssdMessage(String messageText)public New(String messageText)Public Sub New(messageText As String)public UssdMessage(String messageText)

    Parameters

    • messageText
      System.String
      System.String
      System.String
      System.String

      The payload for the @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

    Remarks

    The default @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String) constructor assigns the default DataCodingScheme value and encodes the string supplied to the constructor into the message payload.

Properties

  • DataCodingScheme
    DataCodingScheme
    DataCodingScheme
    DataCodingScheme

    Gets or sets the encoding scheme of the payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

    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 DataCodingScheme { get; set; }public byte DataCodingScheme { get; set; }Public ReadWrite Property DataCodingScheme As bytepublic byte DataCodingScheme { get; set; }

    Property Value

    • byte
      byte
      byte
      byte

      The encoding scheme of the payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

    Remarks

    The data coding scheme is part of the USSD protocol. It is defined in 3GPP TS 23.038 chapter 5, CBS Data Coding Scheme

    .

    When a message is encoded in the default coding scheme, you can access the payload as text using the PayloadAsText property.

  • PayloadAsText
    PayloadAsText
    PayloadAsText
    PayloadAsText

    Gets or sets the payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String) as text.

    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 PayloadAsText { get; set; }public string PayloadAsText { get; set; }Public ReadWrite Property PayloadAsText As stringpublic string PayloadAsText { get; set; }

    Property Value

    • string
      string
      string
      string

      The payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String) as text.

    Remarks

    The PayloadAsText property can be used with the default DataCodingScheme value, which supports only ASCII characters. The maximum length of a message is using the default data-coding scheme is 182 characters.

Methods

  • GetPayload()
    GetPayload()
    GetPayload()
    GetPayload()

    Gets the raw payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

    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[] GetPayload()public byte[] GetPayload()Public Function GetPayload() As byte[]public byte[] GetPayload()

    Returns

    • byte[]
      byte[]
      byte[]
      byte[]

      The raw payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

    Remarks

    The DataCodingScheme property identifies how the payload is encoded.

    The maximum size of the raw payload is 160 bytes.

  • SetPayload(Byte[])
    SetPayload(Byte[])
    SetPayload(Byte[])
    SetPayload(Byte[])

    Sets the raw payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

    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 void SetPayload(Byte[] value)public void SetPayload(Byte[] value)Public Function SetPayload(value As Byte[]) As voidpublic void SetPayload(Byte[] value)

    Parameters

    • value
      System.Byte[]
      System.Byte[]
      System.Byte[]
      System.Byte[]

      The raw payload of this @Windows.Networking.NetworkOperators.UssdMessage.#ctor(System.String).

    Remarks

    When you set the raw payload for a UssdMessage, you must first set the DataCodingScheme property to the encoding scheme for the message. If you do not set the DataCodingScheme property, the default coding scheme is used.

    If you use the default coding scheme, you can access the payload as text using the PayloadAsText property.

    The maximum size of the raw payload is 160 bytes.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute

Details

Assembly

Windows.Networking.NetworkOperators.dll