Adrien Fery 6d82966ebe Update inAppPurchase API doc (#12072 )

* Update inAppPurchase API doc

`addTransactionsListener` is no longer supported. Users have to listen for the `transactions-updated` event instead.

* Tweak `transactions-updated` timing description

Make the documentation edit suggested by @felixrieseberg and thumbs-upped by @AdrienFery

2018-03-02 07:25:37 -06:00

1.2 KiB

Raw Blame History

inAppPurchase

In-app purchases on Mac App Store.

Process: Main

Events

The inAppPurchase module emits the following events:

Event: 'transactions-updated'

Emitted when one or more transactions have been updated.

Returns:

event Event
transactions Transaction[] - Array of Transaction objects.

Methods

The inAppPurchase module has the following methods:

`inAppPurchase.purchaseProduct(productID, quantity, callback)`

productID String - The id of the product to purchase. (the id of com.example.app.product1 is product1).
quantity Integer (optional) - The number of items the user wants to purchase.
callback Function (optional) - The callback called when the payment is added to the PaymentQueue.
isProductValid Boolean - Determine if the product is valid and added to the payment queue.

You should listen for the transactions-updated event as soon as possible and certainly before you call purchaseProduct.

`inAppPurchase.canMakePayments()`

Returns true if the user can make a payment and false otherwise.

`inAppPurchase.getReceiptURL()`

Returns String, the path to the receipt.

1.2 KiB Raw Blame History