API JavaScript Iframe de suporte intermediário

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Esta página de referência descreve a API JavaScript intermediária de suporte ao iframe, que permite manipular o iframe intermediário na UX subsequente.

A tabela a seguir lista todos os métodos disponíveis e os comportamentos deles.

Métodos
verifyParentOrigin realiza a verificação de origem mãe
notifyParentClose notifica o frame pai, o fluxo de UX de um toque é ignorado
notifyParentDone notifica o frame pai sobre a conclusão do fluxo de UX de um toque
notifyParentResize notifica o frame pai para redimensionar o iframe intermediário.
notifyParentTapOutsideMode notifica o frame pai sobre o cancelamento do iframe intermediário quando o usuário clica fora do iframe intermediário.

Carregar a biblioteca JavaScript do suporte intermediário de iframe

Insira o snippet de código a seguir em qualquer página HTML em que você queira carregar o iframe intermediário:

<script src="https://accounts.google.com/gsi/intermediatesupport"></script>

Método: google.accounts.id.intermediate.verifyParentOrigin

O método google.accounts.id.intermediate.verifyParentOrigin executa a verificação de origem pai. Veja o exemplo de código do método a seguir:

google.accounts.id.intermediate.verifyParentOrigin(
    origins, verifiedCallback, verificationFailedCallback)

O exemplo de código a seguir mostra como mostrar a IU somente depois que a origem pai for verificada:

<script>
  window.onload = () => {
    google.accounts.id.intermediate.verifyParentOrigin(
        "https://example.com", showUI, showError);
  };
</script>

A tabela a seguir lista os parâmetros:

Parâmetro
origins As origens que têm permissão para incorporar o iframe intermediário.
verifiedCallback O método de callback JavaScript que será acionado quando a origem pai atual puder incorporar o iframe intermediário.
verificationFailedCallback O método de callback JavaScript que será acionado quando a origem pai atual não tiver permissão para incorporar o iframe intermediário.

origens

As origens que têm permissão para incorporar o iframe intermediário. Consulte a tabela a seguir para mais informações.

Tipo Obrigatório Exemplo
string, matriz de string ou função Opcional allowed_parent_origin: "https://example.com"

A tabela a seguir lista os tipos de valor compatíveis e as respectivas descrições.

Tipos de valor
string Um URI de domínio único. "https://example.com"
string array Uma matriz de URIs de domínio. "https://news.example.com,https://local.example.com"

Retorno de chamada verificado

Esse campo é um método de callback JavaScript que será acionado quando a origem pai atual puder incorporar o iframe intermediário.

Falha na verificação de chamada de retorno

Este campo é um método de callback JavaScript que será acionado quando a origem pai atual não puder incorporar o iframe intermediário.

Método: google.accounts.id.intermediate.notifyParentClose

O método google.accounts.id.intermediate.notifyParentClose notifica o frame pai para fechar o iframe intermediário quando o fluxo de UX de um toque é ignorado. Veja o exemplo de código do método a seguir:

google.accounts.id.intermediate.notifyParentClose()

Método: google.accounts.id.intermediate.notifyParentDone

O método google.accounts.id.intermediate.notifyParentClose notifica o frame principal para fechar o iframe intermediário e atualizar o status de login. Veja o exemplo de código do método a seguir:

google.accounts.id.intermediate.notifyParentDone()

Método: google.accounts.id.intermediate.notifyParentResize

O método google.accounts.id.intermediate.notifyParentResize notifica o frame principal para redimensionar o iframe intermediário. Veja o exemplo de código a seguir do método:

google.accounts.id.intermediate.notifyParentResize(height)

altura

A nova altura em pixels. Este campo é obrigatório. O valor precisa ser um número não negativo.

Se o parâmetro de altura for maior que 0, o iframe intermediário será definido como a nova altura. Se o parâmetro de altura for 0, o iframe intermediário ficará invisível. Um iframe oculto não está fechado. Ela pode ser mostrada mais tarde por outra chamada de método de redimensionamento.

Método: google.accounts.id.intermediate.notifyParentTapOutsideMode

O método google.accounts.id.intermediate.notifyParentTapOutsideMode notifica o frame pai se quer cancelar o iframe intermediário quando o usuário clica fora do iframe intermediário. Veja o exemplo de código a seguir do método:

google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)

cancelar

Esse valor booleano obrigatório indica se o iframe intermediário precisa ser cancelado quando o usuário clicar fora do iframe intermediário.