FBSDKSettings Class Reference
Inherits from | NSObject |
Declared in | FBSDKSettings.h |
Overview
Log errors likely to be preventable by the developer. This is in the default set of enabled logging behaviors.
Tasks
-
+ appID
-
+ setAppID:
-
+ appURLSchemeSuffix
-
+ setAppURLSchemeSuffix:
-
+ clientToken
-
+ setClientToken:
-
+ setGraphErrorRecoveryDisabled:
-
+ displayName
-
+ setDisplayName:
-
+ facebookDomainPart
-
+ setFacebookDomainPart:
-
+ JPEGCompressionQuality
-
+ setJPEGCompressionQuality:
-
+ limitEventAndDataUsage
-
+ setLimitEventAndDataUsage:
-
+ sdkVersion
-
+ loggingBehavior
-
+ setLoggingBehavior:
-
+ enableLoggingBehavior:
-
+ disableLoggingBehavior:
-
+ setLegacyUserDefaultTokenInformationKeyName:
-
+ legacyUserDefaultTokenInformationKeyName
Class Methods
JPEGCompressionQuality
The quality of JPEG images sent to Facebook from the SDK.
+ (CGFloat)JPEGCompressionQuality
Discussion
If not explicitly set, the default is 0.9.
See Also
Declared In
FBSDKSettings.h
appID
Get the Facebook App ID used by the SDK.
+ (NSString *)appID
Discussion
If not explicitly set, the default will be read from the application’s plist (FacebookAppID).
Declared In
FBSDKSettings.h
appURLSchemeSuffix
Get the default url scheme suffix used for sessions.
+ (NSString *)appURLSchemeSuffix
Discussion
If not explicitly set, the default will be read from the application’s plist (FacebookUrlSchemeSuffix).
Declared In
FBSDKSettings.h
clientToken
Retrieve the Client Token that has been set via [FBSDKSettings setClientToken].
+ (NSString *)clientToken
Discussion
If not explicitly set, the default will be read from the application’s plist (FacebookClientToken).
Declared In
FBSDKSettings.h
disableLoggingBehavior:
Disable a particular Facebook SDK logging behavior.
+ (void)disableLoggingBehavior:(NSString *)loggingBehavior
Parameters
- loggingBehavior
The LoggingBehavior to disable. This should be a string defined as a constant with FBSDKLoggingBehavior*.
Declared In
FBSDKSettings.h
displayName
Get the Facebook Display Name used by the SDK.
+ (NSString *)displayName
Discussion
If not explicitly set, the default will be read from the application’s plist (FacebookDisplayName).
Declared In
FBSDKSettings.h
enableLoggingBehavior:
Enable a particular Facebook SDK logging behavior.
+ (void)enableLoggingBehavior:(NSString *)loggingBehavior
Parameters
- loggingBehavior
The LoggingBehavior to enable. This should be a string defined as a constant with FBSDKLoggingBehavior*.
Declared In
FBSDKSettings.h
facebookDomainPart
Get the Facebook domain part.
+ (NSString *)facebookDomainPart
Discussion
If not explicitly set, the default will be read from the application’s plist (FacebookDomainPart).
Declared In
FBSDKSettings.h
legacyUserDefaultTokenInformationKeyName
Get the user defaults key used by legacy token caches.
+ (NSString *)legacyUserDefaultTokenInformationKeyName
Declared In
FBSDKSettings.h
limitEventAndDataUsage
@abstract Gets 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.
+ (BOOL)limitEventAndDataUsage
Declared In
FBSDKSettings.h
loggingBehavior
Retrieve the current Facebook SDK logging behavior.
+ (NSSet *)loggingBehavior
Declared In
FBSDKSettings.h
sdkVersion
Retrieve the current iOS SDK version.
+ (NSString *)sdkVersion
Declared In
FBSDKSettings.h
setAppID:
Set the Facebook App ID to be used by the SDK.
+ (void)setAppID:(NSString *)appID
Parameters
- appID
The Facebook App ID to be used by the SDK.
Declared In
FBSDKSettings.h
setAppURLSchemeSuffix:
Set the app url scheme suffix used by the SDK.
+ (void)setAppURLSchemeSuffix:(NSString *)appURLSchemeSuffix
Parameters
- appURLSchemeSuffix
The url scheme suffix to be used by the SDK.
Declared In
FBSDKSettings.h
setClientToken:
Sets the Client Token for the Facebook App.
+ (void)setClientToken:(NSString *)clientToken
Parameters
- 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]
Discussion
This is needed for certain API calls when made anonymously, without a user-based access token.
Declared In
FBSDKSettings.h
setDisplayName:
Set the default Facebook Display Name to be used by the SDK.
+ (void)setDisplayName:(NSString *)displayName
Parameters
- displayName
The Facebook Display Name to be used by the SDK.
Discussion
This should match the Display Name that has been set for the app with the corresponding Facebook App ID, in the Facebook App Dashboard.
Declared In
FBSDKSettings.h
setFacebookDomainPart:
Set the subpart of the Facebook domain.
+ (void)setFacebookDomainPart:(NSString *)facebookDomainPart
Parameters
- facebookDomainPart
The domain part to be inserted into facebook.com.
Discussion
This can be used to change the Facebook domain (e.g. @“beta”) so that requests will be sent to graph.beta.facebook.com
Declared In
FBSDKSettings.h
setGraphErrorRecoveryDisabled:
A convenient way to toggle error recovery for all FBSDKGraphRequest instances created after this is set.
+ (void)setGraphErrorRecoveryDisabled:(BOOL)disableGraphErrorRecovery
Parameters
- disableGraphErrorRecovery
YES or NO.
Declared In
FBSDKSettings.h
setJPEGCompressionQuality:
Set the quality of JPEG images sent to Facebook from the SDK.
+ (void)setJPEGCompressionQuality:(CGFloat)JPEGCompressionQuality
Parameters
- JPEGCompressionQuality
The quality for JPEG images, expressed as a value from 0.0 to 1.0.
See Also
Declared In
FBSDKSettings.h
setLegacyUserDefaultTokenInformationKeyName:
Set the user defaults key used by legacy token caches.
+ (void)setLegacyUserDefaultTokenInformationKeyName:(NSString *)tokenInformationKeyName
Parameters
- tokenInformationKeyName
the key used by legacy token caches.
Discussion
Use this only if you customized FBSessionTokenCachingStrategy in v3.x of the Facebook SDK for iOS.
Declared In
FBSDKSettings.h
setLimitEventAndDataUsage:
@abstract Sets 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.
+ (void)setLimitEventAndDataUsage:(BOOL)limitEventAndDataUsage
Parameters
- limitEventAndDataUsage
The desired value.
Declared In
FBSDKSettings.h
setLoggingBehavior:
Set the current Facebook SDK logging behavior. This should consist of strings defined as constants with FBSDKLoggingBehavior*.
+ (void)setLoggingBehavior:(NSSet *)loggingBehavior
Parameters
- 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 to an empty set in order to disable all logging.
Discussion
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:
Declared In
FBSDKSettings.h