Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API - fixed internal links #589

Merged
merged 3 commits into from
Dec 15, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 48 additions & 45 deletions Docs/RN_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,52 +9,55 @@ hidden: false
## APIs

The list of available methods for this plugin is described below.
- [APIs](#apis)
- [Android and iOS APIs](#android-and-ios-apis)
- [initSDK](#initsdk)
- [startSdk](#startsdk)
- [logEvent](#logevent)
- [setCustomerUserId](#setcustomeruserid)
- [stop](#stop)
- [setAppInviteOneLinkID](#setappinviteonelinkid)
- [setAdditionalData](#setadditionaldata)
- [setResolveDeepLinkURLs](#setresolvedeeplinkurls)
- [setOneLinkCustomDomain](#setonelinkcustomdomain)
- [setCurrencyCode](#setcurrencycode)
- [logLocation](#loglocation)
- [anonymizeUser](#anonymizeuser)
- [getAppsFlyerUID](#getappsflyeruid)
- [setHost](#sethost)
- [setUserEmails](#setuseremails)
- [generateInviteLink](#generateinvitelink)
- [setSharingFilterForAllPartners](#setsharingfilterforallpartners) *Deprecated*
- [setSharingFilter](#setsharingfilter) *Deprecated*
- [setSharingFilterForPartners](#setsharingfilterforpartners)
- [validateAndLogInAppPurchase](#validateandloginapppurchase)
- [updateServerUninstallToken](#updateserveruninstalltoken)
- [sendPushNotificationData](#sendpushnotificationdata)
- [addPushNotificationDeepLinkPath](#addpushnotificationdeeplinkpath)
- [appendParametersToDeepLinkingURL](#appendparameterstodeeplinkingurl)
- [disableAdvertisingIdentifier](#disableAdvertisingIdentifier)
- [enableTCFDataCollection](#enableTCFDataCollection)
- [setConsentData](#setConsentData)
- [logAdRevenue](#logAdRevenue)
- [initSdk](#initsdk)
- [startSdk](#startsdk)
- [logEvent](#logevent)
- [setCustomerUserId](#setcustomeruserid)
- [stop](#stop)
- [setAppInviteOneLinkID](#setappinviteonelinkid)
- [setAdditionalData](#setadditionaldata)
- [setResolveDeepLinkURLs](#setresolvedeeplinkurls)
- [setOneLinkCustomDomains](#setonelinkcustomdomains)
- [setCurrencyCode](#setcurrencycode)
- [logLocation](#loglocation)
- [anonymizeUser](#anonymizeuser)
- [getAppsFlyerUID](#getappsflyeruid)
- [setHost](#sethost)
- [setUserEmails](#setuseremails)
- [generateInviteLink](#generateinvitelink)
- [setSharingFilterForAllPartners](#setsharingfilterforallpartners)
- [setSharingFilter](#setsharingfilter)
- [setSharingFilterForPartners](#setsharingfilterforpartners)
- [validateAndLogInAppPurchase](#validateandloginapppurchase)
- [updateServerUninstallToken](#updateserveruninstalltoken)
- [sendPushNotificationData](#sendpushnotificationdata)
- [addPushNotificationDeepLinkPath](#addpushnotificationdeeplinkpath)
- [appendParametersToDeepLinkingURL](#appendparameterstodeeplinkingurl)
- [disableAdvertisingIdentifier](#disableadvertisingidentifier)
- [enableTCFDataCollection](#enabletcfdatacollection)
- [setConsentData](#setconsentdata)
- [logAdRevenue](#logadrevenue)
- [Parameters](#parameters)
- [Usage Example for React Native:](#usage-example-for-react-native)
- [Android Only APIs](#android-only-apis)
- [setCollectAndroidID](#setcollectandroidid)
- [setCollectIMEI](#setcollectimei)
- [setDisableNetworkData](#setdisablenetworkdata)
- [performOnDeepLinking](#performondeeplinking)
- [setCollectAndroidID](#setcollectandroidid)
- [setCollectIMEI](#setcollectimei)
- [setDisableNetworkData `setDisableNetworkData(disable)`](#setdisablenetworkdata-setdisablenetworkdatadisable)
- [performOnDeepLinking](#performondeeplinking)
- [iOS Only APIs](#ios-only-apis)
- [disableCollectASA](#disablecollectasa)
- [setUseReceiptValidationSandbox](#setusereceiptvalidationsandbox)
- [disableSKAD](#disableskad)
- [setCurrentDeviceLanguage](#setcurrentdevicelanguage)
- [disableIDFVCollection](#disableidfvcollection)
- [disableCollectASA](#disablecollectasa)
- [disableIDFVCollection](#disableidfvcollection)
- [setUseReceiptValidationSandbox](#setusereceiptvalidationsandbox)
- [disableSKAD](#disableskad)
- [setCurrentDeviceLanguage](#setcurrentdevicelanguage)
- [AppsFlyerConversionData](#appsflyerconversiondata)
- [onInstallConversionData](#oninstallconversiondata)
- [onInstallConversionFailure](#oninstallconversionfailure)
- [onAppOpenAttribution](#onappopenattribution)
- [onAttributionFailure](#onattributionfailure)
- [onDeepLink](#ondeeplink)
- [onInstallConversionData](#oninstallconversiondata)
- [onInstallConversionFailure](#oninstallconversionfailure)
- [onAppOpenAttribution](#onappopenattribution)
- [onAttributionFailure](#onattributionfailure)
- [onDeepLink](#ondeeplink)
---

## Android and iOS APIs
Expand Down Expand Up @@ -109,7 +112,7 @@ appsFlyer.initSdk(
```
---

#### startSdk
### startSdk
`startSdk()`

In version 6.9.1 of the react-native-appslfyer SDK we added the option of splitting between the initialization stage and start stage. All you need to do is add the property manualStart: true to the init object, and later call appsFlyer.startSdk() whenever you decide. If this property is set to false or doesn’t exist, the sdk will start after calling `appsFlyer.initSdk(...)`.
Expand Down Expand Up @@ -147,7 +150,7 @@ appsFlyer.initSdk(
```
---

#### logEvent
### logEvent
`logEvent(eventName, eventValues, success, error)`

In-App Events provide insight on what is happening in your app. It is recommended to take the time and define the events you want to measure to allow you to measure ROI (Return on Investment) and LTV (Lifetime Value).
Expand Down Expand Up @@ -798,7 +801,7 @@ let GDPRUser = AppsFlyerConsent.forGDPRUser(true, false);
appsFlyer.setConsentData(nonGDPRUser /**or**/ GDPRUser);
```

### logAdRevenue - Since 6.15.1
### logAdRevenue
`logAdRevenue(data: AFAdRevenueData): void`

Use this method to log your ad revenue.</br>
Expand Down
Loading