Interface PurchasesConfiguration

Holds parameters to initialize the SDK.

Hierarchy

  • PurchasesConfiguration

Properties

apiKey appUserID? entitlementVerificationMode? observerMode? shouldShowInAppMessagesAutomatically? useAmazon? userDefaultsSuiteName? usesStoreKit2IfAvailable?

Properties

apiKey

apiKey: string

RevenueCat API Key. Needs to be a string

Optional appUserID

appUserID?: null | string

A unique id for identifying the user

Optional entitlementVerificationMode

entitlementVerificationMode?: ENTITLEMENT_VERIFICATION_MODE

Verification strictness levels for [EntitlementInfo]. See https://rev.cat/trusted-entitlements for more info.

Optional observerMode

observerMode?: boolean

An optional boolean. Set this to TRUE if you have your own IAP implementation and want to use only RevenueCat's backend. Default is FALSE. If you are on Android and setting this to ON, you will have to acknowledge the purchases yourself.

Optional shouldShowInAppMessagesAutomatically

shouldShowInAppMessagesAutomatically?: boolean

Whether we should show store in-app messages automatically. Both Google Play and the App Store provide in-app messages for some situations like billing issues. By default, those messages will be shown automatically. This allows to disable that behavior, so you can display those messages at your convenience. For more information, check: https://rev.cat/storekit-message and https://rev.cat/googleplayinappmessaging

Optional useAmazon

useAmazon?: boolean

An optional boolean. Android only. Required to configure the plugin to be used in the Amazon Appstore.

Optional userDefaultsSuiteName

userDefaultsSuiteName?: string

An optional string. iOS-only, will be ignored for Android. Set this if you would like the RevenueCat SDK to store its preferences in a different NSUserDefaults suite, otherwise it will use standardUserDefaults. Default is null, which will make the SDK use standardUserDefaults.

Optional usesStoreKit2IfAvailable

usesStoreKit2IfAvailable?: boolean

iOS-only, will be ignored for Android. Set this to TRUE to enable StoreKit2. Default is FALSE.

Deprecated

RevenueCat currently uses StoreKit 1 for purchases, as its stability in production scenarios has proven to be more performant than StoreKit 2. We're collecting more data on the best approach, but StoreKit 1 vs StoreKit 2 is an implementation detail that you shouldn't need to care about. We recommend not using this parameter, letting RevenueCat decide for you which StoreKit implementation to use.

Settings

Member Visibility

Theme

Generated using TypeDoc