ActionCodeURL class

パスワードのリセット、メールの確認、メールリンク ログインなどのメール アクション URL を解析するユーティリティ クラス。

このクラスのコンストラクタは内部としてマークされています。サードパーティのコードでは、コンストラクタを直接呼び出すことや、ActionCodeURL クラスを拡張するサブクラスを作成しないでください。

署名:

export declare class ActionCodeURL 

プロパティ

プロパティ	修飾キー	タイプ	説明
apiKey		文字列	メールのアクション リンクの API キー。
コード		文字列	メールのアクション リンクのアクション コード。
continueUrl		文字列 |null	メール アクション リンクの続行 URL。指定しない場合は null。
languageCode		文字列 |null	メールのアクション リンクの言語コード。指定しない場合は null。
演算		文字列	メールのアクション リンクで実行されるアクション。ActionCodeInfo の型のいずれかから返されます。
tenantId		文字列 |null	メール アクション リンクのテナント ID。メール アクションが親プロジェクトから送信される場合は null。

メソッド

メソッド	修飾キー	説明
parseLink(link)	static	メールのアクション リンク文字列を解析し、リンクが有効な場合は ActionCodeURL を返し、それ以外の場合は null を返します。

ActionCodeURL.apiKey のキー

メールのアクション リンクの API キー。

署名:

readonly apiKey: string;

ActionCodeURL.code

メールのアクション リンクのアクション コード。

署名:

readonly code: string;

ActionCodeURL.continueUrl

メール アクション リンクの続行 URL。指定されていない場合は null。

署名:

readonly continueUrl: string | null;

ActionCodeURL.languageCode

メールのアクション リンクの言語コード。指定しない場合は 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;

パラメータ

パラメータ	型	説明
リンク	文字列	メールのアクション リンクの文字列。

戻り値:

ActionCodeURL |null

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