パスワード リセット、電子メール検証、電子メール リンク サインインなどの電子メール アクション URL を解析するユーティリティ クラス。
このクラスのコンストラクターは内部としてマークされています。サードパーティのコードは、コンストラクターを直接呼び出したり、 ActionCodeURL
クラスを拡張するサブクラスを作成したりしないでください。
サイン:
export declare class ActionCodeURL
プロパティ
財産 | 修飾子 | タイプ | 説明 |
---|---|---|---|
APIキー | 弦 | 電子メール アクション リンクの API キー。 | |
コード | 弦 | 電子メールアクションリンクのアクションコード。 | |
継続URL | 文字列 |ヌル | 電子メール アクション リンクの続行 URL。指定されていない場合は null。 | |
言語コード | 文字列 |ヌル | 電子メールアクションリンクの言語コード。指定されていない場合は null。 | |
手術 | 弦 | 電子メール アクション リンクによって実行されるアクション。 ActionCodeInfoのいずれかのタイプから返されます。 | |
テナントID | 文字列 |ヌル | 電子メール アクション リンクのテナント ID。電子メール アクションが親プロジェクトからのものである場合は null。 |
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
parseLink(リンク) | static | 電子メール アクション リンク文字列を解析し、リンクが有効な場合はActionCodeURLを返し、それ以外の場合は null を返します。 |
ActionCodeURL.apiKey
電子メール アクション リンクの API キー。
サイン:
readonly apiKey: string;
ActionCodeURL.code
電子メールアクションリンクのアクションコード。
サイン:
readonly code: string;
アクションコードURL.ContinueUrl
電子メール アクション リンクの続行 URL。指定されていない場合は null。
サイン:
readonly continueUrl: string | null;
アクションコードURL.言語コード
電子メールアクションリンクの言語コード。指定されていない場合は null。
サイン:
readonly languageCode: string | null;
ActionCodeURL.operation
電子メール アクション リンクによって実行されるアクション。 ActionCodeInfoのいずれかのタイプから返されます。
サイン:
readonly operation: string;
ActionCodeURL.tenantId
電子メール アクション リンクのテナント ID。電子メール アクションが親プロジェクトからのものである場合は null。
サイン:
readonly tenantId: string | null;
ActionCodeURL.parseLink()
電子メール アクション リンク文字列を解析し、リンクが有効な場合はActionCodeURLを返し、それ以外の場合は null を返します。
サイン:
static parseLink(link: string): ActionCodeURL | null;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
リンク | 弦 | 電子メールアクションのリンク文字列。 |
戻り値:
アクションコードURL |ヌル
ActionCodeURLオブジェクト、またはリンクが無効な場合は null。