Get flows & paywalls - Flutter

After you designed your flow or Paywall Builder paywall, you can display it in your mobile app. The first step is to get the flow or paywall associated with the placement and its view configuration as described below.

Please be aware that this topic refers to flows and Paywall Builder-customized paywalls. If you are implementing your paywalls manually, please refer to the Fetch paywalls and products for remote config paywalls in your mobile app topic.

Before you start displaying flows and paywalls in your mobile app (click to expand)

1. Create your products in the Adapty Dashboard.
2. Create a flow/paywall and incorporate the products into it in the Adapty Dashboard.
3. Create placements and incorporate your flow/paywall into it in the Adapty Dashboard.
4. Install Adapty SDK in your mobile app.

Fetch flow/paywall

If you’ve designed a flow or paywall using the Flow Builder or Paywall Builder, you don’t need to worry about rendering it in your mobile app code to display it to the user. Such a flow or paywall contains both what should be shown within it and how it should be shown. Nevertheless, you need to get its ID via the placement, its view configuration, and then present it in your mobile app.

Fetch the flow or paywall and create its view as early as possible — ideally well before you present it. The createFlowView method loads the view configuration and starts downloading and caching its images in the background. The earlier you call it, the more time these downloads have to complete. By the time you present the flow or paywall, its configuration and images can already be cached and ready to display.

To get a flow or paywall, use the getFlow method:

try {
  final flow = await Adapty().getFlow(placementId: 'YOUR_PLACEMENT_ID');
  // the requested flow/paywall
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
  // handle the error
}

Parameters:

Parameter	Presence	Description
placementId	required	The identifier of the desired Placement. This is the value you specified when creating a placement in the Adapty Dashboard.
fetchPolicy	default: .reloadRevalidatingCacheData	By default, SDK will try to load data from the server and will return cached data in case of failure. We recommend this variant because it ensures your users always get the most up-to-date data. However, if you believe your users deal with unstable internet, consider using .returnCacheDataElseLoad to return cached data if it exists. In this scenario, users might not get the absolute latest data, but they’ll experience faster loading times, no matter how patchy their internet connection is. The cache is updated regularly, so it’s safe to use it during the session to avoid network requests. Note that the cache remains intact upon restarting the app and is only cleared when the app is reinstalled or through manual cleanup. Adapty SDK stores paywalls locally in two layers: regularly updated cache described above and fallback paywalls. We also use CDN to fetch paywalls faster and a stand-alone fallback server in case the CDN is unreachable. This system is designed to make sure you always get the latest version of your paywalls while ensuring reliability even in cases where internet connection is scarce.
loadTimeout	default: 5 sec	A Duration that limits the timeout for this method. If the timeout is reached, cached data or local fallback will be returned. Note that in rare cases this method can timeout slightly later than specified in loadTimeout, since the operation may consist of different requests under the hood.

Response parameters:

Parameter	Description
Flow	An AdaptyFlow object with the flow’s identifiers (instanceIdentity, variationId), name, placement, its paywall variations (paywalls), and any remote configs (remoteConfigs).

Fetch the view configuration

If the placement was designed in the Flow Builder or the Paywall Builder, Adapty renders the UI for you — the hasViewConfiguration property of the fetched flow is true. Create the view with createFlowView, then present the flow or paywall. If the placement is a custom paywall with no Builder UI (hasViewConfiguration is false), handle it as a remote config paywall instead.

import 'package:adapty_flutter/adapty_flutter.dart';

try {
  final view = await AdaptyUI().createFlowView(flow: flow);
} on AdaptyError catch (e) {
  // handle the error
} catch (e) {
  // handle the error
}

Parameters:

Parameter	Presence	Description
flow	required	An AdaptyFlow object to obtain a view for the desired flow/paywall.
customTags	optional	Define a map of custom tags and their resolved values. Custom tags serve as placeholders in the content, dynamically replaced with specific strings for personalized content within the flow/paywall. Refer to Custom tags in paywall builder topic for more details.
preloadProducts	optional	Enable to optimize the display timing of products on the screen. When true AdaptyUI will automatically fetch the necessary products. Default: false.
loadTimeout	optional	A Duration that limits the view configuration loading time. If the timeout is reached, cached data or local fallback will be used.

Once you have the view, present the flow/paywall.

Get a flow or paywall for a default audience to fetch it faster

Typically, flows and paywalls are fetched almost instantly, so you don’t need to worry about speeding up this process. However, in cases where you have numerous audiences and placements, and your users have a weak internet connection, fetching a flow or paywall may take longer than you’d like. In such situations, you might want to display a default flow or paywall to ensure a smooth user experience rather than showing nothing at all.

To address this, you can use the getFlowForDefaultAudience method, which fetches the flow or paywall of the specified placement for the All Users audience. However, it’s crucial to understand that the recommended approach is to fetch the flow or paywall by the getFlow method, as detailed in the Fetch flow/paywall section above.

try {
  final flow = await Adapty().getFlowForDefaultAudience(placementId: 'YOUR_PLACEMENT_ID');
  // the requested flow/paywall
} on AdaptyError catch (adaptyError) {
  // handle error
} catch (e) {
  // handle unknown error
}

Parameter	Presence	Description
placementId	required	The identifier of the Placement. This is the value you specified when creating a placement in your Adapty Dashboard.
fetchPolicy	default: .reloadRevalidatingCacheData	By default, SDK will try to load data from the server and will return cached data in case of failure. We recommend this variant because it ensures your users always get the most up-to-date data. However, if you believe your users deal with unstable internet, consider using .returnCacheDataElseLoad to return cached data if it exists. In this scenario, users might not get the absolute latest data, but they’ll experience faster loading times, no matter how patchy their internet connection is. The cache is updated regularly, so it’s safe to use it during the session to avoid network requests. Note that the cache remains intact upon restarting the app and is only cleared when the app is reinstalled or through manual cleanup.

Customize assets

To customize images and videos in your flow/paywall, implement the custom assets.

Hero images and videos have predefined IDs: hero_image and hero_video. In a custom asset bundle, you target these elements by their IDs and customize their behavior.

For other images and videos, you need to set a custom ID in the Adapty dashboard.

For example, you can:

• Show a different image or video to some users.
• Show a local preview image while a remote main image is loading.
• Show a preview image before running a video.

Here’s an example of how you can provide custom assets via a simple dictionary:

import 'package:adapty_flutter/adapty_flutter.dart';

final customAssets = {
    // Show a local image using a custom ID
    'custom_image': AdaptyCustomAsset.localImageAsset(
        assetId: 'assets/images/image_name.png',
    ),

    // Show a local video with a preview image
    'hero_video': AdaptyCustomAsset.localVideoAsset(
        assetId: 'assets/videos/custom_video.mp4',
    ),
};

try {
  final view = await AdaptyUI().createFlowView(
    flow: flow,
    customAssets: customAssets,
  );
} on AdaptyError catch (e) {
  // handle the error
} catch (e) {
  // handle the error
}

Set up developer-defined timers

To use custom timers in your mobile app, pass a customTimers map to the createFlowView method. Each map key is a timer ID, and its value is a DateTime object that defines when the timer ends. Here is an example:

import 'package:adapty_flutter/adapty_flutter.dart';

try {
  final view = await AdaptyUI().createFlowView(
    flow: flow,
    customTimers: {
      'CUSTOM_TIMER_6H': DateTime.now().add(const Duration(seconds: 3600 * 6)),
      'CUSTOM_TIMER_NY': DateTime(2027, 1, 1), // New Year 2027
    },
  );
} on AdaptyError catch (e) {
  // handle the error
} catch (e) {
  // handle the error
}

In this example, CUSTOM_TIMER_NY and CUSTOM_TIMER_6H are the Timer IDs of developer-defined timers you set in the Adapty Dashboard. The customTimers map ensures your app dynamically updates each timer with the correct value. For example:

• CUSTOM_TIMER_NY: The time remaining until the timer’s end, such as New Year’s Day.
• CUSTOM_TIMER_6H: The time left in a 6-hour period that started when the user opened the flow.

After you designed the visual part for your paywall with the new Paywall Builder in the Adapty Dashboard, you can display it in your mobile app. The first step in this process is to get the paywall associated with the placement and its view configuration as described below.

Please be aware that this topic refers to Paywall Builder-customized paywalls. If you are implementing your paywalls manually, please refer to the Fetch paywalls and products for remote config paywalls in your mobile app topic.

Before you start displaying paywalls in your mobile app (click to expand)

1. Create your products in the Adapty Dashboard.
2. Create a paywall and incorporate the products into it in the Adapty Dashboard.
3. Create placements and incorporate your paywall into it in the Adapty Dashboard.
4. Install Adapty SDK in your mobile app.

Fetch paywall designed with Paywall Builder

If you’ve designed a paywall using the Paywall Builder, you don’t need to worry about rendering it in your mobile app code to display it to the user. Such a paywall contains both what should be shown within the paywall and how it should be shown. Nevertheless, you need to get its ID via the placement, its view configuration, and then present it in your mobile app.

To ensure optimal performance, it’s crucial to retrieve the paywall and its view configuration as early as possible, allowing sufficient time for images to download before presenting them to the user.

To get a paywall, use the getPaywall method:

try {
  final paywall = await Adapty().getPaywall(placementId: "YOUR_PLACEMENT_ID", locale: "en");
  // the requested paywall
} on AdaptyError catch (adaptyError) {
  // handle the error
} catch (e) {
}

Parameters:

Parameter	Presence	Description
placementId	required	The identifier of the desired Placement. This is the value you specified when creating a placement in the Adapty Dashboard.
locale	optional default: en	The identifier of the paywall localization. This parameter is expected to be a language code composed of one or two subtags separated by the minus (-) character. The first subtag is for the language, the second one is for the region. Example: en means English, pt-br represents the Brazilian Portuguese language. See Localizations and locale codes for more information on locale codes and how we recommend using them.
fetchPolicy	default: .reloadRevalidatingCacheData	By default, SDK will try to load data from the server and will return cached data in case of failure. We recommend this variant because it ensures your users always get the most up-to-date data. However, if you believe your users deal with unstable internet, consider using .returnCacheDataElseLoad to return cached data if it exists. In this scenario, users might not get the absolute latest data, but they’ll experience faster loading times, no matter how patchy their internet connection is. The cache is updated regularly, so it’s safe to use it during the session to avoid network requests. Note that the cache remains intact upon restarting the app and is only cleared when the app is reinstalled or through manual cleanup. Adapty SDK stores paywalls locally in two layers: regularly updated cache described above and fallback paywalls. We also use CDN to fetch paywalls faster and a stand-alone fallback server in case the CDN is unreachable. This system is designed to make sure you always get the latest version of your paywalls while ensuring reliability even in cases where internet connection is scarce.
loadTimeout	default: 5 sec	This value limits the timeout for this method. If the timeout is reached, cached data or local fallback will be returned. Note that in rare cases this method can timeout slightly later than specified in loadTimeout, since the operation may consist of different requests under the hood. For Android: You can create TimeInterval with extension functions (like 5.seconds, where .seconds is from import com.adapty.utils.seconds), or TimeInterval.seconds(5). To set no limitation, use TimeInterval.INFINITE.

Response parameters:

Parameter	Description
Paywall	An AdaptyPaywall object with a list of product IDs, the paywall identifier, remote config, and several other properties.

Fetch the view configuration of paywall designed using Paywall Builder

After fetching the paywall, check if it includes a ViewConfiguration, which indicates that it was created using Paywall Builder. This will guide you on how to display the paywall. If the ViewConfiguration is present, treat it as a Paywall Builder paywall; if not, handle it as a remote config paywall.

import 'package:adapty_flutter/adapty_flutter.dart';

try {
  final view = await AdaptyUI().createPaywallView(
        paywall: paywall,
      );
} on AdaptyError catch (e) {
  // handle the error
} catch (e) {
  // handle the error
}

Once you have the view, present the paywall.

Get a paywall for a default audience to fetch it faster

Typically, paywalls are fetched almost instantly, so you don’t need to worry about speeding up this process. However, in cases where you have numerous audiences and paywalls, and your users have a weak internet connection, fetching a paywall may take longer than you’d like. In such situations, you might want to display a default paywall to ensure a smooth user experience rather than showing no paywall at all.

To address this, you can use the getPaywallForDefaultAudience method, which fetches the paywall of the specified placement for the All Users audience. However, it’s crucial to understand that the recommended approach is to fetch the paywall by the getPaywall method, as detailed in the Fetch Paywall Information section above.

try {
    final paywall = await Adapty().getPaywallForDefaultAudience(placementId: 'YOUR_PLACEMENT_ID');
} on AdaptyError catch (adaptyError) {
    // handle error
} catch (e) {
    // handle unknown error
}

Parameter	Presence	Description
placementId	required	The identifier of the Placement. This is the value you specified when creating a placement in your Adapty Dashboard.
locale	optional default: en	The identifier of the paywall localization. This parameter is expected to be a language code composed of one or more subtags separated by the minus (-) character. The first subtag is for the language, the second one is for the region. Example: en means English, pt-br represents the Brazilian Portuguese language. See Localizations and locale codes for more information on locale codes and how we recommend using them.
fetchPolicy	default: .reloadRevalidatingCacheData	By default, SDK will try to load data from the server and will return cached data in case of failure. We recommend this variant because it ensures your users always get the most up-to-date data. However, if you believe your users deal with unstable internet, consider using .returnCacheDataElseLoad to return cached data if it exists. In this scenario, users might not get the absolute latest data, but they’ll experience faster loading times, no matter how patchy their internet connection is. The cache is updated regularly, so it’s safe to use it during the session to avoid network requests. Note that the cache remains intact upon restarting the app and is only cleared when the app is reinstalled or through manual cleanup.

Customize assets

To customize images and videos in your paywall, implement the custom assets.

Hero images and videos have predefined IDs: hero_image and hero_video. In a custom asset bundle, you target these elements by their IDs and customize their behavior.

For other images and videos, you need to set a custom ID in the Adapty dashboard.

For example, you can:

• Show a different image or video to some users.
• Show a local preview image while a remote main image is loading.
• Show a preview image before running a video.

Here’s an example of how you can provide custom assets via a simple dictionary:

import 'package:adapty_flutter/adapty_flutter.dart';

final customAssets = {
    // Show a local image using a custom ID
    'custom_image': AdaptyCustomAsset.localImageAsset(
        assetId: 'assets/images/image_name.png',
    ),

    // Show a local video with a preview image
    'hero_video': AdaptyCustomAsset.localVideoAsset(
        assetId: 'assets/videos/custom_video.mp4',
    ),
};

try {
  final view = await AdaptyUI().createPaywallView(
    paywall: paywall,
    customAssets: customAssets,
  );
} on AdaptyError catch (e) {
  // handle the error
} catch (e) {
  // handle the error
}

Set up developer-defined timers

To use custom timers in your mobile app, pass a customTimers map to the createPaywallView method. Each map key is a timer ID, and its value is a DateTime object that defines when the timer ends. Here is an example:

import 'package:adapty_flutter/adapty_flutter.dart';

try {
  final view = await AdaptyUI().createPaywallView(
        paywall: paywall,
        customTimers: {
          'CUSTOM_TIMER_6H': DateTime.now().add(const Duration(seconds: 3600 * 6)),
          'CUSTOM_TIMER_NY': DateTime(2025, 1, 1), // New Year 2025
        },
      );
} on AdaptyError catch (e) {
  // handle the error
} catch (e) {
  // handle the error
}

In this example, CUSTOM_TIMER_NY and CUSTOM_TIMER_6H are the Timer IDs of developer-defined timers you set in the Adapty Dashboard. The customTimers map ensures your app dynamically updates each timer with the correct value. For example:

• CUSTOM_TIMER_NY: The time remaining until the timer’s end, such as New Year’s Day.
• CUSTOM_TIMER_6H: The time left in a 6-hour period that started when the user opened the paywall.