iOS SDK Version
FBSDKLoginKit Reference

FBSDKLoginConfiguration

@interfaceFBSDKLoginConfiguration:NSObject
A configuration to use for modifying the behavior of a login attempt.
  • The nonce that the configuration was created with. A unique nonce will be used if none is provided to the initializer.

    Declaration

    Objective-C
    @property(nonatomic,copy,readonly)NSString*_Nonnullnonce;
    Swift
    varnonce:String{get}
  • The tracking preference. Defaults to .enabled.

    Declaration

    Objective-C
    @property(nonatomic,readonly)FBSDKLoginTrackingtracking;
    Swift
    vartracking:LoginTracking{get}
  • The requested permissions for the login attempt. Defaults to an empty set.

    Declaration

    Objective-C
    @property(nonatomic,copy,readonly)NSSet<FBSDKPermission*>*_NonnullrequestedPermissions;
    Swift
    varrequestedPermissions:Set<AnyHashable>{get}
  • The Messenger Page Id associated with this login request.

    Declaration

    Objective-C
    @property(nonatomic,copy,readonly,nullable)NSString*messengerPageId;
    Swift
    varmessengerPageId:String?{get}
  • The auth type associated with this login request.

    Declaration

    Objective-C
    @property(nonatomic,readonly,nullable)FBSDKLoginAuthTypeauthType;
    Swift
    varauthType:LoginAuthType?{get}
  • Unavailable
    Undocumented

    Declaration

    Objective-C
    -(instancetype)initNS_UNAVAILABLE;
  • Unavailable
    Undocumented

    Declaration

    Objective-C
    +(instancetype)newNS_UNAVAILABLE;
  • Attempts to initialize a new configuration with the expected parameters.

    Declaration

    Objective-C
    -(nullableinstancetype)initWithPermissions:(nonnullNSArray<NSString*>*)permissionstracking:(FBSDKLoginTracking)trackingnonce:(nonnullNSString*)noncemessengerPageId:(nullableNSString*)messengerPageId;

    Parameters

  • Attempts to initialize a new configuration with the expected parameters.

    Declaration

    Objective-C
    -(nullableinstancetype)initWithPermissions:(nonnullNSArray<NSString*>*)permissionstracking:(FBSDKLoginTracking)trackingnonce:(nonnullNSString*)noncemessengerPageId:(nullableNSString*)messengerPageIdauthType:(nullableFBSDKLoginAuthType)authType;

    Parameters

  • Attempts to initialize a new configuration with the expected parameters.

    Declaration

    Objective-C
    -(nullableinstancetype)initWithPermissions:(nonnullNSArray<NSString*>*)permissionstracking:(FBSDKLoginTracking)trackingnonce:(nonnullNSString*)nonce;

    Parameters

  • Attempts to initialize a new configuration with the expected parameters.

    Declaration

    Objective-C
    -(nullableinstancetype)initWithPermissions:(nonnullNSArray<NSString*>*)permissionstracking:(FBSDKLoginTracking)trackingmessengerPageId:(nullableNSString*)messengerPageId;

    Parameters

  • Attempts to initialize a new configuration with the expected parameters.

    Declaration

    Objective-C
    -(nullableinstancetype)initWithPermissions:(nonnullNSArray<NSString*>*)permissionstracking:(FBSDKLoginTracking)trackingmessengerPageId:(nullableNSString*)messengerPageIdauthType:(nullableFBSDKLoginAuthType)authType;

    Parameters

  • Attempts to initialize a new configuration with the expected parameters.

    Declaration

    Objective-C
    -(nullableinstancetype)initWithPermissions:(nonnullNSArray<NSString*>*)permissionstracking:(FBSDKLoginTracking)tracking;

    Parameters

  • Attempts to initialize a new configuration with the expected parameters.

    Declaration

    Objective-C
    -(nullableinstancetype)initWithTracking:(FBSDKLoginTracking)tracking;

    Parameters

  • Given a string, return the corresponding FBSDKLoginAuthType. Returns nil if the string cannot be mapped to a valid auth type

    Declaration

    Objective-C
    +(nullableFBSDKLoginAuthType)authTypeForString:(nonnullNSString*)rawValue;
    Swift
    classfuncauthType(forrawValue:String)->LoginAuthType?

    Parameters

  • Attempts to allocate and initialize a new configuration with the expected parameters.

    Declaration

    Swift
    convenienceinit?(permissions:Set<Permission>=[],tracking:LoginTracking=.enabled,nonce:String=UUID().uuidString,messengerPageId:String?=nil,authType:LoginAuthType?=.rerequest)

    Parameters