cordova-plugin-appsflyer-sdk
Advanced tools
Comparing version 6.1.20 to 6.1.30
@@ -41,3 +41,5 @@ # API | ||
| [`setUserEmails`](#setUserEmails) | `(emails, function success)` | Set user emails for FB Advanced Matching | | ||
| [`setPhoneNumber`](#setPhoneNumber) | `(String phoneNumber, function successr)` | Set phone number for FB Advanced Matching | | ||
| [`setPhoneNumber`](#setPhoneNumber) | `(String phoneNumber, function success)` | Set phone number for FB Advanced Matching | | ||
| [`setHost`](#setHost) | `(String hostPrefix, String hostName)` | Set custom host prefix and host name | | ||
| [`addPushNotificationDeepLinkPath`](#addPushNotificationDeepLinkPath) | `(path)` | configure push notification deep link resolution | | ||
@@ -103,4 +105,4 @@ | ||
| `eventValue` | `Object` | event details | | ||
| `onSuccess` | `(message: string)=>void` | event details | | ||
| `onError` | `(message: string)=>void` | event details | | ||
| `onSuccess` | `function` | triggered when the event was sent successfully. returns the event's name. can be Null | | ||
| `onError` | `function` | triggered when an error occurred. returns an error message. can be Null | | ||
@@ -126,2 +128,4 @@ *Example:* | ||
window.plugins.appsFlyer.logEvent(eventName, eventValues, successTrackEvent, failureTrackEvent); | ||
//OR | ||
window.plugins.appsFlyer.logEvent(eventName, eventValues, null, null); | ||
``` | ||
@@ -576,3 +580,36 @@ --- | ||
--- | ||
##### <a id="setHost"> **`setHost(String hostPrefix, String hostName): void`** | ||
Set custom host prefix and host name<br> | ||
*Example:* | ||
```javascript | ||
let prefix = "another" | ||
let name = "host" | ||
window.plugins.appsFlyer.setHost(prefix, name); | ||
``` | ||
| parameter | type | description | | ||
| ----------- |-----------------------------|--------------| | ||
| `hostPrefix` | `String` | host prefix | | ||
| `hostName` | `String` | host name | | ||
--- | ||
##### <a id="addPushNotificationDeepLinkPath"> **`addPushNotificationDeepLinkPath(path): void`** | ||
The addPushNotificationDeepLinkPath method provides app owners with a flexible interface for configuring how deep links are extracted from push notification payloads. for more information: [here](https://support.appsflyer.com/hc/en-us/articles/207032126-Android-SDK-integration-for-developers#core-apis-65-configure-push-notification-deep-link-resolution) | ||
❗Important❗ addPushNotificationDeepLinkPath must be called before calling initSDK | ||
*Example:* | ||
```javascript | ||
let path = ["go", "to", "this", "path"] | ||
window.plugins.appsFlyer.addPushNotificationDeepLinkPath(path); | ||
``` | ||
| parameter | type | description | | ||
| ----------- |-----------------------------|--------------| | ||
| `path` | `String[]` | strings array of the path | | ||
--- | ||
### <a id="deep-linking-tracking"> Deep linking Tracking | ||
@@ -579,0 +616,0 @@ |
# Release Notes | ||
### 6.1.30 | ||
Release date **January 11, 2021** | ||
Release type: Major / **Minor** / Hotfix | ||
**Overview and Highlights:** | ||
- iOS SDK 6.1.3 | ||
- Android SDK 6.1.3 | ||
- setHost api | ||
- addPushNotificationDeepLinkPath api | ||
- get in-App events callbacks from sdk | ||
### 6.1.20 | ||
@@ -3,0 +15,0 @@ Release date **December 16, 2020** |
{ | ||
"name": "cordova-plugin-appsflyer-sdk", | ||
"version": "6.1.20", | ||
"version": "6.1.30", | ||
"description": "Cordova AppsFlyer SDK Plugin", | ||
@@ -5,0 +5,0 @@ "cordova": { |
@@ -39,4 +39,4 @@ | ||
- iOS AppsFlyerSDK **v6.1.1** | ||
- Android AppsFlyerSDK **v6.1.0** | ||
- iOS AppsFlyerSDK **v6.1.3** | ||
- Android AppsFlyerSDK **v6.1.3** | ||
@@ -145,7 +145,32 @@ ### <a id="breakingChanges"> ❗v6 Breaking Changes | ||
## <a id="ionic"> 📍 Ionic | ||
***NOTICE!*** In AppsFlyer Cordova plugin version 6.x.x we replaced the word ``track`` with ``log`` from all our api but Ionic-Navite Appsflyer plugin still using ``track``<br> | ||
***NOTICE!*** In AppsFlyer Cordova plugin version 6.x.x we replaced the word ``track`` with ``log`` from all our api but Ionic-Navite Appsflyer plugin still uses ``track``<br> | ||
So the latest version that can work with Ionic-Native for now is **5.4.30**<br> | ||
In case you are using Ionic framework, you have 2 options: | ||
### 1 - Using Ionic native plugin | ||
### 1. Using the `window` object directly | ||
Install the cordova plugin: | ||
``` | ||
$ ionic cordova plugin add cordova-plugin-appsflyer-sdk | ||
``` | ||
In your main ts file, declare a window variable: | ||
```javascript | ||
declare var window; | ||
``` | ||
Now you can use the AppsFlyer plugin directly from cordova: | ||
```javascript | ||
import {Component} from '@angular/core'; | ||
import {Platform} from '@ionic/angular'; | ||
declare var window; | ||
... | ||
export class HomePage { | ||
constructor(public platform: Platform) { | ||
this.platform.ready().then(() => { | ||
window.plugins.appsFlyer.initSdk(options, success, error); | ||
}); | ||
} | ||
} | ||
``` | ||
### 2 - Using Ionic native plugin | ||
#### Ionic 4 | ||
@@ -204,5 +229,2 @@ run this commands: | ||
``` | ||
### 2. Using the `window` object directly | ||
You can use the plugin the same way like in Cordova with only one exception: | ||
instead of `window.plugins...` use `window['plugins']...` | ||
Check out the full [API](/docs/API.md) for more information |
# Release Notes | ||
### 6.1.30 | ||
Release date **January 11, 2021** | ||
Release type: Major / **Minor** / Hotfix | ||
**Overview and Highlights:** | ||
- iOS SDK 6.1.3 | ||
- Android SDK 6.1.3 | ||
- setHost api | ||
- addPushNotificationDeepLinkPath api | ||
- get in-App events callbacks from sdk | ||
### 6.1.20 | ||
@@ -3,0 +15,0 @@ Release date **December 16, 2020** |
@@ -305,3 +305,21 @@ var exec = require('cordova/exec'), | ||
}; | ||
/** | ||
* Set a custom host | ||
* @param hostPrefix | ||
* @param hostName | ||
*/ | ||
AppsFlyer.prototype.setHost = function (hostPrefix, hostName) { | ||
exec(null, null, 'AppsFlyerPlugin', 'setHost', [hostPrefix, hostName]); | ||
}; | ||
/** | ||
* The addPushNotificationDeepLinkPath method provides app owners with a flexible interface for configuring how deep links are extracted from push notification payloads. | ||
* for more information: https://support.appsflyer.com/hc/en-us/articles/207032126-Android-SDK-integration-for-developers#core-apis-65-configure-push-notification-deep-link-resolution | ||
* @param path: an array of string that represents the path | ||
*/ | ||
AppsFlyer.prototype.addPushNotificationDeepLinkPath = function (path) { | ||
exec(null, null, 'AppsFlyerPlugin', 'addPushNotificationDeepLinkPath', [path]); | ||
}; | ||
module.exports = new AppsFlyer(); | ||
})(window); |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
264203
52
1707
228