MobileBroadbandNetwork MobileBroadbandNetwork MobileBroadbandNetwork MobileBroadbandNetwork Class

Definition

Represents a mobile broadband network and the current network state.

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 MobileBroadbandNetwork : IMobileBroadbandNetwork, IMobileBroadbandNetwork2public sealed class MobileBroadbandNetwork : IMobileBroadbandNetwork, IMobileBroadbandNetwork2Public NotInheritable Class MobileBroadbandNetwork Implements IMobileBroadbandNetwork, IMobileBroadbandNetwork2// You can use this class in JavaScript.
Attributes
Windows 10 requirements
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
cellularDeviceControl cellularDeviceIdentity

Properties

AccessPointName AccessPointName AccessPointName AccessPointName

The name of the currently connected access point.

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 AccessPointName { get; }public string AccessPointName { get; }Public ReadOnly Property AccessPointName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The name of the currently connected access point.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

ActivationNetworkError ActivationNetworkError ActivationNetworkError ActivationNetworkError

Attempts to get the latest network activation error.

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 : unsigned int ActivationNetworkError { get; }public uint ActivationNetworkError { get; }Public ReadOnly Property ActivationNetworkError As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The latest network activation error.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

NetworkAdapter NetworkAdapter NetworkAdapter NetworkAdapter

Gets the unique network interface that identifies the mobile broadband network.

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 : NetworkAdapter NetworkAdapter { get; }public NetworkAdapter NetworkAdapter { get; }Public ReadOnly Property NetworkAdapter As NetworkAdapter// You can use this property in JavaScript.
Value
NetworkAdapter NetworkAdapter NetworkAdapter NetworkAdapter

An object that uniquely identifies the network.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

NetworkRegistrationState NetworkRegistrationState NetworkRegistrationState NetworkRegistrationState

Gets the current network registration state.

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 : NetworkRegistrationState NetworkRegistrationState { get; }public NetworkRegistrationState NetworkRegistrationState { get; }Public ReadOnly Property NetworkRegistrationState As NetworkRegistrationState// You can use this property in JavaScript.
Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

PacketAttachNetworkError PacketAttachNetworkError PacketAttachNetworkError PacketAttachNetworkError

Gets the latest packet attach network error.

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 : unsigned int PacketAttachNetworkError { get; }public uint PacketAttachNetworkError { get; }Public ReadOnly Property PacketAttachNetworkError As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The latest packet attach network error.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

RegisteredDataClass RegisteredDataClass RegisteredDataClass RegisteredDataClass

Gets the data class of the current mobile network.

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 : DataClasses RegisteredDataClass { get; }public DataClasses RegisteredDataClass { get; }Public ReadOnly Property RegisteredDataClass As DataClasses// You can use this property in JavaScript.
Value
DataClasses DataClasses DataClasses DataClasses

The data class of the current mobile network.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

RegisteredProviderId RegisteredProviderId RegisteredProviderId RegisteredProviderId

Gets the provider ID for the currently registered mobile network.

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 RegisteredProviderId { get; }public string RegisteredProviderId { get; }Public ReadOnly Property RegisteredProviderId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The provider ID for the currently registered mobile network.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

RegisteredProviderName RegisteredProviderName RegisteredProviderName RegisteredProviderName

Gets the provider name for the currently registered mobile network.

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 RegisteredProviderName { get; }public string RegisteredProviderName { get; }Public ReadOnly Property RegisteredProviderName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The provider name for the currently registered mobile network.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

RegistrationNetworkError RegistrationNetworkError RegistrationNetworkError RegistrationNetworkError

Gets the latest network registration error.

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 : unsigned int RegistrationNetworkError { get; }public uint RegistrationNetworkError { get; }Public ReadOnly Property RegistrationNetworkError As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The latest network registration error.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

RegistrationUiccApps RegistrationUiccApps RegistrationUiccApps RegistrationUiccApps

Gets a list of all UICC apps available on the SIM card that can be used for registration on a mobile network. This list includes UICC apps that are not currently used for registration, but could potentially could be used for registration.

public : IVectorView<MobileBroadbandUiccApp> RegistrationUiccApps { get; }public IReadOnlyList<MobileBroadbandUiccApp> RegistrationUiccApps { get; }Public ReadOnly Property RegistrationUiccApps As IReadOnlyList<MobileBroadbandUiccApp>// You can use this property in JavaScript.
Value
IVectorView<MobileBroadbandUiccApp> IReadOnlyList<MobileBroadbandUiccApp> IReadOnlyList<MobileBroadbandUiccApp> IReadOnlyList<MobileBroadbandUiccApp>

A list of objects that represent UICC applications.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

Methods

GetCellsInfoAsync() GetCellsInfoAsync() GetCellsInfoAsync() GetCellsInfoAsync()

Retrieves a **MobileBroadbandCellsInfo** object that contains all serving and neighboring cell information when device is registered to a network.

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 : IAsyncOperation<MobileBroadbandCellsInfo> GetCellsInfoAsync()public IAsyncOperation<MobileBroadbandCellsInfo> GetCellsInfoAsync()Public Function GetCellsInfoAsync() As IAsyncOperation( Of MobileBroadbandCellsInfo )// You can use this method in JavaScript.
Returns
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)
Capabilities
cellularDeviceControl cellularDeviceIdentity

GetVoiceCallSupportAsync() GetVoiceCallSupportAsync() GetVoiceCallSupportAsync() GetVoiceCallSupportAsync()

Asynchronously retrieves a value indicating whether this network currently supports voice calls.

public : IAsyncOperation<PlatForm::Boolean> GetVoiceCallSupportAsync()public IAsyncOperation<bool> GetVoiceCallSupportAsync()Public Function GetVoiceCallSupportAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns

An asynchronous retrieval operation. On successful completion, contains a value indicating whether the network supports voice calls (if true) or not.

Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

ShowConnectionUI() ShowConnectionUI() ShowConnectionUI() ShowConnectionUI()

Displays the connect UI for a specific mobile network.

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 : void ShowConnectionUI()public void ShowConnectionUI()Public Function ShowConnectionUI() As void// You can use this method in JavaScript.
Additional features and requirements
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
cellularDeviceControl cellularDeviceIdentity

Remarks

The ShowConnectionUI method is useful if you determine that connecting to a different network is preferred due to a roaming relationship, pricing changes, and so on. For example, when your app determines that a different network is preferred, you can inform the user of the preferred network. If the user decides to change networks, you can call the ShowConnectionUI for the preferred network to complete the connection.