UNPKG

voluptasmollitia

Version:
36 lines (23 loc) 1.88 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@firebase/auth](./auth.md) &gt; [ActionCodeURL](./auth.actioncodeurl.md) ## ActionCodeURL class A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. <b>Signature:</b> ```typescript export declare class ActionCodeURL ``` ## Remarks 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. ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [apiKey](./auth.actioncodeurl.apikey.md) | | string | The API key of the email action link. | | [code](./auth.actioncodeurl.code.md) | | string | The action code of the email action link. | | [continueUrl](./auth.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. | | [languageCode](./auth.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. | | [operation](./auth.actioncodeurl.operation.md) | | [ActionCodeOperation](./auth.actioncodeoperation.md) | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth.actioncodeinfo.md) | | [tenantId](./auth.actioncodeurl.tenantid.md) | | 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)](./auth.actioncodeurl.parselink.md) | <code>static</code> | Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md) if the link is valid, otherwise returns null. |