Class SKProduct

Product definition from a store

Hierarchy (view full)

Constructors

constructor

Properties

countryCode? description group? id offers platform raw title type

Accessors

canPurchase owned pricing

Methods

getOffer refresh removeIneligibleDiscounts

Constructors

constructor

  • new SKProduct(validProduct, p, decorator, eligibilities): SKProduct

  • Parameters

    Returns SKProduct

Properties

Optional countryCode

countryCode?: string

AppStore country this product has been fetched for

description

description: string = ''

Product full description from the store.

Optional group

group?: string

Group the product is member of.

Only 1 product of a given group can be owned. This is generally used to provide different levels for subscriptions, for example: silver and gold.

Purchasing a different level will replace the previously owned one.

id

id: string

Product identifier on the store (unique per platform)

offers

offers: Offer[]

List of offers available for this product

platform

platform: Platform

Platform this product is available from

raw

raw: ValidProduct

Raw data returned by native side

title

title: string = ''

Product title from the store.

type

type: ProductType

Type of product (subscription, consumable, etc.)

Accessors

canPurchase

  • get canPurchase(): boolean

  • Returns true if the product can be purchased.

    Returns boolean

owned

  • get owned(): boolean

  • Returns true if the product is owned.

    Returns boolean

pricing

  • get pricing(): undefined | CdvPurchase.PricingPhase

  • Shortcut to offers[0].pricingPhases[0]

    Useful when you know products have a single offer and a single pricing phase.

    Returns undefined | CdvPurchase.PricingPhase

Methods

getOffer

  • getOffer(id?): undefined | Offer

  • Find and return an offer for this product from its id

    If id isn't specified, returns the first offer.

    Parameters

    • id: string = ''

      Identifier of the offer to return

    Returns undefined | Offer

    An Offer or undefined if no match is found

refresh

  • refresh(valid, decorator, eligibilities): void

  • Parameters

    • valid: ValidProduct
    • decorator: ProductDecorator & OfferDecorator
    • eligibilities: IDiscountEligibilities

    Returns void

removeIneligibleDiscounts

  • removeIneligibleDiscounts(eligibilities): void

  • Parameters

    • eligibilities: IDiscountEligibilities

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcountryCodedescriptiongroupidoffersplatformrawtitletypecanPurchaseownedpricinggetOfferrefreshremoveIneligibleDiscounts