Expo

Get Started
API Reference

Facebook

expo-facebook provides Facebook integration, such as logging in through Facebook, for React Native apps. Expo exposes a minimal native API since you can access Facebook's Graph API directly through HTTP (using fetch, for example).

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb

Installation

expo install expo-facebook

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

For bare apps, here are links to the iOS Installation Walkthrough and the Android Installation Walkthrough.

💡
When following these steps you will find on the Facebook Developer site that there are many fields and steps that you don't actually care about. Just look for the information that we ask you for and you will be OK!
Follow Facebook's developer documentation to register an application with Facebook's API and get an application ID. Take note of this application ID because it will be used as the appId option in your Facebook.logInWithReadPermissionsAsync call.
Then follow these steps based on the platforms you're targeting. This will need to be done from the Facebook developer site.
Expo Go from the Android Play Store will use the Facebook App ID that you provide, however, all Facebook API calls in the Expo Go from the iOS App Store will use Expo's own Facebook App ID. This is due to underlying configuration limitations, but the good news is it means less setup for you! The slight downside to this is that you can't customize which permissions your app requests from Facebook (like user_photos or user_friends), or integrate Facebook login with other services like Firebase auth. If you need that functionality on iOS, you can build a standalone app. An easy way to test this is to run expo build:ios -t simulator and install the app in your simulator.

  • Add the field facebookScheme with your Facebook login redirect URL scheme found here under "4. Configure Your info.plist." It should look like "fb123456". If you do not do this, Facebook will not be able to redirect to your app after logging in.
  • Add the fields facebookAppId and facebookDisplayName, using your Facebook App ID and Facebook Display Name, respectively.
  • Optional fields
    • facebookAutoLogAppEventsEnabled, defaults to Facebook's default policy (Only applies to standalone apps)
    • facebookAdvertiserIDCollectionEnabled, defaults to Facebook's default policy (Only applies to standalone apps)

  • Add your app's Bundle ID as a Bundle ID in the app settings page pictured below.
An easy way to test that this is set up correctly is to run a simulator build with expo build:ios -t simulator.

  • Build your standalone app for Android.
  • Run expo fetch:android:hashes.
  • Copy Facebook Key Hash and paste it as a key hash in your Facebook developer page pictured below.
You may have to switch the app from 'development mode' to 'public mode' on the Facebook developer page before other users can log in. This requires adding a privacy policy URL, which can be as simple as a GitHub Gist.

async function logIn() {
  try {
    await Facebook.initializeAsync({
      appId: '<APP_ID>',
    });
    const {
      type,
      token,
      expirationDate,
      permissions,
      declinedPermissions,
    } = await Facebook.logInWithReadPermissionsAsync({
      permissions: ['public_profile'],
    });
    if (type === 'success') {
      // Get the user's name using Facebook's Graph API
      const response = await fetch(`https://graph.facebook.com/me?access_token=${token}`);
      Alert.alert('Logged in!', `Hi ${(await response.json()).name}!`);
    } else {
      // type === 'cancel'
    }
  } catch ({ message }) {
    alert(`Facebook Login Error: ${message}`);
  }
}

import * as Facebook from 'expo-facebook';

Explicitly kicks off flushing of events to Facebook.

  • Promise<void>

Get the advertiser ID from Facebook.

A promise fulfilled with the advertiser id or null if not set.


Get an anonymous ID from Facebook.

A promise fulfilled with an anonymous id or null if not set.


Android only. Gets the attribution ID from Facebook.

A promise fulfilled with the attribution id or null if not set.


Returns the FacebookAuthenticationCredential object if a user is authenticated, and null if no valid authentication exists.

You can use this method to check if the user should sign in or not.


Checks application's permissions for using data for tracking the user or the device.

iOS: it requires the NSUserTrackingUsageDescription message added to the info.plist.

A promise that resolves to an object of type PermissionResponse.


Gets the user ID.

A promise fulfilled with the user id or null if not set.


Calling this method ensures that the SDK is initialized. You have to call this method before calling any method that uses the FBSDK (ex: logInWithReadPermissionsAsync, logOutAsync) to ensure that Facebook support is initialized properly.

  • On Android and iOS you can optionally provide an appId argument.
    • If you don't provide appId, the Facebook SDK will try to use appId from native app resources (which in standalone apps you define in app.json, in app store development clients are unavailable, and in bare apps you configure yourself according to Facebook's setup documentation for iOS and Android). If the Facebook SDK fails to find an appId value, the returned promise will be rejected.
    • The same resolution mechanism works for appName.
  • If you provide an explicit appId, it will override any other source.

  • eventName (string)
  • parameters (Params)

Logs an event with eventName and optional parameters. Supports the optional parameter valueToSum, which when reported, all of the valueToSum properties are summed together. For example, if 10 people purchased one item and each item cost $10 (and passed in valueToSum) then they would be added together to report $100. Parameters must be either strings or numbers, otherwise no event will be logged.

To view and test app events, please visit Facebook's Event Manager- https://www.facebook.com/events_manager2/list/app/


  • options (FacebookOptions) - A map of options:
    • permissions (array) -- An array specifying the permissions to ask for from Facebook for this login. The permissions are strings as specified in the Facebook API documentation. The default permissions are ['public_profile', 'email'].

Prompts the user to log into Facebook and grants your app permission to access their Facebook data. On iOS and Android, if the Facebook app isn't installed then a web view will be used to authenticate.

If the user or Facebook cancelled the login, returns { type: 'cancel' }. Otherwise, returns { type: 'success' } & FacebookAuthenticationCredential.


Logs out of the currently authenticated session.


  • purchaseAmount (number)
  • currencyCode (string)
  • parameters? (Params)

Logs a purchase event with the amount, currency code, and optional parameters. Parameters must be either strings or numbers, otherwise no event will be logged. See http://en.wikipedia.org/wiki/ISO_4217 for currencyCodes.


  • campaign (string)

Logs an app event that tracks that the application was opened via Push Notification. Accepts a string describing the campaign of the Push Notification.


Asks for permissions to use data for tracking the user or the device.

iOS: it requires the NSUserTrackingUsageDescription message added to the info.plist.

A promise that resolves to an object of type PermissionResponse.


  • enabled (boolean) - Whether advertiser-id should be collected

Whether the Facebook SDK should collect advertiser ID properties, like the Apple IDFA and Android Advertising ID, automatically. Advertiser IDs let you identify and target specific customers. To learn more visit Facebook documentation describing that topic.

In some cases, you may want to disable or delay the collection of advertiser-id, such as to obtain user consent or fulfill legal obligations.

This method corresponds to this and this native SDK methods.


  • enabled (boolean) - Whether advertising tracking of the Facebook SDK should be enabled

Sets whether Facebook SDK should enable advertising tracking, (more info here).

Limitations:

  1. AdvertiserTrackingEnabled is only available for iOS 14+.
  2. For iOS 13 or earlier, AdvertiserTrackingEnabled uses the Limit Ad Tracking setting as its value.

This method corresponds to this

Whether the value is set successfully. It will always return false in Android, iOS 13 and below.


Explicitly call initializeAsync instead.

  • enabled (boolean)

  • enabled (boolean) - Whether automatic events logging of the Facebook SDK should be enabled

Sets whether Facebook SDK should log app events. App events involve eg. app installs, app launches (more info here and here).

In some cases, you may want to disable or delay the collection of automatically logged events, such as to obtain user consent or fulfill legal obligations.

This method corresponds to this and this native SDK methods.


Sets additional data about the user to increase the chances of matching a Facebook user.


  • userID (string | null)

Sets a custom user ID to associate with all app events. The userID is persisted until it is cleared by passing nil.

NameTypeDescription
appIdstringApplication ID used to initialize the Facebook SDK app.
dataAccessExpirationDateDateTime at which the current user data access expires.
declinedPermissions
(optional)
string[]List of requested permissions that the user has declined.
expirationDateDateTime at which the token expires.
expiredPermissions
(optional)
string[]List of permissions that were expired with this access token.
graphDomain
(optional)
stringA website domain within the Graph API.https://developers.facebook.com/docs/graph-api/reference/v5.0/domain
permissions
(optional)
string[]List of granted permissions.
refreshDate
(optional)
DateThe last time the token was refreshed (or when it was first obtained)
signedRequest
(optional)
stringA valid raw signed request as a string.
tokenstringAccess token for the authenticated session. This token provides access to the Facebook Graph API.
tokenSource
(optional)
string(Android only) Indicates how this token was obtained.
userIdstringApp-scoped Facebook ID of the user.

NameTypeDescription
type'cancel'-

NameTypeDescription
appName
(optional)
stringAn optional Facebook App Name argument for iOS and Android.

NameTypeDescription
permissions
(optional)
string[]-

NameTypeDescription
appId
(optional)
stringApplication ID used to initialize the FBSDK app.On Android and iOS if you don't provide this, Facebook SDK will try to use appId from Android and iOS. app resources (which in standalone apps you would define in app.json, in the Expo client are unavailable, and in bare you configure yourself according to Facebook setup documentation for iOS and Android). If it fails to find one, the promise will be rejected.
autoLogAppEvents
(optional)
booleanSets whether Facebook SDK should log app events. App events involve app eg. installs, app launches (more info here and here). In some cases, you may want to disable or delay the collection of automatically logged events, such as to obtain user consent or fulfill legal obligations.This method corresponds to:
version
(optional)
stringSelects the version of FBSDK to use.https://developers.facebook.com/docs/javascript/reference/FB.init/v5.0

NameTypeDescription
domain
(optional)
stringAndroid: Sets the base Facebook domain to use when making network requests. Defaults to: 'connect.facebook.net'

Acceptable values are: 'never', number.

Info about a user to increase chances of matching a Facebook user. See https://developers.facebook.com/docs/app-events/advanced-matching for more info about the expected format of each field.

NameTypeDescription
city
(optional)
string-
country
(optional)
string-
dateOfBirth
(optional)
string-
email
(optional)
string-
firstName
(optional)
string-
gender
(optional)
'm' | 'f'-
lastName
(optional)
string-
phone
(optional)
string-
state
(optional)
string-
zip
(optional)
string-

NameTypeDescription
canAskAgainboolean-
expiresPermissionExpiration-
grantedboolean-
statusPermissionStatus-

  • PermissionStatus.DENIED : "denied"
  • PermissionStatus.GRANTED : "granted"
  • PermissionStatus.UNDETERMINED : "undetermined"

Attempted to use the Facebook SDK before it was initialized. Ensure initializeAsync has successfully resolved before attempting to use the Facebook SDK.

Failed to initialize the Facebook SDK app because the appId option wasn't provided and the appId couldn't be resolved automatically from the native configuration files.

An error occurred while trying to log in to Facebook.

You can use the fetch API to get info about the user from the Facebook Graph API. Here are some helper methods you can use to make data access easier.
// Get default info about the currently authenticated user.
async function getUserAsync() {
  const { name } = await requestAsync('me');
  console.log(`Hello ${name} 👋`);
}

// Request data from the Facebook Graph API.
// Learn more https://developers.facebook.com/docs/graph-api/using-graph-api/
async function requestAsync(path: string, token?: string): Promise<any> {
  let resolvedToken = token;
  if (!token) {
    const auth = await Facebook.getAuthenticationCredentialAsync();
    if (!auth) {
      throw new Error(
        'User is not authenticated. Ensure `logInWithReadPermissionsAsync` has successfully resolved before attempting to use the FBSDK Graph API.'
      );
    }
    resolvedToken = auth.token;
  }
  const response = await fetch(
    `https://graph.facebook.com/${path}?access_token=${encodeURIComponent(resolvedToken)}`
  );
  const body = await response.json();
  return body;
}