CdvPurchase.md

Namespace: CdvPurchase

Namespace for the cordova-plugin-purchase plugin.

All classes, enumerations and variables defined by the plugin are in this namespace.

Throughout the documentation, in order to keep examples readable, we omit the CdvPurchase prefix.

When you see, for example ProductType.PAID_SUBSCRIPTION, it refers to CdvPurchase.ProductType.PAID_SUBSCRIPTION.

In the files that interact with the plugin, I recommend creating those shortcuts (and more if needed):

const {store, ProductType, Platform, LogLevel} = CdvPurchase;

Table of contents

Namespaces

• AppleAppStore
• ApplePay
• Braintree
• GooglePlay
• Test
• Utils
• Validator
• WindowsStore

Enumerations

• CancelationReason
• ErrorCode
• LogLevel
• PaymentMode
• Platform
• PriceConsentStatus
• ProductType
• RecurrenceMode
• RenewalIntent
• TransactionState

Classes

• Iaptic
• Logger
• Offer
• PaymentRequestPromise
• Product
• Receipt
• Store
• Transaction
• VerifiedReceipt

Interfaces

• Adapter
• AdditionalData
• Console
• IError
• IRegisterProduct
• IapticConfig
• PaymentRequest
• PostalAddress
• PricingPhase
• TransactionMonitor
• VerifiedPurchase
• When

Type Aliases

• Callback
• IPeriodUnit
• PlatformFunctionality
• PlatformWithOptions
• PrivacyPolicyItem

Variables

• PLUGIN_VERSION
• store

Type Aliases

Callback

Ƭ Callback<T>: (t: T) => void

Type parameters

Name
T

Type declaration

▸ (t): void

Callback

Parameters

Name	Type
t	T

Returns

void

---

IPeriodUnit

Ƭ IPeriodUnit: "Minute" | "Hour" | "Day" | "Week" | "Month" | "Year"

Unit for measuring durations

---

PlatformFunctionality

Ƭ PlatformFunctionality: "requestPayment" | "order" | "manageSubscriptions" | "manageBilling"

Functionality optionality provided by a given platform.

See

checkSupport

---

PlatformWithOptions

Ƭ PlatformWithOptions: { options: AdapterOptions ; platform: BRAINTREE } | { platform: GOOGLE_PLAY } | { options?: AdapterOptions ; platform: APPLE_APPSTORE } | { platform: TEST } | { platform: WINDOWS_STORE }

Used to initialize a platform with some options

See

initialize

---

PrivacyPolicyItem

Ƭ PrivacyPolicyItem: "fraud" | "support" | "analytics" | "tracking"

Variables

PLUGIN_VERSION

• Const PLUGIN_VERSION: "13.0.0"

Current release number of the plugin.

---

store

• store: Store

The global store object.