API JavaScript de suporte de iframe intermediário

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

Consulte o guia Integrar um toque usando um iframe para saber como usar iframes intermediários.

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

Carregar a Biblioteca JavaScript de suporte a iframe intermediária

Coloque o snippet de código a seguir nas páginas HTML em que você quer 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 da origem mãe. Confira o exemplo de código do método a seguir:

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

O exemplo de código abaixo mostra como mostrar a IU somente após a origem mãe ser verificada:

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

A tabela a seguir lista os parâmetros:

origens

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

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

Callback verificado

Esse campo é um método de callback JavaScript acionado quando a origem pai atual tem permissão para incorporar o iframe intermediário.

VerificationFailedCallback

Esse campo é um método de callback JavaScript acionado quando a origem pai atual não tem permissão para 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 com um toque é ignorado. Confira 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 pai para fechar o iframe intermediário e atualizar o status de login. Confira 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 pai para redimensionar o iframe intermediário. Confira o exemplo de código do método a seguir:

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. Ele pode ser mostrado 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 o iframe intermediário precisa ser cancelado quando o usuário clicar fora dele. Confira o exemplo de código do método a seguir:

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 clica fora dele.