-
Notifications
You must be signed in to change notification settings - Fork 3
module InAppBilling.API
- Source:
-
invalid product id passed
- Source:
-
invalid purchase id passed
- Source:
-
the prduct to be bought is not loaded
- Source:
-
Buy or subscribe to an item. The product should be loaded before this call. You can either load items at
init
or by callingloadProductDetails
.Name Type Description success
buySuccessCallback the callback for successful purchse
fail
errorCallback the callback for failed purchase
productId
string the product's ID to be bought
- Source:
-
Consume an item. The product should be of consumable type.
Name Type Description success
consumeProductSuccessCallback callback for successful consumption
fail
type callback for failed consumption
productId
type id of the already bought product (not the purchase itself)
- Source:
-
Get all the loaded products. Products should be loaded before this call. You can either load items at
init
or by callingloadProductDetails
.Name Type Description success
getLoadedProductsSuccessCallback callback for successful query
fail
errorCallback callback for failed query
- Source:
-
This will return full data of a purchase including its verification payload. Depending on the platform verification payload means either the
purchaseToken
of one single purchase (on PlayStore) or the applicationreceipt
(on iTunes).The puchase data should have been loaded before this call using
getPurchases
.Name Type Description success
getPurchaseDetailsSuccessCallback fail
errorCallback purchaseId
string - Source:
-
This will return bought products in a chronological order (oldest first) that are not cunsumed or the subscriptions that are not expired. Following items will not appear on this list: - consumable products which has been consumed - products which have been cancelled (as possible in iOS) - subscriptions that are expired
Because of the differences between purchase verification on iOS and android, the verification payload may not be set here. If you need that piece of data reliably on both iOS and andoird, you may ask
getPurchaseDetails
for full data.This is best practice to always look at this list on startup to activate products in your application.
Name Type Description success
getPurchasesSuccessCallback fail
errorCallback - Source:
-
This initiates the plugin, you can optionally pass in one or multiple product IDs for their details to be loaded during initialization.
Name Type Description success
initSuccessCallback the success callback
fail
errorCallback the failure callback
options
Object options for configuring the plugin
Name Type Argument Description showLog
Boolean <optional>
[true] wether to show logs or not, this is strongly recommended to be set to false for production
productIds
Object an optional list of product IDs to load after initialization was successful
- Source:
-
Get details for a list of product ids. This will also load the products' details if they are not already loaded. Will only return the product details for the valid product ids. Will also return the items which have been loaded
Name Type Description success
loadProductDetailsSuccessCallback callback for successful query
fail
errorCallback callback for failed query
productIds
String | Array.<String> - Source:
-
on iOS: Asks store to re-queue previously processed transactions. Use this with caution and don't call it again until you get the callback either on success or on failure.
on Android: This will do the same as
getPurchases
Name Type Description success
restoreSuccessCallback fail
errorCallback - Source:
Generated with wicked.
- Installation
- [Stores setup](Stores setup)
- [Purchase verification](Purchase verification)
- [Testing plugin](Automatic tests)
- [API documentation](API documentation)
- Debugging
- Roadmap
- [Compatibility issues](Compatibility issues)