Você pode transmitir o estado por meio de um URL de confirmação ao enviar ações de e-mail para redefinição de senha ou verificar o e-mail de um usuário. Isso possibilita ao usuário retornar ao app após a conclusão da ação. Além disso, você pode especificar se o link de ação do e-mail deverá ser processado diretamente de um aplicativo para dispositivos móveis quando ele for instalado, em vez de uma página da Web.
Isso pode ser extremamente útil nas seguintes situações comuns:
Um usuário que não está conectado no momento pode estar tentando acessar conteúdo que exija que o usuário faça login. No entanto, o usuário pode ter esquecido a senha e, por conta disso, acionou o fluxo de redefinição de senha. No final do fluxo, o usuário espera voltar para a seção do app que estava tentando acessar.
Um aplicativo só pode oferecer acesso a contas verificadas. Por exemplo, um app de newsletter pode exigir que o usuário verifique o próprio e-mail antes de se inscrever. O usuário passa pelo fluxo de verificação de e-mail e espera retornar ao app para concluir a inscrição.
Em geral, quando um usuário inicia uma redefinição de senha ou um fluxo de verificação de e-mail em um app iOS, ele espera completar o fluxo dentro do app. A capacidade de passar o estado por meio de um URL contínuo torna isso possível.
A possibilidade de passar de estado por meio de um URL contínuo é um recurso poderoso que o Firebase Authentication oferece e que pode melhorar significativamente a experiência do usuário.
Como transmitir o estado de um URL de confirmação nas ações de e-mail
Para transmitir um URL de confirmação com segurança, o domínio do URL precisa estar na lista de permissões do console do Firebase. Na seção Autenticação, verifique se esse domínio está na lista de Domínios autorizados da guia Método de login. Se não estiver, adicione-o.
Uma instância FIRActionCodeSettings
precisa ser fornecida ao enviar um e-mail de redefinição de senha ou de verificação. Essa interface tem os seguintes parâmetros:
Swift
Parâmetro | Tipo | Descrição |
---|---|---|
URL |
String | Define o link (estado/URL de confirmação) que tem diferentes significados em contextos distintos:
|
iOSBundleID |
String | Define o ID do pacote iOS para ajudar a Firebase Authentication a determinar se ela precisa criar um link somente para Web ou um link para dispositivos móveis que seja aberto em um dispositivo Apple. |
androidPackageName |
String | Define o nome do pacote Android para ajudar o Firebase Authentication a determinar se ele precisa criar um link somente para Web ou um link para dispositivos móveis que seja aberto em um dispositivo Android. |
handleCodeInApp |
Booleano | Se o link de ação de e-mail deverá ser aberto em um aplicativo para dispositivos móveis ou em um link da Web primeiro. O valor padrão é falso. Quando definido como verdadeiro, o link do código de ação será enviado como um link universal ou um link do app Android e será aberto pelo app, se estiver instalado. Caso seja falso, o código será enviado primeiro ao widget da Web e, em seguida, redirecionará para o app, se estiver instalado. |
linkDomain |
String | Quando os domínios de link personalizados do Hosting são definidos
para um projeto, especifique qual deles usar quando o link for aberto por um app para dispositivos móveis
especificado. Caso contrário, o domínio padrão será selecionado automaticamente (por
exemplo,
PROJECT_ID.firebaseapp.com |
dynamicLinkDomain |
String | Obsoleto. Não especifique esse parâmetro. |
Objective-C
Parâmetro | Tipo | Descrição |
---|---|---|
URL |
NSString | Define o link (estado/URL de confirmação) que tem diferentes significados em contextos distintos:
|
iOSBundleID |
NSString | Define o ID do pacote iOS para ajudar a Firebase Authentication a determinar se ela precisa criar um link somente para Web ou um link para dispositivos móveis que seja aberto em um dispositivo Android ou Apple |
androidPackageName |
NSString | Define o nome do pacote Android para ajudar o Firebase Authentication a determinar se ele precisa criar um link somente para Web ou um link para dispositivos móveis que seja aberto em um dispositivo Android ou Apple |
handleCodeInApp |
BOOL | Se o link de ação de e-mail deverá ser aberto em um aplicativo para dispositivos móveis ou em um link da Web primeiro. O valor padrão é falso. Quando definido como verdadeiro, o link do código de ação será enviado como um link universal ou um link do app Android e será aberto pelo app, se estiver instalado. Caso seja falso, o código será enviado primeiro ao widget da Web e, em seguida, redirecionará para o app, se estiver instalado. |
linkDomain |
NSString | Quando os domínios de link personalizados do Hosting são definidos
para um projeto, especifique qual deles usar quando o link for aberto por um app para dispositivos móveis
especificado. Caso contrário, o domínio padrão será selecionado automaticamente (por
exemplo,
PROJECT_ID.firebaseapp.com |
dynamicLinkDomain |
NSString | Obsoleto. Não especifique esse parâmetro. |
O exemplo a seguir ilustra como enviar um link de verificação de e-mail que
será aberto primeiro em um app para dispositivos móveis usando o domínio de link personalizado do Hosting
custom-domain.com
. O link direto conterá o payload do URL de confirmação
https://www.example.com/?email=user@example.com
.
Swift
var actionCodeSettings = ActionCodeSettings.init() actionCodeSettings.canHandleInApp = true let user = Auth.auth().currentUser() actionCodeSettings.URL = String(format: "https://www.example.com/?email=%@", user.email) actionCodeSettings.iOSbundleID = Bundle.main.bundleIdentifier! actionCodeSettings.setAndroidPakageName("com.example.android") // Specify a custom Hosting link domain to use. The domain must be // configured in Firebase Hosting and owned by the project. actionCodeSettings.linkDomain = "custom-domain.com" user.sendEmailVerification(withActionCodeSettings:actionCodeSettings { error in if error { // Error occurred. Inspect error.code and handle error. return } // Email verification sent. })
Objective-C
FIRActionCodeSettings *actionCodeSettings = [[FIRActionCodeSettings alloc] init]; actionCodeSettings.handleCodeInApp = YES; FIRUser *user = [FIRAuth auth].currentUser; NSString *urlString = [NSString stringWithFormat:@"https://www.example.com/?email=%@", user.email]; actionCodeSettings.URL = [NSURL URLWithString:urlString]; actionCodeSettings.iOSBundleID = [NSBundle mainBundle].bundleIdentifier; // Specify a custom Hosting link domain to use. The domain must be // configured in Firebase Hosting and owned by the project. actionCodeSettings.linkDomain = @"custom-domain.com"; [actionCodeSettings setAndroidPackageName:@"com.example.android"]; [user sendEmailVerificationWithActionCodeSettings:actionCodeSettings completion:^(NSError *_Nullable error) { if (error) { // Error occurred. Inspect error.code and handle error. return; } // Email verification sent. }];
Como configurar links do Firebase Hosting
O Firebase Authentication usa Firebase Hosting ao enviar um link que deve ser aberto em um aplicativo para dispositivos móveis. Para usar esse recurso, os links do Hosting precisam ser configurados no console do Firebase.
Configurar aplicativos da Apple:
- Se você planeja processar esses links no seu aplicativo, vai precisar configurar o domínio de link do Hosting como um domínio associado nos recursos do aplicativo.
- Para ver mais informações, consulte as Instruções para receber links do Hosting no iOS.
Configurar apps Android:
- Se você planeja processar esses links do app Android, o nome do pacote do app precisa ser especificado nas configurações do projeto do console do Firebase. Além disso, o SHA-1 e o SHA-256 do certificado do aplicativo precisam ser fornecidos.
- Você também precisará configurar o filtro de intent para o link direto no
arquivo
AndroidManifest.xml
. - Para mais informações, consulte as Instruções para receber links do Hosting no Android.
Processamento de ações de e-mail em um app da Web
Você pode especificar se quer processar o link de código de ação de um aplicativo da Web primeiro e, em seguida, redirecionar para outra página da Web ou aplicativo para dispositivos móveis após a conclusão bem-sucedida, desde que o aplicativo para dispositivos móveis esteja disponível.
Para isso, defina handleCodeInApp
como false
no
objeto FIRActionCodeSettings
(Obj-C) ou ActionCodeSettings
(Swift). Ainda que
um ID de pacote
ou nome de pacote Android não seja necessário, fornecê-los permitirá ao usuário
ser redirecionado para o app especificado na conclusão do código de ação de e-mail.
O URL da Web usado aqui é aquele configurado na seção de modelos de ações de e-mail. Um padrão é provisionado para todos os projetos. Consulte Personalizar gerenciadores de e-mail para saber mais sobre como personalizar o gerenciador de ações de e-mail.
Neste caso, o link dentro do parâmetro de consulta continueURL
será
um link do Hosting com payload URL
especificado no
objeto ActionCodeSettings
.
Ao processar ações de e-mail como a verificação, o código de ação do parâmetro de consulta oobCode
precisa ser analisado no link direto e aplicado via applyActionCode
para que a alteração seja concluída, ou seja, para que o e-mail seja verificado.
Processamento de ações de e-mail em um app para dispositivos móveis
É possível especificar se você quer processar o link do código de ação em seu aplicativo para dispositivos móveis primeiro, desde que esteja instalado. Se o link for clicado em
um dispositivo não compatível com o aplicativo para dispositivos móveis, ele será aberto de uma página
da Web. Para isso, defina handleCodeInApp
como true
no
objeto FIRActionCodeSettings
(Obj-C) ou ActionCodeSettings
(Swift). O
nome do pacote Android ou o ID do pacote do aplicativo para dispositivos móveis também precisa ser
especificado. O URL da Web substituto usado aqui, quando nenhum aplicativo para dispositivos móveis está disponível, é aquele configurado na seção de modelos de ação de e-mail. Um URL padrão é fornecido para todos os projetos. Consulte
Como personalizar gerenciadores de e-mail para saber mais sobre
como personalizar o gerenciador de ações de e-mail.
Neste caso, o link do aplicativo para dispositivos móveis enviado ao usuário será um link do Hosting
em que o payload é a URL do código de ação, configurado no console, com os parâmetros
de consulta oobCode
, mode
, apiKey
e continueUrl
. O último será o
URL
original especificado no objeto FIRActionCodeSettings
(Obj-C) ou
ActionCodeSettings
(Swift). É possível aplicar o código de ação diretamente
a partir de um app para dispositivos móveis da mesma forma que ele é processado no fluxo da Web
descrito na
seção Como personalizar gerenciadores de e-mail.
Ao processar ações de e-mail como a verificação, o código de ação do parâmetro de consulta oobCode
precisa ser analisado no link direto e aplicado via applyActionCode
para que a alteração seja concluída, ou seja, para que o e-mail seja verificado.