|
AdaptySDK 4.1.1
|
Classes | |
| class | Adapty |
| The main class for interacting with the Adapty SDK. More... | |
| class | AdaptyCallbacks |
| The one policy for calling back into the app, and the only implementation of it. More... | |
| class | AdaptyConfiguration |
| Everything Adapty.Activate(AdaptyConfiguration, System.Action<AdaptyError>) needs. Build one with Builder. More... | |
| class | AdaptyCustomAsset |
| Base class for custom assets that can be used in Adapty UI. More... | |
| class | AdaptyCustomAssetColor |
| Custom asset representing a color. More... | |
| class | AdaptyCustomAssetLinearGradient |
| Custom asset representing a linear gradient. More... | |
| class | AdaptyCustomAssetLocalImageAsset |
| Custom asset representing a local image asset. More... | |
| class | AdaptyCustomAssetLocalImageData |
| Custom asset representing local image data. More... | |
| class | AdaptyCustomAssetLocalImageFile |
| Custom asset representing a local image file. More... | |
| class | AdaptyCustomAssetLocalVideoAsset |
| Custom asset representing a local video asset. More... | |
| class | AdaptyCustomAssetLocalVideoFile |
| Custom asset representing a local video file. More... | |
| class | AdaptyCustomAssetPath |
| Shared helpers for the write-only custom asset payloads. More... | |
| class | AdaptyCustomerIdentity |
| Customer identity parameters for iOS and Android platforms. More... | |
| class | AdaptyError |
| A failure reported by the native SDK. Every completion handler takes one, and it is null when the call succeeded. More... | |
| class | AdaptyExternalAttributionProvider |
| An external attribution provider recognized by the Adapty backend. More... | |
| class | AdaptyFlow |
| Represents a flow configuration in Adapty. More... | |
| class | AdaptyFlowPaywall |
| Represents a paywall variation of an AdaptyFlow. More... | |
| class | AdaptyInstallationDetails |
| What the SDK knows about this installation of the app. More... | |
| class | AdaptyInstallationStatus |
| What Adapty.GetCurrentInstallationStatus(System.Action<AdaptySDK.AdaptyInstallationStatus, AdaptySDK.AdaptyError>) reports: how much is known about this installation, and the details when they are. More... | |
| class | AdaptyOnboarding |
| Represents an onboarding configuration in Adapty. More... | |
| class | AdaptyOnboardingsAnalyticsEvent |
| class | AdaptyOnboardingsAnalyticsEventOnboardingCompleted |
| class | AdaptyOnboardingsAnalyticsEventOnboardingStarted |
| class | AdaptyOnboardingsAnalyticsEventProductsScreenPresented |
| class | AdaptyOnboardingsAnalyticsEventRegistrationScreenPresented |
| class | AdaptyOnboardingsAnalyticsEventScreenCompleted |
| class | AdaptyOnboardingsAnalyticsEventScreenPresented |
| class | AdaptyOnboardingsAnalyticsEventSecondScreenPresented |
| class | AdaptyOnboardingsAnalyticsEventUnknown |
| class | AdaptyOnboardingsAnalyticsEventUserEmailCollected |
| class | AdaptyOnboardingsDatePickerParams |
| class | AdaptyOnboardingsEmailInput |
| class | AdaptyOnboardingsInput |
| class | AdaptyOnboardingsInputParams |
| class | AdaptyOnboardingsMultiSelectParams |
| class | AdaptyOnboardingsNumberInput |
| class | AdaptyOnboardingsSelectParams |
| class | AdaptyOnboardingsStateUpdatedParams |
| class | AdaptyOnboardingsTextInput |
| class | AdaptyPaywallProduct |
| Represents a product available for purchase in a paywall. More... | |
| class | AdaptyPlacement |
| The placement a flow was fetched for, with the A/B test and audience it resolved to. More... | |
| class | AdaptyPlacementFetchPolicy |
| Whether a fetch may answer from the cache, and for how long. Pick one of the shared instances or build one with ReturnCacheDataIfNotExpiredElseLoad. More... | |
| class | AdaptyPrice |
| A price as the store reports it: the amount, and the strings to show it with. More... | |
| class | AdaptyProductIdentifier |
| A lightweight identifier used when addressing a specific product across platforms. More... | |
| class | AdaptyProfile |
| Represents a user profile in Adapty. More... | |
| class | AdaptyProfileParameters |
| The profile attributes Adapty.UpdateProfile(AdaptySDK.AdaptyProfileParameters, System.Action<AdaptySDK.AdaptyError>) sends. Build one with Builder. More... | |
| class | AdaptyPromotedProduct |
| A product for an App Store promoted in-app purchase. iOS only. More... | |
| class | AdaptyPurchaseParameters |
| The optional extras of a purchase. Both are Android only — on iOS an instance changes nothing, and Adapty.MakePurchase(AdaptyPaywallProduct, System.Action<AdaptyPurchaseResult, AdaptyError>) without one is the same call. More... | |
| class | AdaptyPurchaseParametersBuilder |
| Assembles an AdaptyPurchaseParameters. Every setter returns the builder, so calls chain; the constructor takes both values directly if that reads better. More... | |
| class | AdaptyPurchaseResult |
| How a purchase ended, and the updated profile when it succeeded. More... | |
| class | AdaptyRemoteConfig |
| The JSON configured against a flow in the Dashboard, for one localization. More... | |
| class | AdaptyRequest |
| The one way a public method reaches the native side, and the one place a request names itself when the app's completion handler throws. More... | |
| class | AdaptyResult< T > |
| class | AdaptySubscription |
| What a product's subscription looks like: its period, its offer, and how it renews. More... | |
| class | AdaptySubscriptionOffer |
| A discounted offer on a subscription, and the phases it runs through. More... | |
| class | AdaptySubscriptionPeriod |
| A span of time, as the stores express it — a number and a unit, not a duration. More... | |
| class | AdaptySubscriptionPhase |
| One stretch of an offer at one price: a free trial, then a discounted period, then the rest. More... | |
| class | AdaptySubscriptionUpdateParameters |
| Android only. Turns a purchase into an upgrade or downgrade of a subscription the user already has, rather than a new one. Pass it through AdaptyPurchaseParameters.SubscriptionUpdateParams; iOS handles the change itself through the subscription group and ignores this. More... | |
| class | AdaptyUI |
| Building, presenting and dismissing the views that render a flow. More... | |
| class | AdaptyUICreateFlowViewParameters |
| 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... | |
| class | AdaptyUIDialogConfiguration |
| What AdaptyUI.ShowDialog(AdaptySDK.AdaptyUIFlowView, AdaptySDK.AdaptyUIDialogConfiguration, System.Action<AdaptySDK.AdaptyUIDialogActionType, AdaptySDK.AdaptyError>) puts on the dialog. Only the default action title is required; a dialog without a secondary one has a single button. More... | |
| class | AdaptyUIFlowView |
| A flow view built by AdaptyUI.CreateFlowView(AdaptySDK.AdaptyFlow, AdaptySDK.AdaptyUICreateFlowViewParameters, System.Action<AdaptySDK.AdaptyUIFlowView, AdaptySDK.AdaptyError>). Single use: once dismissed it is destroyed, and showing the flow again means building another one. More... | |
| class | AdaptyUIMediaCacheConfiguration |
| Limits for the cache the flow renderer keeps for images and video. Any limit left null keeps the native default. More... | |
| class | AdaptyUIOnboardingMeta |
| class | AdaptyUIOnboardingView |
| class | AdaptyUIUserAction |
Something the user did in a flow view, reported through FlowViewDidPerformAction. Nothing is done for you — a close does not dismiss the view. More... | |
| interface | IAdaptyEventListener |
| Interface for listening to Adapty SDK events. More... | |
| interface | IAdaptyFlowsEventsListener |
| Interface for listening to flow view events. More... | |
| interface | IAdaptyOnboardingsEventsListener |
| Interface for listening to onboarding view events. More... | |
| interface | IAdaptyUIObserverModeResolver |
| Interface for resolving purchases and restores initiated by a flow while the SDK runs in Observer mode. More... | |
| interface | IAdaptyUISystemRequestsHandler |
| Interface for handling system requests initiated by a flow: OS permission prompts and store review requests. More... | |
Enumerations | |
| enum | AdaptyErrorCode { Unknown = 0 , ClientInvalid = 1 , PaymentCancelled = 2 , PaymentInvalid = 3 , PaymentNotAllowed = 4 , StoreProductNotAvailable = 5 , CloudServicePermissionDenied = 6 , CloudServiceNetworkConnectionFailed = 7 , CloudServiceRevoked = 8 , PrivacyAcknowledgementRequired = 9 , UnauthorizedRequestData = 10 , InvalidOfferIdentifier = 11 , InvalidSignature = 12 , MissingOfferParams = 13 , InvalidOfferPrice = 14 , AdaptyNotInitialized = 20 , ProductNotFound = 22 , CurrentSubscriptionToUpdateNotFoundInHistory = 24 , BillingServiceTimeout = 97 , FeatureNotSupported = 98 , BillingServiceDisconnected = 99 , BillingServiceUnavailable = 102 , BillingUnavailable = 103 , DeveloperError = 105 , BillingError = 106 , ItemAlreadyOwned = 107 , ItemNotOwned = 108 , BillingNetworkError = 112 , NoProductIDsFound = 1000 , ProductRequestFailed = 1002 , CantMakePayments = 1003 , NoPurchasesToRestore = 1004 , CantReadReceipt = 1005 , ProductPurchaseFailed = 1006 , RefreshReceiptFailed = 1010 , FetchSubscriptionStatusFailed = 1020 , PaymentPendingError = 1050 , NotActivated = 2002 , BadRequest = 2003 , ServerError = 2004 , NetworkFailed = 2005 , DecodingFailed = 2006 , EncodingFailed = 2009 , AnalyticsDisabled = 3000 , WrongParam = 3001 , ActivateOnceError = 3005 , ProfileWasChanged = 3006 , UnsupportedData = 3007 , UnidentifiedUserLogout = 3020 , FetchTimeoutError = 3101 , WrongAssetType = 4104 , JsException = 4105 , NavigatorNotFound = 4106 , InvalidActionUrl = 4107 , OperationInterrupted = 9000 } |
| The numeric code carried by AdaptyError.Code. More... | |
| enum | AdaptyInstallationStatusType { NotAvailable = 0 , NotDetermined = 1 , Determined = 2 } |
| How much the SDK knows about this installation. More... | |
| enum | AdaptyLogLevel { Error = 0 , Warn = 1 , Info = 2 , Verbose = 3 , Debug = 4 } |
| How much the native SDK writes to the platform log. More... | |
| enum | AdaptyPaymentMode { PayAsYouGo = 0 , PayUpFront = 1 , FreeTrial = 2 , Unknown = 3 } |
| How a discounted subscription phase is paid for. More... | |
| enum | AdaptyProfileGender { Female = 0 , Male = 1 , Other = 2 } |
| The gender recorded on a profile. More... | |
| enum | AdaptyPurchaseResultType { Pending = 0 , UserCancelled = 1 , Success = 2 } |
| How a purchase ended. More... | |
| enum | AdaptyRefundPreference { NoPreference = 0 , Grant = 1 , Decline = 2 } |
| iOS only. What to tell the App Store when it consults you about a refund request for this user. More... | |
| enum | AdaptyServerCluster { Default = 0 , EU = 1 , CN = 2 } |
| Which Adapty server region the SDK talks to. Set it in the configuration to match where your account's data is held. More... | |
| enum | AdaptySubscriptionOfferType { Introductory = 0 , Promotional = 1 , WinBack = 2 , Code = 3 } |
| Which kind of discounted offer a subscription phase belongs to. More... | |
| enum | AdaptySubscriptionPeriodUnit { Day = 0 , Week = 1 , Month = 2 , Year = 3 , Unknown = 4 } |
| The unit a subscription period is counted in. More... | |
| enum | AdaptySubscriptionRenewalType { Prepaid = 0 , Autorenewable = 1 } |
| Android only. Whether the subscription renews by itself. More... | |
| enum | AdaptySubscriptionUpdateReplacementMode { WithTimeProration = 0 , ChargeProratedPrice = 1 , WithoutProration = 2 , Deferred = 3 , ChargeFullPrice = 4 } |
| Android only. When a subscription change takes effect and what happens to the time the user has already paid for. More... | |
| enum | AdaptyUIDialogActionType { Primary = 0 , Secondary = 1 } |
| Which button closed a dialog shown by AdaptyUI.ShowDialog(AdaptySDK.AdaptyUIFlowView, AdaptySDK.AdaptyUIDialogConfiguration, System.Action<AdaptySDK.AdaptyUIDialogActionType, AdaptySDK.AdaptyError>). More... | |
| enum | AdaptyUIIOSPresentationStyle { FullScreen = 0 , PageSheet = 1 } |
| iOS only. How a flow view is presented. Ignored on Android. More... | |
| enum | AdaptyUIUserActionType { Close = 0 , SystemBack = 1 , OpenUrl = 2 , Custom = 3 } |
What the user did in a flow view, as reported by FlowViewDidPerformAction. More... | |
| enum | AdaptyWebPresentation { ExternalBrowser = 0 , InAppBrowser = 1 } |
| Where a web paywall opens. More... | |
| enum | AppTrackingTransparencyStatus { NotDetermined = 0 , Restricted = 1 , Denied = 2 , Authorized = 3 } |
iOS only. What the user answered to the App Tracking Transparency prompt, as ATTrackingManager.AuthorizationStatus reports it. More... | |
The numeric code carried by AdaptyError.Code.
Almost every value is the native SDK's own, so a code always arrives whether or not this enum names it. Most of those are produced by one platform only, and each member says which; where both produce a number, both meanings are given, because they are not always the same one. Each was traced to its throw site in AdaptySDK-iOS 4.0.2 and AdaptySDK-Android 4.0.1; the pinned iOS 4.1.2 and Android 4.1.0 natives declare the same set of codes, with the one behavioural change noted on NoPurchasesToRestore. Two are different: WrongParam and DecodingFailed are also raised by this SDK itself, on either platform, when a wrong argument is caught before sending or a reply cannot be read — the native side is never reached in the first case and has already answered in the second.
| Enumerator | |
|---|---|
| Unknown | A failure the native SDK could not classify. |
| ClientInvalid | iOS only. The client is not allowed to make the request. |
| PaymentCancelled | iOS only. The user cancelled the request. Not a failure to report to them. |
| PaymentInvalid | iOS only. The purchase identifier was invalid. |
| PaymentNotAllowed | iOS only. This device is not allowed to make the payment — parental controls, for example. |
| StoreProductNotAvailable | The product is not available in the current storefront. On Android this is Google Play's |
| CloudServicePermissionDenied | iOS only. The user has not allowed access to cloud service information. |
| CloudServiceNetworkConnectionFailed | iOS only. The device could not connect to the network. |
| CloudServiceRevoked | iOS only. The user has revoked permission to use this cloud service. |
| PrivacyAcknowledgementRequired | iOS only. The user needs to acknowledge Apple's privacy policy. |
| UnauthorizedRequestData | iOS only. The app is using |
| InvalidOfferIdentifier | iOS only. The subscription offer identifier is not valid. |
| InvalidSignature | iOS only. The cryptographic signature of a promotional offer is not valid. |
| MissingOfferParams | iOS only. One or more parameters of |
| InvalidOfferPrice | iOS only. The price of the offer is not valid. |
| AdaptyNotInitialized | Android only. The SDK was called before Adapty.Activate(AdaptySDK.AdaptyConfiguration, System.Action<AdaptySDK.AdaptyError>). |
| ProductNotFound | Android only. The product was not found in Google Play for this application. |
| CurrentSubscriptionToUpdateNotFoundInHistory | Android only. The subscription being replaced was not found in the purchase history. |
| BillingServiceTimeout | Android only. Google Play's |
| FeatureNotSupported | Android only. Google Play's |
| BillingServiceDisconnected | Android only. Google Play's |
| BillingServiceUnavailable | Android only. Google Play's |
| BillingUnavailable | Android only. Google Play's |
| DeveloperError | Android only. Google Play's |
| BillingError | Android only. Google Play's |
| ItemAlreadyOwned | Android only. Google Play's |
| ItemNotOwned | Android only. Google Play's |
| BillingNetworkError | Android only. Google Play's |
| NoProductIDsFound | No products were found for the placement. Usually a Dashboard or store configuration that has not propagated yet. |
| ProductRequestFailed | iOS only. The App Store could not be asked for the products. |
| CantMakePayments | iOS only. In-app purchases are not allowed on this device. |
| NoPurchasesToRestore | Nothing to restore. No pinned native produces it any more: iOS never did, and the Android 4.1 native handles it internally — Adapty.RestorePurchases(System.Action<AdaptySDK.AdaptyProfile, AdaptySDK.AdaptyError>) completes with the current profile instead. The member stays because the code is still the native SDKs' own and an older native, or a future one, may send it. |
| CantReadReceipt | iOS only. No valid App Store receipt was found on the device. |
| ProductPurchaseFailed | iOS only. The purchase failed in StoreKit. |
| RefreshReceiptFailed | iOS only. Refreshing the App Store receipt failed. |
| FetchSubscriptionStatusFailed | iOS only. The subscription status could not be fetched from the App Store. |
| PaymentPendingError | iOS only, and not reachable from Unity today. The native SDK raises it when StoreKit answers a purchase with |
| NotActivated | The two platforms mean different things by this number. On iOS the SDK was called before Adapty.Activate(AdaptySDK.AdaptyConfiguration, System.Action<AdaptySDK.AdaptyError>); on Android the Adapty backend answered 401 or 403, which points at the API key. |
| BadRequest | The Adapty backend answered with a 4xx other than 401 and 403. |
| ServerError | The Adapty backend answered 429, 499 or a 5xx. Worth retrying. |
| NetworkFailed | The request to the Adapty backend failed on the network. |
| DecodingFailed | A response could not be decoded. If it arrives from a call this SDK makes, the versions of the Unity and native SDKs may not match. Raised by this SDK on either platform, as well as by the native ones. |
| EncodingFailed | The parameters of a request could not be encoded. Declared by the native iOS SDK for its own encoding failures. This SDK does not raise it: a request it cannot encode is reported as WrongParam — the code the native side answers a wrong argument with. |
| AnalyticsDisabled | The call needs analytics, which the profile has switched off. |
| WrongParam | A parameter of the call was not valid. Also raised by this SDK itself, on either platform, when it can see the argument is wrong before sending — a null the request cannot carry, or a value the serializer cannot write. The call never leaves the SDK in that case. |
| ActivateOnceError | iOS only. Adapty.Activate(AdaptySDK.AdaptyConfiguration, System.Action<AdaptySDK.AdaptyError>) was called more than once. |
| ProfileWasChanged | The profile changed while the operation was running — an Adapty.Identify(System.String, System.Action<AdaptySDK.AdaptyError>) or Adapty.Logout(System.Action<AdaptySDK.AdaptyError>) in between. Repeat the operation on the new profile. |
| UnsupportedData | iOS only. The data handed to the SDK is of a shape it does not support. |
| UnidentifiedUserLogout | Adapty.Logout(System.Action<AdaptySDK.AdaptyError>) was called for a profile that was never identified. |
| FetchTimeoutError | iOS only. The fetch did not finish within the timeout the call was given. |
| WrongAssetType | Android only. Reported through |
| JsException | Android only. Reported through |
| NavigatorNotFound | Android only. Reported through |
| InvalidActionUrl | Android only. Reported through |
| OperationInterrupted | iOS only. The operation was interrupted before it could finish. |
How much the SDK knows about this installation.
| Enumerator | |
|---|---|
| NotAvailable | The details are not available. Reported when the platform has nothing to report — which includes the case of Adapty Attribution being off, its default, since the 4.1 natives collect nothing until it is on — and on iOS also when the install time or the launch count could not be obtained. |
| NotDetermined | Not established yet. Ask again later. |
| Determined | Established — the details are on AdaptyInstallationStatus.Details. |
How much the native SDK writes to the platform log.
Each level includes the ones before it. Set it in the configuration, or at any time with Adapty.SetLogLevel(AdaptySDK.AdaptyLogLevel, System.Action<AdaptySDK.AdaptyError>).
How a discounted subscription phase is paid for.
How a purchase ended.
iOS only. What to tell the App Store when it consults you about a refund request for this user.
A preference, not a decision — the App Store is not obliged to follow it.
| Enumerator | |
|---|---|
| NoPreference | Express no preference and let the App Store decide. |
| Grant | Ask the App Store to grant the refund. |
| Decline | Ask the App Store to decline it. |
Which Adapty server region the SDK talks to. Set it in the configuration to match where your account's data is held.
| Enumerator | |
|---|---|
| Default | The default cluster. |
| EU | The European Union cluster. |
| CN | The mainland China cluster. |
Which kind of discounted offer a subscription phase belongs to.
Android only. When a subscription change takes effect and what happens to the time the user has already paid for.
These are Google Play's replacement modes; see its documentation
for which ones a given change allows.
Which button closed a dialog shown by AdaptyUI.ShowDialog(AdaptySDK.AdaptyUIFlowView, AdaptySDK.AdaptyUIDialogConfiguration, System.Action<AdaptySDK.AdaptyUIDialogActionType, AdaptySDK.AdaptyError>).
| Enumerator | |
|---|---|
| Primary | The default action — the title given as the default one. |
| Secondary | The other action. Only reported when the dialog was configured with one. |
What the user did in a flow view, as reported by FlowViewDidPerformAction.
iOS only. What the user answered to the App Tracking Transparency prompt, as ATTrackingManager.AuthorizationStatus reports it.
The numbers are Apple's own, so a value read from ATTrackingManager can be cast across directly.