FirebaseAuth Framework Reference

FIRMultiFactor


@interface FIRMultiFactor : NSObject

The interface defining the multi factor related properties and operations pertaining to a user. This class is available on iOS only.

  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic, readonly) NSArray<FIRMultiFactorInfo *> *enrolledFactors
  • Get a session for a second factor enrollment operation.

    Declaration

    Objective-C

    - (void)getSessionWithCompletion:
        (nullable void (^)(FIRMultiFactorSession *_Nullable,
                           NSError *_Nullable))completion;

    Parameters

    completion

    A block with the session identifier for a second factor enrollment operation. This is used to identify the current user trying to enroll a second factor.

  • Enrolls a second factor as identified by the MultiFactorAssertion parameter for the current user.

    Declaration

    Objective-C

    - (void)enrollWithAssertion:(nonnull FIRMultiFactorAssertion *)assertion
                    displayName:(nullable NSString *)displayName
                     completion:(nullable void (^)(NSError *_Nullable))completion;

    Parameters

    displayName

    An optional display name associated with the multi factor to enroll.

    completion

    The block invoked when the request is complete, or fails.

  • Unenroll the given multi factor.

    Declaration

    Objective-C

    - (void)unenrollWithInfo:(nonnull FIRMultiFactorInfo *)factorInfo
                  completion:(nullable void (^)(NSError *_Nullable))completion;

    Parameters

    completion

    The block invoked when the request to send the verification email is complete, or fails.

  • Unenroll the given multi factor.

    Declaration

    Objective-C

    - (void)unenrollWithFactorUID:(nonnull NSString *)factorUID
                       completion:(nullable void (^)(NSError *_Nullable))completion;

    Parameters

    completion

    The block invoked when the request to send the verification email is complete, or fails.