Вы можете передавать состояние через URL-адрес продолжения при отправке действий по электронной почте для сброса пароля или подтверждения адреса электронной почты пользователя. Это позволяет пользователю вернуться в приложение после завершения действия. Кроме того, вы можете указать, следует ли обрабатывать ссылку на действие по электронной почте непосредственно из мобильного приложения, если оно установлено, а не с веб-страницы.
Это может быть чрезвычайно полезно в следующих распространенных сценариях:
Пользователь, не вошедший в систему, может пытаться получить доступ к контенту, требующему входа в систему. Однако он мог забыть пароль и запустить процесс сброса пароля. В конце процесса пользователь ожидает вернуться в раздел приложения, к которому пытался получить доступ.
Приложение может предоставлять доступ только к подтверждённым учётным записям. Например, для подписки на новостную рассылку пользователю может потребоваться подтвердить адрес электронной почты. Пользователь пройдёт процедуру подтверждения адреса электронной почты и, скорее всего, вернётся в приложение для завершения подписки.
В других случаях пользователь мог запустить процесс со своего мобильного устройства и ожидать после проверки возвращения в мобильное приложение вместо браузера.
Возможность передачи состояния через URL-адрес продолжения — мощная функция, предоставляемая Firebase Auth, которая может значительно улучшить пользовательский опыт.
Передача состояния URL-адреса продолжения в действиях электронной почты
Для безопасной передачи URL-адреса продолжения необходимо добавить домен URL в качестве авторизованного в консоли Firebase . Это можно сделать в разделе «Аутентификация» , добавив этот домен в список авторизованных доменов на вкладке «Способ входа», если он там ещё не указан.
При отправке письма для сброса пароля или подтверждения необходимо предоставить экземпляр firebase.auth.ActionCodeSettings
. Этот интерфейс принимает следующие параметры:
Параметр | Тип | Описание |
---|---|---|
url | нить | Устанавливает ссылку (URL состояния/продолжения), которая имеет разные значения в разных контекстах:
|
iOS | ({bundleId: string}|не определено) | Устанавливает идентификатор пакета iOS, который помогает Firebase Authentication определить, следует ли создавать веб-ссылку или мобильную ссылку, открываемую на устройстве Apple. |
android | ({packageName: string, installApp:boolean|undefined, minimumVersion: string|undefined}|undefined) | Задает имя пакета Android, чтобы помочь Firebase Authentication определить, следует ли создавать веб-ссылку или мобильную ссылку, открываемую на устройстве Android. |
handleCodeInApp | (логическое значение|неопределено) | Будет ли ссылка действия, отправленная по электронной почте, сначала открываться в мобильном приложении или на веб-странице. Значение по умолчанию — false. При значении true ссылка с кодом действия будет отправлена как универсальная ссылка или ссылка на приложение Android и будет открыта приложением, если оно установлено. В противном случае код сначала будет отправлен в веб-виджет, а затем при нажатии «Continue» перенаправит в приложение, если оно установлено. |
linkDomain | (строка|не определено) | Если для проекта определены пользовательские домены для ссылок Hosting , укажите, какой из них будет использоваться при открытии ссылки в указанном мобильном приложении. В противном случае автоматически выбирается домен по умолчанию (например,PROJECT_ID .firebaseapp.com ). |
dynamicLinkDomain | (строка|не определено) | Устарело. Не указывайте этот параметр. |
В следующем примере показано, как отправить ссылку для подтверждения адреса электронной почты, которая сначала откроется в мобильном приложении, используя Hosting custom-domain.com
. Глубокая ссылка будет содержать полезную нагрузку URL-адреса продолжения https://www.example.com/?email=user@example.com
.
const actionCodeSettings = {
url: 'https://www.example.com/?email=' + firebase.auth().currentUser.email,
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
},
handleCodeInApp: true,
// Specify a custom Hosting link domain to use. The domain must be
// configured in Firebase Hosting and owned by the project.
linkDomain: "custom-domain.com"
};
firebase.auth().currentUser.sendEmailVerification(actionCodeSettings)
.then(function() {
// Verification email sent.
})
.catch(function(error) {
// Error occurred. Inspect error.code.
});
Настройка ссылок Firebase Hosting
Firebase Authentication использует Firebase Hosting при отправке ссылки, предназначенной для открытия в мобильном приложении. Для использования этой функции необходимо настроить ссылки Hosting в консоли Firebase .
Настройка Android-приложений:
- Если вы планируете обрабатывать эти ссылки из своего приложения Android, необходимо указать имя пакета приложения в настройках проекта консоли Firebase . Кроме того, необходимо предоставить SHA-1 и SHA-256 сертификата приложения.
- Вам также потребуется настроить фильтр намерений для глубокой ссылки в файле
AndroidManifest.xml
. - Более подробную информацию см. в разделе «Инструкции по получению ссылок на хостинг Android» .
Настройка iOS-приложений:
- Если вы планируете обрабатывать эти ссылки из своего приложения iOS, вам потребуется настроить домен ссылки Hosting как ассоциированный домен в возможностях вашего приложения.
- Более подробную информацию см. в разделе «Инструкции по получению ссылок на хостинг iOS» .
Обработка действий с электронной почтой в веб-приложении
Вы можете указать, следует ли сначала обрабатывать ссылку с кодом действия из веб-приложения, а затем перенаправлять пользователя на другую веб-страницу или мобильное приложение после успешного завершения, при условии, что мобильное приложение доступно. Для этого установите handleCodeInApp
в значение false
в объекте firebase.auth.ActionCodeSettings
. Хотя идентификатор пакета iOS или имя пакета Android не являются обязательными, их предоставление позволит пользователю перенаправляться обратно в указанное приложение при завершении кода действия в электронной почте.
Используемый здесь URL-адрес веб-сайта настроен в разделе шаблонов действий с электронной почтой. Для всех проектов предусмотрен URL-адрес по умолчанию. Подробнее о настройке обработчика действий с электронной почтой см. в разделе «Настройка обработчиков электронной почты».
В этом случае ссылка в параметре запроса continueUrl
будет ссылкой Hosting, полезной нагрузкой которой является URL
указанный в объекте ActionCodeSettings
.
При обработке действий с электронной почтой, таких как проверка электронной почты, код действия из параметра запроса oobCode
необходимо проанализировать из глубинной ссылки, а затем применить через applyActionCode
, чтобы изменения вступили в силу, т. е. чтобы адрес электронной почты был проверен.
Обработка действий с электронной почтой в мобильном приложении
Вы можете указать, следует ли сначала обрабатывать ссылку с кодом действия в мобильном приложении, если оно установлено. Если ссылка нажата с устройства, не поддерживающего мобильное приложение, она открывается на веб-странице. Это делается путём установки handleCodeInApp
в true
в объекте firebase.auth.ActionCodeSettings
. Также необходимо указать имя пакета Android или идентификатор пакета iOS мобильного приложения.
Резервный URL-адрес, используемый здесь при отсутствии мобильного приложения, — это URL-адрес, настроенный в разделе шаблонов действий с электронной почтой. Для всех проектов предусмотрен URL-адрес по умолчанию. Подробнее о настройке обработчика действий с электронной почтой см. в разделе «Настройка обработчиков электронной почты».
В этом случае ссылка на мобильное приложение, отправляемая пользователю, будет представлять собой ссылку Hosting , полезной нагрузкой которой является URL-адрес кода действия, настроенный в консоли, с параметрами запроса oobCode
, mode
, apiKey
и continueUrl
. Последний будет исходным URL
указанным в объекте ActionCodeSettings
. Код действия можно применить непосредственно из мобильного приложения, аналогично тому, как это делается в веб-процессе, описанном в разделе «Настройка обработчиков электронной почты» .
При обработке действий с электронной почтой, таких как проверка электронной почты, код действия из параметра запроса oobCode
необходимо проанализировать из глубинной ссылки, а затем применить через applyActionCode
, чтобы изменения вступили в силу, т. е. чтобы адрес электронной почты был проверен.