EuiccManager.DownloadSubscription Method

Definition

Namespace:

Android.Telephony.Euicc

Assembly:

Mono.Android.dll

Attempt to download the given DownloadableSubscription.

[Android.Runtime.Register("downloadSubscription", "(Landroid/telephony/euicc/DownloadableSubscription;ZLandroid/app/PendingIntent;)V", "GetDownloadSubscription_Landroid_telephony_euicc_DownloadableSubscription_ZLandroid_app_PendingIntent_Handler", ApiSince=28)]
public virtual void DownloadSubscription (Android.Telephony.Euicc.DownloadableSubscription? subscription, bool switchAfterDownload, Android.App.PendingIntent? callbackIntent);

[<Android.Runtime.Register("downloadSubscription", "(Landroid/telephony/euicc/DownloadableSubscription;ZLandroid/app/PendingIntent;)V", "GetDownloadSubscription_Landroid_telephony_euicc_DownloadableSubscription_ZLandroid_app_PendingIntent_Handler", ApiSince=28)>]
abstract member DownloadSubscription : Android.Telephony.Euicc.DownloadableSubscription * bool * Android.App.PendingIntent -> unit
override this.DownloadSubscription : Android.Telephony.Euicc.DownloadableSubscription * bool * Android.App.PendingIntent -> unit

Parameters

subscription

DownloadableSubscription

the subscription to download.

switchAfterDownload

Boolean

if true, the profile will be activated upon successful download.

callbackIntent

PendingIntent

a PendingIntent to launch when the operation completes.

Attributes

RegisterAttribute

Remarks

Attempt to download the given DownloadableSubscription.

Requires the android.Manifest.permission#WRITE_EMBEDDED_SUBSCRIPTIONS or the calling app must be authorized to manage both the currently-active subscription on the current eUICC and the subscription to be downloaded according to the subscription metadata. Without the former, an #EMBEDDED_SUBSCRIPTION_RESULT_RESOLVABLE_ERROR will be returned in the callback intent to prompt the user to accept the download.

Starting from Android android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM, if the caller has the android.Manifest.permission#MANAGE_DEVICE_POLICY_MANAGED_SUBSCRIPTIONS permission or is a profile owner or device owner, then the downloaded subscription will be managed by that caller. In case the caller is device owner or profile owner of an organization-owned device, switchAfterDownload can be set to true to automatically enable the subscription after download. If the caller is a profile owner on non organization owned device switchAfterDownload should be false otherwise the operation will fail with #EMBEDDED_SUBSCRIPTION_RESULT_ERROR.

On a multi-active SIM device, requires the android.Manifest.permission#WRITE_EMBEDDED_SUBSCRIPTIONS permission, or a calling app only if the targeted eUICC does not currently have an active subscription or the calling app is authorized to manage the active subscription on the target eUICC, and the calling app is authorized to manage any active subscription on any SIM. Without it, an #EMBEDDED_SUBSCRIPTION_RESULT_RESOLVABLE_ERROR will be returned in the callback intent to prompt the user to accept the download. The caller should also be authorized to manage the subscription to be downloaded.

If device support PackageManager#FEATURE_TELEPHONY_EUICC_MEP and switchAfterDownload is true, the subscription will be enabled on an esim port based on the following selection rules: <ul> <li>In SS(Single SIM) mode, if the embedded slot already has an active port, then download and enable the subscription on this port. <li>In SS mode, if the embedded slot is not active, then try to download and enable the subscription on the default port 0 of eUICC. <li>In DSDS mode, find first available port to download and enable the subscription. (see #isSimPortAvailable(int)) </ul> If there is no available port, an #EMBEDDED_SUBSCRIPTION_RESULT_RESOLVABLE_ERROR will be returned in the callback intent to prompt the user to disable an already-active subscription.

Java documentation for android.telephony.euicc.EuiccManager.downloadSubscription(android.telephony.euicc.DownloadableSubscription, boolean, android.app.PendingIntent).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.