Skip to content

Commit

Permalink
Merge branch 'SK2-clean' into develop
Browse files Browse the repository at this point in the history 
* SK2-clean:
  Added old version of Flutter
  update
  • Loading branch information
@Lutik-sun
Lutik-sun committed Nov 21, 2024
2 parents cac19d2 + 0b78a64 commit 620378a
Show file tree
Hide file tree
Showing 2 changed files with 157 additions and 22 deletions.
9 changes: 5 additions & 4 deletions versioned_docs/version-3.0/migration-to-adapty-sdk-v3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,8 @@ Please note that the AdaptyUI library is deprecated and is now included as part

```diff
dependencies:
adapty_flutter: ^3.2.1
+ adapty_flutter: ^3.2.1
- adapty_flutter: ^2.10.3
- adapty_ui_flutter: ^2.1.3
```

Expand All @@ -220,17 +221,17 @@ Please note that the AdaptyUI library is deprecated and is now included as part

## Configure Adapty SDKs

Previously, you needed to create `Adapty-Info.plist` and `AndroidManifest.xml` files and add them to your project for Adapty SDK configuration.
Previously, you needed to use `Adapty-Info.plist` and `AndroidManifest.xml` files for Adapty SDK configuration.

Now, there’s no need to create additional files. Instead, you can provide all required parameters during activation.
Now, there’s no need to use additional files. Instead, you can provide all required parameters during activation.

You only need to configure the Adapty SDK once, typically at the start of your app’s lifecycle.

### Activate Adapty module of Adapty SDK

1. Remove the AdaptyUI SDK import from your application as follows:

```dart title="Dart"
```diff
import 'package:adapty_flutter/adapty_flutter.dart';
- import 'package:adapty_ui_flutter/adapty_ui_flutter.dart';
```
Expand Down
170 changes: 152 additions & 18 deletions versioned_docs/version-3.0/sdk-installation-flutter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ description: "Discover step-by-step instructions for installing and configuring
metadataTitle: "Flutter - Adapty SDK Installation and Configuration Guide"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs> <TabItem value="3" label="v3.2.x and up (current)" default>

Adapty SDK includes two key modules for seamless integration into your mobile app:

- **Core Adapty**: This essential SDK is required for Adapty to function properly in your app.
Expand Down Expand Up @@ -45,20 +50,20 @@ You only need to configure the Adapty SDK once, typically early in your app's li

2. Activate Adapty SDK with the following code:

```dart title="Dart"
try {
await Adapty().activate(
configuration: AdaptyConfiguration(apiKey: 'YOUR_API_KEY')
..withLogLevel(AdaptyLogLevel.debug)
..withObserverMode(false)
..withCustomerUserId(null)
..withIpAddressCollectionDisabled(false)
..withIdfaCollectionDisabled(false),
);
} catch (e) {
// handle the error
}
```
```dart title="Dart"
try {
await Adapty().activate(
configuration: AdaptyConfiguration(apiKey: 'YOUR_API_KEY')
..withLogLevel(AdaptyLogLevel.debug)
..withObserverMode(false)
..withCustomerUserId(null)
..withIpAddressCollectionDisabled(false)
..withIdfaCollectionDisabled(false),
);
} catch (e) {
// handle the error
}
```

Parameters:

Expand All @@ -76,7 +81,6 @@ Parameters:
You need to configure the AdaptyUI module only if you plan to use [Paywall Builder](display-pb-paywalls) and have [installed AdaptyUI module](sdk-installation-ios#install-sdks-via-cocoapods):

```dart title="Dart"
try {
final mediaCache = AdaptyUIMediaCacheConfiguration(
memoryStorageTotalCostLimit: 100 * 1024 * 1024, // 100MB
Expand All @@ -103,8 +107,138 @@ Parameters:
| **memoryStorageCountLimit** | required | The item count limit of the memory storage. |
| **diskStorageSizeLimit** | required | The file size limit on disk of the storage in bytes. 0 means no limit. |

</TabItem> <TabItem value="2" label="Up to v2.x (legacy)" default>

Adapty comprises two crucial SDKs for seamless integration into your mobile app:

- Core **AdaptySDK**: This is a fundamental, mandatory SDK necessary for the proper functioning of Adapty within your app.
- **AdaptyUI SDK**: This optional SDK becomes necessary if you use the Adapty Paywall builder: a user-friendly, no-code tool for easily creating cross-platform paywalls. These paywalls are built in a visual constructor right in our dashboard, run entirely natively on the device, and require minimal effort from you to create something that performs well.

Please consult the compatibility table below to choose the correct pair of Adapty SDK and AdaptyUI SDK.

| Adapty SDK version | AdaptyUI SDK version |
| :----------------- | :------------------- |
| 2.9.3 | 2.1.0 |
| 2.10.0 | 2.1.1 |
| 2.10.1 | 2.1.2 |
| 2.10.3 | 2.1.3 |

## Install Adapty SDKs

1. Add Adapty and AdaptyUI to your `pubspec.yaml` file:

```yaml title="pubspec.yaml"
dependencies:
adapty_flutter: ^2.10.3
adapty_ui_flutter: ^2.1.3
```
2. Run:
```bash title="Bash"
flutter pub get
```

3. Import Adapty SDKs in your application in the following way:

```dart title="Dart"
import 'package:adapty_flutter/adapty_flutter.dart';
import 'package:adapty_ui_flutter/adapty_ui_flutter.dart';
```

## Configure Adapty SDKs

The configuration of the Adapty SDK for Flutter slightly differs depending on the mobile operating system (iOS or Android) you are going to release it for.

### Configure Adapty SDKs for iOS

Create `Adapty-Info.plist` and add it to your project. Add the flag `AdaptyPublicSdkKey` in this file with the value of your Public SDK key.

```xml title="Adapty-Info.plist"
<dict>
<key>AdaptyPublicSdkKey</key>
<string>PUBLIC_SDK_KEY</string>
<key>AdaptyObserverMode</key>
<false/>
</dict>
```

Parameters:

| Parameter | Presence | Description |
| -------------------------- | -------- | ------------------------------------------------------------ |
| **AdaptyPublicSdkKey** | required | The key you can find in the **Public SDK key** field of your app settings in Adapty: [**App settings**-> **General** tab -> **API keys** subsection](https://app.adapty.io/settings/general) |
| **AdaptyObserverMode** | optional | <p>A boolean value controlling [Observer mode](observer-vs-full-mode). Turn it on if you handle purchases and subscription status yourself and use Adapty for sending subscription events and analytics. At any purchase or restore in your application, you'll need to call `.restorePurchases()` method to record the action in Adapty. The default value is `false`.</p><p></p><p>🚧 When running in Observer mode, Adapty SDK won't close any transactions, so make sure you're handling it.</p> |
| **idfaCollectionDisabled** | optional | <p>A boolean parameter, that allows you to disable IDFA collection for your iOS app. The default value is `false`.</p><p>For more details, refer to the [Analytics integration](analytics-integration#disable-collection-of-idfa) section.</p> |

### Configure Adapty SDKs for Android

1. Add the `AdaptyPublicSdkKey` flag into the app’s `AndroidManifest.xml` \(Android) file with the value of your Public SDK key.

```xml title="AndroidManifest.xml"
<application ...>
...
<meta-data
android:name="AdaptyPublicSdkKey"
android:value="PUBLIC_SDK_KEY" />
<meta-data
android:name="AdaptyObserverMode"
android:value="false" />
</application>
```

Required parameters:

| Parameter | Presence | Description |
| ---------------------------- | -------- | ------------------------------------------------------------ |
| PUBLIC_SDK_KEY | required | <p>Contents of the **Public SDK key** field in the [**App Settings** -> **General** tab](https://app.adapty.io/settings/general) in the Adapty Dashboard. **SDK keys** are unique for every app, so if you have multiple apps make sure you choose the right one.</p><p>Make sure you use the **Public SDK key** for Adapty initialization, since the **Secret key** should be used for [server-side API](getting-started-with-server-side-api) only.</p> |
| AdaptyObserverMode | optional | <p>A boolean value that is controlling [Observer mode](observer-vs-full-mode) . Turn it on if you handle purchases and subscription status yourself and use Adapty for sending subscription events and analytics.</p><p>The default value is `false`.</p><p>🚧 When running in Observer mode, Adapty SDK won't close any transactions, so make sure you're handling it.</p> |
| AdaptyIDFACollectionDisabled | optional | <p>A boolean parameter, that allows you to disable IDFA collection for your app. The default value is `false`.</p><p>For more details, refer to the [Analytics integration](analytics-integration#disable-collection-of-idfa) section.</p> |



2. In your application, add:

```javascript title="Flutter"
import 'package:adapty_flutter/adapty_flutter.dart';
```

3. Activate Adapty SDK with the following code:

```javascript title="Flutter"
try {
Adapty().activate();
} on AdaptyError catch (adaptyError) {}
} catch (e) {}
```

Please keep in mind that for paywalls and products to be displayed in your mobile application, and for analytics to work, you need to [display the paywalls](display-pb-paywalls) and, if you're using paywalls not created with the Paywall Builder, [handle the purchase process](making-purchases) within your app.

### Set up the logging system

Adapty logs errors and other crucial information to provide insight into your app's functionality. There are the following available levels:

| Level | Description |
| :------ | :----------------------------------------------------------- |
| error | Only errors will be logged. |
| warn | Errors and messages from the SDK that do not cause critical errors, but are worth paying attention to will be logged. |
| info | Errors, warnings, and serious information messages, such as those that log the lifecycle of various modules will be logged. |
| verbose | Any additional information that may be useful during debugging, such as function calls, API queries, etc. will be logged. |

You can set `logLevel` in your app before configuring Adapty.

```javascript title="Flutter"
try {
await Adapty().setLogLevel(AdaptyLogLevel.verbose);
} on AdaptyError catch (adaptyError) {
} catch (e) {}
```

</TabItem> </Tabs>

:::danger
Read the checklist before releasing your app
Read checklist before releasing the app

Before releasing your application, go through the [Release Checklist](release-checklist) to ensure that you have completed all the steps, and also check the success of the integration using the criteria for assessing its success.
:::

Before launching your app, make sure to go through the [Release Checklist](release-checklist) to confirm all steps are completed. Additionally, evaluate the integration's success using the provided criteria.
:::

0 comments on commit 620378a

Please sign in to comment.