傳送密碼重設電子郵件動作或驗證使用者的電子郵件時,您可以透過繼續網址傳遞狀態。這樣一來,使用者就能在完成動作後返回應用程式。此外,您可以指定是否要直接從已安裝的行動應用程式 (而非網頁) 處理電子郵件動作連結。
這在下列常見情境中非常實用:
使用者可能會嘗試存取需要登入才能存取的內容,但目前並未登入。不過,使用者可能忘記密碼,因此會觸發重設密碼流程。在流程結束時,使用者會預期返回嘗試存取的應用程式部分。
應用程式只能提供經過驗證的帳戶存取權。舉例來說,電子報應用程式可能會要求使用者在訂閱前驗證電子郵件地址。使用者會完成電子郵件驗證流程,並預期會返回應用程式完成訂閱。
一般來說,當使用者在 Apple 應用程式中開始重設密碼或電子郵件驗證流程時,他們會預期在應用程式內完成流程;透過繼續網址傳遞狀態的功能可讓這項作業順利進行。
透過繼續網址傳遞狀態是 Firebase Auth 提供的強大功能,可大幅改善使用者體驗。
在電子郵件動作中傳遞繼續網址的狀態
為確保安全地傳送繼續網址,您需要在 Firebase 控制台中將網址的網域加入許可清單。如要這麼做,請前往「Authentication」部分,將這個網域新增至「Sign-in method」分頁下方的「Authorized domains」清單中 (如果尚未加入)。
傳送密碼重設電子郵件或驗證電子郵件時,必須提供 FIRActionCodeSettings
例項。這個介面會採用下列參數:
Swift
參數 | 類型 | 說明 |
---|---|---|
URL |
字串 | 設定在不同情境中具有不同意義的連結 (狀態/繼續網址):
|
iOSBundleID |
字串 | 設定 iOS 軟體包 ID,協助 Firebase Authentication 判斷是否應建立在 Apple 裝置上開啟的網頁專屬或行動連結 |
androidPackageName |
字串 | 設定 Android 套件名稱,協助 Firebase Authentication 判斷是否應建立在 Android 裝置上開啟的僅限網頁或行動連結 |
handleCodeInApp |
布林值 | 電子郵件動作連結是否會先在行動應用程式或網頁連結中開啟。預設值為 false。如果設為 True,系統會以通用連結或 Android 應用程式連結傳送動作碼連結,並在應用程式安裝後由應用程式開啟。在 false 的情況下,系統會先將程式碼傳送至網頁小工具,然後在繼續時將重新導向至已安裝的應用程式。 |
linkDomain |
字串 | 為專案定義自訂代管連結網域時,請指定在連結由指定行動應用程式開啟時,要使用哪一個網域。否則,系統會自動選取預設網域 (例如 PROJECT_ID.firebaseapp.com |
dynamicLinkDomain |
字串 | 已淘汰,請勿指定此參數。 |
Objective-C
參數 | 類型 | 說明 |
---|---|---|
URL |
NSString | 設定在不同情境中具有不同意義的連結 (狀態/繼續網址):
|
iOSBundleID |
NSString | 設定 iOS 套件 ID,協助 Firebase Authentication 判斷是否應建立在 Android 或 Apple 裝置上開啟的僅限網頁或行動連結 |
androidPackageName |
NSString | 設定 Android 套件名稱,協助 Firebase Authentication 判斷是否應建立在 Android 或 Apple 裝置上開啟的純網頁或行動連結 |
handleCodeInApp |
BOOL | 電子郵件動作連結是否會先在行動應用程式或網頁連結中開啟。預設值為 false。如果設為 True,系統會以通用連結或 Android 應用程式連結傳送動作碼連結,並在應用程式安裝後由應用程式開啟。在 false 的情況下,系統會先將程式碼傳送至網頁小工具,然後在繼續時將重新導向至已安裝的應用程式。 |
linkDomain |
NSString | 為專案定義自訂 Hosting 連結網域時,請在連結由指定行動應用程式開啟時,指定要使用的網域。否則,系統會自動選取預設網域 (例如 PROJECT_ID.firebaseapp.com |
dynamicLinkDomain |
NSString | 已淘汰,請勿指定此參數。 |
以下範例說明如何傳送電子郵件驗證連結,並使用自訂 Hosting 連結網域 custom-domain.com
在行動應用程式中開啟。深層連結會包含繼續網址酬載 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. }];
設定 Firebase Hosting 連結
Firebase Authentication 在傳送要在行動應用程式中開啟的連結時,會使用 Firebase Hosting。如要使用這項功能,您必須在 Firebase 控制台中設定 Hosting 連結。
設定 Apple 應用程式:
- 如果您打算透過應用程式處理這些連結,就必須將 Hosting 連結網域設為應用程式功能中的相關聯網域。
- 詳情請參閱「接收 iOS 代管連結指南」。
設定 Android 應用程式:
- 如果您打算透過 Android 應用程式處理這些連結,就必須在 Firebase 控制台專案設定中指定應用程式的套件名稱。此外,您也必須提供應用程式憑證的 SHA-1 和 SHA-256。
- 您還需要在
AndroidManifest.xml
檔案中設定深層連結的意圖篩選器。 - 如需更多資訊,請參閱「接收 Android 代管連結的操作說明」。
在網路應用程式中處理電子郵件動作
您可以指定是否要先從網頁應用程式處理動作碼連結,然後在完成後重新導向至其他網頁或行動應用程式 (如果有)。方法是在 FIRActionCodeSettings
(Obj-C) 或 ActionCodeSettings
(Swift) 物件中,將 handleCodeInApp
設為 false
。雖然不需要提供套件 ID 或 Android 套件名稱,但提供這些資訊可讓使用者在完成電子郵件動作代碼後,重新導向至指定的應用程式。
這裡使用的網址是電子郵件動作範本部分中設定的網址。系統會為所有專案配置預設的專案。如要進一步瞭解如何自訂電子郵件動作處理常式,請參閱「自訂電子郵件處理常式」。
在這種情況下,continueURL
查詢參數中的連結會是 Hosting 連結,其酬載為 ActionCodeSettings
物件中指定的 URL
。
處理電子郵件驗證等電子郵件動作時,需要從深層連結解析 oobCode
查詢參數的動作代碼,然後透過 applyActionCode
套用變更,才能生效,也就是驗證電子郵件。
在行動應用程式中處理電子郵件動作
您可以指定是否要在行動應用程式中先處理動作碼連結 (如果已安裝)。如果使用者從不支援行動應用程式的裝置點選連結,系統會改為從網頁開啟連結。方法是在 FIRActionCodeSettings
(Obj-C) 或 ActionCodeSettings
(Swift) 物件中,將 handleCodeInApp
設為 true
。您也必須指定行動應用程式的 Android 套件名稱或軟體包 ID。在沒有行動應用程式可供使用時,這裡使用的備用網頁網址,就是在電子郵件動作範本部分中設定的網址。系統會為所有專案提供預設的專案。如要進一步瞭解如何自訂電子郵件動作處理常式,請參閱「自訂電子郵件處理常式」。
在這種情況下,傳送給使用者的行動應用程式連結會是 Hosting 連結,其酬載是使用控制台中設定的動作碼網址,以及查詢參數 oobCode
、mode
、apiKey
和 continueUrl
。後者是 FIRActionCodeSettings
(Obj-C) 或 ActionCodeSettings
(Swift) 物件中指定的原始 URL
。行動應用程式可以直接套用動作代碼,類似於「自訂電子郵件處理程序」一節所述的網頁流程處理方式。
處理電子郵件驗證等電子郵件動作時,需要從深層連結解析 oobCode
查詢參數的動作代碼,然後透過 applyActionCode
套用變更,才能生效,也就是驗證電子郵件。