Class InAppOffer

One of the available offers to purchase a given product

Hierarchy (view full)

Offer
- InAppOffer

Index

Constructors

Properties

id pricingPhases token? type

Accessors

canPurchase platform productGroup productId productType

Methods

Constructors

constructor

new InAppOffer(options, decorator): CdvPurchase.GooglePlay.InAppOffer
Parameters
- options: {
      id: string;
      pricingPhases: CdvPurchase.PricingPhase[];
      product: GProduct;
      token?: string;
  }
  - id: string
  - pricingPhases: CdvPurchase.PricingPhase[]
  - product: GProduct
  - Optional token?: string
- decorator: OfferDecorator
Returns CdvPurchase.GooglePlay.InAppOffer
Overrides CdvPurchase.Offer.constructor

Properties

id

id: string

Offer identifier

pricingPhases

pricingPhases: CdvPurchase.PricingPhase[]

Pricing phases

`Optional` token

token?: string

type

type: string = 'inapp'

Accessors

canPurchase

get canPurchase(): boolean
true if the offer can be purchased.

Returns boolean
Inherited from CdvPurchase.Offer.canPurchase

platform

get platform(): Platform
Platform this offer is available from

Returns Platform
Inherited from CdvPurchase.Offer.platform

productGroup

get productGroup(): undefined | string
Group the product related to this offer is member of

Returns undefined | string
Inherited from CdvPurchase.Offer.productGroup

productId

get productId(): string
Identifier of the product related to this offer

Returns string
Inherited from CdvPurchase.Offer.productId

productType

get productType(): ProductType
Type of the product related to this offer

Returns ProductType
Inherited from CdvPurchase.Offer.productType

Methods

order

order(additionalData?): Promise<undefined | IError>
Initiate a purchase of this offer.
Parameters
- Optional additionalData: CdvPurchase.AdditionalData
Returns Promise<undefined | IError>
Example
```
store.get("my-product").getOffer().order();
```
Inherited from Offer.order