ActionCodeResult
public interfaceActionCodeResult
Interface for holding the information related to an out of band code.
Summary
Nested types |
|---|
@IntDef(value = )Keys to access the account information related to an out of band code. |
@IntDef(value = )Holds the possible operations that an out of band code can perform, which are password reset, verify email, and recover email. |
Constants | |
|---|---|
default static final int | EMAIL = 0Represents an |
default static final int | ERROR = 3Represents an |
default static final int | FROM_EMAIL = 1Represents an |
default static final int | PASSWORD_RESET = 0Represents an |
default static final int | RECOVER_EMAIL = 2Represents an |
default static final int | Represents an |
default static final int | Represents an |
default static final int | Represents an |
default static final int | VERIFY_EMAIL = 1Represents an |
Public methods | |
|---|---|
abstract @NullableString | This method is deprecated. Use |
abstract @NullableActionCodeInfo | getInfo()Returns an |
abstract int | Returns the |
Constants
default static final int EMAIL = 0
Represents anActionDataKey which is used to key calls togetData. This signifies the email before the application of the out of band code.
ERROR
default static final int ERROR = 3
Represents anOperation signifying that there was some error in determining what the out of band code is for.
FROM_EMAIL
default static final int FROM_EMAIL = 1
Represents anActionDataKey which is used to key calls togetData. This signifies the current email associated with the account, which may have changed as a result of theOperation performed.
PASSWORD_RESET
default static final int PASSWORD_RESET = 0
Represents anOperation signifying that the out of band code was for a password reset.
RECOVER_EMAIL
default static final int RECOVER_EMAIL = 2
Represents anOperation signifying that the out of band code was for email recovery.
REVERT_SECOND_FACTOR_ADDITION
default static final int REVERT_SECOND_FACTOR_ADDITION = 6
Represents anOperation signifying that the out of band code was for reverting a second factor addition.
SIGN_IN_WITH_EMAIL_LINK
default static final int SIGN_IN_WITH_EMAIL_LINK = 4
Represents anOperation signifying that the out of band code was for signing in a user via an email link.
VERIFY_BEFORE_CHANGE_EMAIL
default static final int VERIFY_BEFORE_CHANGE_EMAIL = 5
Represents anOperation signifying that the out of band code was for verifying and updating the user's email.
VERIFY_EMAIL
default static final int VERIFY_EMAIL = 1
Represents anOperation signifying that the out of band code was for email verification.
Public methods
getData
abstract @NullableStringgetData(@ActionCodeResult.ActionDataKey int key)
UsegetInfo.
Getter for fields pertaining to the operation being performed. Keyed byActionDataKey.
getInfo
abstract @NullableActionCodeInfo getInfo()
Returns anActionCodeInfo object that holds information regarding the operation being performed.
ForVERIFY_EMAIL andPASSWORD_RESET operations, this will be anActionCodeInfo
For aREVERT_SECOND_FACTOR_ADDITION operation, this will be anActionCodeMultiFactorInfo
ForRECOVER_EMAIL andVERIFY_BEFORE_CHANGE_EMAIL operations, this will return
For aSIGN_IN_WITH_EMAIL_LINK operation, this will return null.
Returns null if an error occurred.
getOperation
@ActionCodeResult.Operation
abstract int getOperation()
Returns theOperation for which this out of band code was intended.
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 2025-07-21 UTC.