FBSettings - 文件 - Meta for Developers

FBSettings

最新版本的 SDK 已不再提供此課程。
有此級別的更新版本。前往查看最新版本。

類別方式

appVersion

Gets the application version to the provided string. FBAppEvents, for instance, attaches the app version to events that it logs, which are then available in App Insights.

+ (NSString *) appVersion;

宣告於： 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.

參數	說明
`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.

參數	說明
`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.

參數	說明
`betaFeatures`	The beta features to enable (expects a bitwise OR of FBBetaFeatures)

+ (void) enableBetaFeatures:(NSUInteger)betaFeatures;

宣告於： FBSettings.h

facebookDomainPart

Get the Facebook domain part

+ (NSString*) facebookDomainPart;

宣告於： FBSettings.h

isBetaFeatureEnabled:

Determines whether a beta feature is enabled or not.

參數	說明
`betaFeature`	The beta feature to check.

+ (BOOL) isBetaFeatureEnabled:(FBBetaFeatures)betaFeature;

宣告於： 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

publishInstall:

This method has been replaced by [FBAppEvents activateApp]

+ (void) publishInstall:(NSString *)appID __attribute__((deprecated("use [FBAppEvents activateApp] instead")));

宣告於： FBSettings.h

publishInstall:withHandler:

Manually publish an attributed install to the Facebook graph, and return the server response back in the supplied handler. Calling this method will implicitly turn off auto-publish. This method acquires the current attribution id from the facebook application, queries the graph API to determine if the application has install attribution enabled, publishes the id, and records success to avoid reporting more than once.

參數	說明
`appID`	A specific appID to publish an install for. If nil, uses [FBSession defaultAppID].
`handler`	A block to call with the server's response.

+ (void)

`publishInstall:`	`(NSString *)appID`
`withHandler:`	`(FBInstallResponseDataHandler)handler`

__attribute__((deprecated));

宣告於： 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:

Sets the application version to the provided string. FBAppEvents, for instance, attaches the app version to events that it logs, which are then available in App Insights.

參數	說明
`appVersion`	The version identifier of the iOS app.

+ (void) setAppVersion:(NSString *)appVersion;

宣告於： 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.

參數	說明
`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)

參數	說明
`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

參數	說明
`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.

參數	說明
`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

參數	說明
`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.

參數	說明
`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:].

參數	說明
`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

參數	說明
`bundleName`	The name of the bundle (MyFBBundle).

+ (void) setResourceBundleName:(NSString*)bundleName;

宣告於： FBSettings.h

setShouldAutoPublishInstall:

Deprecated method

+ (void) setShouldAutoPublishInstall:(BOOL)autoPublishInstall __attribute__((deprecated));

宣告於： FBSettings.h

shouldAutoPublishInstall

Deprecated method

+ (BOOL) shouldAutoPublishInstall __attribute__((deprecated));

宣告於： FBSettings.h

常數

FBLoggingBehaviorAccessTokens

extern NSString *const FBLoggingBehaviorAccessTokens;

Discussion:

Include access token in logging.

宣告於： FBSettings.h

FBLoggingBehaviorAppEvents

extern NSString *const FBLoggingBehaviorAppEvents;

Discussion:

Log FBAppEvents interactions

宣告於： FBSettings.h

FBLoggingBehaviorDeveloperErrors

extern NSString *const FBLoggingBehaviorDeveloperErrors;

Discussion:

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

宣告於： FBSettings.h

FBLoggingBehaviorFBRequests

extern NSString *const FBLoggingBehaviorFBRequests;

Discussion:

Log requests from FBRequest* classes

宣告於： FBSettings.h

FBLoggingBehaviorFBURLConnections

extern NSString *const FBLoggingBehaviorFBURLConnections;

Discussion:

Log requests from FBURLConnection* classes

宣告於： FBSettings.h

FBLoggingBehaviorInformational

extern NSString *const FBLoggingBehaviorInformational;

Discussion:

Log Informational occurrences

宣告於： FBSettings.h

FBLoggingBehaviorPerformanceCharacteristics

extern NSString *const FBLoggingBehaviorPerformanceCharacteristics;

Discussion:

Log performance characteristics

宣告於： FBSettings.h

FBLoggingBehaviorSessionStateTransitions

extern NSString *const FBLoggingBehaviorSessionStateTransitions;

Discussion:

Log session state transitions.

宣告於： FBSettings.h

Typedefs

FBBetaFeatures

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 enum : NSUInteger { 
    FBBetaFeaturesNone = 0, 
    #if defined(DEBUG) || defined(FB_BUILD_ONLY) 
    FBBetaFeaturesShareDialog = 1 << 0, 
    FBBetaFeaturesOpenGraphShareDialog = 1 << 1, 
    #endif  
} FBBetaFeatures;

宣告於： FBSettings.h

FBInstallResponseDataHandler

Block type used to get install data that is returned by server when publishInstall is called

typedef void (^FBInstallResponseDataHandler)(
    FBGraphObject *response,
    NSError *error);

宣告於： FBSettings.h

NS_ENUM

Indicates if this app should be restricted

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

常數	簡介
`FBRestrictedTreatmentNO`	The default treatment indicating the app is not restricted.
`FBRestrictedTreatmentYES`	Indicates the app is restricted.

宣告於： FBSettings.h