ActionCodeURL class

A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ActionCodeURL class.

Signature:

exportdeclareclassActionCodeURL

Properties

PropertyModifiersTypeDescription
apiKeystringThe API key of the email action link.
codestringThe action code of the email action link.
continueUrlstring | nullThe continue URL of the email action link. Null if not provided.
languageCodestring | nullThe language code of the email action link. Null if not provided.
operationstringThe action performed by the email action link. It returns from one of the types from ActionCodeInfo
tenantIdstring | nullThe tenant ID of the email action link. Null if the email action is from the parent project.

Methods

MethodModifiersDescription
parseLink(link)staticParses the email action link string and returns an ActionCodeURL if the link is valid, otherwise returns null.

ActionCodeURL.apiKey

The API key of the email action link.

Signature:

readonlyapiKey:string;

ActionCodeURL.code

The action code of the email action link.

Signature:

readonlycode:string;

ActionCodeURL.continueUrl

The continue URL of the email action link. Null if not provided.

Signature:

readonlycontinueUrl:string|null;

ActionCodeURL.languageCode

The language code of the email action link. Null if not provided.

Signature:

readonlylanguageCode:string|null;

ActionCodeURL.operation

The action performed by the email action link. It returns from one of the types from ActionCodeInfo

Signature:

readonlyoperation:string;

ActionCodeURL.tenantId

The tenant ID of the email action link. Null if the email action is from the parent project.

Signature:

readonlytenantId:string|null;

Parses the email action link string and returns an ActionCodeURL if the link is valid, otherwise returns null.

Signature:

staticparseLink(link:string):ActionCodeURL|null;

Parameters

ParameterTypeDescription
linkstringThe email action link string.

Returns:

ActionCodeURL | null

The ActionCodeURL object, or null if the link is invalid.