ActionCodeResult

public interface ActionCodeResult

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

Summary

Nested types
@IntDef(value = )
@Retention(value = RetentionPolicy.SOURCE)
public annotation ActionCodeResult.ActionDataKey

Keys to access the account information related to an out of band code.
@IntDef(value = )
@Retention(value = RetentionPolicy.SOURCE)
public annotation ActionCodeResult.Operation

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 = 0

Represents an ActionDataKey which is used to key calls to getData.
default static final int
ERROR = 3

Represents an Operation signifying that there was some error in determining what the out of band code is for.
default static final int

Represents an ActionDataKey which is used to key calls to getData.
default static final int

Represents an Operation signifying that the out of band code was for a password reset.
default static final int

Represents an Operation signifying that the out of band code was for email recovery.
default static final int

Represents an Operation signifying that the out of band code was for reverting a second factor addition.
default static final int

Represents an Operation signifying that the out of band code was for signing in a user via an email link.
default static final int

Represents an Operation signifying that the out of band code was for verifying and updating the user's email.
default static final int

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

Public methods
abstract @Nullable String

This method is deprecated.

Use getInfo.
abstract @Nullable ActionCodeInfo

Returns an ActionCodeInfo object that holds information regarding the operation being performed.
abstract int

Returns the Operation for which this out of band code was intended.

Constants

EMAIL

default static final int EMAIL = 0

Represents an ActionDataKey which is used to key calls to getData. This signifies the email before the application of the out of band code.

ERROR

default static final int ERROR = 3

Represents an Operation 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 an ActionDataKey which is used to key calls to getData. This signifies the current email associated with the account, which may have changed as a result of the Operation performed.

PASSWORD_RESET

default static final int PASSWORD_RESET = 0

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

RECOVER_EMAIL

default static final int RECOVER_EMAIL = 2

Represents an Operation 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 an Operation 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 an Operation 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 an Operation 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 an Operation signifying that the out of band code was for email verification.

Public methods

getData

abstract @Nullable String getData(@ActionCodeResult.ActionDataKey int key)

Getter for fields pertaining to the operation being performed. Keyed by ActionDataKey.

getInfo

abstract @Nullable ActionCodeInfo getInfo()

Returns an ActionCodeInfo object that holds information regarding the operation being performed.

For VERIFY_EMAIL and PASSWORD_RESET operations, this will be an ActionCodeInfo

For a REVERT_SECOND_FACTOR_ADDITION operation, this will be an ActionCodeMultiFactorInfo

For RECOVER_EMAIL and VERIFY_BEFORE_CHANGE_EMAIL operations, this will return

For a SIGN_IN_WITH_EMAIL_LINK operation, this will return null.

Returns null if an error occurred.

getOperation

@ActionCodeResult.Operation
abstract int getOperation()

Returns the Operation for which this out of band code was intended.