-
Notifications
You must be signed in to change notification settings - Fork 3
module InAppBilling.API
- Source:
-
invalid purchase id passed
- Source:
-
Buy or subscribe to an item. The product should be loaded before this call. You can either load items at
initor by callingloadProductDetails.Name Type Description successbuySuccessCallback the callback for successful purchse
failerrorCallback the callback for failed purchase
productIdstring the product's ID to be bought
- Source:
-
Buys an item. The product should be loaded before this call. You can either load items at
initor by callingloadProductDetails.Name Type Description successbuySuccessCallback the callback for successful purchse
failerrorCallback the callback for failed purchase
productIdstring the product's ID to be bought
- Source:
-
Consume an item. The product should be of consumable type.
Name Type Description successconsumeProductSuccessCallback callback for successful consumption
failtype callback for failed consumption
productIdtype 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
initor by callingloadProductDetails.Name Type Description successgetLoadedProductsSuccessCallback callback for successful query
failerrorCallback callback for failed query
- 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
This is best practice to always look at this list on startup to activate products in your application.
Name Type Description successgetPurchasesSuccessCallback failerrorCallback - Source:
-
This will return the already boutgh items. The consumed items will not be on this list, nor can be retrieved with any other method.
Name Type Description successgetPurchasesSuccessCallback failerrorCallback - Source:
-
This will return a verification payload for one purchase. Depending on the platform it means either the
purchaseTokenor the applicationreceipton PlayStore and iTunes respectively.Name Type Description successtype failtype purchaseIdtype - 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 successinitSuccessCallback the success callback
failerrorCallback the failure callback
optionsObject options for configuring the plugin
Name Type Argument Description showLogBoolean <optional>
[true] wether to show logs or not, this is strongly recommended to be set to false for production
productIdsObject an optional list of product IDs to load after initialization was successful
- 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 successinitSuccessCallback the success callback
failerrorCallback the failure callback
optionsObject options for configuring the plugin
Name Type Argument Description showLogBoolean <optional>
[true] wether to show logs or not, this is strongly recommended to be set to false for production
productIdsObject 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 from the requested list. Will not return the items which have been loaded before. Use
getLoadedProductsto get the complete list of all products loaded ever.Name Type Description successloadProductDetailsSuccessCallback callback for successful query
failerrorCallback callback for failed query
productIdsString | Array.<String> - Source:
-
Get details for a list of product ids. This will also load the products' details if they are not already loaded.
Name Type Description successloadProductDetailsSuccessCallback callback for successful query
failerrorCallback callback for failed query
productIdsString | Array.<String> - Source:
-
This function accepts and outputs all the logs, both from native and from JS this is intended to make the debuging easier, you only need to have access to JS console output.
Name Type Description msgString - Source:
-
This function accepts and outputs all the logs, both from native and from JS this is intended to make the debuging easier, you only need to have access to JS console output.
Name Type Description msgString - Source:
-
Asks store to re-queue previously processed transaction. Use this with caution and don't call it again until you get the callback either on success or on failure.
This is only available on iOS and is a must to have for approval.
Name Type Description successrestoreSuccessCallback failerrorCallback - Source:
-
Subscribes to an item. The product should be loaded before this call. You can either load items at
initor by callingloadProductDetails.on iOS, subscribing does exactly what buy does!
Name Type Description successbuySuccessCallback callback for successful subscription
failerrorCallback callback for failed subscription
productIdString id of the subscription item
- Source:
- Source:
-
invalid purchase id passed
- Source:
-
Buy or subscribe to an item. The product should be loaded before this call. You can either load items at
initor by callingloadProductDetails.Name Type Description successbuySuccessCallback the callback for successful purchse
failerrorCallback the callback for failed purchase
productIdstring the product's ID to be bought
- Source:
-
Buys an item. The product should be loaded before this call. You can either load items at
initor by callingloadProductDetails.Name Type Description successbuySuccessCallback the callback for successful purchse
failerrorCallback the callback for failed purchase
productIdstring the product's ID to be bought
- Source:
-
Consume an item. The product should be of consumable type.
Name Type Description successconsumeProductSuccessCallback callback for successful consumption
failtype callback for failed consumption
productIdtype 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
initor by callingloadProductDetails.Name Type Description successgetLoadedProductsSuccessCallback callback for successful query
failerrorCallback callback for failed query
- 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
This is best practice to always look at this list on startup to activate products in your application.
Name Type Description successgetPurchasesSuccessCallback failerrorCallback - Source:
-
This will return the already boutgh items. The consumed items will not be on this list, nor can be retrieved with any other method.
Name Type Description successgetPurchasesSuccessCallback failerrorCallback - Source:
-
This will return a verification payload for one purchase. Depending on the platform it means either the
purchaseTokenor the applicationreceipton PlayStore and iTunes respectively.Name Type Description successtype failtype purchaseIdtype - 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 successinitSuccessCallback the success callback
failerrorCallback the failure callback
optionsObject options for configuring the plugin
Name Type Argument Description showLogBoolean <optional>
[true] wether to show logs or not, this is strongly recommended to be set to false for production
productIdsObject an optional list of product IDs to load after initialization was successful
- 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 successinitSuccessCallback the success callback
failerrorCallback the failure callback
optionsObject options for configuring the plugin
Name Type Argument Description showLogBoolean <optional>
[true] wether to show logs or not, this is strongly recommended to be set to false for production
productIdsObject 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 from the requested list. Will not return the items which have been loaded before. Use
getLoadedProductsto get the complete list of all products loaded ever.Name Type Description successloadProductDetailsSuccessCallback callback for successful query
failerrorCallback callback for failed query
productIdsString | Array.<String> - Source:
-
Get details for a list of product ids. This will also load the products' details if they are not already loaded.
Name Type Description successloadProductDetailsSuccessCallback callback for successful query
failerrorCallback callback for failed query
productIdsString | Array.<String> - Source:
-
This function accepts and outputs all the logs, both from native and from JS this is intended to make the debuging easier, you only need to have access to JS console output.
Name Type Description msgString - Source:
-
This function accepts and outputs all the logs, both from native and from JS this is intended to make the debuging easier, you only need to have access to JS console output.
Name Type Description msgString - Source:
-
Asks store to re-queue previously processed transaction. Use this with caution and don't call it again until you get the callback either on success or on failure.
This is only available on iOS and is a must to have for approval.
Name Type Description successrestoreSuccessCallback failerrorCallback - Source:
-
Subscribes to an item. The product should be loaded before this call. You can either load items at
initor by callingloadProductDetails.on iOS, subscribing does exactly what buy does!
Name Type Description successbuySuccessCallback callback for successful subscription
failerrorCallback callback for failed subscription
productIdString id of the subscription item
- 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)