État de passage dans les actions par e-mail

Vous pouvez transmettre l'état via une URL de poursuite lors de l'envoi d'actions par e-mail pour les réinitialisations de mot de passe ou la vérification de l'e-mail d'un utilisateur. Cela permet à l'utilisateur de revenir à l'application une fois l'action terminée. En outre, vous pouvez spécifier si vous souhaitez gérer le lien d'action de l'e-mail directement à partir d'une application mobile lorsqu'elle est installée au lieu d'une page Web.

Cela peut être extrêmement utile dans les scénarios courants suivants :

  • Un utilisateur, actuellement non connecté, peut essayer d'accéder à un contenu qui nécessite que l'utilisateur soit connecté. Cependant, l'utilisateur peut avoir oublié son mot de passe et déclencher le flux de réinitialisation du mot de passe. À la fin du flux, l'utilisateur s'attend à revenir à la section de l'application à laquelle il tentait d'accéder.

  • Une application ne peut offrir l'accès qu'à des comptes vérifiés. Par exemple, une application de newsletter peut demander à l'utilisateur de vérifier son adresse e-mail avant de s'abonner. L'utilisateur passerait par le flux de vérification des e-mails et s'attendrait à être renvoyé à l'application pour terminer son abonnement.

  • En général, lorsqu'un utilisateur commence un flux de réinitialisation de mot de passe ou de vérification d'e-mail sur une application Apple, il s'attend à terminer le flux au sein de l'application ; la possibilité de transmettre l'état via l'URL de continuation rend cela possible.

La possibilité de transmettre l'état via une URL de continuation est une fonctionnalité puissante fournie par Firebase Auth et qui peut considérablement améliorer l'expérience utilisateur.

Passer l'URL d'état/continuer dans les actions par e-mail

Afin de transmettre en toute sécurité une URL de continuation, le domaine de l'URL doit être ajouté à la liste blanche dans la console Firebase . Cela se fait dans la section Authentification en ajoutant ce domaine à la liste des domaines autorisés sous l'onglet Méthode de connexion s'il ne s'y trouve pas déjà.

Une instance FIRActionCodeSettings doit être fournie lors de l'envoi d'un e-mail de réinitialisation de mot de passe ou d'un e-mail de vérification. Cette interface prend les paramètres suivants :

Rapide

Paramètre Taper Description
URL Chaîne de caractères

Définit le lien (état/continuer l'URL) qui a différentes significations dans différents contextes :

  • Lorsque le lien est géré dans les widgets d'action Web, il s'agit du lien profond dans le paramètre de requête continueUrl .
  • Lorsque le lien est géré directement dans l'application, il s'agit du paramètre de requête continueUrl dans le lien profond du lien dynamique.
iOSBundleID Chaîne de caractères Définit l'ID de groupe. Cela essaiera d'ouvrir le lien dans une application Apple si elle est installée. L'application doit être enregistrée dans la console. Si aucun ID de bundle n'est fourni, la valeur de ce champ est définie sur l'ID de bundle du bundle principal de l'application.
androidPackageName Chaîne de caractères Définit le nom du package Android. Cela essaiera d'ouvrir le lien dans une application Android si elle est installée.
androidInstallIfNotAvailable Bool Spécifie s'il faut installer l'application Android si l'appareil la prend en charge et si l'application n'est pas déjà installée. Si ce champ est fourni sans packageName, une erreur est renvoyée expliquant que le packageName doit être fourni conjointement avec ce champ.
androidMinimumVersion Chaîne de caractères Version minimale de l'application prise en charge dans ce flux. Si minimumVersion est spécifié et qu'une ancienne version de l'application est installée, l'utilisateur est redirigé vers le Play Store pour mettre à niveau l'application. L'application Android doit être enregistrée dans la console.
handleCodeInApp Bool Indique si le lien d'action par e-mail sera d'abord ouvert dans une application mobile ou un lien Web. Le défaut est faux. Lorsqu'il est défini sur true, le lien du code d'action sera envoyé sous forme de lien universel ou de lien d'application Android et sera ouvert par l'application si elle est installée. Dans le cas faux, le code sera d'abord envoyé au widget Web, puis sur continuer redirigera vers l'application si elle est installée.
dynamicLinkDomain Chaîne de caractères Définit le domaine (ou sous-domaine) de lien dynamique à utiliser pour le lien actuel s'il doit être ouvert à l'aide de Firebase Dynamic Links. Comme plusieurs domaines de liens dynamiques peuvent être configurés par projet, ce champ permet d'en choisir explicitement un. Si aucun n'est fourni, le premier domaine est utilisé par défaut.

Objectif c

Paramètre Taper Description
URL NSString

Définit le lien (état/continuer l'URL) qui a différentes significations dans différents contextes :

  • Lorsque le lien est géré dans les widgets d'action Web, il s'agit du lien profond dans le paramètre de requête continueUrl .
  • Lorsque le lien est géré directement dans l'application, il s'agit du paramètre de requête continueUrl dans le lien profond du lien dynamique.
iOSBundleID NSString Définit l'ID de groupe. Cela essaiera d'ouvrir le lien dans une application Apple si elle est installée. L'application doit être enregistrée dans la console.
androidPackageName NSString Définit le nom du package Android. Cela essaiera d'ouvrir le lien dans une application Android si elle est installée.
androidInstallIfNotAvailable BOOL spécifie s'il faut installer l'application Android si l'appareil la prend en charge et si l'application n'est pas déjà installée. Si ce champ est fourni sans packageName, une erreur est renvoyée expliquant que le packageName doit être fourni conjointement avec ce champ.
androidMinimumVersion NSString Version minimale de l'application prise en charge dans ce flux. Si minimumVersion est spécifié et qu'une ancienne version de l'application est installée, l'utilisateur est redirigé vers le Play Store pour mettre à niveau l'application. L'application Android doit être enregistrée dans la console.
handleCodeInApp BOOL Indique si le lien d'action par e-mail sera d'abord ouvert dans une application mobile ou un lien Web. Le défaut est faux. Lorsqu'il est défini sur true, le lien du code d'action sera envoyé sous forme de lien universel ou de lien d'application Android et sera ouvert par l'application si elle est installée. Dans le cas faux, le code sera d'abord envoyé au widget Web, puis sur continuer redirigera vers l'application si elle est installée.
dynamicLinkDomain NSString Définit le domaine (ou sous-domaine) de lien dynamique à utiliser pour le lien actuel s'il doit être ouvert à l'aide de Firebase Dynamic Links. Comme plusieurs domaines de liens dynamiques peuvent être configurés par projet, ce champ permet d'en choisir explicitement un. Si aucun n'est fourni, le premier domaine est utilisé par défaut.

L'exemple suivant illustre comment envoyer un lien de vérification d'e-mail qui s'ouvrira d'abord dans une application mobile en tant que lien dynamique Firebase à l'aide du domaine de lien dynamique personnalisé example.page.link (application iOS com.example.ios ou application Android com.example.android où l'application sera installée si elle n'est pas déjà installée et la version minimale est 12 ). Le lien profond contiendra la charge utile de l'URL de continuation https://www.example.com/?email=user@example.com .

Rapide


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",
                                         installIfNotAvailable:true,
                                         minumumVersion:"12")
// When multiple custom dynamic link domains are defined, specify which one to use.
actionCodeSettings.dynamicLinkDomain = "example.page.link"
user.sendEmailVerification(withActionCodeSettings:actionCodeSettings { error in
  if error {
    // Error occurred. Inspect error.code and handle error.
    return
  }
  // Email verification sent.
})

Objectif 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;
 // When multiple custom dynamic link domains are defined, specify which one to use.
 actionCodeSettings.dynamicLinkDomain = @"example.page.link";
 [actionCodeSettings setAndroidPackageName:@"com.example.android"
                     installIfNotAvailable:YES
                            minimumVersion:'12'];
 [user sendEmailVerificationWithActionCodeSettings:actionCodeSettings
                                        completion:^(NSError *_Nullable error) {
   if (error) {
     // Error occurred. Inspect error.code and handle error.
     return;
   }
   // Email verification sent.
 }];

Firebase Auth utilise Firebase Dynamic Links lors de l'envoi d'un lien destiné à être ouvert dans une application mobile. Pour utiliser cette fonctionnalité, les liens dynamiques doivent être configurés dans la console Firebase.

  1. Activez les liens dynamiques Firebase :

    1. Dans la console Firebase , ouvrez la section Liens dynamiques .
    2. Si vous n'avez pas encore accepté les conditions Dynamic Links et créé un domaine Dynamic Links, faites-le maintenant.

      Si vous avez déjà créé un domaine Dynamic Links, notez-le. Un domaine Dynamic Links ressemble généralement à l'exemple suivant :

      example.page.link

      Vous aurez besoin de cette valeur lorsque vous configurerez votre application Apple ou Android pour intercepter le lien entrant.

  2. Configuration des applications Android :

    1. Si vous prévoyez de gérer ces liens à partir de votre application Android, le nom du package Android doit être spécifié dans les paramètres du projet de la console Firebase. De plus, les SHA-1 et SHA-256 du certificat d'application doivent être fournis.
    2. Vous devrez également configurer le filtre d'intention pour le lien profond dans votre fichier AndroidManifest.xml.
    3. Pour plus d'informations à ce sujet, reportez-vous aux instructions de réception des liens dynamiques Android .
  3. Configuration des applications Apple :

    1. Si vous prévoyez de gérer ces liens à partir de votre application, l'ID de groupe doit être spécifié dans les paramètres du projet de la console Firebase. De plus, l'ID App Store et l'ID de l'équipe de développeurs Apple doivent également être spécifiés.
    2. Vous devrez également configurer le domaine de liaison universelle FDL en tant que domaine associé dans les fonctionnalités de votre application.
    3. Si vous envisagez de distribuer votre application aux versions iOS 8 et antérieures, vous devrez définir votre ID de bundle en tant que schéma personnalisé pour les URL entrantes.
    4. Pour plus d'informations à ce sujet, reportez-vous aux instructions de réception des liens dynamiques des plates-formes Apple .

Gestion des actions de messagerie dans une application Web

Vous pouvez spécifier si vous souhaitez d'abord gérer le lien du code d'action à partir d'une application Web, puis rediriger vers une autre page Web ou application mobile une fois l'opération réussie, à condition que l'application mobile soit disponible. Pour ce faire, définissez handleCodeInApp sur false dans l' FIRActionCodeSettings (Obj-C) ou ActionCodeSettings (Swift). Bien qu'un ID de bundle ou un nom de package Android ne soient pas requis, leur fourniture permettra à l'utilisateur de rediriger vers l'application spécifiée une fois le code d'action de l'e-mail terminé.

L'URL Web utilisée ici est celle configurée dans la section des modèles d'action d'e-mail. Un par défaut est provisionné pour tous les projets. Reportez-vous à la personnalisation des gestionnaires d'e-mails pour en savoir plus sur la personnalisation du gestionnaire d'action d'e-mail.

Dans ce cas, le lien dans le paramètre de requête continueURL sera un lien FDL dont la charge utile est l' URL spécifiée dans l'objet ActionCodeSettings . Bien que vous puissiez intercepter et gérer le lien entrant depuis votre application sans aucune dépendance supplémentaire, nous vous recommandons d'utiliser la bibliothèque cliente FDL pour analyser le lien profond pour vous.

Lors de la gestion d'actions d'e-mail telles que la vérification d'e-mail, le code d'action du paramètre de requête oobCode doit être analysé à partir du lien profond, puis appliqué via applyActionCode pour que la modification prenne effet, c'est-à-dire que l'e-mail soit vérifié.

Gestion des actions email dans une application mobile

Vous pouvez spécifier si vous souhaitez d'abord gérer le lien du code d'action dans votre application mobile, à condition qu'il soit installé. Avec les applications Android, vous avez également la possibilité de spécifier via androidInstallIfNotAvailable que l'application doit être installée si l'appareil la prend en charge et qu'elle n'est pas déjà installée. Si le lien est cliqué à partir d'un appareil qui ne prend pas en charge l'application mobile, il est ouvert à la place à partir d'une page Web. Pour ce faire, définissez handleCodeInApp sur true dans l' FIRActionCodeSettings (Obj-C) ou ActionCodeSettings (Swift). Le nom du package Android ou l'ID de l'ensemble de l'application mobile devra également être spécifié. L'URL Web de secours utilisée ici, lorsqu'aucune application mobile n'est disponible, est celle configurée dans la section des modèles d'action d'e-mail. Un par défaut est provisionné pour tous les projets. Reportez-vous à la personnalisation des gestionnaires d'e-mails pour en savoir plus sur la personnalisation du gestionnaire d'action d'e-mail.

Dans ce cas, le lien de l'application mobile envoyé à l'utilisateur sera un lien FDL dont la charge utile est l'URL du code d'action, configuré dans la console, avec les paramètres de requête oobCode , mode , apiKey et continueUrl . Ce dernier sera l' URL d'origine spécifiée dans l' FIRActionCodeSettings (Obj-C) ou ActionCodeSettings (Swift). Bien que vous puissiez intercepter et gérer le lien entrant depuis votre application sans aucune dépendance supplémentaire, nous vous recommandons d'utiliser la bibliothèque cliente FDL pour analyser le lien profond pour vous. Le code d'action peut être appliqué directement à partir d'une application mobile de la même manière qu'il est géré à partir du flux Web décrit dans la section personnalisation des gestionnaires de messagerie .

Lors de la gestion d'actions d'e-mail telles que la vérification d'e-mail, le code d'action du paramètre de requête oobCode doit être analysé à partir du lien profond, puis appliqué via applyActionCode pour que la modification prenne effet, c'est-à-dire que l'e-mail soit vérifié.