iOS SDK Version

FBSDKSettings

@interfaceFBSDKSettings:NSObject-(instancetype)initNS_UNAVAILABLE;+(instancetype)newNS_UNAVAILABLE;/** Retrieve the current iOS SDK version. */@property(class,nonatomic,copy,readonly)NSString*sdkVersion;/** Retrieve the current default Graph API version. */@property(class,nonatomic,copy,readonly)NSString*defaultGraphAPIVersion;/** The quality of JPEG images sent to Facebook from the SDK, expressed as a value from 0.0 to 1.0. If not explicitly set, the default is 0.9. @see [UIImageJPEGRepresentation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIKitFunctionReference/#//apple_ref/c/func/UIImageJPEGRepresentation) */@property(class,nonatomic,assign)CGFloatJPEGCompressionQualityNS_SWIFT_NAME(jpegCompressionQuality);/** Controls sdk auto initailization. If not explicitly set, the default is true */@property(class,nonatomic,assign,getter=isAutoInitEnabled)BOOLautoInitEnabled;/** Controls the auto logging of basic app events, such as activateApp and deactivateApp. If not explicitly set, the default is true */@property(class,nonatomic,assign,getter=isAutoLogAppEventsEnabled)BOOLautoLogAppEventsEnabled;/** Controls the fb_codeless_debug logging event If not explicitly set, the default is true */@property(class,nonatomic,assign,getter=isCodelessDebugLogEnabled)BOOLcodelessDebugLogEnabled;/** Controls the fb_codeless_debug logging event If not explicitly set, the default is true */@property(class,nonatomic,assign,getter=isAdvertiserIDCollectionEnabled)BOOLadvertiserIDCollectionEnabled;/** Whether data such as that generated through FBSDKAppEvents and sent to Facebook should be restricted from being used for other than analytics and conversions. Defaults to NO. This value is stored on the device and persists across app launches. */@property(class,nonatomic,assign,getter=shouldLimitEventAndDataUsage)BOOLlimitEventAndDataUsage;/** A convenient way to toggle error recovery for all FBSDKGraphRequest instances created after this is set. */@property(class,nonatomic,assign,getter=isGraphErrorRecoveryEnabled)BOOLgraphErrorRecoveryEnabled;/** The Facebook App ID used by the SDK. If not explicitly set, the default will be read from the application's plist (FacebookAppID). */@property(class,nonatomic,copy,nullable)NSString*appID;/** The default url scheme suffix used for sessions. If not explicitly set, the default will be read from the application's plist (FacebookUrlSchemeSuffix). */@property(class,nonatomic,copy,nullable)NSString*appURLSchemeSuffix;/** The Client Token that has been set via [FBSDKSettings setClientToken]. This is needed for certain API calls when made anonymously, without a user-based access token. The Facebook App's "client token", which, for a given appid can be found in the Security section of the Advanced tab of the Facebook App settings found at <https://developers.facebook.com/apps/[your-app-id]> If not explicitly set, the default will be read from the application's plist (FacebookClientToken). */@property(class,nonatomic,copy,nullable)NSString*clientToken;/** The Facebook Display Name used by the SDK. This should match the Display Name that has been set for the app with the corresponding Facebook App ID, in the Facebook App Dashboard. If not explicitly set, the default will be read from the application's plist (FacebookDisplayName). */@property(class,nonatomic,copy,nullable)NSString*displayName;/** The Facebook domain part. This can be used to change the Facebook domain (e.g. @"beta") so that requests will be sent to `graph.beta.facebook.com` If not explicitly set, the default will be read from the application's plist (FacebookDomainPart). */@property(class,nonatomic,copy,nullable)NSString*facebookDomainPart;/** The current Facebook SDK logging behavior. This should consist of strings defined as constants with FBSDKLoggingBehavior*. This should consist a set of strings indicating what information should be logged defined as constants with FBSDKLoggingBehavior*. Set to an empty set in order to disable all logging. You can also define this via an array in your app plist with key "FacebookLoggingBehavior" or add and remove individual values via enableLoggingBehavior: or disableLogginBehavior: The default is a set consisting of FBSDKLoggingBehaviorDeveloperErrors */@property(class,nonatomic,copy)NSSet<FBSDKLoggingBehavior>*loggingBehaviorsNS_REFINED_FOR_SWIFT;/** Overrides the default Graph API version to use with `FBSDKGraphRequests`. This overrides `FBSDK_TARGET_PLATFORM_VERSION`. The string should be of the form `@"v2.7"`. Defaults to `FBSDK_TARGET_PLATFORM_VERSION`. */@property(class,nonatomic,copy,null_resettable)NSString*graphAPIVersion;/** Set the data processing options. @param options list of options */+(void)setDataProcessingOptions:(nullableNSArray<NSString*>*)options;/** Set the data processing options. @param options list of the options @param country code of the country @param state code of the state */+(void)setDataProcessingOptions:(nullableNSArray<NSString*>*)optionscountry:(int)countrystate:(int)state;/** Enable a particular Facebook SDK logging behavior. @param loggingBehavior The LoggingBehavior to enable. This should be a string defined as a constant with FBSDKLoggingBehavior*. */+(void)enableLoggingBehavior:(FBSDKLoggingBehavior)loggingBehavior;/** Disable a particular Facebook SDK logging behavior. @param loggingBehavior The LoggingBehavior to disable. This should be a string defined as a constant with FBSDKLoggingBehavior*. */+(void)disableLoggingBehavior:(FBSDKLoggingBehavior)loggingBehavior;@end
Undocumented
  • Unavailable
    Undocumented

    Declaration

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

    Declaration

    Objective-C
    +(instancetype)newNS_UNAVAILABLE;
  • Retrieve the current iOS SDK version.

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readonly)NSString*_NonnullsdkVersion;
    Swift
    classvarsdkVersion:String{get}
  • Retrieve the current default Graph API version.

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readonly)NSString*_NonnulldefaultGraphAPIVersion;
    Swift
    classvardefaultGraphAPIVersion:String{get}
  • The quality of JPEG images sent to Facebook from the SDK, expressed as a value from 0.0 to 1.0.
    If not explicitly set, the default is 0.9.

    Declaration

    Objective-C
    @property(class,nonatomic,assign,unsafe_unretained,readwrite)CGFloatJPEGCompressionQuality;
    Swift
    classvarjpegCompressionQuality:CGFloat{getset}
  • Controls sdk auto initailization. If not explicitly set, the default is true

    Declaration

    Objective-C
    @property(class,nonatomic,assign,unsafe_unretained,readwrite,getter=isAutoInitEnabled)BOOLautoInitEnabled;
    Swift
    classvarisAutoInitEnabled:Bool{getset}
  • Controls the auto logging of basic app events, such as activateApp and deactivateApp. If not explicitly set, the default is true

    Declaration

    Objective-C
    @property(class,nonatomic,assign,unsafe_unretained,readwrite,getter=isAutoLogAppEventsEnabled)BOOLautoLogAppEventsEnabled;
    Swift
    classvarisAutoLogAppEventsEnabled:Bool{getset}
  • Controls the fb_codeless_debug logging event If not explicitly set, the default is true

    Declaration

    Objective-C
    @property(class,nonatomic,assign,unsafe_unretained,readwrite,getter=isCodelessDebugLogEnabled)BOOLcodelessDebugLogEnabled;
    Swift
    classvarisCodelessDebugLogEnabled:Bool{getset}
  • Controls the fb_codeless_debug logging event If not explicitly set, the default is true

    Declaration

    Objective-C
    @property(class,nonatomic,assign,unsafe_unretained,readwrite,getter=isAdvertiserIDCollectionEnabled)BOOLadvertiserIDCollectionEnabled;
    Swift
    classvarisAdvertiserIDCollectionEnabled:Bool{getset}
  • Whether data such as that generated through FBSDKAppEvents and sent to Facebook should be restricted from being used for other than analytics and conversions. Defaults to NO. This value is stored on the device and persists across app launches.

    Declaration

    Objective-C
    @property(class,nonatomic,assign,unsafe_unretained,readwrite,getter=shouldLimitEventAndDataUsage)BOOLlimitEventAndDataUsage;
    Swift
    classvarshouldLimitEventAndDataUsage:Bool{getset}
  • A convenient way to toggle error recovery for all FBSDKGraphRequest instances created after this is set.

    Declaration

    Objective-C
    @property(class,nonatomic,assign,unsafe_unretained,readwrite,getter=isGraphErrorRecoveryEnabled)BOOLgraphErrorRecoveryEnabled;
    Swift
    classvarisGraphErrorRecoveryEnabled:Bool{getset}
  • The Facebook App ID used by the SDK.
    If not explicitly set, the default will be read from the application’s plist (FacebookAppID).

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readwrite,nullable)NSString*appID;
    Swift
    classvarappID:String?{getset}
  • The default url scheme suffix used for sessions.
    If not explicitly set, the default will be read from the application’s plist (FacebookUrlSchemeSuffix).

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readwrite,nullable)NSString*appURLSchemeSuffix;
    Swift
    classvarappURLSchemeSuffix:String?{getset}
  • The Client Token that has been set via [FBSDKSettings setClientToken]. This is needed for certain API calls when made anonymously, without a user-based access token.
    The Facebook App’s “client token”, which, for a given appid can be found in the Security section of the Advanced tab of the Facebook App settings found at https://developers.facebook.com/apps/[your-app-id]
    If not explicitly set, the default will be read from the application’s plist (FacebookClientToken).

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readwrite,nullable)NSString*clientToken;
    Swift
    classvarclientToken:String?{getset}
  • The Facebook Display Name used by the SDK.
    This should match the Display Name that has been set for the app with the corresponding Facebook App ID, in the Facebook App Dashboard.
    If not explicitly set, the default will be read from the application’s plist (FacebookDisplayName).

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readwrite,nullable)NSString*displayName;
    Swift
    classvardisplayName:String?{getset}
  • The Facebook domain part. This can be used to change the Facebook domain (e.g. @“beta”) so that requests will be sent to graph.beta.facebook.com
    If not explicitly set, the default will be read from the application’s plist (FacebookDomainPart).

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readwrite,nullable)NSString*facebookDomainPart;
    Swift
    classvarfacebookDomainPart:String?{getset}
  • The current Facebook SDK logging behavior. This should consist of strings defined as constants with FBSDKLoggingBehavior*.
    This should consist a set of strings indicating what information should be logged defined as constants with FBSDKLoggingBehavior*. Set to an empty set in order to disable all logging.
    You can also define this via an array in your app plist with key “FacebookLoggingBehavior” or add and remove individual values via enableLoggingBehavior: or disableLogginBehavior:
    The default is a set consisting of FBSDKLoggingBehaviorDeveloperErrors

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readwrite)NS_REFINED_FOR_SWIFTNSSet<NSString*>*loggingBehaviors;
    Swift
    classvar__loggingBehaviors:Set<String>{getset}
  • Overrides the default Graph API version to use with FBSDKGraphRequests. This overrides FBSDK_TARGET_PLATFORM_VERSION.
    The string should be of the form @"v2.7".
    Defaults to FBSDK_TARGET_PLATFORM_VERSION.

    Declaration

    Objective-C
    @property(class,nonatomic,copy,readwrite,null_resettable)NSString*graphAPIVersion;
    Swift
    classvargraphAPIVersion:String!{getset}
  • Set the data processing options.

    Declaration

    Objective-C
    +(void)setDataProcessingOptions:(nullableNSArray<NSString*>*)options;
    Swift
    classfuncsetDataProcessingOptions(_options:[String]?)

    Parameters

    options
    list of options
  • Set the data processing options.

    Declaration

    Objective-C
    +(void)setDataProcessingOptions:(nullableNSArray<NSString*>*)optionscountry:(int)countrystate:(int)state;
    Swift
    classfuncsetDataProcessingOptions(_options:[String]?,country:Int32,state:Int32)

    Parameters

    options
    list of the options
    country
    code of the country
    state
    code of the state
  • Enable a particular Facebook SDK logging behavior.

    Declaration

    Objective-C
    +(void)enableLoggingBehavior:(nonnullFBSDKLoggingBehavior)loggingBehavior;
    Swift
    classfuncenableLoggingBehavior(_loggingBehavior:LoggingBehavior)

    Parameters

    loggingBehavior
    The LoggingBehavior to enable. This should be a string defined as a constant with FBSDKLoggingBehavior*.
  • Disable a particular Facebook SDK logging behavior.

    Declaration

    Objective-C
    +(void)disableLoggingBehavior:(nonnullFBSDKLoggingBehavior)loggingBehavior;
    Swift
    classfuncdisableLoggingBehavior(_loggingBehavior:LoggingBehavior)

    Parameters

    loggingBehavior
    The LoggingBehavior to disable. This should be a string defined as a constant with FBSDKLoggingBehavior*.