AdaptySDK 4.1.1
Loading...
Searching...
No Matches
AdaptySDK.AdaptyUICreateFlowViewParameters Class Referencesealed

The optional extras of AdaptyUI.CreateFlowView(AdaptySDK.AdaptyFlow, AdaptySDK.AdaptyUICreateFlowViewParameters, System.Action<AdaptySDK.AdaptyUIFlowView, AdaptySDK.AdaptyError>): which localization and layout to render, how long to wait, and the tags, timers and assets the flow substitutes into its layout. More...

Public Member Functions

override string ToString ()
 A description for logs and the debugger. The format is not part of the contract — read the members rather than parsing it.
AdaptyUICreateFlowViewParameters SetLocale (string locale)
 Sets Locale.
AdaptyUICreateFlowViewParameters SetCustomLayoutId (string customLayoutId)
 Sets CustomLayoutId.
AdaptyUICreateFlowViewParameters SetLoadTimeout (TimeSpan? loadTimeout)
 Sets LoadTimeout.
AdaptyUICreateFlowViewParameters SetPreloadProducts (bool? preloadProducts)
 Sets PreloadProducts.
AdaptyUICreateFlowViewParameters SetCustomTags (IReadOnlyDictionary< string, string > customTags)
 Sets CustomTags, copying the dictionary.
AdaptyUICreateFlowViewParameters SetCustomTimers (IReadOnlyDictionary< string, DateTime > customTimers)
 Sets CustomTimers, copying the dictionary.
AdaptyUICreateFlowViewParameters SetCustomAssets (IReadOnlyDictionary< string, AdaptyCustomAsset > customAssets)
 Sets CustomAssets, copying the dictionary.
AdaptyUICreateFlowViewParameters SetProductPurchaseParameters (IReadOnlyDictionary< AdaptyProductIdentifier, AdaptyPurchaseParameters > productPurchaseParameters)
 Sets ProductPurchaseParameters, copying the dictionary. Android only.
AdaptyUICreateFlowViewParameters SetEnableSafeAreaPaddings (bool? enableSafeAreaPaddings)
 Sets EnableSafeAreaPaddings. Android only.

Public Attributes

string Locale
 The identifier of the localization to render the flow with, e.g. "en", "es", "fr". When null, en is requested rather than the flow's default localization.
string CustomLayoutId
 The identifier of the layout to render, instead of the one the flow resolves for the current device. When null, the flow picks the layout itself.
TimeSpan? LoadTimeout
 How long to wait for the flow's assets before giving up. Null leaves the native default.
bool? PreloadProducts
 Fetches the flow's products while the view is being built, so the first frame already has prices. Null leaves the native default.
bool? EnableSafeAreaPaddings
 Android only. Lays the view out without safe area paddings when false. Null leaves the native default, which is true. Ignored on iOS.

Properties

double? LoadTimeoutInSeconds [get]
 The contract carries the timeout in seconds, not as a duration literal.
IReadOnlyDictionary< string, string > CustomTags [get]
 The values the flow substitutes for its custom tags, keyed by tag name. Null when none were set.
IReadOnlyDictionary< string, DateTime > CustomTimers [get]
 When each of the flow's custom timers ends, keyed by timer name. A value with no DateTimeKind of its own is read as the user's local clock. Null when none were set.
IReadOnlyDictionary< string, AdaptyCustomAsset > CustomAssets [get]
 The assets the flow uses in place of its own, keyed by the asset id in the layout. Null when none were set.
IReadOnlyDictionary< AdaptyProductIdentifier, AdaptyPurchaseParameters > ProductPurchaseParameters [get]
 Android only. The purchase extras to apply to each product the flow offers, keyed by identifier. Null when none were set; ignored on iOS.
Dictionary< string, AdaptyPurchaseParameters > ProductPurchaseParametersForRequest [get]
 The contract keys these by adapty_product_id — neither the composite identifier the app passes nor the store's own vendor_product_id. Swapping in either of those compiles and sends a well-formed request whose parameters match no product.

Static Private Member Functions

static Dictionary< TKey, TValue > Copy< TKey, TValue > (IReadOnlyDictionary< TKey, TValue > source)

Private Attributes

Dictionary< string, string > _CustomTags
Dictionary< string, DateTime > _CustomTimers
Dictionary< string, AdaptyCustomAsset > _CustomAssets
Dictionary< AdaptyProductIdentifier, AdaptyPurchaseParameters > _ProductPurchaseParameters
 Android only. Purchase parameters applied to the products the flow offers. Ignored on iOS.

Detailed Description

The optional extras of AdaptyUI.CreateFlowView(AdaptySDK.AdaptyFlow, AdaptySDK.AdaptyUICreateFlowViewParameters, System.Action<AdaptySDK.AdaptyUIFlowView, AdaptySDK.AdaptyError>): which localization and layout to render, how long to wait, and the tags, timers and assets the flow substitutes into its layout.

A dictionary handed to a setter is copied, so writing into your own copy afterwards does not change what the view is built with.

Member Function Documentation

◆ Copy< TKey, TValue >()

Dictionary< TKey, TValue > AdaptySDK.AdaptyUICreateFlowViewParameters.Copy< TKey, TValue > ( IReadOnlyDictionary< TKey, TValue > source)
staticprivate

◆ SetCustomAssets()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetCustomAssets ( IReadOnlyDictionary< string, AdaptyCustomAsset > customAssets)

Sets CustomAssets, copying the dictionary.

Parameters
customAssetsThe asset to use for each id in the layout.

◆ SetCustomLayoutId()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetCustomLayoutId ( string customLayoutId)

Sets CustomLayoutId.

Parameters
customLayoutIdThe id of the layout to render, as the flow's schema names it.

◆ SetCustomTags()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetCustomTags ( IReadOnlyDictionary< string, string > customTags)

Sets CustomTags, copying the dictionary.

Parameters
customTagsThe value for each custom tag, keyed by tag name.

◆ SetCustomTimers()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetCustomTimers ( IReadOnlyDictionary< string, DateTime > customTimers)

Sets CustomTimers, copying the dictionary.

Parameters
customTimersWhen each timer ends. A DateTime with no DateTimeKind of its own is read as the user's local clock, so new DateTime(2026, 7, 30, 22, 0, 0) means 22:00 where the user is; pass a DateTimeKind.Utc value to mean 22:00 UTC.

◆ SetEnableSafeAreaPaddings()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetEnableSafeAreaPaddings ( bool? enableSafeAreaPaddings)

Sets EnableSafeAreaPaddings. Android only.

Parameters
enableSafeAreaPaddingsFalse to lay the view out without safe area paddings.

◆ SetLoadTimeout()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetLoadTimeout ( TimeSpan? loadTimeout)

Sets LoadTimeout.

Parameters
loadTimeoutHow long to wait for the flow's assets.

◆ SetLocale()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetLocale ( string locale)

Sets Locale.

Parameters
localeThe localization to render the flow with, such as "en" or "es".

◆ SetPreloadProducts()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetPreloadProducts ( bool? preloadProducts)

Sets PreloadProducts.

Parameters
preloadProductsTrue to fetch the products while the view is built.

◆ SetProductPurchaseParameters()

AdaptyUICreateFlowViewParameters AdaptySDK.AdaptyUICreateFlowViewParameters.SetProductPurchaseParameters ( IReadOnlyDictionary< AdaptyProductIdentifier, AdaptyPurchaseParameters > productPurchaseParameters)

Sets ProductPurchaseParameters, copying the dictionary. Android only.

Parameters
productPurchaseParametersThe purchase extras for each product.
Exceptions
ArgumentExceptionTwo identifiers share one adapty_product_id.

◆ ToString()

override string AdaptySDK.AdaptyUICreateFlowViewParameters.ToString ( )

A description for logs and the debugger. The format is not part of the contract — read the members rather than parsing it.

Member Data Documentation

◆ _CustomAssets

Dictionary<string, AdaptyCustomAsset> AdaptySDK.AdaptyUICreateFlowViewParameters._CustomAssets
private

◆ _CustomTags

Dictionary<string, string> AdaptySDK.AdaptyUICreateFlowViewParameters._CustomTags
private

◆ _CustomTimers

Dictionary<string, DateTime> AdaptySDK.AdaptyUICreateFlowViewParameters._CustomTimers
private

◆ _ProductPurchaseParameters

Dictionary< AdaptyProductIdentifier, AdaptyPurchaseParameters > AdaptySDK.AdaptyUICreateFlowViewParameters._ProductPurchaseParameters
private

Android only. Purchase parameters applied to the products the flow offers. Ignored on iOS.

◆ CustomLayoutId

string AdaptySDK.AdaptyUICreateFlowViewParameters.CustomLayoutId

The identifier of the layout to render, instead of the one the flow resolves for the current device. When null, the flow picks the layout itself.

The id is the one the layout carries in the flow's schema, so a value naming no layout there fails view creation rather than falling back to the resolved one.

◆ EnableSafeAreaPaddings

bool? AdaptySDK.AdaptyUICreateFlowViewParameters.EnableSafeAreaPaddings

Android only. Lays the view out without safe area paddings when false. Null leaves the native default, which is true. Ignored on iOS.

◆ LoadTimeout

TimeSpan? AdaptySDK.AdaptyUICreateFlowViewParameters.LoadTimeout

How long to wait for the flow's assets before giving up. Null leaves the native default.

◆ Locale

string AdaptySDK.AdaptyUICreateFlowViewParameters.Locale

The identifier of the localization to render the flow with, e.g. "en", "es", "fr". When null, en is requested rather than the flow's default localization.

A flow is localized when its view is built, not when the flow is fetched — this is the only place that selects the localization. When the requested localization does not exist in the flow, its default localization is used.

◆ PreloadProducts

bool? AdaptySDK.AdaptyUICreateFlowViewParameters.PreloadProducts

Fetches the flow's products while the view is being built, so the first frame already has prices. Null leaves the native default.

Property Documentation

◆ CustomAssets

IReadOnlyDictionary<string, AdaptyCustomAsset> AdaptySDK.AdaptyUICreateFlowViewParameters.CustomAssets
get

The assets the flow uses in place of its own, keyed by the asset id in the layout. Null when none were set.

◆ CustomTags

IReadOnlyDictionary<string, string> AdaptySDK.AdaptyUICreateFlowViewParameters.CustomTags
get

The values the flow substitutes for its custom tags, keyed by tag name. Null when none were set.

◆ CustomTimers

IReadOnlyDictionary<string, DateTime> AdaptySDK.AdaptyUICreateFlowViewParameters.CustomTimers
get

When each of the flow's custom timers ends, keyed by timer name. A value with no DateTimeKind of its own is read as the user's local clock. Null when none were set.

◆ LoadTimeoutInSeconds

double? AdaptySDK.AdaptyUICreateFlowViewParameters.LoadTimeoutInSeconds
getprivate

The contract carries the timeout in seconds, not as a duration literal.

◆ ProductPurchaseParameters

IReadOnlyDictionary< AdaptyProductIdentifier, AdaptyPurchaseParameters > AdaptySDK.AdaptyUICreateFlowViewParameters.ProductPurchaseParameters
get

Android only. The purchase extras to apply to each product the flow offers, keyed by identifier. Null when none were set; ignored on iOS.

◆ ProductPurchaseParametersForRequest

Dictionary<string, AdaptyPurchaseParameters> AdaptySDK.AdaptyUICreateFlowViewParameters.ProductPurchaseParametersForRequest
getprivate

The contract keys these by adapty_product_id — neither the composite identifier the app passes nor the store's own vendor_product_id. Swapping in either of those compiles and sends a well-formed request whose parameters match no product.

The documentation for this class was generated from the following file: