Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
morisgateno-appsflyer authored Mar 7, 2024
1 parent f56a4a5 commit 1c61190
Showing 1 changed file with 37 additions and 3 deletions.
40 changes: 37 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
<img src="https://www.appsflyer.com/wp-content/uploads/2016/11/logo-1.svg" width="200">
<img src="https://massets.appsflyer.com/wp-content/uploads/2018/06/20092440/static-ziv_1TP.png" width="400" >

# Cocos2dX AppsFlyer plugin for Android and iOS.

[![GitHub tag](https://img.shields.io/github/v/release/AppsFlyerSDK/appsflyer-unity-plugin)](https://img.shields.io/github/v/release/AppsFlyerSDK/appsflyer-unity-plugin)
----------


Expand All @@ -16,6 +15,7 @@ In order for us to provide optimal support, we would kindly ask you to submit an

- [integration](#integration)
- [Usage](#usage)
- [Manual start mode](#manual-start)
- [API methods](#api-methods)
- [setIsDebug](#setIsDebug)
- [stop](#stopTracking)
Expand Down Expand Up @@ -116,9 +116,43 @@ void AppDelegate::applicationDidEnterBackground() {

```

## <a id="manual-start"> Manual mode:
Starting version 6.13.0, we support a manual mode to seperate the initialization of the AppsFlyer SDK and the start of the SDK. In this case, the AppsFlyer SDK won't start automatically, giving the developer more freedom when to start the AppsFlyer SDK. Please note that in manual mode, the developer is required to implement the API start() in order to start the SDK.
<br>If you are using CMP to collect consent data this feature is needed. See explanation [here](#dma_support).
### Examples:

```cpp
bool AppDelegate::applicationDidFinishLaunching() {
...
AppsFlyerX::setAppsFlyerDevKey("devkey");

#if (CC_TARGET_PLATFORM == CC_PLATFORM_IOS)
// In case you want to use manual mode.
AppsFlyerX::setManualStart(true);
//
AppsFlyerX::setAppleAppID("appleAppId");
...
}
```
- See that we aren't calling any AppsFlyerX::start() in any case.
The init function is called in the background in order to catch any deeplinking.
And to start the AppsFlyer SDK:
### Example:
```cpp
//In case you use manual mode
#if (CC_TARGET_PLATFORM == CC_PLATFORM_IOS)
AppsFlyerX::setManualStart(false);
#endif
AppsFlyerX::start();
//
```

##<a id="api-methods"> API Methods

## <a id="api-methods"> API Methods

---

Expand Down

0 comments on commit 1c61190

Please sign in to comment.