From 110e1ac15c7f6a3cb981c5ace4995205f580ed9e Mon Sep 17 00:00:00 2001 From: David Vawter <47464449+dgvawter@users.noreply.github.com> Date: Thu, 18 Apr 2019 16:47:11 -0700 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 994f79f..d9b2c1c 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,8 @@ In order to use the AppsFlyer wrapper: 1. [Follow the steps here](https://firebase.google.com/docs/analytics/android/start) to set up the Google Analytics for Firebase SDK in your app. -2. Copy the source files inside the AppsFlyerWrapper directory into your project. +2. Copy the source files inside the AppsFlyerWrapper directory into your + project. 3. Replace supported references to `AppsFlyerLib.getInstance()` with `AppsFlyerLibWrapper.getInstance()`, and references to `AppsFlyerProperties.getInstance()` with @@ -21,3 +22,28 @@ In order to use the AppsFlyer wrapper: Some methods are not supported by the wrapper. For these methods, directly call the base implementation in `AppsFlyerLib.getInstance()` or `AppsFlyerProperties.getInstance()`. + +### Supported Methods + +The following API methods and properties are supported in the AppsFlyer wrapper. +Use the wrapper by replacing `AppsFlyerLib.getInstance()` in these instances +with `AppsFlyerLibWrapper.getInstance()`: + +* `AppsFlyerLib.setAppUserId(id)` +* `AppsFlyerLib.setCustomerUserId(id)` +* `AppsFlyerLib.setCustomerIdAndTrack(id, context)` +* `AppsFlyerLib.init(key, appsFlyerConversionListener, context)` +* `AppsFlyerLib.startTracking(application)` +* `AppsFlyerLib.startTracking(application, key)` +* `AppsFlyerLib.startTracking(application, key, listener)` +* `AppsFlyerLib.setCurrencyCode(currencyCode)` +* `AppsFlyerLib.trackEvent(context, eventName, eventValue)` +* `AppsFlyerLib.setDeviceTrackingDisabled(isDisabled)` +* `AppsFlyerLib.setPreinstallAttribution(mediaSource, campaign, siteId)` +* `AppsFlyerLib.setMinTimeBetweenSessions(seconds)` + +Use the wrapper by replacing `AppsFlyerProperties.getInstance()` in these +instances with `AppsFlyerPropertiesWrapper.getInstance()`: + +* `AppsFlyerPropertiesWrapper.set(key, value)` +* `AppsFlyerPropertiesWrapper.remove(key)`