ActionCodeURL class Stay organized with collections Save and categorize content based on your preferences.
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 theActionCodeURL class.
Signature:
exportdeclareclassActionCodeURLProperties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| apiKey | string | The API key of the email action link. | |
| code | string | The action code of the email action link. | |
| continueUrl | string | null | The continue URL of the email action link. Null if not provided. | |
| languageCode | string | null | The language code of the email action link. Null if not provided. | |
| operation | string | The action performed by the email action link. It returns from one of the types fromActionCodeInfo | |
| tenantId | string | null | The tenant ID of the email action link. Null if the email action is from the parent project. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| parseLink(link) | static | Parses the email action link string and returns anActionCodeURL 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 fromActionCodeInfo
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;ActionCodeURL.parseLink()
Parses the email action link string and returns anActionCodeURL if the link is valid, otherwise returns null.
Signature:
staticparseLink(link:string):ActionCodeURL|null;Parameters
| Parameter | Type | Description |
|---|---|---|
| link | string | The email action link string. |
Returns:
ActionCodeURL | null
TheActionCodeURL object, or null if the link is invalid.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-01-19 UTC.