FacebookSdk (facebook 4.3.0 API)

java.lang.Object
- com.facebook.FacebookSdk

```
public final class FacebookSdk
extends java.lang.Object
```
This class allows some customization of Facebook SDK behavior.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPLICATION_ID_PROPERTY` The key for the application ID in the Android manifest.
`static java.lang.String`	`APPLICATION_NAME_PROPERTY` The key for the application name in the Android manifest.
`static java.lang.String`	`CLIENT_TOKEN_PROPERTY` The key for the client token in the Android manifest.
`static java.lang.String`	`WEB_DIALOG_THEME` The key for the web dialog theme in the Android manifest.

Constructor Summary

Constructors
Constructor and Description

FacebookSdk()

Constructors
Constructor and Description
`FacebookSdk()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addLoggingBehavior(LoggingBehavior behavior)` Certain logging behaviors are available for debugging beyond those that should be enabled in production.
`static void`	`clearLoggingBehaviors()` Certain logging behaviors are available for debugging beyond those that should be enabled in production.
`static android.content.Context`	`getApplicationContext()` The getter for the context of the current application.
`static java.lang.String`	`getApplicationId()` Gets the Facebook application ID for the current app.
`static java.lang.String`	`getApplicationName()` Gets the Facebook application name of the current app.
`static java.lang.String`	`getApplicationSignature(android.content.Context context)` Internal call please don't use directly.
`static java.io.File`	`getCacheDir()` Gets the cache directory to use for caching responses, etc.
`static int`	`getCallbackRequestCodeOffset()` Getter for the callback request code offset.
`static java.lang.String`	`getClientToken()` Gets the client token for the current app.
`static java.util.concurrent.Executor`	`getExecutor()` Returns the Executor used by the SDK for non-AsyncTask background work.
`static java.lang.String`	`getFacebookDomain()` Gets the base Facebook domain to use when making Web requests; in production code this will always be "facebook.com".
`static boolean`	`getLimitEventAndDataUsage(android.content.Context context)` Returns whether data such as those generated through AppEventsLogger and sent to Facebook should be restricted from being used for purposes other than analytics and conversions, such as targeting ads to this user.
`static java.util.Set<LoggingBehavior>`	`getLoggingBehaviors()` Certain logging behaviors are available for debugging beyond those that should be enabled in production.
`static long`	`getOnProgressThreshold()` Gets the threshold used to report progress on requests.
`static java.lang.String`	`getSdkVersion()` Returns the current version of the Facebook SDK for Android as a string.
`static int`	`getWebDialogTheme()` Gets the theme used by `WebDialog`
`static boolean`	`isDebugEnabled()` Indicates if we are in debug mode.
`static boolean`	`isFacebookRequestCode(int requestCode)` Returns true if the request code is within the range used by Facebook SDK requests.
`static boolean`	`isInitialized()` Indicates whether the Facebook SDK has been initialized.
`static boolean`	`isLegacyTokenUpgradeSupported()` Indicates if the SDK should fallback and read the legacy token.
`static boolean`	`isLoggingBehaviorEnabled(LoggingBehavior behavior)` Certain logging behaviors are available for debugging beyond those that should be enabled in production.
`static void`	`publishInstallAsync(android.content.Context context, java.lang.String applicationId)` This method is public in order to be used by app events, please don't use directly.
`static void`	`removeLoggingBehavior(LoggingBehavior behavior)` Certain logging behaviors are available for debugging beyond those that should be enabled in production.
`static void`	`sdkInitialize(android.content.Context applicationContext)` This function initializes the Facebook SDK, the behavior of Facebook SDK functions are undetermined if this function is not called.
`static void`	`sdkInitialize(android.content.Context applicationContext, int callbackRequestCodeOffset)` This function initializes the Facebook SDK, the behavior of Facebook SDK functions are undetermined if this function is not called.
`static void`	`setApplicationId(java.lang.String applicationId)` Sets the Facebook application ID for the current app.
`static void`	`setApplicationName(java.lang.String applicationName)` Sets the Facebook application name for the current app.
`static void`	`setCacheDir(java.io.File cacheDir)` Sets the cache directory to use for caching responses, etc.
`static void`	`setClientToken(java.lang.String clientToken)` Sets the Facebook client token for the current app.
`static void`	`setExecutor(java.util.concurrent.Executor executor)` Sets the Executor used by the SDK for non-AsyncTask background work.
`static void`	`setFacebookDomain(java.lang.String facebookDomain)` Sets the base Facebook domain to use when making Web requests.
`static void`	`setIsDebugEnabled(boolean enabled)` Used to enable or disable logging, and other debug features.
`static void`	`setLegacyTokenUpgradeSupported(boolean supported)` Setter for legacy token upgrade.
`static void`	`setLimitEventAndDataUsage(android.content.Context context, boolean limitEventUsage)` Sets whether data such as those generated through AppEventsLogger and sent to Facebook should be restricted from being used for purposes other than analytics and conversions, such as targeting ads to this user.
`static void`	`setOnProgressThreshold(long threshold)` Sets the threshold used to report progress on requests.
`static void`	`setWebDialogTheme(int theme)` Sets the theme used by `WebDialog`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - APPLICATION_ID_PROPERTY
```
public static final java.lang.String APPLICATION_ID_PROPERTY
```
    The key for the application ID in the Android manifest.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_NAME_PROPERTY
```
public static final java.lang.String APPLICATION_NAME_PROPERTY
```
    The key for the application name in the Android manifest.
    
    See Also:
    
    Constant Field Values
  - CLIENT_TOKEN_PROPERTY
```
public static final java.lang.String CLIENT_TOKEN_PROPERTY
```
    The key for the client token in the Android manifest.
    
    See Also:
    
    Constant Field Values
  - WEB_DIALOG_THEME
```
public static final java.lang.String WEB_DIALOG_THEME
```
    The key for the web dialog theme in the Android manifest.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FacebookSdk
```
public FacebookSdk()
```
- Method Detail
  - sdkInitialize
```
public static void sdkInitialize(android.content.Context applicationContext,
                                 int callbackRequestCodeOffset)
```
    This function initializes the Facebook SDK, the behavior of Facebook SDK functions are undetermined if this function is not called. It should be called as early as possible.
    
    Parameters:
    
    applicationContext - The application context
    
    callbackRequestCodeOffset - The request code offset that Facebook activities will be called with. Please do not use the range between the value you set and another 100 entries after it in your other requests.
  - sdkInitialize
```
public static void sdkInitialize(android.content.Context applicationContext)
```
    This function initializes the Facebook SDK, the behavior of Facebook SDK functions are undetermined if this function is not called. It should be called as early as possible.
    
    Parameters:
    
    applicationContext - The application context
  - isInitialized
```
public static boolean isInitialized()
```
    Indicates whether the Facebook SDK has been initialized.
    
    Returns:
    
    true if initialized, false if not
  - getLoggingBehaviors
```
public static java.util.Set<LoggingBehavior> getLoggingBehaviors()
```
    Certain logging behaviors are available for debugging beyond those that should be enabled in production. Returns the types of extended logging that are currently enabled.
    
    Returns:
    
    a set containing enabled logging behaviors
  - addLoggingBehavior
```
public static void addLoggingBehavior(LoggingBehavior behavior)
```
    Certain logging behaviors are available for debugging beyond those that should be enabled in production. Enables a particular extended logging in the SDK.
    
    Parameters:
    
    behavior - The LoggingBehavior to enable
  - removeLoggingBehavior
```
public static void removeLoggingBehavior(LoggingBehavior behavior)
```
    Certain logging behaviors are available for debugging beyond those that should be enabled in production. Disables a particular extended logging behavior in the SDK.
    
    Parameters:
    
    behavior - The LoggingBehavior to disable
  - clearLoggingBehaviors
```
public static void clearLoggingBehaviors()
```
    Certain logging behaviors are available for debugging beyond those that should be enabled in production. Disables all extended logging behaviors.
  - isLoggingBehaviorEnabled
```
public static boolean isLoggingBehaviorEnabled(LoggingBehavior behavior)
```
    Certain logging behaviors are available for debugging beyond those that should be enabled in production. Checks if a particular extended logging behavior is enabled.
    
    Parameters:
    
    behavior - The LoggingBehavior to check
    
    Returns:
    
    whether behavior is enabled
  - isDebugEnabled
```
public static boolean isDebugEnabled()
```
    Indicates if we are in debug mode.
  - setIsDebugEnabled
```
public static void setIsDebugEnabled(boolean enabled)
```
    Used to enable or disable logging, and other debug features. Defaults to BuildConfig.DEBUG.
    
    Parameters:
    
    enabled - Debug features (like logging) are enabled if true, disabled if false.
  - isLegacyTokenUpgradeSupported
```
public static boolean isLegacyTokenUpgradeSupported()
```
    Indicates if the SDK should fallback and read the legacy token. This is turned off by default for performance.
    
    Returns:
    
    if the legacy token upgrade is supported.
  - setLegacyTokenUpgradeSupported
```
public static void setLegacyTokenUpgradeSupported(boolean supported)
```
    Setter for legacy token upgrade.
    
    Parameters:
    
    supported - True if upgrade should be supported.
  - getExecutor
```
public static java.util.concurrent.Executor getExecutor()
```
    Returns the Executor used by the SDK for non-AsyncTask background work. By default this uses AsyncTask Executor via reflection if the API level is high enough. Otherwise this creates a new Executor with defaults similar to those used in AsyncTask.
    
    Returns:
    
    an Executor used by the SDK. This will never be null.
  - setExecutor
```
public static void setExecutor(java.util.concurrent.Executor executor)
```
    Sets the Executor used by the SDK for non-AsyncTask background work.
    
    Parameters:
    
    executor - the Executor to use; must not be null.
  - getFacebookDomain
```
public static java.lang.String getFacebookDomain()
```
    Gets the base Facebook domain to use when making Web requests; in production code this will always be "facebook.com".
    
    Returns:
    
    the Facebook domain
  - setFacebookDomain
```
public static void setFacebookDomain(java.lang.String facebookDomain)
```
    Sets the base Facebook domain to use when making Web requests. This defaults to "facebook.com", but may be overridden to, e.g., "beta.facebook.com" to direct requests at a different domain. This method should never be called from production code.
    
    Parameters:
    
    facebookDomain - the base domain to use instead of "facebook.com"
  - getApplicationContext
```
public static android.content.Context getApplicationContext()
```
    The getter for the context of the current application.
    
    Returns:
    
    The context of the current application.
  - publishInstallAsync
```
public static void publishInstallAsync(android.content.Context context,
                                       java.lang.String applicationId)
```
    This method is public in order to be used by app events, please don't use directly.
    
    Parameters:
    
    context - The application context.
    
    applicationId - The application id.
  - getSdkVersion
```
public static java.lang.String getSdkVersion()
```
    Returns the current version of the Facebook SDK for Android as a string.
    
    Returns:
    
    the current version of the SDK
  - getLimitEventAndDataUsage
```
public static boolean getLimitEventAndDataUsage(android.content.Context context)
```
    Returns whether data such as those generated through AppEventsLogger and sent to Facebook should be restricted from being used for purposes other than analytics and conversions, such as targeting ads to this user. Defaults to false. This value is stored on the device and persists across app launches.
    
    Parameters:
    
    context - Used to read the value.
  - setLimitEventAndDataUsage
```
public static void setLimitEventAndDataUsage(android.content.Context context,
                                             boolean limitEventUsage)
```
    Sets whether data such as those generated through AppEventsLogger and sent to Facebook should be restricted from being used for purposes other than analytics and conversions, such as targeting ads to this user. Defaults to false. This value is stored on the device and persists across app launches. Changes to this setting will apply to app events currently queued to be flushed.
    
    Parameters:
    
    context - Used to persist this value across app runs.
  - getOnProgressThreshold
```
public static long getOnProgressThreshold()
```
    Gets the threshold used to report progress on requests.
  - setOnProgressThreshold
```
public static void setOnProgressThreshold(long threshold)
```
    Sets the threshold used to report progress on requests. Note that the value will be read when the request is started and cannot be changed during a request (or batch) execution.
    
    Parameters:
    
    threshold - The number of bytes progressed to force a callback.
  - getApplicationSignature
```
public static java.lang.String getApplicationSignature(android.content.Context context)
```
    Internal call please don't use directly.
    
    Parameters:
    
    context - The application context.
    
    Returns:
    
    The application signature.
  - getApplicationId
```
public static java.lang.String getApplicationId()
```
    Gets the Facebook application ID for the current app. This should only be called after the SDK has been initialized by calling FacebookSdk.sdkInitialize().
    
    Returns:
    
    the application ID
  - setApplicationId
```
public static void setApplicationId(java.lang.String applicationId)
```
    Sets the Facebook application ID for the current app.
    
    Parameters:
    
    applicationId - the application ID
  - getApplicationName
```
public static java.lang.String getApplicationName()
```
    Gets the Facebook application name of the current app. This should only be called after the SDK has been initialized by calling FacebookSdk.sdkInitialize().
    
    Returns:
    
    the application name
  - setApplicationName
```
public static void setApplicationName(java.lang.String applicationName)
```
    Sets the Facebook application name for the current app.
    
    Parameters:
    
    applicationName - the application name
  - getClientToken
```
public static java.lang.String getClientToken()
```
    Gets the client token for the current app. This will be null unless explicitly set or unless loadDefaultsFromMetadata has been called.
    
    Returns:
    
    the client token
  - setClientToken
```
public static void setClientToken(java.lang.String clientToken)
```
    Sets the Facebook client token for the current app.
    
    Parameters:
    
    clientToken - the client token
  - getWebDialogTheme
```
public static int getWebDialogTheme()
```
    Gets the theme used by WebDialog
    
    Returns:
    
    the theme
  - setWebDialogTheme
```
public static void setWebDialogTheme(int theme)
```
    Sets the theme used by WebDialog
    
    Parameters:
    
    theme - A theme to use
  - getCacheDir
```
public static java.io.File getCacheDir()
```
    Gets the cache directory to use for caching responses, etc. The default will be the value returned by Context.getCacheDir() when the SDK was initialized, but it can be overridden.
    
    Returns:
    
    the cache directory
  - setCacheDir
```
public static void setCacheDir(java.io.File cacheDir)
```
    Sets the cache directory to use for caching responses, etc.
    
    Parameters:
    
    cacheDir - the cache directory
  - getCallbackRequestCodeOffset
```
public static int getCallbackRequestCodeOffset()
```
    Getter for the callback request code offset. The request codes starting at this offset and the next 100 values are used by the Facebook SDK.
    
    Returns:
    
    The callback request code offset.
  - isFacebookRequestCode
```
public static boolean isFacebookRequestCode(int requestCode)
```
    Returns true if the request code is within the range used by Facebook SDK requests. This does not include request codes that you explicitly set on the dialogs, buttons or LoginManager. The range of request codes that the SDK uses starts at the callbackRequestCodeOffset and continues for the next 100 values.
    
    Parameters:
    
    requestCode - the request code to check.
    
    Returns:
    
    true if the request code is within the range used by the Facebook SDK.

Class FacebookSdk

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APPLICATION_ID_PROPERTY

APPLICATION_NAME_PROPERTY

CLIENT_TOKEN_PROPERTY

WEB_DIALOG_THEME

Constructor Detail

FacebookSdk

Method Detail

sdkInitialize

sdkInitialize

isInitialized

getLoggingBehaviors

addLoggingBehavior

removeLoggingBehavior

clearLoggingBehaviors

isLoggingBehaviorEnabled

isDebugEnabled

setIsDebugEnabled

isLegacyTokenUpgradeSupported

setLegacyTokenUpgradeSupported

getExecutor

setExecutor

getFacebookDomain

setFacebookDomain

getApplicationContext

publishInstallAsync

getSdkVersion

getLimitEventAndDataUsage

setLimitEventAndDataUsage

getOnProgressThreshold

setOnProgressThreshold

getApplicationSignature

getApplicationId

setApplicationId

getApplicationName

setApplicationName

getClientToken

setClientToken

getWebDialogTheme

setWebDialogTheme

getCacheDir

setCacheDir

getCallbackRequestCodeOffset

isFacebookRequestCode