Status in E-Mail-Aktionen übergeben

Sie können den Status über eine Weiter-URL übergeben, wenn Sie E-Mail-Aktionen für Passwörter senden setzt die E-Mail-Adresse eines Nutzers zurück oder verifiziert sie. So kann der Nutzer nach Abschluss der Aktion zur App zurückkehren. Darüber hinaus können Sie angeben, ob der E-Mail-Aktionslink direkt aus einer mobilen App verarbeitet werden soll, wenn und nicht auf einer Webseite installiert.

Dies kann in den folgenden gängigen Szenarien äußerst nützlich sein:

  • Ein Nutzer, der derzeit nicht angemeldet ist, versucht möglicherweise, auf Inhalte zuzugreifen, die setzt voraus, dass der Nutzer angemeldet ist. Möglicherweise hat der Nutzer jedoch sein Passwort vergessen und löst daher den Ablauf zum Zurücksetzen des Passworts aus. Am Ende des erwartet die nutzende Person, zu dem Bereich der App zurückzukehren, auf die Sie zugreifen möchten.

  • Eine Anwendung darf nur Zugriff auf bestätigte Konten bieten. Für So kann es z. B. sein, dass Nutzer in einem Newsletter ihre E-Mail-Adresse bestätigen müssen, Abos. Der Nutzer durchläuft die E-Mail-Bestätigung und erwartet, kehren zur App zurück, um das Abo abzuschließen.

  • Es kann aber auch sein, dass der Nutzer den User Flow auf seinem Mobilgerät gestartet hat. und erwarten, dass Sie nach der Bestätigung zur mobilen App zurückkehren, im Browser.

Die Möglichkeit, den Status über eine Weiter-URL zu übergeben, ist eine leistungsstarke Funktion, Firebase Auth bietet eine und kann die Nutzererfahrung erheblich verbessern.

Status-/Fortsetzungs-URL in E-Mail-Aktionen übergeben

Damit eine Weiterleitungs-URL sicher übergeben werden kann, muss die Domain für die URL in der Firebase-Konsole auf die Zulassungsliste gesetzt werden. Fügen Sie dazu im Abschnitt Authentication (Authentifizierung) diese Domain zum Liste Autorisierter Domains auf dem Tab Anmeldemethode, falls diese nicht bereits vorhanden ist.

ActionCodeSettings -Instanz angegeben werden, wenn eine E-Mail zum Zurücksetzen des Passworts oder eine Bestätigungs-E-Mail. Er kann mit dem zugehörigen ActionCodeSettings.Builder erstellt werden. -Klasse mit den folgenden Methoden:

Methode Beschreibung
setUrl(String url)

Legt den Link (Status-/Fortsetzungs-URL) fest, der unterschiedliche Bedeutungen hat unterschiedlichen Kontexten:

  • Wenn der Link in den Webaktions-Widgets aufgerufen wird, im Abfrageparameter continueUrl.
  • Wird der Link direkt in der App aufgerufen, ist dies der continueUrl im Deeplink der Dynamischer Link.
setIOSBundleId(String iOSBundleId) Legt die iOS-Paket-ID fest. Dadurch wird versucht, den Link in einer iOS-App zu öffnen, sofern diese installiert ist. Die iOS-App muss in der Console registriert sein.
setAndroidPackageName(String androidPackageName, boolean installIfNotAvailable, String minimumVersion) Legt den Android-Paketnamen fest. Dadurch wird versucht, den Link in einem Android-App, falls sie installiert ist. Wenn „installIfNotAvailable“ auf true gesetzt ist, wird Folgendes angegeben: Ob die Android-App installiert werden soll, wenn das Gerät sie und die App unterstützt ist noch nicht installiert. Wenn MinimumVersion angegeben ist, und eine ältere Version der App installiert ist, wird der Nutzer zur Play Store, um die App zu aktualisieren. Die Android-App muss registriert sein in in der Konsole.
setHandleCodeInApp(boolean status) Ob der Link zur E-Mail-Aktion zuerst in einer mobilen App oder über einen Weblink geöffnet wird. Der Standardwert ist "false". Wenn die Richtlinie auf „true“ gesetzt ist, wird als universellen Link oder Android-App-Link gesendet und wird geöffnet von der App, falls installiert. Im falschen Fall wird der Code an die Web-Widget zuerst und dann weiter zur App, wenn installiert haben.
setDynamicLinkDomain(String dynamicLinkDomain) Hiermit wird die Dynamic Link-Domain (oder ‑Subdomain) festgelegt, die für den aktuellen Link verwendet werden soll, wenn er mit Firebase Dynamic Links geöffnet werden soll. Als mehrere dynamische Creatives Linkdomains pro Projekt konfiguriert werden, enthält dieses Feld eine Option explizit auszuwählen. Wenn keine angegeben ist, wird die erste Domain wird standardmäßig verwendet.

Das folgende Beispiel zeigt, wie ein E-Mail-Bestätigungslink gesendet wird, wird zuerst in einer mobilen App als Firebase Dynamic Link geöffnet (iOS-App com.example.ios oder Android-App com.example.android). Die Deep-Link enthält die Nutzlast der Fortsetzungs-URL https://www.example.com/?email=user@example.com

Kotlin+KTX

val auth = Firebase.auth
val user = auth.currentUser!!

val url = "http://www.example.com/verify?uid=" + user.uid
val actionCodeSettings = ActionCodeSettings.newBuilder()
    .setUrl(url)
    .setIOSBundleId("com.example.ios")
    // The default for this is populated with the current android package name.
    .setAndroidPackageName("com.example.android", false, null)
    .build()

user.sendEmailVerification(actionCodeSettings)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            Log.d(TAG, "Email sent.")
        }
    }

Java

FirebaseAuth auth = FirebaseAuth.getInstance();
FirebaseUser user = auth.getCurrentUser();

String url = "http://www.example.com/verify?uid=" + user.getUid();
ActionCodeSettings actionCodeSettings = ActionCodeSettings.newBuilder()
        .setUrl(url)
        .setIOSBundleId("com.example.ios")
        // The default for this is populated with the current android package name.
        .setAndroidPackageName("com.example.android", false, null)
        .build();

user.sendEmailVerification(actionCodeSettings)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                if (task.isSuccessful()) {
                    Log.d(TAG, "Email sent.");
                }
            }
        });

Firebase Auth verwendet Firebase Dynamic Links beim Senden einer der in einer mobilen App geöffnet werden soll. Damit Sie diese Funktion verwenden können, müssen Dynamic Links in der Firebase Console konfiguriert werden.

  1. Aktivieren Sie Firebase Dynamic Links:

    1. Öffnen Sie in der Firebase-Konsole den Abschnitt Dynamic Links.
    2. Wenn Sie die Dynamic Links-Nutzungsbedingungen noch nicht akzeptiert und ein Dynamic Links erstellt haben holen Sie dies jetzt nach.

      Wenn Sie bereits eine Dynamic Links-Domain erstellt haben, notieren Sie sich diese. Eine Dynamic Links-Domain sieht in der Regel so aus:

      example.page.link

      Sie benötigen diesen Wert, wenn Sie Ihre Apple- oder Android-App so konfigurieren, dass den eingehenden Link abfangen.

  2. Android-Anwendungen konfigurieren:

    1. Wenn Sie diese Links über Ihre Android-Anwendung verarbeiten möchten, muss der Name des Android-Pakets in den Projekteinstellungen der Firebase Console angegeben werden. Außerdem werden SHA-1 und SHA-256 der Anwendung muss angegeben werden.
    2. Außerdem müssen Sie den Intent-Filter für den Deeplink konfigurieren in die Datei „AndroidManifest.xml“.
    3. Weitere Informationen hierzu finden Sie unter Anleitung für Android Dynamic Links erhalten
  3. iOS-Anwendungen konfigurieren:

    1. Wenn Sie vorhaben, diese Links von Ihrer iOS-App aus zu verwalten, Die iOS-Paket-ID muss in der Firebase Console angegeben werden Projekteinstellungen. Die App Store-ID und der Apple Developer Die Team-ID muss ebenfalls angegeben werden.
    2. Außerdem müssen Sie die universelle Link-Domain (FDL) als Verknüpfte Domain in den App-Funktionen.
    3. Wenn Sie Ihre App für iOS-Version 8 oder niedriger bereitstellen möchten, müssen Sie Ihre iOS-Paket-ID als benutzerdefiniertes Schema für eingehende URLs.
    4. Weitere Informationen finden Sie unter Anleitung zum Empfangen von iOS-Dynamic Links.

E-Mail-Aktionen in einer Webanwendung verarbeiten

Sie können angeben, ob der Aktionscode-Link von einem Web- und dann auf eine andere Webseite oder mobile App weiterleiten. nach erfolgreichem Abschluss, vorausgesetzt, die mobile App ist verfügbar. Rufen Sie dazu setHandleCodeInApp(false) im ActionCodeSettings.Builder-Objekt auf. Eine iOS-Bundle-ID oder ein Android-Paketname sind zwar nicht erforderlich, aber wenn Sie sie angeben, kann der Nutzer nach Abschluss des E-Mail-Aktionscodes zur angegebenen App weitergeleitet werden.

Die hier verwendete Web-URL ist die in den E-Mail-Aktionsvorlagen konfigurierte URL . Für alle Projekte wird eine Standard-Konfiguration bereitgestellt. Weitere Informationen finden Sie unter Anpassen von E-Mail-Handlern, um mehr über E-Mail-Aktions-Handler anpassen.

In diesem Fall lautet der Link im Suchparameter continueUrl einen FDL-Link, dessen Nutzlast dem URL entspricht, das in der ActionCodeSettings angegeben ist -Objekt enthält. Du kannst den von deiner App eingehenden Link abfangen und verarbeiten. ohne zusätzliche Abhängigkeit, empfehlen wir die Verwendung der FDL-Clientbibliothek, den Deeplink für Sie zu parsen.

Bei E-Mail-Aktionen wie der E-Mail-Bestätigung muss der Aktionscode aus dem Der Abfrageparameter „oobCode“ muss aus dem Deeplink geparst und dann angewendet werden über applyActionCode, damit die Änderung wirksam wird, d.h. per E-Mail, die bestätigt werden soll.

E-Mail-Aktionen in einer mobilen App verarbeiten

Sie können angeben, ob Sie den Aktionscode-Link in Ihrem mobile App zuerst, sofern sie installiert ist. Bei Android-Apps kannst du auch über den booleschen Wert installIfNotAvailable festlegen, muss installiert werden, wenn das Gerät dies unterstützt und es noch nicht installiert ist. Wenn der Link auf einem Gerät angeklickt wird, das die mobile wird sie stattdessen über eine Webseite geöffnet. Rufen Sie dazu setHandleCodeInApp(true) im ActionCodeSettings.Builder -Objekt enthält. Außerdem muss der Android-Paketname oder die iOS-Paket-ID der mobilen App angegeben werden.

Wenn keine mobile App verfügbar ist, wird die hier verwendete Fallback-Web-URL verwendet. E-Mail-Aktionsvorlagen konfiguriert wurden. Eine Standard-URL wird bereitgestellt. für alle Projekte. Weitere Informationen finden Sie unter Anpassen von E-Mail-Handlern, um mehr über E-Mail-Aktions-Handler anpassen.

In diesem Fall ist der an den Nutzer gesendete Link zur mobilen App ein FDL-Link, payload ist die in der Konsole konfigurierte Aktionscode-URL mit der Abfrage Parameter oobCode, mode, apiKey und continueUrl. Letzteres ist das ursprüngliche URL, das im ActionCodeSettings-Objekt angegeben ist. Sie können zwar den eingehenden Link von deiner App abzufangen und zu verarbeiten, abhängig ist, empfehlen wir, die FDL-Clientbibliothek zum Parsen des Deeplinks für von dir. Der Aktionscode kann direkt von einer mobilen App über die Web-Flow-Methode, die in den Anpassen von E-Mail-Handlern.

Beim Ausführen von E-Mail-Aktionen wie der E-Mail-Bestätigung muss der Aktionscode aus dem Abfrageparameter oobCode aus dem Deeplink geparst und dann über applyActionCode angewendet werden, damit die Änderung wirksam wird, d. h. die E-Mail bestätigt wird.