ActionCodeURL class

パスワード リセット、電子メール検証、電子メール リンク サインインなどの電子メール アクション 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を返し、それ以外の場合は null を返します。

サイン:

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

パラメーター

パラメータタイプ説明
リンク電子メールアクションのリンク文字列。

戻り値:

アクションコードURL |ヌル

ActionCodeURLオブジェクト、またはリンクが無効な場合は null。