APIs eUICC

No Android 9, as APIs de gerenciamento de perfis (public e @SystemApi) estão disponíveis por meio da classe EuiccManager . APIs de comunicação eUICC (@SystemApi somente) estão disponíveis por meio da classe EuiccCardManager .

Sobre eUICC

As operadoras podem criar aplicativos de operadora usando o EuiccManager para gerenciar perfis, conforme mostrado na Figura 1. Os aplicativos de operadora não precisam ser aplicativos de sistema, mas precisam ter privilégios de operadora concedidos por perfis eUICC. Um aplicativo LPA (backend LUI e LPA) precisa ser um aplicativo de sistema (ou seja, incluído na imagem do sistema) para chamar o método @SystemApi.

Telefone Android com aplicativo Carrier e OEM LPA

Figura 1. Telefones Android com aplicativo da operadora e OEM LPA

Além da lógica de chamar EuiccCardManager e conversar com o eUICC, os aplicativos LPA devem implementar o seguinte:

  • Cliente SM-DP+ conversando com o servidor SM-DP+ para autenticar e baixar perfis
  • [Opcional] SM-DS para obter mais perfis possíveis para download
  • Tratamento de notificações para enviar notificações ao servidor para atualizar o estado do perfil
  • [Opcional] Gerenciamento de slots, incluindo alternância entre lógica eSIM e pSIM. Isso é opcional se o telefone tiver apenas um chip eSIM.
  • eSIM OTA

Embora mais de um aplicativo LPA possa estar presente em um telefone Android, apenas um LPA pode ser selecionado para ser o LPA funcional real com base na prioridade definida no arquivo AndroidManifest.xml de cada aplicativo.

Usando EuiccManager

As APIs LPA são públicas através EuiccManager (no pacote android.telephony.euicc ). Um aplicativo de operadora pode obter a instância de EuiccManager e chamar os métodos em EuiccManager para obter as informações de eUICC e gerenciar assinaturas (chamadas de perfis em documentos RSP da GSMA) como instâncias de SubscriptionInfo.

Para chamar APIs públicas, incluindo operações de download, troca e exclusão de assinatura, o aplicativo da operadora deve ter os privilégios necessários. Os privilégios da operadora são adicionados pela operadora móvel nos metadados do perfil. A API eUICC impõe as regras de privilégio da operadora de acordo.

A plataforma Android não suporta as regras da política de perfil. Se uma regra de política for declarada nos metadados do perfil, a LPA poderá escolher como lidar com o download do perfil e o procedimento de instalação. Por exemplo, é possível que uma LPA OEM de terceiros lide com regras de política usando um código de erro especial (o código de erro é passado da LPA OEM para a plataforma e, em seguida, a plataforma passa o código para a LUI OEM).

Para obter informações sobre APIs de vários perfis habilitados, consulte Vários perfis habilitados .

APIs

As APIs a seguir podem ser encontradas na documentação de referência EuiccManager e EuiccManager.java .

Obter instância (pública)

Obtém a instância do EuiccManager por meio de Context#getSystemService . Para obter detalhes, consulte getSystemService .

EuiccManager mgr = (EuiccManager) context.getSystemService(Context.EUICC_SERVICE);

Verificação ativada (pública)

Verifica se a assinatura incorporada está habilitada. Isso deve ser verificado antes de acessar APIs LPA. Para obter detalhes, consulte isEnabled .

boolean isEnabled = mgr.isEnabled();
if (!isEnabled) {
    return;
}

Obter EID (público)

Obtém o EID que identifica o hardware eUICC. Isto pode ser nulo se o eUICC não estiver pronto. O chamador deve ter privilégio de operadora ou permissão READ_PRIVILEGED_PHONE_STATE . Para obter detalhes, consulte getEid .

String eid = mgr.getEid();
if (eid == null) {
  // Handle null case.
}

Obtenha EuiccInfo (público)

Obtém informações sobre o eUICC. Contém a versão do sistema operacional. Para obter detalhes, consulte getEuiccInfo .

EuiccInfo info = mgr.getEuiccInfo();
String osVer = info.getOsVersion();

Baixar assinatura (pública)

Faz download da assinatura fornecida (referida como "perfil" nos documentos RSP da GSMA). A assinatura pode ser criada a partir de um código de ativação. Por exemplo, um código de ativação pode ser analisado a partir de um código QR. Baixar uma assinatura é uma operação assíncrona.

O chamador deve ter a permissão WRITE_EMBEDDED_SUBSCRIPTIONS ou ter privilégios de operadora para a assinatura de destino. Para obter detalhes, consulte downloadSubscription .

// Register receiver.
String action = "download_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE,
                    0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(
        receiver,
        new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/, null /* handler */);

// Download subscription asynchronously.
DownloadableSubscription sub =
        DownloadableSubscription.forActivationCode(code /* encodedActivationCode*/);
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.downloadSubscription(sub, true /* switchAfterDownload */, callbackIntent);

Trocar assinatura (pública)

Muda para (ativa) a assinatura fornecida. O chamador deve ter WRITE_EMBEDDED_SUBSCRIPTIONS ou ter privilégios de operadora para a assinatura habilitada atual e a assinatura de destino. Para obter detalhes, consulte switchToSubscription .

// Register receiver.
String action = "switch_to_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE, 0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver, new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/, null /* handler */);

// Switch to a subscription asynchronously.
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.switchToSubscription(1 /* subscriptionId */, callbackIntent);

Trocar assinatura com porta (pública)

(Disponível no Android 13) Alterna para (ativa) a assinatura fornecida com o índice de porta especificado. O chamador deve ter WRITE_EMBEDDED_SUBSCRIPTIONS ou ter privilégios de operadora para a assinatura habilitada atual e a assinatura de destino. Para obter detalhes, consulte switchToSubscription .

// Register receiver.
String action = "switch_to_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE, 0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver, new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/, null /* handler */);

// Switch to a subscription asynchronously.
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.switchToSubscription(1 /* subscriptionId */, 0 /*portIndex*/, callbackIntent);

A porta SIM está disponível (pública)

public boolean isSimPortAvailable(int portIndex)

(Disponível no Android 13) Retorna se o índice da porta de passagem está disponível. Uma porta estará disponível se não tiver nenhuma assinatura habilitada ou se o aplicativo de chamada tiver privilégio de operadora sobre a assinatura instalada na porta selecionada. Para obter detalhes, consulte isSimPortAvailable .

Excluir assinatura (pública)

Exclui uma assinatura com um ID de assinatura. Se a assinatura estiver ativa no momento, ela será desativada primeiro. O chamador deve ter WRITE_EMBEDDED_SUBSCRIPTIONS ou privilégios de operadora para a assinatura de destino. Para obter detalhes, consulte deleteSubscription .

// Register receiver.
String action = "delete_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE,
                    0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver, new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/,
        null /* handler */);

// Delete a subscription asynchronously.
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.deleteSubscription(1 /* subscriptionId */, callbackIntent);

Apagar todas as assinaturas (API do sistema)

Apaga todas as assinaturas de um dispositivo. A partir do Android 11, você deve fornecer um valor de enum EuiccCardManager#ResetOption para especificar se deseja apagar todos os tipos de assinaturas de teste, operacionais ou ambos. O chamador deve ter permissão WRITE_EMBEDDED_SUBSCRIPTIONS .

// Register receiver.
String action = "delete_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE,
                    0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver, new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/,
        null /* handler */);

// Erase all operational subscriptions asynchronously.
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.eraseSubscriptions(
        EuiccCardManager.RESET_OPTION_DELETE_OPERATIONAL_PROFILES, callbackIntent);

Iniciar atividade de resolução (pública)

Inicia uma atividade para resolver um erro que pode ser resolvido pelo usuário. Se uma operação retornar EuiccManager#EMBEDDED_SUBSCRIPTION_RESULT_RESOLVABLE_ERROR , esse método poderá ser chamado para solicitar ao usuário que resolva o problema. Este método só pode ser chamado uma vez para um erro específico.

...
mgr.startResolutionActivity(getActivity(), 0 /* requestCode */, resultIntent, callbackIntent);

Constantes

Para ver uma lista das constantes public em EuiccManager , consulte Constantes .