In-App Products Module for iOS

API Docs for: 1.0.2
Show:

Product Class

Module: Readme

Methods

purchase

(
  • [params]
)
Void

Available since 1.0.0

Begins purchase process for provided product

Parameters:

  • [params] Object optional

    An object with the following properties:

    • [applicationPayload] String optional

      An opaque identifier for the user’s account on your system. This is used to help the store detect irregular activity. For example, in a game, it would be unusual for dozens of different iTunes Store accounts making purchases on behalf of the same in-game character. The recommended implementation is to use a one-way hash of the user’s account name to calculate the value for this property. Optional, defaults null.

    • [quantity=1] Number optional

      Number of products to purchase. Optional, defaults to 1.

Returns:

Void:

Properties

description

String read-only

Available since 1.0.0

Product description.

priceAsNumber

Number read-only

Available since 1.0.0

Product price as number.

priceAsString

String read-only

Available since 1.0.0

Product price as string, formatted for correct locale.

priceLocale

String read-only

Available since 1.0.0

The locale used to format the price of the product.

SKU

String read-only

Available since 1.0.0

The product identifier.

title

String read-only

Available since 1.0.0

Product title.