Difference between revisions of "GoogleBilling"

From GiderosMobile
Line 3: Line 3:
 
'''Available since:''' Gideros 2012.09<br/>
 
'''Available since:''' Gideros 2012.09<br/>
 
=== Description ===
 
=== Description ===
<br />
+
<translate><br />
The `GoogleBilling` class is defined in the module &quot;googlebilling&quot;. Therefore, you need to call<br />
+
The [[[GoogleBilling]]] class is defined in the module &quot;googlebilling&quot;. Therefore, you need to call<br />
`require(&quot;googlebilling&quot;)` before using it. Loading the Google Billing module <br />
+
[[[require(&quot;googlebilling&quot;)]]] before using it. Loading the Google Billing module <br />
also creates a global variable `googlebilling` of type `GoogleBilling` for direct use. <br />
+
also creates a global variable [[[googlebilling` of type `GoogleBilling]]] for direct use. <br />
 
  <br />
 
  <br />
 
&lt;h3&gt;GoogleBilling Events and Response Codes&lt;/h3&gt;<br />
 
&lt;h3&gt;GoogleBilling Events and Response Codes&lt;/h3&gt;<br />
 
<br />
 
<br />
`GoogleBilling` class dispatches 5 events: `Event.CHECK_BILLING_SUPPORTED_COMPLETE`,<br />
+
[[[GoogleBilling` class dispatches 5 events: `Event.CHECK_BILLING_SUPPORTED_COMPLETE]]],<br />
`Event.REQUEST_PURCHASE_COMPLETE`,`Event.RESTORE_TRANSACTIONS_COMPLETE`,<br />
+
[[[Event.REQUEST_PURCHASE_COMPLETE`,`Event.RESTORE_TRANSACTIONS_COMPLETE]]],<br />
`Event.CONFIRM_NOTIFICATION_COMPLETE` and `Event.PURCHASE_STATE_CHANGE`.<br />
+
[[[Event.CONFIRM_NOTIFICATION_COMPLETE` and `Event.PURCHASE_STATE_CHANGE]]].<br />
 
<br />
 
<br />
`Event.*_COMPLETE` events contains a field `event.responseCode` which provides status information <br />
+
[[[Event.*_COMPLETE` events contains a field `event.responseCode]]] which provides status information <br />
 
and error information about a request. Response code can be one of these values:<br />
 
and error information about a request. Response code can be one of these values:<br />
 
<br />
 
<br />
 
&lt;ul&gt;<br />
 
&lt;ul&gt;<br />
&lt;li&gt;`GoogleBilling.OK`: Indicates that the request was sent to the server successfully. When this code is returned&lt;/li&gt;<br />
+
&lt;li&gt;[[[GoogleBilling.OK]]]: Indicates that the request was sent to the server successfully. When this code is returned&lt;/li&gt;<br />
 
&lt;/ul&gt;<br />
 
&lt;/ul&gt;<br />
in response to a `checkBillingSupported` function, indicates that billing is supported.<br />
+
in response to a [[[checkBillingSupported]]] function, indicates that billing is supported.<br />
 
&lt;ul&gt;<br />
 
&lt;ul&gt;<br />
&lt;li&gt;`GoogleBilling.USER_CANCELED`: Indicates that the user pressed the back button on the checkout page instead of buying the item.&lt;/li&gt;<br />
+
&lt;li&gt;[[[GoogleBilling.USER_CANCELED]]]: Indicates that the user pressed the back button on the checkout page instead of buying the item.&lt;/li&gt;<br />
&lt;li&gt;`GoogleBilling.SERVICE_UNAVAILABLE`: Indicates that the network connection is down.&lt;/li&gt;<br />
+
&lt;li&gt;[[[GoogleBilling.SERVICE_UNAVAILABLE]]]: Indicates that the network connection is down.&lt;/li&gt;<br />
&lt;li&gt;`GoogleBilling.BILLING_UNAVAILABLE`: Indicates that in-app billing is not available because the API version that&lt;/li&gt;<br />
+
&lt;li&gt;[[[GoogleBilling.BILLING_UNAVAILABLE]]]: Indicates that in-app billing is not available because the API version that&lt;/li&gt;<br />
 
&lt;/ul&gt;<br />
 
&lt;/ul&gt;<br />
 
you specified is not recognized by the Google Play application or the user is ineligible for in-app billing <br />
 
you specified is not recognized by the Google Play application or the user is ineligible for in-app billing <br />
 
(for example, the user resides in a country that prohibits in-app purchases).<br />
 
(for example, the user resides in a country that prohibits in-app purchases).<br />
 
&lt;ul&gt;<br />
 
&lt;ul&gt;<br />
&lt;li&gt;`GoogleBilling.ITEM_UNAVAILABLE`: Indicates that Google Play cannot find the requested item in the application&#039;s product list.&lt;/li&gt;<br />
+
&lt;li&gt;[[[GoogleBilling.ITEM_UNAVAILABLE]]]: Indicates that Google Play cannot find the requested item in the application&#039;s product list.&lt;/li&gt;<br />
 
&lt;/ul&gt;<br />
 
&lt;/ul&gt;<br />
This can happen if the product ID is misspelled in your `requestPurchase` function or if an item is unpublished in the application&#039;s product list.<br />
+
This can happen if the product ID is misspelled in your [[[requestPurchase]]] function or if an item is unpublished in the application&#039;s product list.<br />
 
&lt;ul&gt;<br />
 
&lt;ul&gt;<br />
&lt;li&gt;`GoogleBilling.DEVELOPER_ERROR`: Indicates that an application is trying to make an in-app billing request but the application has not declared the&lt;/li&gt;<br />
+
&lt;li&gt;[[[GoogleBilling.DEVELOPER_ERROR]]]: Indicates that an application is trying to make an in-app billing request but the application has not declared the&lt;/li&gt;<br />
 
&lt;/ul&gt;<br />
 
&lt;/ul&gt;<br />
 
com.android.vending.BILLING permission in its manifest. Can also indicate that an application is not properly signed, <br />
 
com.android.vending.BILLING permission in its manifest. Can also indicate that an application is not properly signed, <br />
 
or that you sent a malformed request, such as a request with missing Bundle keys or a request that uses an unrecognized request type.<br />
 
or that you sent a malformed request, such as a request with missing Bundle keys or a request that uses an unrecognized request type.<br />
 
&lt;ul&gt;<br />
 
&lt;ul&gt;<br />
&lt;li&gt;`GoogleBilling.ERROR`: Indicates an unexpected server error. For example, this error is triggered if you try to purchase an item from yourself, which is not allowed by Google Wallet.&lt;/li&gt;<br />
+
&lt;li&gt;[[[GoogleBilling.ERROR]]]: Indicates an unexpected server error. For example, this error is triggered if you try to purchase an item from yourself, which is not allowed by Google Wallet.&lt;/li&gt;<br />
 
&lt;/ul&gt;<br />
 
&lt;/ul&gt;<br />
 
<br />
 
<br />
 
&lt;h3&gt;# Event.CHECK_BILLING_SUPPORTED_COMPLETE&lt;/h3&gt;<br />
 
&lt;h3&gt;# Event.CHECK_BILLING_SUPPORTED_COMPLETE&lt;/h3&gt;<br />
Dispatched when `checkBillingSuported` function completes. It contains `event.responseCode` and `event.productType` fields.<br />
+
Dispatched when [[[checkBillingSuported` function completes. It contains `event.responseCode` and `event.productType]]] fields.<br />
 
<br />
 
<br />
 
&lt;h3&gt;# Event.REQUEST_PURCHASE_COMPLETE&lt;/h3&gt;<br />
 
&lt;h3&gt;# Event.REQUEST_PURCHASE_COMPLETE&lt;/h3&gt;<br />
Dispatched when `requestPurchase` function completes. It contains `event.responseCode`, `event.productId`, `event.productType` and `event.developerPayload` fields.<br />
+
Dispatched when [[[requestPurchase` function completes. It contains `event.responseCode`, `event.productId`, `event.productType` and `event.developerPayload]]] fields.<br />
 
<br />
 
<br />
 
&lt;h3&gt;# Event.RESTORE_TRANSACTIONS_COMPLETE&lt;/h3&gt;<br />
 
&lt;h3&gt;# Event.RESTORE_TRANSACTIONS_COMPLETE&lt;/h3&gt;<br />
Dispatched when `restoreTransactions` function completes. It contains `event.responseCode` fields.<br />
+
Dispatched when [[[restoreTransactions` function completes. It contains `event.responseCode]]] fields.<br />
 
<br />
 
<br />
 
&lt;h3&gt;# Event.CONFIRM_NOTIFICATION_COMPLETE&lt;/h3&gt;<br />
 
&lt;h3&gt;# Event.CONFIRM_NOTIFICATION_COMPLETE&lt;/h3&gt;<br />
Dispatched when `confirmNotification` function completes. It contains `event.responseCode` and `event.notificationId` fields.<br />
+
Dispatched when [[[confirmNotification` function completes. It contains `event.responseCode` and `event.notificationId]]] fields.<br />
 
<br />
 
<br />
 
&lt;h3&gt;# Event.PURCHASE_STATE_CHANGE&lt;/h3&gt;<br />
 
&lt;h3&gt;# Event.PURCHASE_STATE_CHANGE&lt;/h3&gt;<br />
Dispatched when information about a transaction is received. It contains `event.purchaseState`, `event.productId`, `event.notificationId`, `event.purchaseTime` and `event.developerPayload` fields.<br />
+
Dispatched when information about a transaction is received. It contains [[[event.purchaseState`, `event.productId`, `event.notificationId`, `event.purchaseTime` and `event.developerPayload]]] fields.<br />
<br />
+
<br /></translate>
 
{|-
 
{|-
 
| style="width: 50%;"|
 
| style="width: 50%;"|

Revision as of 13:33, 23 August 2018

Supported platforms: android
Available since: Gideros 2012.09

Description


The [[[GoogleBilling]]] class is defined in the module "googlebilling". Therefore, you need to call
[[[require("googlebilling")]]] before using it. Loading the Google Billing module
also creates a global variable [[[googlebilling` of type `GoogleBilling]]] for direct use.


<h3>GoogleBilling Events and Response Codes</h3>

[[[GoogleBilling` class dispatches 5 events: `Event.CHECK_BILLING_SUPPORTED_COMPLETE]]],
[[[Event.REQUEST_PURCHASE_COMPLETE`,`Event.RESTORE_TRANSACTIONS_COMPLETE]]],
[[[Event.CONFIRM_NOTIFICATION_COMPLETE` and `Event.PURCHASE_STATE_CHANGE]]].

[[[Event.*_COMPLETE` events contains a field `event.responseCode]]] which provides status information
and error information about a request. Response code can be one of these values:

<ul>
<li>[[[GoogleBilling.OK]]]: Indicates that the request was sent to the server successfully. When this code is returned</li>
</ul>
in response to a [[[checkBillingSupported]]] function, indicates that billing is supported.
<ul>
<li>[[[GoogleBilling.USER_CANCELED]]]: Indicates that the user pressed the back button on the checkout page instead of buying the item.</li>
<li>[[[GoogleBilling.SERVICE_UNAVAILABLE]]]: Indicates that the network connection is down.</li>
<li>[[[GoogleBilling.BILLING_UNAVAILABLE]]]: Indicates that in-app billing is not available because the API version that</li>
</ul>
you specified is not recognized by the Google Play application or the user is ineligible for in-app billing
(for example, the user resides in a country that prohibits in-app purchases).
<ul>
<li>[[[GoogleBilling.ITEM_UNAVAILABLE]]]: Indicates that Google Play cannot find the requested item in the application's product list.</li>
</ul>
This can happen if the product ID is misspelled in your [[[requestPurchase]]] function or if an item is unpublished in the application's product list.
<ul>
<li>[[[GoogleBilling.DEVELOPER_ERROR]]]: Indicates that an application is trying to make an in-app billing request but the application has not declared the</li>
</ul>
com.android.vending.BILLING permission in its manifest. Can also indicate that an application is not properly signed,
or that you sent a malformed request, such as a request with missing Bundle keys or a request that uses an unrecognized request type.
<ul>
<li>[[[GoogleBilling.ERROR]]]: Indicates an unexpected server error. For example, this error is triggered if you try to purchase an item from yourself, which is not allowed by Google Wallet.</li>
</ul>

<h3># Event.CHECK_BILLING_SUPPORTED_COMPLETE</h3>
Dispatched when [[[checkBillingSuported` function completes. It contains `event.responseCode` and `event.productType]]] fields.

<h3># Event.REQUEST_PURCHASE_COMPLETE</h3>
Dispatched when [[[requestPurchase` function completes. It contains `event.responseCode`, `event.productId`, `event.productType` and `event.developerPayload]]] fields.

<h3># Event.RESTORE_TRANSACTIONS_COMPLETE</h3>
Dispatched when [[[restoreTransactions` function completes. It contains `event.responseCode]]] fields.

<h3># Event.CONFIRM_NOTIFICATION_COMPLETE</h3>
Dispatched when [[[confirmNotification` function completes. It contains `event.responseCode` and `event.notificationId]]] fields.

<h3># Event.PURCHASE_STATE_CHANGE</h3>
Dispatched when information about a transaction is received. It contains [[[event.purchaseState`, `event.productId`, `event.notificationId`, `event.purchaseTime` and `event.developerPayload]]] fields.

Methods

GoogleBilling:checkBillingSupported -
GoogleBilling:confirmNotification -
GoogleBilling:requestPurchase -
GoogleBilling:restoreTransactions -
GoogleBilling:setApiVersion -
GoogleBilling:setPublicKey -

Events

Event.CHECK_BILLING_SUPPORTED_COMPLETE
Event.CONFIRM_NOTIFICATION_COMPLETE
Event.PURCHASE_STATE_CHANGE
Event.REQUEST_PURCHASE_COMPLETE
Event.RESTORE_TRANSACTIONS_COMPLETE

Constants

GoogleBilling.BILLING_UNAVAILABLE
GoogleBilling.CANCELED
GoogleBilling.DEVELOPER_ERROR
GoogleBilling.ERROR
GoogleBilling.EXPIRED
GoogleBilling.INAPP
GoogleBilling.ITEM_UNAVAILABLE
GoogleBilling.OK
GoogleBilling.PURCHASED
GoogleBilling.REFUNDED
GoogleBilling.SERVICE_UNAVAILABLE
GoogleBilling.SUBS
GoogleBilling.USER_CANCELED