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

Represents a flow configuration in Adapty. 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.

Public Attributes

readonly AdaptyPlacement Placement
 An AdaptyPlacement object that contains information about the placement of the flow.
readonly string InstanceIdentity
 A unique identifier for this flow instance.
readonly string Name
 The flow name configured in the Adapty Dashboard.
readonly string VariationId
 The identifier of the variation, used to attribute purchases to the flow.

Properties

IReadOnlyList< AdaptyRemoteConfig > RemoteConfigs [get, private set]
 The remote configs of the flow, one per localization. Empty when none is configured; RemoteConfig is the first of them.
AdaptyRemoteConfig RemoteConfig [get]
 The first custom JSON formatted data configured in the Adapty Dashboard.
IReadOnlyList< AdaptyFlowPaywall > Paywalls [get, private set]
 The paywall variations this flow offers.
bool HasViewConfiguration [get]
 Whether this flow carries a view configuration and can be rendered with AdaptyUI.CreateFlowView(AdaptyFlow, AdaptyUICreateFlowViewParameters, System.Action<AdaptyUIFlowView, AdaptyError>).
IReadOnlyList< string > VendorProductIds [get]
 Array of vendor product IDs (App Store or Google Play product identifiers) aggregated across all paywall variations of this flow.
IReadOnlyList< AdaptyProductIdentifier > ProductIdentifiers [get]
 Array of product identifiers aggregated across all paywall variations of this flow.

Private Member Functions

 AdaptyFlow ()
void OnDeserialized (StreamingContext context)
void Freeze ()

Private Attributes

readonly List< AdaptyRemoteConfig > _RemoteConfigs = new List<AdaptyRemoteConfig>()
 Array of custom JSON formatted data configured in the Adapty Dashboard, one entry per locale.
readonly List< AdaptyFlowPaywall > _Paywalls
 Array of paywall variations associated with this flow.
readonly string _FlowVersionId
 The renderer-internal version of the flow's view configuration. Opaque to the app: carried only so a flow handed back to the native side keeps it.
readonly JObject _UiSchema
 The renderer's custom-layout schema. Opaque to the app: carried only so a flow handed back to the native side keeps it.
readonly long _ResponseCreatedAt
readonly string _PayloadData

Detailed Description

Represents a flow configuration in Adapty.

A flow is a set of paywall variations that can be displayed to users. It contains information about the placement, paywalls, and remote configs. Read more at Adapty Documentation

Constructor & Destructor Documentation

◆ AdaptyFlow()

AdaptySDK.AdaptyFlow.AdaptyFlow ( )
private

Member Function Documentation

◆ Freeze()

void AdaptySDK.AdaptyFlow.Freeze ( )
private

◆ OnDeserialized()

void AdaptySDK.AdaptyFlow.OnDeserialized ( StreamingContext context)
private

◆ ToString()

override string AdaptySDK.AdaptyFlow.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

◆ _FlowVersionId

readonly string AdaptySDK.AdaptyFlow._FlowVersionId
private

The renderer-internal version of the flow's view configuration. Opaque to the app: carried only so a flow handed back to the native side keeps it.

◆ _PayloadData

readonly string AdaptySDK.AdaptyFlow._PayloadData
private

◆ _Paywalls

readonly List<AdaptyFlowPaywall> AdaptySDK.AdaptyFlow._Paywalls
private

Array of paywall variations associated with this flow.

◆ _RemoteConfigs

readonly List<AdaptyRemoteConfig> AdaptySDK.AdaptyFlow._RemoteConfigs = new List<AdaptyRemoteConfig>()
private

Array of custom JSON formatted data configured in the Adapty Dashboard, one entry per locale.

◆ _ResponseCreatedAt

readonly long AdaptySDK.AdaptyFlow._ResponseCreatedAt
private

◆ _UiSchema

readonly JObject AdaptySDK.AdaptyFlow._UiSchema
private

The renderer's custom-layout schema. Opaque to the app: carried only so a flow handed back to the native side keeps it.

◆ InstanceIdentity

readonly string AdaptySDK.AdaptyFlow.InstanceIdentity

A unique identifier for this flow instance.

◆ Name

readonly string AdaptySDK.AdaptyFlow.Name

The flow name configured in the Adapty Dashboard.

◆ Placement

readonly AdaptyPlacement AdaptySDK.AdaptyFlow.Placement

An AdaptyPlacement object that contains information about the placement of the flow.

◆ VariationId

readonly string AdaptySDK.AdaptyFlow.VariationId

The identifier of the variation, used to attribute purchases to the flow.

Property Documentation

◆ HasViewConfiguration

bool AdaptySDK.AdaptyFlow.HasViewConfiguration
get

Whether this flow carries a view configuration and can be rendered with AdaptyUI.CreateFlowView(AdaptyFlow, AdaptyUICreateFlowViewParameters, System.Action<AdaptyUIFlowView, AdaptyError>).

Both natives treat the configuration as present only when the version identifier and the schema arrive together, and send them that way or not at all.

◆ Paywalls

IReadOnlyList<AdaptyFlowPaywall> AdaptySDK.AdaptyFlow.Paywalls
getprivate set

The paywall variations this flow offers.

◆ ProductIdentifiers

IReadOnlyList<AdaptyProductIdentifier> AdaptySDK.AdaptyFlow.ProductIdentifiers
get

Array of product identifiers aggregated across all paywall variations of this flow.

◆ RemoteConfig

AdaptyRemoteConfig AdaptySDK.AdaptyFlow.RemoteConfig
get

The first custom JSON formatted data configured in the Adapty Dashboard.

This can be null if no remote config is configured for the flow. Use RemoteConfigs to access configs for a specific locale.

◆ RemoteConfigs

IReadOnlyList<AdaptyRemoteConfig> AdaptySDK.AdaptyFlow.RemoteConfigs
getprivate set

The remote configs of the flow, one per localization. Empty when none is configured; RemoteConfig is the first of them.

◆ VendorProductIds

IReadOnlyList<string> AdaptySDK.AdaptyFlow.VendorProductIds
get

Array of vendor product IDs (App Store or Google Play product identifiers) aggregated across all paywall variations of this flow.

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