electron/docs/api/in-app-purchase.md

58 lines
1.6 KiB
Markdown
Raw Normal View History

2018-01-10 08:21:52 +00:00
# inAppPurchase
2017-11-30 13:27:33 +00:00
> In-app purchases on Mac App Store.
Process: [Main](../glossary.md#main-process)
## Events
The `inAppPurchase` module emits the following events:
### Event: 'transactions-updated'
Emitted when one or more transactions have been updated.
Returns:
* `event` Event
2018-04-09 20:58:10 +00:00
* `transactions` Transaction[] - Array of [`Transaction`](structures/transaction.md) objects.
2017-11-30 13:27:33 +00:00
## Methods
2017-11-30 13:27:33 +00:00
The `inAppPurchase` module has the following methods:
### `inAppPurchase.purchaseProduct(productID, quantity)`
* `productID` String - The identifiers of the product to purchase. (The identifier of `com.example.app.product1` is `product1`).
* `quantity` Integer (optional) - The number of items the user wants to purchase.
Returns `Promise<Boolean>` - Returns `true` 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`.
2017-11-30 13:27:33 +00:00
### `inAppPurchase.getProducts(productIDs)`
* `productIDs` String[] - The identifiers of the products to get.
Returns `Promise<Product[]>` - Resolves with an array of [`Product`](structures/product.md) objects.
Retrieves the product descriptions.
2017-11-30 13:27:33 +00:00
### `inAppPurchase.canMakePayments()`
Returns `Boolean`, whether a user can make a payment.
2017-11-30 13:27:33 +00:00
### `inAppPurchase.getReceiptURL()`
Returns `String`, the path to the receipt.
### `inAppPurchase.finishAllTransactions()`
Completes all pending transactions.
### `inAppPurchase.finishTransactionByDate(date)`
* `date` String - The ISO formatted date of the transaction to finish.
Completes the pending transactions corresponding to the date.