DownloadableSubscription

public final class DownloadableSubscription
extends Object implements Parcelable

java.lang.Object
   ↳ android.telephony.euicc.DownloadableSubscription


Information about a subscription which is downloadable to an eUICC using {@link EuiccManager#downloadSubscription(DownloadableSubscription, boolean, PendingIntent).

For example, a DownloadableSubscription can be created through an activation code parsed from a QR code. A server address can be parsed from the activation code to download more information about the profile, such as carrier name, access rules, etc.

Summary

Inherited constants

Fields

public static final Creator<DownloadableSubscription> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

static DownloadableSubscription forActivationCode(String encodedActivationCode)

Create a DownloadableSubscription for the given activation code.

String getConfirmationCode()

Returns the confirmation code.

String getEncodedActivationCode()

Gets the activation code.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 28
public static final Creator<DownloadableSubscription> CREATOR

Public methods

describeContents

added in API level 28
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

forActivationCode

added in API level 28
public static DownloadableSubscription forActivationCode (String encodedActivationCode)

Create a DownloadableSubscription for the given activation code.

This fills the encodedActivationCode field. Other fields like confirmationCode, carrierName and accessRules may be filled in the implementation of android.service.euicc.EuiccService if exists.

Parameters
encodedActivationCode String: the activation code to use. An activation code can be parsed from a user scanned QR code. The format of activation code is defined in SGP.22. For example, "1$SMDP.GSMA.COM$04386-AGYFT-A74Y8-3F815$1.3.6.1.4.1.31746". For detail, see com.android.euicc.data.ActivationCode. Must not be null.

Returns
DownloadableSubscription the DownloadableSubscription which may be passed to EuiccManager.downloadSubscription(DownloadableSubscription, boolean, PendingIntent).

getConfirmationCode

added in API level 28
public String getConfirmationCode ()

Returns the confirmation code.

As an example, the confirmation code can be input by the user through a carrier app or the UI component of the eUICC local profile assistant (LPA) application.

Returns
String

This value may be null.

getEncodedActivationCode

added in API level 28
public String getEncodedActivationCode ()

Gets the activation code.

Returns
String

This value may be null.

writeToParcel

added in API level 28
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.