FirebaseAuth Framework Reference

FIRMultiFactor

@interfaceFIRMultiFactor: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:(nullablevoid(^)(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 theMultiFactorAssertion parameter for the current user.

    Declaration

    Objective-C

    -(void)enrollWithAssertion:(nonnullFIRMultiFactorAssertion*)assertiondisplayName:(nullableNSString*)displayNamecompletion:(nullablevoid(^)(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:(nonnullFIRMultiFactorInfo*)factorInfocompletion:(nullablevoid(^)(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:(nonnullNSString*)factorUIDcompletion:(nullablevoid(^)(NSError*_Nullable))completion;

    Parameters

    completion

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

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 2022-05-04 UTC.