Improve in-app purchase for MacOS (#12464)
* Add methods to finish transactions * Add a method to get the product descriptions from the App Store * Improve the documentation of a transaction structure * Add a tutorial for In App Purchase * Fix typo in In-App Purchase tutorial * Fix style of In-App Purchase files * Fix In-App-Purchase product structure conversion in amr64 * Fix code style in In-App Purchase tutorial documentation * Fix typos in In-App Purchase documentation * Fix typo in In-App Purchase spec * Slight style fixes
This commit is contained in:
Adrien Fery
Cheng Zhao
parent
52b1065b3b
commit
5486a65702
13 changed files with 481 additions and 22 deletions
|
|
@ -21,15 +21,24 @@ Returns:
|
|||
|
||||
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`).
|
||||
* `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.
|
||||
* `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.
|
||||
* `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.getProducts(productIDs, callback)`
|
||||
|
||||
* `productIDs` String[] - The identifiers of the products to get.
|
||||
* `callback` Function - The callback called with the products or an empty array if the products don't exist.
|
||||
* `products` Product[] - Array of [`Product`](structures/product) objects
|
||||
|
||||
Retrieves the product descriptions.
|
||||
|
||||
### `inAppPurchase.canMakePayments()`
|
||||
|
||||
Returns `true` if the user can make a payment and `false` otherwise.
|
||||
|
|
@ -37,3 +46,15 @@ Returns `true` if the user can make a payment and `false` otherwise.
|
|||
### `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.
|
||||
|
|
|
|||
10
docs/api/structures/product.md
Normal file
10
docs/api/structures/product.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# Product Object
|
||||
|
||||
* `productIdentifier` String - The string that identifies the product to the Apple App Store.
|
||||
* `localizedDescription` String - A description of the product.
|
||||
* `localizedTitle` String - The name of the product.
|
||||
* `contentVersion` String - A string that identifies the version of the content.
|
||||
* `contentLengths` Number[] - The total size of the content, in bytes.
|
||||
* `price` Number - The cost of the product in the local currency.
|
||||
* `formattedPrice` String - The locale formatted price of the product.
|
||||
* `downloadable` Boolean - A Boolean value that indicates whether the App Store has downloadable content for this product.
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
# Transaction Object
|
||||
|
||||
* `transactionIdentifier` String
|
||||
* `transactionDate` String
|
||||
* `originalTransactionIdentifier` String
|
||||
* `transactionIdentifier` String - A string that uniquely identifies a successful payment transaction.
|
||||
* `transactionDate` String - The date the transaction was added to the App Store’s payment queue.
|
||||
* `originalTransactionIdentifier` String - The identifier of the restored transaction by the App Store.
|
||||
* `transactionState` String - The transaction sate (`"purchasing"`, `"purchased"`, `"failed"`, `"restored"`, or `"deferred"`)
|
||||
* `errorCode` Integer
|
||||
* `errorMessage` String
|
||||
* `errorCode` Integer - The error code if an error occurred while processing the transaction.
|
||||
* `errorMessage` String - The error message if an error occurred while processing the transaction.
|
||||
* `payment` Object
|
||||
* `productIdentifier` String
|
||||
* `quantity` Integer
|
||||
* `productIdentifier` String - The identifier of the purchased product.
|
||||
* `quantity` Integer - The quantity purchased.
|
||||
|
|
|
|||
125
docs/tutorial/in-app-purchases.md
Normal file
125
docs/tutorial/in-app-purchases.md
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
# In-App Purchase (macOS)
|
||||
|
||||
## Preparing
|
||||
|
||||
### Paid Applications Agreement
|
||||
If you haven't already, you’ll need to sign the Paid Applications Agreement and set up your banking and tax information in iTunes Connect.
|
||||
|
||||
[iTunes Connect Developer Help: Agreements, tax, and banking overview](https://help.apple.com/itunes-connect/developer/#/devb6df5ee51)
|
||||
|
||||
### Create Your In-App Purchases
|
||||
Then, you'll need to configure your in-app purchases in iTunes Connect, and include details such as name, pricing, and description that highlights the features and functionality of your in-app purchase.
|
||||
|
||||
[iTunes Connect Developer Help: Create an in-app purchase](https://help.apple.com/itunes-connect/developer/#/devae49fb316)
|
||||
|
||||
|
||||
### Change the CFBundleIdentifier
|
||||
|
||||
To test In-App Purchase in development with Electron you'll have to change the `CFBundleIdentifier` in `node_modules/electron/dist/Electron.app/Contents/Info.plist`. You have to replace `com.github.electron` by the bundle identifier of the application you created with iTunes Connect.
|
||||
|
||||
```xml
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.example.app</string>
|
||||
```
|
||||
|
||||
|
||||
## Code example
|
||||
|
||||
Here is an example that shows how to use In-App Purchases in Electron. You'll have to replace the product ids by the identifiers of the products created with iTunes Connect (the identifier of `com.example.app.product1` is `product1`). Note that you have to listen to the `transactions-updated` event as soon as possible in your app.
|
||||
|
||||
|
||||
```javascript
|
||||
const { inAppPurchase } = require('electron').remote
|
||||
const PRODUCT_IDS = ['id1', 'id2']
|
||||
|
||||
// Listen for transactions as soon as possible.
|
||||
inAppPurchase.on('transactions-updated', (event, transactions) => {
|
||||
if (!Array.isArray(transactions)) {
|
||||
return
|
||||
}
|
||||
|
||||
// Check each transaction.
|
||||
transactions.forEach(function (transaction) {
|
||||
var payment = transaction.payment
|
||||
|
||||
switch (transaction.transactionState) {
|
||||
case 'purchasing':
|
||||
console.log(`Purchasing ${payment.productIdentifier}...`)
|
||||
break
|
||||
case 'purchased':
|
||||
|
||||
console.log(`${payment.productIdentifier} purchased.`)
|
||||
|
||||
// Get the receipt url.
|
||||
let receiptURL = inAppPurchase.getReceiptURL()
|
||||
|
||||
console.log(`Receipt URL: ${receiptURL}`)
|
||||
|
||||
// Submit the receipt file to the server and check if it is valid.
|
||||
// @see https://developer.apple.com/library/content/releasenotes/General/ValidateAppStoreReceipt/Chapters/ValidateRemotely.html
|
||||
// ...
|
||||
// If the receipt is valid, the product is purchased
|
||||
// ...
|
||||
|
||||
// Finish the transaction.
|
||||
inAppPurchase.finishTransactionByDate(transaction.transactionDate)
|
||||
|
||||
break
|
||||
case 'failed':
|
||||
|
||||
console.log(`Failed to purchase ${payment.productIdentifier}.`)
|
||||
|
||||
// Finish the transaction.
|
||||
inAppPurchase.finishTransactionByDate(transaction.transactionDate)
|
||||
|
||||
break
|
||||
case 'restored':
|
||||
|
||||
console.log(`The purchase of ${payment.productIdentifier} has been restored.`)
|
||||
|
||||
break
|
||||
case 'deferred':
|
||||
|
||||
console.log(`The purchase of ${payment.productIdentifier} has been deferred.`)
|
||||
|
||||
break
|
||||
default:
|
||||
break
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
// Check if the user is allowed to make in-app purchase.
|
||||
if (!inAppPurchase.canMakePayments()) {
|
||||
console.log('The user is not allowed to make in-app purchase.')
|
||||
}
|
||||
|
||||
// Retrieve and display the product descriptions.
|
||||
inAppPurchase.getProducts(PRODUCT_IDS, (products) => {
|
||||
// Check the parameters.
|
||||
if (!Array.isArray(products) || products.length <= 0) {
|
||||
console.log('Unable to retrieve the product informations.')
|
||||
return
|
||||
}
|
||||
|
||||
// Display the name and price of each product.
|
||||
products.forEach((product) => {
|
||||
console.log(`The price of ${product.localizedTitle} is ${product.formattedPrice}.`)
|
||||
})
|
||||
|
||||
// Ask the user which product he/she wants to purchase.
|
||||
// ...
|
||||
let selectedProduct = products[0]
|
||||
let selectedQuantity = 1
|
||||
|
||||
// Purchase the selected product.
|
||||
inAppPurchase.purchaseProduct(selectedProduct.productIdentifier, selectedQuantity, (isProductValid) => {
|
||||
if (!isProductValid) {
|
||||
console.log('The product is not valid.')
|
||||
return
|
||||
}
|
||||
|
||||
console.log('The payment has been added to the payment queue.')
|
||||
})
|
||||
})
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue