FBSettings - Documentation - Meta for Developers

FBSettings

Cette classe n’est plus disponible dans la version la plus récente du SDK.
Une version plus récente de cette classe est disponible. Rendez-vous sur la dernière version.

Méthodes Class

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;

Déclaré dans : FBSettings.h

clientToken

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

+ (NSString *) clientToken;

Déclaré dans : 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;

Déclaré dans : 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;

Déclaré dans : 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;

Déclaré dans : FBSettings.h

disableBetaFeature:

Disables a beta feature.

Paramètre	Description
`betaFeature`	The beta feature to disable.

+ (void) disableBetaFeature:(FBBetaFeatures)betaFeature;

Déclaré dans : 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.

Paramètre	Description
`betaFeature`	The beta feature to enable.

+ (void) enableBetaFeature:(FBBetaFeatures)betaFeature;

Déclaré dans : 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.

Paramètre	Description
`betaFeatures`	The beta features to enable (expects a bitwise OR of FBBetaFeatures)

+ (void) enableBetaFeatures:(NSUInteger)betaFeatures;

Déclaré dans : FBSettings.h

facebookDomainPart

Get the Facebook domain part

+ (NSString*) facebookDomainPart;

Déclaré dans : FBSettings.h

isBetaFeatureEnabled:

Determines whether a beta feature is enabled or not.

Paramètre	Description
`betaFeature`	The beta feature to check.

+ (BOOL) isBetaFeatureEnabled:(FBBetaFeatures)betaFeature;

Déclaré dans : 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;

Déclaré dans : FBSettings.h

loggingBehavior

Retrieve the current Facebook SDK logging behavior.

+ (NSSet *) loggingBehavior;

Déclaré dans : FBSettings.h

publishInstall:

This method has been replaced by [FBAppEvents activateApp]

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

Déclaré dans : 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.

Paramètre	Description
`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));

Déclaré dans : FBSettings.h

resourceBundleName

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

+ (NSString*) resourceBundleName;

Déclaré dans : FBSettings.h

sdkVersion

Retrieve the current iOS SDK version.

+ (NSString *) sdkVersion;

Déclaré dans : 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.

Paramètre	Description
`appVersion`	The version identifier of the iOS app.

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

Déclaré dans : 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.

Paramètre	Description
`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;

Déclaré dans : 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)

Paramètre	Description
`appID`	The default Facebook App ID to be used by the SDK.

+ (void) setDefaultAppID:(NSString*)appID;

Déclaré dans : 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

Paramètre	Description
`displayName`	The default Facebook Display Name to be used by the SDK.

+ (void) setDefaultDisplayName:(NSString *)displayName;

Déclaré dans : FBSettings.h

setDefaultUrlSchemeSuffix:

Set the default url scheme suffix used by the SDK.

Paramètre	Description
`urlSchemeSuffix`	The default url scheme suffix to be used by the SDK.

+ (void) setDefaultUrlSchemeSuffix:(NSString*)urlSchemeSuffix;

Déclaré dans : FBSettings.h

setFacebookDomainPart:

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

Paramètre	Description
`facebookDomainPart`	The domain part to be inserted into facebook.com

+ (void) setFacebookDomainPart:(NSString*)facebookDomainPart;

Déclaré dans : 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.

Paramètre	Description
`limitEventAndDataUsage`	The desired value.

+ (void) setLimitEventAndDataUsage:(BOOL)limitEventAndDataUsage;

Déclaré dans : 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:].

Paramètre	Description
`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;

Déclaré dans : FBSettings.h

setResourceBundleName:

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

Paramètre	Description
`bundleName`	The name of the bundle (MyFBBundle).

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

Déclaré dans : FBSettings.h

setShouldAutoPublishInstall:

Deprecated method

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

Déclaré dans : FBSettings.h

shouldAutoPublishInstall

Deprecated method

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

Déclaré dans : FBSettings.h

Constantes

FBLoggingBehaviorAccessTokens

extern NSString *const FBLoggingBehaviorAccessTokens;

Discussion:

Include access token in logging.

Déclaré dans : FBSettings.h

FBLoggingBehaviorAppEvents

extern NSString *const FBLoggingBehaviorAppEvents;

Discussion:

Log FBAppEvents interactions

Déclaré dans : 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.

Déclaré dans : FBSettings.h

FBLoggingBehaviorFBRequests

extern NSString *const FBLoggingBehaviorFBRequests;

Discussion:

Log requests from FBRequest* classes

Déclaré dans : FBSettings.h

FBLoggingBehaviorFBURLConnections

extern NSString *const FBLoggingBehaviorFBURLConnections;

Discussion:

Log requests from FBURLConnection* classes

Déclaré dans : FBSettings.h

FBLoggingBehaviorInformational

extern NSString *const FBLoggingBehaviorInformational;

Discussion:

Log Informational occurrences

Déclaré dans : FBSettings.h

FBLoggingBehaviorPerformanceCharacteristics

extern NSString *const FBLoggingBehaviorPerformanceCharacteristics;

Discussion:

Log performance characteristics

Déclaré dans : FBSettings.h

FBLoggingBehaviorSessionStateTransitions

extern NSString *const FBLoggingBehaviorSessionStateTransitions;

Discussion:

Log session state transitions.

Déclaré dans : 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;

Déclaré dans : 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);

Déclaré dans : FBSettings.h

NS_ENUM

Indicates if this app should be restricted

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

Constante	Description
`FBRestrictedTreatmentNO`	The default treatment indicating the app is not restricted.
`FBRestrictedTreatmentYES`	Indicates the app is restricted.

Déclaré dans : FBSettings.h