Class

Adapty

Declaration 

final class Adapty

Topics

Type Properties

static let SDKVersion: String
static var delegate: AdaptyDelegate?
Set the delegate to listen for AdaptyProfile updates and user initiated an in-app purchases
static var idfaCollectionDisabled: Bool
You can disable IDFA collecting by using this property. Make sure you call it before .activate() method.
static var logLevel: AdaptyLogLevel
Set to the most appropriate level of logging

Type Methods

static func activate(String, observerMode: Bool, customerUserId: String?, enableUsageLogs: Bool, storeKit2Usage: StoreKit2Usage, dispatchQueue: DispatchQueue) async throws
Use this method to initialize the Adapty SDK.
static func activate(String, observerMode: Bool, customerUserId: String?, enableUsageLogs: Bool, storeKit2Usage: StoreKit2Usage, dispatchQueue: DispatchQueue, AdaptyErrorCompletion?)
Use this method to initialize the Adapty SDK.
static func getPaywall(String, locale: String?) async throws -> AdaptyPaywall?
Adapty allows you remotely configure the products that will be displayed in your app. This way you don’t have to hardcode the products and can dynamically change offers or run A/B tests without app releases.
static func getPaywall(String, locale: String?, AdaptyResultCompletion<AdaptyPaywall>)
Adapty allows you remotely configure the products that will be displayed in your app. This way you don’t have to hardcode the products and can dynamically change offers or run A/B tests without app releases.
static func getPaywallProduct(from: JSONDecoder, data: Data, AdaptyResultCompletion<AdaptyPaywallProduct>)
This method is intended to be used by cross-platform SDKs, we do not expect you to use it directly.
static func getPaywallProducts(paywall: AdaptyPaywall) async throws -> [AdaptyPaywallProduct]?
Once you have a AdaptyPaywall, fetch corresponding products array using this method.
static func getPaywallProducts(paywall: AdaptyPaywall, AdaptyResultCompletion<[AdaptyPaywallProduct]>)
Once you have a AdaptyPaywall, fetch corresponding products array using this method.
static func getProductsIntroductoryOfferEligibility(products: [AdaptyPaywallProduct]) async throws -> [String : AdaptyEligibility]
Once you have an AdaptyPaywallProduct array, fetch introductory offers information for this products.
static func getProductsIntroductoryOfferEligibility(products: [AdaptyPaywallProduct], AdaptyResultCompletion<[String : AdaptyEligibility]>)
Once you have an AdaptyPaywallProduct array, fetch introductory offers information for this products.
static func getProductsIntroductoryOfferEligibility(vendorProductIds: [String]) async throws -> [String : AdaptyEligibility]
Once you have an AdaptyPaywallProduct array, fetch introductory offers information for this products.
static func getProductsIntroductoryOfferEligibility(vendorProductIds: [String], AdaptyResultCompletion<[String : AdaptyEligibility]>)
Once you have an AdaptyPaywallProduct array, fetch introductory offers information for this products.
static func getProfile() async throws -> AdaptyProfile?
The main function for getting a user profile. Allows you to define the level of access, as well as other parameters.
static func getProfile(AdaptyResultCompletion<AdaptyProfile>)
The main function for getting a user profile. Allows you to define the level of access, as well as other parameters.
static func getReceipt() async throws -> Data
You can fetch the StoreKit receipt by calling this method
static func getReceipt(AdaptyResultCompletion<Data>)
You can fetch the StoreKit receipt by calling this method
static func identify(String) async throws
Use this method for identifying user with it’s user id in your system.
static func identify(String, AdaptyErrorCompletion?)
Use this method for identifying user with it’s user id in your system.
static func logShowOnboarding(AdaptyOnboardingScreenParameters, AdaptyErrorCompletion?)
static func logShowOnboarding(name: String?, screenName: String?, screenOrder: UInt) async throws
Call this method to keep track of the user’s steps while onboarding
static func logShowOnboarding(name: String?, screenName: String?, screenOrder: UInt, AdaptyErrorCompletion?)
Call this method to keep track of the user’s steps while onboarding
static func logShowPaywall(AdaptyPaywall) async throws
Call this method to notify Adapty SDK, that particular paywall was shown to user.
static func logShowPaywall(AdaptyPaywall, AdaptyErrorCompletion?)
Call this method to notify Adapty SDK, that particular paywall was shown to user.
static func logout() async throws
You can logout the user anytime by calling this method.
static func logout(AdaptyErrorCompletion?)
You can logout the user anytime by calling this method.
static func makePurchase(product: AdaptyPaywallProduct) async throws -> AdaptyPurchasedInfo
To make the purchase, you have to call this method.
static func makePurchase(product: AdaptyPaywallProduct, AdaptyResultCompletion<AdaptyPurchasedInfo>)
To make the purchase, you have to call this method.
static func presentCodeRedemptionSheet()
Call this method to have StoreKit present a sheet enabling the user to redeem codes provided by your app.
static func restorePurchases() async throws -> AdaptyProfile
To restore purchases, you have to call this method.
static func restorePurchases(AdaptyResultCompletion<AdaptyProfile>)
To restore purchases, you have to call this method.
static func setBackendEnvironment(baseUrl: URL)
static func setBackendEnvironment(withProxy: String, withProxyPort: Int)
static func setCrossPlatformSDK(version: String, name: String)
static func setFallbackPaywalls(Data) async throws
To set fallback paywalls, use this method. You should pass exactly the same payload you’re getting from Adapty backend. You can copy it from Adapty Dashboard.
static func setFallbackPaywalls(Data, AdaptyErrorCompletion?)
To set fallback paywalls, use this method. You should pass exactly the same payload you’re getting from Adapty backend. You can copy it from Adapty Dashboard.
static func setLogHandler(AdaptyLogHandler)
Override the default logger behavior using this method
static func setVariationId(String, forPurchasedTransaction: Transaction) async throws
Link purchased transaction with paywall’s variationId.
static func setVariationId(String, forPurchasedTransaction: SKPaymentTransaction) async throws
Link purchased transaction with paywall’s variationId.
static func setVariationId(String, forPurchasedTransaction: SKPaymentTransaction, AdaptyErrorCompletion?)
Link purchased transaction with paywall’s variationId.
static func setVariationId(String, forPurchasedTransaction: Transaction, AdaptyErrorCompletion?)
Link purchased transaction with paywall’s variationId.
static func setVariationId(from: JSONDecoder, data: Data, AdaptyErrorCompletion?)
This method is intended to be used by cross-platform SDKs, we do not expect you to use it directly.
static func updateAttribution([AnyHashable : Any], source: AdaptyAttributionSource, networkUserId: String?) async throws
To set attribution data for the profile, use this method.
static func updateAttribution([AnyHashable : Any], source: AdaptyAttributionSource, networkUserId: String?, AdaptyErrorCompletion?)
To set attribution data for the profile, use this method.
static func updateProfile(params: AdaptyProfileParameters) async throws
You can set optional attributes such as email, phone number, etc, to the user of your app. You can then use attributes to create user segments or just view them in CRM.
static func updateProfile(params: AdaptyProfileParameters, AdaptyErrorCompletion?)
You can set optional attributes such as email, phone number, etc, to the user of your app. You can then use attributes to create user segments or just view them in CRM.
static func writeLog(time: Date, level: AdaptyLogLevel, message: String, file: String, function: String, line: UInt)