Allows configuration of SDK behavior.
Inherits from: | NSObject |
Declared in: | FBSettings.h |
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.")));
FBSettings.h
clientToken
Retrieve the Client Token that has been set via [FBSettings setClientToken]
+ (NSString *)
clientToken;
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;
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;
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;
FBSettings.h
disableBetaFeature:
Disables a beta feature.
Parameter | Keterangan |
---|---|
betaFeature | The beta feature to disable. |
+ (void)
disableBetaFeature:(FBBetaFeatures)betaFeature;
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.
Parameter | Keterangan |
---|---|
betaFeature | The beta feature to enable. |
+ (void)
enableBetaFeature:(FBBetaFeatures)betaFeature;
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.
Parameter | Keterangan |
---|---|
betaFeatures | The beta features to enable (expects a bitwise OR of FBBetaFeatures) |
+ (void)
enableBetaFeatures:(NSUInteger)betaFeatures;
FBSettings.h
enablePlatformCompatibility:
Configures the SDK to use the legacy platform.
Parameter | Keterangan |
---|---|
enable | Indicates whether to use the legacy mode |
+ (void)
enablePlatformCompatibility:(BOOL)enable;
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.
FBSettings.h
facebookDomainPart
Get the Facebook domain part
+ (NSString *)
facebookDomainPart;
FBSettings.h
isBetaFeatureEnabled:
Determines whether a beta feature is enabled or not.
Parameter | Keterangan |
---|---|
betaFeature | The beta feature to check. |
+ (BOOL)
isBetaFeatureEnabled:(FBBetaFeatures)betaFeature;
FBSettings.h
isPlatformCompatibilityEnabled
Returns YES if the legacy Graph API mode is enabled
+ (BOOL)
isPlatformCompatibilityEnabled;
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;
FBSettings.h
loggingBehavior
Retrieve the current Facebook SDK logging behavior.
+ (NSSet *)
loggingBehavior;
FBSettings.h
resourceBundleName
Get the name of the bundle to override the SDK images and text
+ (NSString *)
resourceBundleName;
FBSettings.h
sdkVersion
Retrieve the current iOS SDK version.
+ (NSString *)
sdkVersion;
FBSettings.h
setAppVersion:
This method is deprecated -- App Events favors using bundle identifiers to this.
+ (void)
setAppVersion:(NSString *)appVersion __attribute__((deprecated("App Events favors use of bundle identifiers for version identification.")));
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.
Parameter | Keterangan |
---|---|
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;
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)
Parameter | Keterangan |
---|---|
appID | The default Facebook App ID to be used by the SDK. |
+ (void)
setDefaultAppID:(NSString *)appID;
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
Parameter | Keterangan |
---|---|
displayName | The default Facebook Display Name to be used by the SDK. |
+ (void)
setDefaultDisplayName:(NSString *)displayName;
FBSettings.h
setDefaultUrlSchemeSuffix:
Set the default url scheme suffix used by the SDK.
Parameter | Keterangan |
---|---|
urlSchemeSuffix | The default url scheme suffix to be used by the SDK. |
+ (void)
setDefaultUrlSchemeSuffix:(NSString *)urlSchemeSuffix;
FBSettings.h
setFacebookDomainPart:
Set the subpart of the facebook domain (e.g. @"beta") so that requests will be sent to graph.beta.facebook.com
Parameter | Keterangan |
---|---|
facebookDomainPart | The domain part to be inserted into facebook.com |
+ (void)
setFacebookDomainPart:(NSString *)facebookDomainPart;
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.
Parameter | Keterangan |
---|---|
limitEventAndDataUsage | The desired value. |
+ (void)
setLimitEventAndDataUsage:(BOOL)limitEventAndDataUsage;
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:].
Parameter | Keterangan |
---|---|
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;
FBSettings.h
setResourceBundleName:
Set the bundle name from the SDK will try and load overrides of images and text
Parameter | Keterangan |
---|---|
bundleName | The name of the bundle (MyFBBundle). |
+ (void)
setResourceBundleName:(NSString *)bundleName;
FBSettings.h
FBLoggingBehaviorAccessTokens
FBSDK_EXTER N NSString *const FBLoggingBehaviorAccessTokens;
Include access token in logging.
FBSettings.h
FBLoggingBehaviorAppEvents
FBSDK_EXTER N NSString *const FBLoggingBehaviorAppEvents;
Log FBAppEvents interactions
FBSettings.h
FBLoggingBehaviorCacheErrors
FBSDK_EXTER N NSString *const FBLoggingBehaviorCacheErrors;
Log cache errors.
FBSettings.h
FBLoggingBehaviorDeveloperErrors
FBSDK_EXTER N NSString *const FBLoggingBehaviorDeveloperErrors;
Log errors likely to be preventable by the developer. This is in the default set of enabled logging behaviors.
FBSettings.h
FBLoggingBehaviorFBRequests
FBSDK_EXTER N NSString *const FBLoggingBehaviorFBRequests;
Log requests from FBRequest* classes
FBSettings.h
FBLoggingBehaviorFBURLConnections
FBSDK_EXTER N NSString *const FBLoggingBehaviorFBURLConnections;
Log requests from FBURLConnection* classes
FBSettings.h
FBLoggingBehaviorInformational
FBSDK_EXTER N NSString *const FBLoggingBehaviorInformational;
Log Informational occurrences
FBSettings.h
FBLoggingBehaviorPerformanceCharacteristics
FBSDK_EXTER N NSString *const FBLoggingBehaviorPerformanceCharacteristics;
Log performance characteristics
FBSettings.h
FBLoggingBehaviorSessionStateTransitions
FBSDK_EXTER N NSString *const FBLoggingBehaviorSessionStateTransitions;
Log session state transitions.
FBSettings.h
NS_ENUM
Indicates if this app should be restricted
typedef NS_ENUM(NSUInteger, FBRestrictedTreatment) { FBRestrictedTreatmentNO = 0, FBRestrictedTreatmentYES = 1 };
Konstanta | Keterangan |
---|---|
FBRestrictedTreatmentNO | The default treatment indicating the app is not restricted. |
FBRestrictedTreatmentYES | Indicates the app is restricted. |
FBSettings.h
NSUInteger
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, #if defined(DEBUG) || defined(FB_BUILD_ONLY) #endif };
FBSettings.h