appsflyer-capacitor-plugin/README.md

AppsFlyer SDK plugin for Capacitor

<img src="https://raw.githubusercontent.com/AppsFlyerSDK/appsflyer-capacitor-plugin/main/assets/AFLogo_primary.png"  width="600" > 

# AppsFlyer Capacitor plugin for Android and iOS.


[![npm version](https://badge.fury.io/js/appsflyer-capacitor-plugin.svg)](https://badge.fury.io/js/appsflyer-capacitor-plugin)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) 
[![Downloads](https://img.shields.io/npm/dm/appsflyer-capacitor-plugin)](https://www.npmjs.com/package/appsflyer-capacitor-plugin)

🛠 In order for us to provide optimal support, we would kindly ask you to submit any issues to support@appsflyer.com

> *When submitting an issue please specify your AppsFlyer sign-up (account) email , your app ID , production steps, logs, code snippets and any additional relevant information.*


### <a id="plugin-build-for"> This plugin is built for:

<img src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/android/android.png" width="18" height="18">  Android AppsFlyer SDK **6.17.0**</br>
<img src="https://icon.icepanel.io/Technology/svg/Apple.svg" width="18" height="18">  iOS AppsFlyer SDK **6.17.0**</br>
<img src="https://icon.icepanel.io/Technology/svg/Capacitor.svg" width="18" height="18">  Capacitor 7</br>

## <a id="breaking-changes-6-17-0"> 	❗❗ Breaking changes when updating to v6.17.0 ❗❗
Starting from v6.17.0, this plugin works only with Capacitor 7. </br>
If you are still interested in using Capacitor 6, please follow the instructions [here](/docs/Installation.md#cap6) to install the latest version that supports Capacitor 6.

## <a id="breaking-changes-6-15-0"> 	❗❗ Breaking changes when updating to v6.15.0 ❗❗
Starting from v6.15.0, this plugin works only with Capacitor 6. </br>
If you are still interested in using Capacitor 5, please follow the instructions [here](/docs/Installation.md#cap5) to install the latest version that supports Capacitor 5.

## <a id="breaking-changes-6-12-1"> 	❗❗ Breaking changes when updating to v6.12.1 ❗❗
Starting from v6.12.1, this plugin works only with Capacitor 5. </br>
If you are still interested in using Capacitor 4, please follow the instructions [here](/docs/Installation.md#cap4) to install the latest version that supports Capacitor 4.

## <a id="breaking-changes"> 	❗❗ Breaking changes when updating to v6.9.2 ❗❗
Starting from v6.9.2, this plugin works only with Capacitor 4. </br>
If you are still interested in using Capacitor 3, please follow the instructions [here](/docs/Installation.md#cap3) to install the latest version that supports Capacitor 3.


<!---

## <a id="migration"> ⏩ Migration 
  
✏️✏️ Migration guided if needed✏️✏️ 
-->

 ##  📖 Guides
- [Adding the SDK to your project](/docs/Installation.md)
- [Initializing The SDK](/docs/BasicIntegration.md)
- [In-app Events](/docs/InAppEvents.md)
- [Deep Linking](/docs/DeepLink.md)
- [Advanced API](/docs/AdvancedAPI.md)
- [Testing The integration](/docs/Testing.md)
- [API](/docs/API.md)
- [Set Consent For DMA Compliance](/docs/DMA.md)