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 the ActionCodeURL class.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-01-19 UTC."],[],[],null,["# ActionCodeURL class\n\nA utility class to parse email action URLs such as password reset, email verification, email link sign in, etc.\n\nThe 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.\n\n**Signature:** \n\n export declare class ActionCodeURL \n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|-------------------------------------------------------------------|-----------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [apiKey](./auth.actioncodeurl.md#actioncodeurlapikey) | | string | The API key of the email action link. |\n| [code](./auth.actioncodeurl.md#actioncodeurlcode) | | string | The action code of the email action link. |\n| [continueUrl](./auth.actioncodeurl.md#actioncodeurlcontinueurl) | | string \\| null | The continue URL of the email action link. Null if not provided. |\n| [languageCode](./auth.actioncodeurl.md#actioncodeurllanguagecode) | | string \\| null | The language code of the email action link. Null if not provided. |\n| [operation](./auth.actioncodeurl.md#actioncodeurloperation) | | string | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth.actioncodeinfo.md#actioncodeinfo_interface) |\n| [tenantId](./auth.actioncodeurl.md#actioncodeurltenantid) | | string \\| null | The tenant ID of the email action link. Null if the email action is from the parent project. |\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|-------------------------------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [parseLink(link)](./auth.actioncodeurl.md#actioncodeurlparselink) | `static` | Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null. |\n\nActionCodeURL.apiKey\n--------------------\n\nThe API key of the email action link.\n\n**Signature:** \n\n readonly apiKey: string;\n\nActionCodeURL.code\n------------------\n\nThe action code of the email action link.\n\n**Signature:** \n\n readonly code: string;\n\nActionCodeURL.continueUrl\n-------------------------\n\nThe continue URL of the email action link. Null if not provided.\n\n**Signature:** \n\n readonly continueUrl: string | null;\n\nActionCodeURL.languageCode\n--------------------------\n\nThe language code of the email action link. Null if not provided.\n\n**Signature:** \n\n readonly languageCode: string | null;\n\nActionCodeURL.operation\n-----------------------\n\nThe action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth.actioncodeinfo.md#actioncodeinfo_interface)\n\n**Signature:** \n\n readonly operation: string;\n\nActionCodeURL.tenantId\n----------------------\n\nThe tenant ID of the email action link. Null if the email action is from the parent project.\n\n**Signature:** \n\n readonly tenantId: string | null;\n\nActionCodeURL.parseLink()\n-------------------------\n\nParses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) if the link is valid, otherwise returns null.\n\n**Signature:** \n\n static parseLink(link: string): ActionCodeURL | null;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-----------|--------|-------------------------------|\n| link | string | The email action link string. |\n\n**Returns:**\n\n[ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) \\| null\n\nThe [ActionCodeURL](./auth.actioncodeurl.md#actioncodeurl_class) object, or null if the link is invalid."]]
