FBSettings
This class is no longer available in the most recent version of the SDK.
A more recent version of this class is available. Check out the latest version.

Allows configuration of SDK behavior.

Inherits from:NSObject
Declared in:FBSettings.h
Class Methods
appVersion

This method is deprecated -- App Events favors using bundle identifiers to this.

+ (NSString *) appVersion __attribute__((deprecated("App Events favors use of bundle identifiers for version identification.")));
Declared In: FBSettings.h
clientToken

Retrieve the Client Token that has been set via [FBSettings setClientToken]

+ (NSString *) clientToken;
Declared In: FBSettings.h
defaultAppID

Get the default Facebook App ID used by the SDK. If not explicitly set, the default will be read from the application's plist. The SDK allows the appID to be overridden per instance in certain cases (e.g. per instance of FBSession)

+ (NSString *) defaultAppID;
Declared In: FBSettings.h
defaultDisplayName

Get the default Facebook Display Name used by the SDK. If not explicitly set, the default will be read from the application's plist.

+ (NSString *) defaultDisplayName;
Declared In: FBSettings.h
defaultUrlSchemeSuffix

Get the default url scheme suffix used for sessions. If not explicitly set, the default will be read from the application's plist value for 'FacebookUrlSchemeSuffix'.

+ (NSString *) defaultUrlSchemeSuffix;
Declared In: FBSettings.h
disableBetaFeature:

Disables a beta feature.

ParameterDescription
betaFeature

The beta feature to disable.

+ (void) disableBetaFeature:(FBBetaFeatures)betaFeature;
Declared In: FBSettings.h
enableBetaFeature:

Enables a beta feature. Beta features are for evaluation only, and are therefore only enabled for debug builds. Beta features should not be enabled in release builds.

ParameterDescription
betaFeature

The beta feature to enable.

+ (void) enableBetaFeature:(FBBetaFeatures)betaFeature;
Declared In: FBSettings.h
enableBetaFeatures:

Enables the specified beta features. Beta features are for evaluation only, and are therefore only enabled for debug builds. Beta features should not be enabled in release builds.

ParameterDescription
betaFeatures

The beta features to enable (expects a bitwise OR of FBBetaFeatures)

+ (void) enableBetaFeatures:(NSUInteger)betaFeatures;
Declared In: FBSettings.h
enablePlatformCompatibility:

Configures the SDK to use the legacy platform.

ParameterDescription
enable

Indicates whether to use the legacy mode

+ (void) enablePlatformCompatibility:(BOOL)enable;
Discussion:

Setting this flag has several effects: - FBRequests will target v1.0 of the Graph API. - Login will use the prior behavior without abilities to decline permission. - Specific new features such as FBLikeButton that require the current platform will not work.

Declared In: FBSettings.h
facebookDomainPart

Get the Facebook domain part

+ (NSString *) facebookDomainPart;
Declared In: FBSettings.h
isBetaFeatureEnabled:

Determines whether a beta feature is enabled or not.

ParameterDescription
betaFeature

The beta feature to check.

+ (BOOL) isBetaFeatureEnabled:(FBBetaFeatures)betaFeature;
Declared In: FBSettings.h
isPlatformCompatibilityEnabled

Returns YES if the legacy Graph API mode is enabled

+ (BOOL) isPlatformCompatibilityEnabled;
Declared In: FBSettings.h
limitEventAndDataUsage

Gets whether data such as that generated through FBAppEvents 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.

+ (BOOL) limitEventAndDataUsage;
Declared In: FBSettings.h
loggingBehavior

Retrieve the current Facebook SDK logging behavior.

+ (NSSet *) loggingBehavior;
Declared In: FBSettings.h
resourceBundleName

Get the name of the bundle to override the SDK images and text

+ (NSString *) resourceBundleName;
Declared In: FBSettings.h
sdkVersion

Retrieve the current iOS SDK version.

+ (NSString *) sdkVersion;
Declared In: FBSettings.h
setAppVersion:

This method is deprecated -- App Events favors using bundle identifiers to this.

ParameterDescription
appVersion

Deprecated

+ (void) setAppVersion:(NSString *)appVersion __attribute__((deprecated("App Events favors use of bundle identifiers for version identification.")));
Declared In: FBSettings.h
setClientToken:

Sets the Client Token for the Facebook App. This is needed for certain API calls when made anonymously, without a user-based Session.

ParameterDescription
clientToken

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]

+ (void) setClientToken:(NSString *)clientToken;
Declared In: FBSettings.h
setDefaultAppID:

Set the default Facebook App ID to use for sessions. The SDK allows the appID to be overridden per instance in certain cases (e.g. per instance of FBSession)

ParameterDescription
appID

The default Facebook App ID to be used by the SDK.

+ (void) setDefaultAppID:(NSString *)appID;
Declared In: FBSettings.h
setDefaultDisplayName:

Set the default Facebook Display Name to be 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

ParameterDescription
displayName

The default Facebook Display Name to be used by the SDK.

+ (void) setDefaultDisplayName:(NSString *)displayName;
Declared In: FBSettings.h
setDefaultUrlSchemeSuffix:

Set the default url scheme suffix used by the SDK.

ParameterDescription
urlSchemeSuffix

The default url scheme suffix to be used by the SDK.

+ (void) setDefaultUrlSchemeSuffix:(NSString *)urlSchemeSuffix;
Declared In: FBSettings.h
setFacebookDomainPart:

Set the subpart of the facebook domain (e.g. @"beta") so that requests will be sent to graph.beta.facebook.com

ParameterDescription
facebookDomainPart

The domain part to be inserted into facebook.com

+ (void) setFacebookDomainPart:(NSString *)facebookDomainPart;
Declared In: FBSettings.h
setLimitEventAndDataUsage:

Sets whether data such as that generated through FBAppEvents 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.

ParameterDescription
limitEventAndDataUsage

The desired value.

+ (void) setLimitEventAndDataUsage:(BOOL)limitEventAndDataUsage;
Declared In: FBSettings.h
setLoggingBehavior:

Set the current Facebook SDK logging behavior. This should consist of strings defined as constants with FBLogBehavior*, and can be constructed with, e.g., [NSSet initWithObjects:].

ParameterDescription
loggingBehavior

A set of strings indicating what information should be logged. If nil is provided, the logging behavior is reset to the default set of enabled behaviors. Set in an empty set in order to disable all logging.

+ (void) setLoggingBehavior:(NSSet *)loggingBehavior;
Declared In: FBSettings.h
setResourceBundleName:

Set the bundle name from the SDK will try and load overrides of images and text

ParameterDescription
bundleName

The name of the bundle (MyFBBundle).

+ (void) setResourceBundleName:(NSString *)bundleName;
Declared In: FBSettings.h
Constants
FBLoggingBehaviorAccessTokens
FBSDK_EXTER N NSString *const FBLoggingBehaviorAccessTokens;
Discussion:

Include access token in logging.

Declared In: FBSettings.h
FBLoggingBehaviorAppEvents
FBSDK_EXTER N NSString *const FBLoggingBehaviorAppEvents;
Discussion:

Log FBAppEvents interactions

Declared In: FBSettings.h
FBLoggingBehaviorCacheErrors
FBSDK_EXTER N NSString *const FBLoggingBehaviorCacheErrors;
Discussion:

Log cache errors.

Declared In: FBSettings.h
FBLoggingBehaviorDeveloperErrors
FBSDK_EXTER N NSString *const FBLoggingBehaviorDeveloperErrors;
Discussion:

Log errors likely to be preventable by the developer. This is in the default set of enabled logging behaviors.

Declared In: FBSettings.h
FBLoggingBehaviorFBRequests
FBSDK_EXTER N NSString *const FBLoggingBehaviorFBRequests;
Discussion:

Log requests from FBRequest* classes

Declared In: FBSettings.h
FBLoggingBehaviorFBURLConnections
FBSDK_EXTER N NSString *const FBLoggingBehaviorFBURLConnections;
Discussion:

Log requests from FBURLConnection* classes

Declared In: FBSettings.h
FBLoggingBehaviorInformational
FBSDK_EXTER N NSString *const FBLoggingBehaviorInformational;
Discussion:

Log Informational occurrences

Declared In: FBSettings.h
FBLoggingBehaviorPerformanceCharacteristics
FBSDK_EXTER N NSString *const FBLoggingBehaviorPerformanceCharacteristics;
Discussion:

Log performance characteristics

Declared In: FBSettings.h
FBLoggingBehaviorSessionStateTransitions
FBSDK_EXTER N NSString *const FBLoggingBehaviorSessionStateTransitions;
Discussion:

Log session state transitions.

Declared In: FBSettings.h
FBLoggingBehaviorUIControlErrors
FBSDK_EXTER N NSString *const FBLoggingBehaviorUIControlErrors;
Discussion:

Log errors from SDK UI controls

Declared In: FBSettings.h
Typedefs
NS_ENUM

A list of beta features that can be enabled for the SDK. Beta features are for evaluation only, and are therefore only enabled for DEBUG builds. Beta features should not be enabled in release builds.

typedef NS_ENUM(NSUInteger, FBBetaFeatures) {
FBBetaFeaturesNone = 0,
};
ConstantDescription
FBBetaFeaturesNone

Default value indicating no beta features

Declared In: FBSettings.h
NS_ENUM

Indicates if this app should be restricted

typedef NS_ENUM(NSUInteger, FBRestrictedTreatment) {
FBRestrictedTreatmentNO = 0,
FBRestrictedTreatmentYES = 1
};
ConstantDescription
FBRestrictedTreatmentNO

The default treatment indicating the app is not restricted.

FBRestrictedTreatmentYES

Indicates the app is restricted.

Declared In: FBSettings.h