ActionCodeURL class

Класс утилиты для анализа URL-адресов действий электронной почты, таких как сброс пароля, проверка электронной почты, вход по ссылке электронной почты и т. д.

Конструктор этого класса помечен как внутренний. Сторонний код не должен вызывать конструктор напрямую или создавать подклассы, расширяющие класс ActionCodeURL .

Подпись:

export declare class ActionCodeURL

Характеристики

Свойство Модификаторы Тип Описание
APIKey нить Ключ API ссылки на действие по электронной почте.
код нить Код действия ссылки действия по электронной почте.
продолжитьURL строка | нулевой URL-адрес продолжения ссылки действия по электронной почте. Нуль, если не указано.
языковой код строка | нулевой Код языка ссылки действия по электронной почте. Нуль, если не указано.
операция нить Действие, выполняемое ссылкой на действие по электронной почте. Он возвращает один из типов из ActionCodeInfo.
идентификатор арендатора строка | нулевой Идентификатор клиента ссылки на действие по электронной почте. Значение NULL, если действие по электронной почте относится к родительскому проекту.

Методы

Метод Модификаторы Описание
синтаксический анализСсылка (ссылка) static Анализирует строку ссылки на действие электронной почты и возвращает ActionCodeURL , если ссылка действительна, в противном случае возвращает значение NULL.

ActionCodeURL.apiKey

Ключ API ссылки на действие по электронной почте.

Подпись:

readonly apiKey: string;

ActionCodeURL.code

Код действия ссылки действия по электронной почте.

Подпись:

readonly code: string;

ActionCodeURL.continueUrl

URL-адрес продолжения ссылки действия по электронной почте. Нуль, если не указано.

Подпись:

readonly continueUrl: string | null;

ActionCodeURL.languageCode

Код языка ссылки действия по электронной почте. Нуль, если не указано.

Подпись:

readonly languageCode: string | null;

ActionCodeURL.operation

Действие, выполняемое ссылкой на действие по электронной почте. Он возвращает один из типов из ActionCodeInfo.

Подпись:

readonly operation: string;

ActionCodeURL.tenantId

Идентификатор клиента ссылки на действие по электронной почте. Значение NULL, если действие по электронной почте относится к родительскому проекту.

Подпись:

readonly tenantId: string | null;

Анализирует строку ссылки на действие электронной почты и возвращает ActionCodeURL , если ссылка действительна, в противном случае возвращает значение NULL.

Подпись:

static parseLink(link: string): ActionCodeURL | null;

Параметры

Параметр Тип Описание
связь нить Строка ссылки на действие по электронной почте.

Возврат:

КодДействияURL | нулевой

Объект ActionCodeURL или значение NULL, если ссылка недействительна.