ESimProfileMetadata Class

Definition

Namespace:

Windows.Networking.NetworkOperators

A class representing eSIM profile installation metadata.

Note

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

If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.

public ref class ESimProfileMetadata sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ESimProfileMetadata final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 393216)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ESimProfileMetadata

Public NotInheritable Class ESimProfileMetadata

Inheritance

Object Platform::Object IInspectable ESimProfileMetadata

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v6.0)
App capabilities	Microsoft.eSIMManagement_8wekyb3d8bbwe

Properties

Id	Gets the identification number (an ICCID) of the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
IsConfirmationCodeRequired	Gets a value that indicates whether the profile requires a confirmation to download. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
Policy	Gets the policy for an eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
ProviderIcon	Gets a memory buffer containing the icon of the mobile network operator (MNO) provider for the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
ProviderId	Gets the identifier (an MCC/MNC tuple) of the mobile network operator (MNO) provider for the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
ProviderName	Gets the name of the mobile network operator (MNO) provider for the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
State	Gets the state of the eSIM profile metadata. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.

Methods

ConfirmInstallAsync()	Asynchronously (with progress) downloads and installs an eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
ConfirmInstallAsync(String)	Asynchronously (with progress) downloads and installs an eSIM profile whose confirmation code is provided. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
DenyInstallAsync()	Asynchronously denies installation of the profile. The profile is revoked at the profile server. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
PostponeInstallAsync()	Asynchronously postpones the installation of an eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.

Events

StateChanged

Occurs when the state of the eSIM profile metadata changes. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.