ActionCodeInfo interface

A response fromcheckActionCode().

Signature:

exportinterfaceActionCodeInfo

Properties

PropertyTypeDescription
data{ email?: string | null; multiFactorInfo?:MultiFactorInfo | null; previousEmail?: string | null; }The data associated with the action code.
operation(typeofActionCodeOperationMap)[keyof typeofActionCodeOperationMap]The type of operation that generated the action code.

ActionCodeInfo.data

The data associated with the action code.

For theActionCodeOperation.PASSWORD_RESET,ActionCodeOperation.VERIFY_EMAIL, andActionCodeOperation.RECOVER_EMAIL actions, this object contains an email field with the address the email was sent to.

For theActionCodeOperation.RECOVER_EMAIL action, which allows a user to undo an email address change, this object also contains apreviousEmail field with the user account's current email address. After the action completes, the user's email address will revert to the value in theemail field from the value inpreviousEmail field.

For theActionCodeOperation.VERIFY_AND_CHANGE_EMAIL action, which allows a user to verify the email before updating it, this object contains apreviousEmail field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in theemail field from the value inpreviousEmail field.

For theActionCodeOperation.REVERT_SECOND_FACTOR_ADDITION action, which allows a user to unenroll a newly added second factor, this object contains amultiFactorInfo field with the information about the second factor. For phone second factor, themultiFactorInfo is aMultiFactorInfo object, which contains the phone number.

Signature:

data:{email?:string|null;multiFactorInfo?:MultiFactorInfo|null;previousEmail?:string|null;};

ActionCodeInfo.operation

The type of operation that generated the action code.

Signature:

operation:(typeofActionCodeOperationMap)[keyoftypeofActionCodeOperationMap];

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.