ActionCodeResult

interfaceActionCodeResult


Interface for holding the information related to an out of band code.

Summary

Nested types

@IntDef(value = )
@Retention(value = RetentionPolicy.SOURCE)
annotationActionCodeResult.ActionDataKey

Keys to access the account information related to an out of band code.

@IntDef(value = )
@Retention(value = RetentionPolicy.SOURCE)
annotationActionCodeResult.Operation

Holds the possible operations that an out of band code can perform, which are password reset, verify email, and recover email.

Constants

constInt
EMAIL = 0

Represents anActionDataKey which is used to key calls togetData.

constInt
ERROR = 3

Represents anOperation signifying that there was some error in determining what the out of band code is for.

constInt

Represents anActionDataKey which is used to key calls togetData.

constInt

Represents anOperation signifying that the out of band code was for a password reset.

constInt

Represents anOperation signifying that the out of band code was for email recovery.

constInt

Represents anOperation signifying that the out of band code was for reverting a second factor addition.

constInt

Represents anOperation signifying that the out of band code was for signing in a user via an email link.

constInt

Represents anOperation signifying that the out of band code was for verifying and updating the user's email.

constInt

Represents anOperation signifying that the out of band code was for email verification.

Public functions

String?

This function is deprecated.

UsegetInfo.

ActionCodeInfo?

Returns anActionCodeInfo object that holds information regarding the operation being performed.

Int

Returns theOperation for which this out of band code was intended.

Constants

EMAIL

const val EMAIL = 0: Int

Represents anActionDataKey which is used to key calls togetData. This signifies the email before the application of the out of band code.

ERROR

const val ERROR = 3: Int

Represents anOperation signifying that there was some error in determining what the out of band code is for.

FROM_EMAIL

const val FROM_EMAIL = 1: Int

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

const val PASSWORD_RESET = 0: Int

Represents anOperation signifying that the out of band code was for a password reset.

RECOVER_EMAIL

const val RECOVER_EMAIL = 2: Int

Represents anOperation signifying that the out of band code was for email recovery.

REVERT_SECOND_FACTOR_ADDITION

const val REVERT_SECOND_FACTOR_ADDITION = 6: Int

Represents anOperation signifying that the out of band code was for reverting a second factor addition.

SIGN_IN_WITH_EMAIL_LINK

const val SIGN_IN_WITH_EMAIL_LINK = 4: Int

Represents anOperation signifying that the out of band code was for signing in a user via an email link.

VERIFY_BEFORE_CHANGE_EMAIL

const val VERIFY_BEFORE_CHANGE_EMAIL = 5: Int

Represents anOperation signifying that the out of band code was for verifying and updating the user's email.

VERIFY_EMAIL

const val VERIFY_EMAIL = 1: Int

Represents anOperation signifying that the out of band code was for email verification.

Public functions

getData

fun getData(@ActionCodeResult.ActionDataKey key: Int): String?
This function is deprecated.

UsegetInfo.

Getter for fields pertaining to the operation being performed. Keyed byActionDataKey.

getInfo

fun getInfo(): ActionCodeInfo?

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
fun getOperation(): Int

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.