Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thebergamo/react-native-fbsdk-next
https://github.com/thebergamo/react-native-fbsdk-next
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/thebergamo/react-native-fbsdk-next
- Owner: thebergamo
- License: mit
- Created: 2021-03-09T14:38:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T23:37:02.000Z (7 months ago)
- Last Synced: 2024-05-16T23:45:45.275Z (6 months ago)
- Language: TypeScript
- Size: 4.23 MB
- Stars: 635
- Watchers: 12
- Forks: 165
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# React Native FBSDK Next
This project aims to keep continuity of the [React Native FBSDK](https://github.com/facebook/react-native-fbsdk) from Facebook. As Facebook dropped support from it. As a community for this is our effort in order to keep upgrading and improving support for this module.
React Native FBSDK is a wrapper around the iOS Facebook SDK and Android Facebook SDK, allowing for Facebook integration in [React Native](https://facebook.github.io/react-native/) apps. Access to native components, from login to sharing, is provided entirely through documented JavaScript modules so you don't have to call a single native function directly.
Functionality is provided through one single npm package so you can use it for both platforms without downloading any extra packages. Follow this guide to use react-native-fbsdk in your React Native app. You can also visit https://developers.facebook.com/docs/react-native for tutorials and reference documentation.
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#join-the-react-native-community)
- [License](#license)
---
## Installation
## React Native Compatibility
To use this library you need to ensure you match up with the correct version of React Native you are using.
| FB SDK | lib version | Required React Native Version |
| --------- | ------------------------------------- | ----------------------------- |
| >= 9.3.0+ | `react-native-fbsdk-next` `> 4.3.0` | `>=0.63.3`* |
| >= 9.0.0+ | `react-native-fbsdk-next` `>= 3.0.1` | `>= 0.60` |
| <= 8.0.1 | `react-native-fbsdk` `>= 1.0.0` | `>= 0.60` |
| <= 8.0.1 | `react-native-fbsdk` `<= 0.10` | `<= 0.59.x` |
> ⚠️ * Attention
>
> Please notice that this module in versions after 4.2.0 only supports React Native versions above 0.63.3 as it's the oldest version of React Native which support latest XCode version. Technically, it may work on older versions (test it to be sure) but **they are not supported**. Changes that accidentally break older react-native versions may be issued without regard to semantic versioning constraints because we do not test against the older versions. Please see [this issue](https://github.com/thebergamo/react-native-fbsdk-next/issues/30) for an example of a previous break. Please update to current `react-native` versions.
### 1. Install the library
using either Yarn:
```
yarn add react-native-fbsdk-next
```
or npm:
```
npm install --save react-native-fbsdk-next
```
### 2. Link
- **React Native 0.60+**
[CLI autolink feature](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) links the module while building the app.
*Note* For `iOS` using `cocoapods`, run:
```bash
$ cd ios/ && pod install
```
- **React Native <= 0.59**
> For support with React Native <= 0.59, please refer to [React Native FBSDK](https://github.com/facebook/react-native-fbsdk)
If you can't or don't want to use the CLI tool, you can also manually link the library using the instructions below (click on the arrow to show them):
Manually link the library on iOS
Either follow the [instructions in the React Native documentation](https://facebook.github.io/react-native/docs/linking-libraries-ios#manual-linking) to manually link the framework or link using [Cocoapods](https://cocoapods.org) by adding this to your `Podfile`:
```ruby
pod 'react-native-fbsdk-next', :path => '../node_modules/react-native-fbsdk-next'
```
Manually link the library on Android
Make the following changes:
#### `android/settings.gradle`
```groovy
include ':react-native-fbsdk-next'
project(':react-native-fbsdk-next').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-fbsdk-next/android')
```
#### `android/app/build.gradle`
```groovy
dependencies {
...
implementation project(':react-native-fbsdk-next')
}
```
#### `android/app/src/main/.../MainApplication.java`
On top, where imports are:
```java
import com.facebook.reactnative.androidsdk.FBSDKPackage;
```
Add the `FBSDKPackage` class to your list of exported packages.
```java
@Override
protected List getPackages() {
return Arrays.asList(
new MainReactPackage(),
new FBSDKPackage()
);
}
```
### 3. Configure projects
#### 3.1 Android
Before you can run the project, follow the [Getting Started Guide](https://developers.facebook.com/docs/android/getting-started/) for Facebook Android SDK to set up a Facebook app. You can skip the build.gradle changes since that's taken care of by the rnpm link step above, but **make sure** you follow the rest of the steps such as updating `strings.xml` and `AndroidManifest.xml`. In addition, keep in mind that you have to point the Key Hash generation command at your app's `debug.keystore` file. You can find its location by checking [`storeFile`](https://developer.android.com/studio/build/gradle-tips#sign-your-app) in one of the `build.gradle` files (its default path is `android/app/build.gradle` however this can vary from project to project).
#### 3.2 iOS
Follow ***steps 2, 3 and 4*** in the [Getting Started Guide](https://developers.facebook.com/docs/ios/use-cocoapods) for Facebook SDK for iOS.
**NOTE:** The above link (Step 3 and 4) contains Swift code instead of Objective-C which is inconvenient since `react-native` ecosystem still relies
on Objective-C. To make it work in Objective-C you need to do the following in `/ios/PROJECT/AppDelegate.m`:
1. Add
```objc
#import
#import
#import
```
2. Inside `didFinishLaunchingWithOptions`, add the following:
```objc
[[FBSDKApplicationDelegate sharedInstance] application:application
didFinishLaunchingWithOptions:launchOptions];
```
3. After this step, if you run into this `build` issue: `Undefined symbols for architecture x86_64:`,
then you need to create a new file `File.swift` on your project folder. After doing this, you will get a prompt from `Xcode` asking if you would like to create a `Bridging Header`. Click accept.
4. From the facebook-ios-sdk docs steps 1-3, but in Objective-C since they have moved to Swift for their examples - make something like the following code is in AppDelegate.m:
```objc
- (BOOL)application:(UIApplication *)app
openURL:(NSURL *)url
options:(NSDictionary *)options
{
return [[FBSDKApplicationDelegate sharedInstance]application:app
openURL:url
options:options];
}
```
Without this code login might not work if Facebook app is installed, see https://github.com/thebergamo/react-native-fbsdk-next/issues/59#issuecomment-1038149447 - if you are also using react-native deep-linking you may need have multiple entries in this openURL method, as detailed in the next section
**If you're not using cocoapods already** you can also follow step 1.1 to set it up.
**If you're using React Native's RCTLinkingManager**
The `AppDelegate.m` file can only have one method for `openUrl`. If you're also using `RCTLinkingManager` to handle deep links, you should handle both results in your `openUrl` method.
```objc
#import // <- Add This Import
#import // <- Add This Import
#import // <- Add This Import
#import // <- Add This Import
- (BOOL)application:(UIApplication *)app
openURL:(NSURL *)url
options:(NSDictionary *)options
{
if ([[FBSDKApplicationDelegate sharedInstance] application:app openURL:url options:options]) {
return YES;
}
if ([RCTLinkingManager application:app openURL:url options:options]) {
return YES;
}
return NO;
}
```
### Troubleshooting
1. You cannot run the Android project.
- Make sure you added the code snippet in step 3.1.
- Make sure you set up a Facebook app and updated the `AndroidManifest.xml` and `res/values/strings.xml` with Facebook app settings.
2. You get duplicate symbol errors.
- Make sure that `FBSDK[Core, Login, Share]Kit.framework` are **not** in `Link Binary with Libraries` for your **root project** when using CocoaPods.
3. You get this build error: `no type or protocol named UIApplicationOpenURLOptionsKey`.
- Your Xcode version is too old. Upgrade to Xcode 10.0+.
4. You get a compilation error with the error `Undefined symbols for architecture x86_64`.
```
Undefined symbols for architecture x86_64:
"_swift_FORCE_LOAD$_swiftUniformTypeIdentifiers", referenced from:
_swift_FORCE_LOAD$swiftUniformTypeIdentifiers$_FBSDKShareKit in libFBSDKShareKit.a(Enums+Extensions.o)
(maybe you meant: _swift_FORCE_LOAD$swiftUniformTypeIdentifiers$_FBSDKShareKit)
"_swift_FORCE_LOAD$_swiftCoreMIDI", referenced from:
_swift_FORCE_LOAD$swiftCoreMIDI$_FBSDKShareKit in libFBSDKShareKit.a(Enums+Extensions.o)
(maybe you meant: _swift_FORCE_LOAD$swiftCoreMIDI$_FBSDKShareKit)
"_swift_FORCE_LOAD$_swiftWebKit", referenced from:
_swift_FORCE_LOAD$swiftWebKit$_FBSDKCoreKit in libFBSDKCoreKit.a(AccessToken.o)
_swift_FORCE_LOAD$swiftWebKit$_FBSDKCoreKit in libFBSDKCoreKit.a(Permission.o)
_swift_FORCE_LOAD$swiftWebKit$_FBSDKCoreKit in libFBSDKCoreKit.a(Settings.o)
_swift_FORCE_LOAD$swiftWebKit$_FBSDKLoginKit in libFBSDKLoginKit.a(FBLoginButton.o)
_swift_FORCE_LOAD$swiftWebKit$_FBSDKLoginKit in libFBSDKLoginKit.a(LoginManager.o)
_swift_FORCE_LOAD$swiftWebKit$_FBSDKShareKit in libFBSDKShareKit.a(Enums+Extensions.o)
(maybe you meant: _swift_FORCE_LOAD$swiftWebKit$_FBSDKLoginKit, _swift_FORCE_LOAD$swiftWebKit$_FBSDKShareKit , _swift_FORCE_LOAD$swiftWebKit$_FBSDKCoreKit )
ld: symbol(s) not found for architecture x86_64
```
After **[facebook-ios-sdk](https://github.com/facebook/facebook-ios-sdk) v7** (written with Swift parts) you need to coordinate Swift language usage with Objective-C for iOS.
Either:
- add a new file named `File.Swift` in the main project folder and answer "yes" when Xcode asks you if you want to "Create Bridging Header"
The empty swift file makes this change to the Header Search Path on your build settings:
```bash
$(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)
$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)
```
- or add this stanza in the postinstall section of your Podfile as a possible workaround (then `pod deintegrate && pod install`):
```ruby
# Mixing Swift and Objective-C in a react-native project may be problematic.
# Workaround: https://github.com/facebookarchive/react-native-fbsdk/issues/755#issuecomment-787488994
installer.aggregate_targets.first.user_project.native_targets.each do |target|
target.build_configurations.each do |config|
config.build_settings['LIBRARY_SEARCH_PATHS'] = ['$(inherited)', '$(SDKROOT)/usr/lib/swift']
end
end
```
Both result in fixing search paths.
5. `AppLink.fetchDeferredAppLink` does not work (on iOS at least).
Both the Facebook App and your app have to have App Tracking Transparency (ATT) permission granted for facebook deferred app links to work. See [this related issue](https://github.com/thebergamo/react-native-fbsdk-next/issues/104#issuecomment-931488609)
6. You get an exception `App ID not found. Add a string value with your app ID for the key FacebookAppID to the Info.plist or call [FBSDKSettings setAppID:].`
If you find yourself in this situation, and you are certain that you have the FacebookAppID in your `Info.plist` or that you have called `setAppId`, you *may* be able to fix it by adding the following lines to `AppDelegate.m` inside the `- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions`, just before the `return YES` statement:
```objective-c
[[FBSDKApplicationDelegate sharedInstance] application:application
didFinishLaunchingWithOptions:launchOptions];
```
7. You don't see any events in the Facebook Events Manager
For it to work you need to:
- Run the app on a real device
- Have the facebook app running in the background and logged in to an account
- Have that account you used on Facebook added as an "Advertising Account" for your app on Facebook's dashboard
- **Most important:** Have ATT enabled on both the **Facebook app** and **your app**.
This will make it so events you log on your app by **you** – which I guess they determine by seeing who is logged in on the Facebook App – are the ones to show up on the Event manager.
8. You get “There is an error in logging you into this application” when attempting to log in via the native Facebook app on Android.
This typically means the appropriate signing certificate hash hasn’t been saved to your Facebook app.
You can follow the [instructions here](https://developers.facebook.com/docs/facebook-login/android#6--provide-the-development-and-release-key-hashes-for-your-app) to generate and save the hash from your signing certificate.
**Note:** If Google is signing your releases, you’ll need to get the SHA-1 from the **Release** > **App signing** > **App signing key certificate** in the [Play Console](https://play.google.com/console/) and run this command:
```bash
echo YOUR_SHA1_HERE | xxd -r -p | openssl base64
```
If you’re also using App Tester for internal releases, you’ll need to run the same command for the SHA-1 from **Release** > **Internal app sharing** > **Internal test certificate** and save that hash as well.
Once you have your hashes, return [here](https://developers.facebook.com/docs/facebook-login/android#6--provide-the-development-and-release-key-hashes-for-your-app) and enter them under **Key Hashes**.
## Usage
### SDK Initialization
To comply with Apple privacy requirements, for iOS the `autoInitEnabled` option is removed from [facebook-ios-sdk#v9.0.0](https://github.com/facebook/facebook-ios-sdk/blob/master/CHANGELOG.md#900).
Using this module, there are two options to comply with this requirement, one is platform-neutral and can be used from your javascript code whenever it makes sense for your app, and one is native.
### Setting Facebook app ID from code
In case you e.g. would like to use multiple facebook apps, you can set the facebook app ID using setAppID
```js
import { Settings } from 'react-native-fbsdk-next';
// Setting the facebook app id using setAppID
// Remember to set CFBundleURLSchemes in Info.plist on iOS if needed
Settings.setAppID('APP ID');
```
#### Platform-neutral SDK initialization
If you do not need to handle a [GDPR-type opt-in flow](https://developers.facebook.com/docs/app-events/gdpr-compliance), on iOS you should include the following javascript code as early in startup as possible. For Android auto-init is the default still, so this is not strictly necessary for Android but will work.
If you need to handle a GDPR-type flow, make sure your SDK is configured natively to delay all logging activity according to [the GDPR instructions](https://developers.facebook.com/docs/app-events/gdpr-compliance), ask for user consent, and after obtaining consent include code similar to this:
```js
import { Settings } from 'react-native-fbsdk-next';
// Ask for consent first if necessary
// Possibly only do this for iOS if no need to handle a GDPR-type flow
Settings.initializeSDK();
```
#### iOS Native Initialization
If you would like to initialize the Facebook SDK even earlier in startup for iOS, you need to include this code in your AppDelegate.m file now that auto-initialization is removed.
```objective-c
#import // <- Add This Import
#import // <- Add This Import
#import // <- Add This Import
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
[FBSDKApplicationDelegate.sharedInstance initializeSDK]; // <- add this
// your other stuff
}
```
### [Login](https://developers.facebook.com/docs/facebook-login)
#### Login Button + Access Token
```jsx
import React, { Component } from 'react';
import { View } from 'react-native';
import { AccessToken, LoginButton } from 'react-native-fbsdk-next';
export default class Login extends Component {
render() {
return (
{
if (error) {
console.log("login has error: " + result.error);
} else if (result.isCancelled) {
console.log("login is cancelled.");
} else {
AccessToken.getCurrentAccessToken().then(
(data) => {
console.log(data.accessToken.toString())
}
)
}
}
}
onLogoutFinished={() => console.log("logout.")}/>
);
}
};
```
#### Requesting additional permissions with Login Manager
You can also use the Login Manager with custom UI to perform Login.
```js
// ...
import { LoginManager } from "react-native-fbsdk-next";
// ...
// Attempt a login using the Facebook login dialog asking for default permissions.
LoginManager.logInWithPermissions(["public_profile"]).then(
function(result) {
if (result.isCancelled) {
console.log("Login cancelled");
} else {
console.log(
"Login success with permissions: " +
result.grantedPermissions.toString()
);
}
},
function(error) {
console.log("Login fail with error: " + error);
}
);
```
#### Get profile information
You can retrieve the profile information after a successful login attempt. The data returned will be related to the type of
authentication you are using (limited or not) and the permission granted by the login method.
```js
// ...
import { Profile } from "react-native-fbsdk-next";
// ...
const currentProfile = Profile.getCurrentProfile().then(
function(currentProfile) {
if (currentProfile) {
console.log(
"The current logged user is: " +
currentProfile.name +
". Their profile id is: " +
currentProfile.userID
);
}
}
);
```
There's some platform related specific behaviors that you need to consider:
- On Android, the `email` field isn't retrieved even if the `[..., "email", ...]` permission is requested.
In fact, the `email` field doesn't exist in the native Java SDK provided by Facebook at the moment ([reference](https://developers.facebook.com/docs/reference/androidsdk/current/facebook/com/facebook/profile.html/)).
- The width and height query params for the profile picture URI will be 100 (iOS SDK default values).
### [Limited Login (iOS only)](https://developers.facebook.com/docs/facebook-login/limited-login/ios)
#### Login Button with Limited Login + Authentication Token
[Limited Login](https://developers.facebook.com/docs/facebook-login/limited-login/) was introduced by Facebook based on Apple’s [App Transparency Tracking enforcement](https://developer.apple.com/news/?id=3d8a9yyh) so that iOS users who have opted out of ATT are able to use Facebook login.
**Note:** Limited Login is required for iOS if using React Native FBSDK Next >= 13.0.0 due to [facebook-ios-sdk#v17.0.0](https://github.com/facebook/facebook-ios-sdk/blob/master/CHANGELOG.md#1700) (see [this comment](https://github.com/facebook/facebook-ios-sdk/issues/2384#issuecomment-2080038284)).
**`loginTrackingIOS`**: The possible values are `"enabled"` and `"limited"`. The default is `"enabled"`.
When `loginTrackingIOS` is `"limited"`, an `AccessToken` will be unavailable. Instead an `AuthenticationToken` that wraps an OpenID Connect token is provided.
**Note:** An `AuthenticationToken` **cannot** be used to access the GraphAPI. Attempting to do so will result in this error:
```json
{
"error": {
"message": "Invalid OAuth access token - Cannot parse access token",
"type": "OAuthException",
"code": 190,
"fbtrace_id": "AqAQuOb32_wZqY1R132lpBI"
}
}
```
See [this issue](https://github.com/thebergamo/react-native-fbsdk-next/issues/521) for more information.
`nonceIOS`: Limited Login allows developers to optionally pass a custom nonce for use in [validating an authentication attempt](https://developers.facebook.com/docs/facebook-login/limited-login/token/validating) on their servers. A valid nonce must be a non-empty string without whitespace. An invalid nonce will not be set. Instead, a default unique nonce will be used.
```jsx
import React, { Component } from 'react';
import { Platform, View } from 'react-native';
import {
AccessToken,
AuthenticationToken,
LoginButton,
} from 'react-native-fbsdk-next';
export default class Login extends Component {
render() {
return (
{
if (error) {
console.log("login has error: " + result.error);
} else if (result.isCancelled) {
console.log("login is cancelled.");
} else {
if (Platform.OS === "ios") {
AuthenticationToken.getAuthenticationTokenIOS().then((data) => {
console.log(data?.authenticationToken);
});
} else {
AccessToken.getCurrentAccessToken().then((data) => {
console.log(data?.accessToken.toString());
});
}
}
}}
onLogoutFinished={() => console.log("logout.")}
loginTrackingIOS="limited"
nonceIOS="my_nonce" // Optional
/>
);
}
}
```
#### Login Manager with Limited Login + Authentication Token
```js
//...
import {
AccessToken,
AuthenticationToken,
LoginManager,
} from "react-native-fbsdk-next";
//...
try {
const result = await LoginManager.logInWithPermissions(
[
"public_profile",
"email",
],
"limited",
"my_nonce", // Optional
);
console.log(result);
if (Platform.OS === "ios") {
// This token **cannot** be used to access the Graph API.
// https://developers.facebook.com/docs/facebook-login/limited-login/
const result = await AuthenticationToken.getAuthenticationTokenIOS();
console.log(result?.authenticationToken);
} else {
// This token can be used to access the Graph API.
const result = await AccessToken.getCurrentAccessToken();
console.log(result?.accessToken);
}
} catch (error) {
console.log(error);
}
//...
```
### [Sharing](https://developers.facebook.com/docs/sharing)
#### Share dialogs
All of the dialogs included are used in a similar way, with differing content types.
```js
// ...
import { ShareDialog } from 'react-native-fbsdk-next';
// ...
// Build up a shareable link.
const shareLinkContent = {
contentType: 'link',
contentUrl: "https://facebook.com",
};
// ...
// Share the link using the share dialog.
shareLinkWithShareDialog() {
var tmp = this;
ShareDialog.canShow(this.state.shareLinkContent).then(
function(canShow) {
if (canShow) {
return ShareDialog.show(tmp.state.shareLinkContent);
}
}
).then(
function(result) {
if (result.isCancelled) {
console.log("Share cancelled");
} else {
console.log("Share successful with postId: " + result.postId);
}
},
function(error) {
console.log("Share failed with error: " + error);
}
);
}
```
#### Share Photos
See [SharePhotoContent](/js/models/FBSharePhotoContent.js) and [SharePhoto](/js/models/FBSharePhoto.js) to refer other options.
```js
// ...
import { ShareApi } from "react-native-fbsdk-next";
// ...
const photoUri = "file://" + "/path/of/photo.png";
const sharePhotoContent = {
contentType = "photo",
photos: [{ imageUrl: photoUri }],
};
// ...
ShareDialog.show(tmp.state.sharePhotoContent);
```
#### Share Videos
See [ShareVideoContent](/js/models/FBShareVideoContent.js) and [ShareVideo](/js/models/FBShareVideo.js) to refer other options.
```js
// ...
import { ShareApi } from "react-native-fbsdk-next";
// ...
const videoUri = "file://" + "/path/of/video.mp4";
const shareVideoContent = {
contentType = "video",
video: { localUrl: videoUri },
};
// ...
ShareDialog.show(tmp.state.shareVideoContent);
```
#### Share API
Your app must have the `publish_actions` permission approved to share through the share API. You should prefer to use the Share Dialogs for an easier and more consistent experience.
```js
// ...
import { ShareApi } from 'react-native-fbsdk-next';
// ...
// Build up a shareable link.
const shareLinkContent = {
contentType: "link",
contentUrl: "https://facebook.com",
};
// ...
// Share using the share API.
ShareApi.canShare(this.state.shareLinkContent).then(
var tmp = this;
function(canShare) {
if (canShare) {
return ShareApi.share(tmp.state.shareLinkContent, "/me", "Some message.");
}
}
).then(
function(result) {
console.log("Share with ShareApi success.");
},
function(error) {
console.log("Share with ShareApi failed with error: " + error);
}
);
```
### [App Events](https://developers.facebook.com/docs/app-events)
#### App events
```js
// ...
import { AppEventsLogger } from "react-native-fbsdk-next";
// ...
// Log a $15 purchase.
AppEventsLogger.logPurchase(15, "USD", { param: "value" });
// Log standard event. e.g. completed registration
AppEventsLogger.logEvent(AppEventsLogger.AppEvents.CompletedRegistration, {
[AppEventsLogger.AppEventParams.RegistrationMethod]: "email",
});
```
### [Aggregated Event Measurement(AEM) for iOS](https://developers.facebook.com/docs/app-events/guides/aggregated-event-measurement/)
Aggregated Event Measurement (AEM) for iOS apps allows for the measurement of app events from iOS 14.5+ users who have opted out of app tracking. To implement AEM for your app you can follow the steps below.
#### **Step 1. Connect the App Delegate**
Add the following code in the system `application:openURL:options:` function from `AppDelegate`/`SceneDelegate` where `{app-id}` is your Facebook app ID. The call sequence matters.
The DeepLink URL from the re-engagement ads should be passed to the AEM Kit even if the app is opened in cold start.
```objc
#import
// apply codes below to `application:openURL:options:`
// in `AppDelegate.m` or `SceneDelegate.m`
[FBAEMReporter configureWithNetworker:nil appID:@"{app-id}" reporter:nil]; // Replace {app-id} with your Facebook App id
[FBAEMReporter enable];
[FBAEMReporter handle:url];
```
#### **Step 2. Add AEM Logging**
Use the AEMReporterIOS exported from the sdk to log event to AEM, `logAEMEvent` function will bypass if platform isn't iOS, it's safe to call without platform determined.
```js
import {AEMReporterIOS} from 'react-native-fbsdk-next';
// This will do nothing if Platform.OS !== "ios"
AEMReporterIOS.logAEMEvent(eventName, value, currency, otherParameters);
```
Event names for AEM must match event names you used in app event logging.
Here's an example of how to use this method -
```ts
LogFBPurchase = (purchaseAmount: number, currencyCode: string, parameters?: Params | undefined) => {
AppEventsLogger.logPurchase(purchaseAmount, currencyCode, parameters);
AEMReporterIOS.logAEMEvent("fb_mobile_purchase", purchaseAmount, currencyCode, parameters);
}
LogFBEvent = (eventName: string, valueToSum: number, parameters: Record)=> {
AppEventsLogger.logEvent(eventName, valueToSum, parameters);
AEMReporterIOS.logAEMEvent(eventName, valueToSum, parameters.fb_currency, parameters);
}
```
### [Graph API](https://developers.facebook.com/docs/graph-api)
**Note:** Graph API requests cannot be made with a [Limited Login](https://developers.facebook.com/docs/facebook-login/limited-login/) `AuthenticationToken`.
#### Graph API Requests
```js
// ...
import { GraphRequest, GraphRequestManager } from 'react-native-fbsdk-next';
// ...
// Create response callback.
_responseInfoCallback(error, result) {
if (error) {
console.log("Error fetching data: " + error.toString());
} else {
console.log("Success fetching data: " + result.toString());
}
}
// Create a graph request asking for user information with a callback to handle the response.
const infoRequest = new GraphRequest(
"/me",
null,
this._responseInfoCallback,
);
// Start the graph request.
new GraphRequestManager().addRequest(infoRequest).start();
```
## Expo installation
> This package cannot be used in the "Expo Go" app because [it requires custom native code](https://docs.expo.io/workflow/customizing/).
After installing this npm package, add the [config plugin](https://docs.expo.io/guides/config-plugins/) to the [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) array of your `app.json` or `app.config.js`:
```json
{
"expo": {
"plugins": ["react-native-fbsdk-next"]
}
}
```
Unless you are managing your own native code, the config plugin must be configured per the following "API" section.
Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) guide.
### API
The plugin provides props for extra customization. Every time you change the props or plugins, you'll need to rebuild (and `prebuild`) the native app. If no extra properties are added, defaults will be used.
Required configuration:
- `appID` (_string_): Facebook Application ID.
- `displayName` (_string_): Application Name.
- `clientToken` (_string_): Client Token.
- `scheme` (_string_): The scheme to use for returning to the app from Facebook. Of the form `fb[app-id]`.
Optional configuration:
- `iosUserTrackingPermission` (_string_ || false): iOS User Tracking Permission.
- `advertiserIDCollectionEnabled` (_boolean_): Enable advertiser ID collection. Default `false`.
- `autoLogAppEventsEnabled` (_boolean_): Default `false`.
- `isAutoInitEnabled` (_boolean_): Default `false`.
> If you are migrating from `expo-facebook` to this library, it is important to consider that `clientToken` was not required in `expo-facebook`, but it is required here. You can get that value from "Facebook Developers > Your App > Configurations > Advanced".
#### Example
```json
{
"expo": {
"plugins": [
[
"react-native-fbsdk-next",
{
"appID": "48127127xxxxxxxx",
"clientToken": "c5078631e4065b60d7544a95xxxxxxxx",
"displayName": "RN SDK Demo",
"scheme": "fb48127127xxxxxxxx",
"advertiserIDCollectionEnabled": false,
"autoLogAppEventsEnabled": false,
"isAutoInitEnabled": true,
"iosUserTrackingPermission": "This identifier will be used to deliver personalized ads to you."
}
]
]
}
}
```
## Enabling Auto App Installs in Expo
To enable auto app installs in Expo, you need to set autoLogAppEventsEnabled and advertiserIDCollectionEnabled flags to **true** in your `app.json` or `app.config.js`.
Moreover, on iOS you need user consent to collect user data. You can do this by adding the following code somewhere to your `App.tsx`:
```js
import { requestTrackingPermissionsAsync } from 'expo-tracking-transparency';
const { status } = await requestTrackingPermissionsAsync();
Settings.initializeSDK();
if (status === 'granted') {
await Settings.setAdvertiserTrackingEnabled(true);
}
```
## Migrating from expo-facebook to react-native-fbsdk-next
The [expo-facebook](https://github.com/expo/expo-facebook) module was deprecated in Expo SDK 45 and removed in Expo SDK 46. The following feature parity table lists the `expo-facebook` API functions and their `react-native-fbsdk-native` counterparts, where available:
| expo-facebook | Supported | react-native-fbsdk-next |
| --- | --- | --- |
| [flushAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#flushasync) | ✅ | AppEventsLogger.flush() |
| [getAdvertiserIDAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#getadvertiseridasync) | ❌ | Not supported |
| [getAnonymousIDAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#getanonymousidasync) | ✅ | AppEventsLogger.getAnonymousID() |
| [getAttributionIDAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#getattributionidasync) | ✅ | AppEventsLogger.getAttributionID() |
| [getAuthenticationCredentialAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#getauthenticationcredentialasync) | ✅ | AccessToken.accessToken |
| [getPermissionsAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#getpermissionsasync) | ❌ | Not supported |
| [getUserIDAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#getuseridasync) | ✅ | AppEventsLogger.getUserId() |
| [initializeAsync(optionsOrAppId, appName)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#initializeasyncoptionsorappid-appname) | ✅ | Settings.setAppID($appId); Settings.setAppName($appName); Settings.setGraphAPIVersion($version); Settings.setAutoLogAppEventsEnabled($autoLogAppEvents);
Settings.initializeSDK() |
| [logEventAsync(eventName, parameters)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#logeventasynceventname-parameters) | ✅ | AppEventsLogger.logEvent(eventName, parameters) |
| [logInWithReadPermissionsAsync(options)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#loginwithreadpermissionsasyncoptions) | ✅ | LoginManager.logInWithPermissions(permissions) |
| [logOutAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#logoutasync) | ✅ | LoginManager.logOut() |
| [logPurchaseAsync(purchaseAmount, currencyCode, parameters)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#logpurchaseasyncpurchaseamount-currencycode-parameters) | ✅ | AppEventsLogger.logPurchase(purchaseAmount, currency, parameters) |
| [logPushNotificationOpenAsync(campaign)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#logpushnotificationopenasynccampaign) | ✅ | AppEventsLogger.logPushNotificationOpen(payload) |
| [requestPermissionsAsync()](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#requestpermissionsasync) | ❌ | Not supported |
| [setAdvertiserIDCollectionEnabledAsync(enabled)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#setadvertiseridcollectionenabledasyncenabled) | ✅ | Settings.setAdvertiserIDCollectionEnabled(enabled) |
| [setAdvertiserTrackingEnabledAsync(enabled)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#setadvertisertrackingenabledasyncenabled) | ✅ | Settings.setAdvertiserTrackingEnabled(enabled) |
| [setAutoLogAppEventsEnabledAsync(enabled)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#setautologappeventsenabledasyncenabled) | ✅ | Settings.setAutoLogAppEventsEnabled(enabled) |
| [setUserDataAsync(userData)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#setuserdataasyncuserdata) | ✅ | AppEventsLogger.setUserData(userData) |
| [setUserIDAsync(userID)](https://docs.expo.dev/versions/v45.0.0/sdk/facebook/#setuseridasyncuserid) | ✅ | AppEventsLogger.setUserID(userID) |
## Example app
Start the metro javascript server:
```bash
yarn example:start
```
Then start either the iOS or android app:
```bash
yarn example:ios
```
or
```bash
yarn example:android
```
As you make changes to the module's code you will want to copy those into the example:
```bash
yarn example:devcopy
```
Note: You'll probably want to change the Facebook App ID to your own, else the example app won't be able to login. To change it, edit your local copy of `refresh-example.sh`, update the `FacebookAppId` variable, then re-run `refresh-example.sh` to regenerate the example directory.
To update the example app, you should be able to just run the refresh script:
```
refresh-example.sh
```
This will create a new app in the `RNFBSDKExample` directory, using the latest version of React Native.
Next, it will patch the necessary files so you may run the example app.
Occasionally react-native version changes mean that there is some incompatibility
between what the script expects to find in the fresh react-native app as it does
string search/replace operations, but typically they are easy to fix.
## Testing with Jest
We have a example mock inside `jest/setup.js` but you just add the following line to your setup file:
```js
jest.mock("react-native-fbsdk-next", () => require("react-native-fbsdk-next/jest/mocks").default);
```
You also can `spyOn` one of this mock to return whatever you want inside your test:
```js
import { LoginManager } from "react-native-fbsdk-next"
jest.spyOn(LoginManager, "logInWithPermissions").mockImplementation(() => Promise.resolve({ isCancelled: false }))
```
## Join the React Native community
- Website: https://facebook.github.io/react-native
- Twitter: https://twitter.com/reactnative
See the [CONTRIBUTING](./CONTRIBUTING.md) file for how to help out.
## License
See the [LICENSE](./LICENSE) file.