Adapty SDK for Flutter

The AdaptyProfile class represents the current state of a user within the Adapty ecosystem. It contains identifiers, custom attributes, access levels, and purchase history (subscriptions and non-subscriptions). This object is the primary way to inspect a user's entitlements and metadata in your Flutter app.

Key properties include:

• profileId: The unique identifier for the user in Adapty.
• customerUserId: An optional identifier from your own system.
• customAttributes: A map of user-defined attributes previously set via .updateProfile().
• accessLevels: A map where keys are access level identifiers (configured in the Adapty Dashboard) and values are AdaptyAccessLevel objects.
• subscriptions: A map of store product IDs to AdaptySubscription information.
• nonSubscriptions: A map of store product IDs to lists of AdaptyNonSubscription (consumables) information.
• appliedAttributionSources: A list of AdaptyAttributionSource values used for segmentation.
• isTestUser: A boolean indicating if the profile belongs to a test device.

To display a paywall or onboarding flow designed in the Adapty Flow Builder, first obtain an AdaptyFlow object. Use createFlowView to generate an AdaptyUIFlowView instance, then call presentFlowView to show it to the user.

Key Parameters for createFlowView:

• flow: The AdaptyFlow object to render.
• locale: (Optional) The localization identifier (e.g., en, es). Falls back to the flow's default if the requested locale is unavailable.
• preloadProducts: If true, the SDK prefetches required products during view assembly.
• androidEnableSafeArea: (Android only) If true, applies safe-area insets as paddings. Defaults to true.
• productPurchaseParams: A map of AdaptyProductIdentifier to AdaptyPurchaseParameters for specific product configurations.

Presentation Options: When calling presentFlowView, you can specify iosPresentationStyle (e.g., AdaptyUIIOSPresentationStyle.fullScreen).

// 1. Create the view
final flowView = await AdaptyUI().createFlowView(
  flow: myAdaptyFlow,
  locale: 'en',
  preloadProducts: true,
);

// 2. Present the view
await AdaptyUI().presentFlowView(flowView);

// 3. Dismiss when finished
await AdaptyUI().dismissFlowView(flowView);

Use AdaptyConfiguration to initialize the SDK with your API key and customize its behavior. The configuration follows a builder-like pattern where you instantiate the object with a required apiKey and then call various with... methods to set specific properties.

Key configuration options include:

• Customer Identity: Use withCustomerUserId to associate a user in your system with Adapty. You can optionally provide an iosAppAccountToken (UUID string) or an androidObfuscatedAccountId.
• Observer Mode: Use withObserverMode(true) if you handle purchases and subscription status manually and only use Adapty for analytics and event reporting.
• Privacy & Collection: Methods like withAppleIdfaCollectionDisabled, withGoogleAdvertisingIdCollectionDisabled, and withIpAddressCollectionDisabled allow you to control data collection for compliance.
• Server Cluster: Use withServerCluster to specify the backend cluster (defaultCluster, eu, or cn).
• Logging: Use withLogLevel to set the AdaptyLogLevel.

final configuration = AdaptyConfiguration(apiKey: 'YOUR_API_KEY')
  ..withCustomerUserId('user_123', iosAppAccountToken: 'UUID-HERE')
  ..withObserverMode(false)
  ..withLogLevel(AdaptyLogLevel.debug)
  ..withServerCluster(AdaptyServerCluster.eu);

The AdaptyNonSubscription class represents a non-subscription (one-time or consumable) purchase processed through Adapty. It contains metadata about the transaction, the store used, and the product details. This model is useful for tracking one-time products and ensuring you don't process the same purchaseId multiple times.

// Example of the fields available in an AdaptyNonSubscription object
final String purchaseId;          // Unique identifier for the purchase in Adapty
final String store;               // 'app_store', 'play_store', or 'adapty'
final String vendorProductId;    // The product ID from the store
final String? vendorTransactionId; // The transaction ID from the store (nullable)
final DateTime purchasedAt;       // Timestamp of purchase
final bool isSandbox;            // True if purchased in a sandbox environment
final bool isRefund;             // True if the purchase was refunded
final bool isConsumable;          // True if the product is consumable