com.creativemobile.dragracing.payment.google.util

Class IabHelper

java.lang.Object

com.creativemobile.dragracing.payment.google.util.IabHelper

public class IabHelper
extends Object

Provides convenience methods for in-app billing. You can create one instance of this class for your application and use it to process in-app billing operations. It provides synchronous (blocking) and asynchronous (non-blocking) methods for many common in-app billing operations, as well as automatic signature verification. After instantiating, you must perform setup in order to start using the object. To perform setup, call the startSetup(com.creativemobile.dragracing.payment.google.util.IabHelper.OnIabSetupFinishedListener) method and provide a listener; that listener will be notified when setup is complete, after which (and not before) you may call other methods. After setup is complete, you will typically want to request an inventory of owned items and subscriptions. See queryInventory(boolean, java.util.List<java.lang.String>), queryInventoryAsync(boolean, java.util.List<java.lang.String>, com.creativemobile.dragracing.payment.google.util.IabHelper.QueryInventoryFinishedListener) and related methods. When you are done with this object, don't forget to call dispose() to ensure proper cleanup. This object holds a binding to the in-app billing service, which will leak unless you dispose of it correctly. If you created the object on an Activity's onCreate method, then the recommended place to dispose of it is the Activity's onDestroy method. A note about threading: When using this object from a background thread, you may call the blocking versions of methods; when using from a UI thread, call only the asynchronous versions and handle the results via callbacks. Also, notice that you can only call one asynchronous operation at a time; attempting to start a second asynchronous operation while the first one has not yet completed will result in an exception being thrown.

Author:

Bruno Oliveira (Google)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IabHelper.OnConsumeFinishedListener Callback that notifies when a consumption operation finishes.
static interface	IabHelper.OnConsumeMultiFinishedListener Callback that notifies when a multi-item consumption operation finishes.
static interface	IabHelper.OnIabPurchaseFinishedListener Callback that notifies when a purchase is finished.
static interface	IabHelper.OnIabSetupFinishedListener Callback for setup process.
static interface	IabHelper.QueryInventoryFinishedListener Listener that notifies when an inventory query operation completes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BILLING_RESPONSE_RESULT_BILLING_UNAVAILABLE
static int	BILLING_RESPONSE_RESULT_DEVELOPER_ERROR
static int	BILLING_RESPONSE_RESULT_ERROR
static int	BILLING_RESPONSE_RESULT_ITEM_ALREADY_OWNED
static int	BILLING_RESPONSE_RESULT_ITEM_NOT_OWNED
static int	BILLING_RESPONSE_RESULT_ITEM_UNAVAILABLE
static int	BILLING_RESPONSE_RESULT_OK
static int	BILLING_RESPONSE_RESULT_USER_CANCELED
static String	GET_SKU_DETAILS_ITEM_LIST
static String	GET_SKU_DETAILS_ITEM_TYPE_LIST
static int	IABHELPER_BAD_RESPONSE
static int	IABHELPER_ERROR_BASE
static int	IABHELPER_INVALID_CONSUMPTION
static int	IABHELPER_MISSING_TOKEN
static int	IABHELPER_REMOTE_EXCEPTION
static int	IABHELPER_SEND_INTENT_FAILED
static int	IABHELPER_SUBSCRIPTIONS_NOT_AVAILABLE
static int	IABHELPER_UNKNOWN_ERROR
static int	IABHELPER_UNKNOWN_PURCHASE_RESPONSE
static int	IABHELPER_USER_CANCELLED
static int	IABHELPER_VERIFICATION_FAILED
static String	INAPP_CONTINUATION_TOKEN
static String	ITEM_TYPE_INAPP
static String	ITEM_TYPE_SUBS
static String	RESPONSE_BUY_INTENT
static String	RESPONSE_CODE
static String	RESPONSE_GET_SKU_DETAILS_LIST
static String	RESPONSE_INAPP_ITEM_LIST
static String	RESPONSE_INAPP_PURCHASE_DATA
static String	RESPONSE_INAPP_PURCHASE_DATA_LIST
static String	RESPONSE_INAPP_SIGNATURE
static String	RESPONSE_INAPP_SIGNATURE_LIST

Constructor Summary

Constructors

Constructor and Description
IabHelper(android.content.Context ctx, String base64PublicKey) Creates an instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	consumeAsync(List<Purchase> purchases, IabHelper.OnConsumeMultiFinishedListener listener) Same as consumeAsync, but for multiple items at once.
void	consumeAsync(Purchase purchase, IabHelper.OnConsumeFinishedListener listener) Asynchronous wrapper to item consumption.
void	dispose() Dispose of object, releasing resources.
void	enableDebugLogging(boolean enable)
void	enableDebugLogging(boolean enable, String tag) Enables or disable debug logging through LogCat.
static String	getResponseDesc(int code) Returns a human-readable description for the given response code.
boolean	handleActivityResult(int requestCode, int resultCode, android.content.Intent data) Handles an activity result that's part of the purchase flow in in-app billing.
void	launchPurchaseFlow(android.app.Activity act, String sku, int requestCode, IabHelper.OnIabPurchaseFinishedListener listener)
void	launchPurchaseFlow(android.app.Activity act, String sku, int requestCode, IabHelper.OnIabPurchaseFinishedListener listener, String extraData)
void	launchPurchaseFlow(android.app.Activity act, String sku, String itemType, int requestCode, IabHelper.OnIabPurchaseFinishedListener listener, String extraData) Initiate the UI flow for an in-app purchase.
void	launchSubscriptionPurchaseFlow(android.app.Activity act, String sku, int requestCode, IabHelper.OnIabPurchaseFinishedListener listener)
void	launchSubscriptionPurchaseFlow(android.app.Activity act, String sku, int requestCode, IabHelper.OnIabPurchaseFinishedListener listener, String extraData)
Inventory	queryInventory(boolean querySkuDetails, List<String> moreSkus)
Inventory	queryInventory(boolean querySkuDetails, List<String> moreItemSkus, List<String> moreSubsSkus) Queries the inventory.
void	queryInventoryAsync(boolean querySkuDetails, IabHelper.QueryInventoryFinishedListener listener)
void	queryInventoryAsync(boolean querySkuDetails, List<String> moreSkus, IabHelper.QueryInventoryFinishedListener listener) Asynchronous wrapper for inventory query.
void	queryInventoryAsync(IabHelper.QueryInventoryFinishedListener listener)
void	startSetup(IabHelper.OnIabSetupFinishedListener listener) Starts the setup process.
boolean	subscriptionsSupported() Returns whether subscriptions are supported.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BILLING_RESPONSE_RESULT_OK

public static final int BILLING_RESPONSE_RESULT_OK

See Also:

Constant Field Values

BILLING_RESPONSE_RESULT_USER_CANCELED

public static final int BILLING_RESPONSE_RESULT_USER_CANCELED

See Also:

Constant Field Values

BILLING_RESPONSE_RESULT_BILLING_UNAVAILABLE

public static final int BILLING_RESPONSE_RESULT_BILLING_UNAVAILABLE

See Also:

Constant Field Values

BILLING_RESPONSE_RESULT_ITEM_UNAVAILABLE

public static final int BILLING_RESPONSE_RESULT_ITEM_UNAVAILABLE

See Also:

Constant Field Values

BILLING_RESPONSE_RESULT_DEVELOPER_ERROR

public static final int BILLING_RESPONSE_RESULT_DEVELOPER_ERROR

See Also:

Constant Field Values

BILLING_RESPONSE_RESULT_ERROR

public static final int BILLING_RESPONSE_RESULT_ERROR

See Also:

Constant Field Values

BILLING_RESPONSE_RESULT_ITEM_ALREADY_OWNED

public static final int BILLING_RESPONSE_RESULT_ITEM_ALREADY_OWNED

See Also:

Constant Field Values

BILLING_RESPONSE_RESULT_ITEM_NOT_OWNED

public static final int BILLING_RESPONSE_RESULT_ITEM_NOT_OWNED

See Also:

Constant Field Values

IABHELPER_ERROR_BASE

public static final int IABHELPER_ERROR_BASE

See Also:

Constant Field Values

IABHELPER_REMOTE_EXCEPTION

public static final int IABHELPER_REMOTE_EXCEPTION

See Also:

Constant Field Values

IABHELPER_BAD_RESPONSE

public static final int IABHELPER_BAD_RESPONSE

See Also:

Constant Field Values

IABHELPER_VERIFICATION_FAILED

public static final int IABHELPER_VERIFICATION_FAILED

See Also:

Constant Field Values

IABHELPER_SEND_INTENT_FAILED

public static final int IABHELPER_SEND_INTENT_FAILED

See Also:

Constant Field Values

IABHELPER_USER_CANCELLED

public static final int IABHELPER_USER_CANCELLED

See Also:

Constant Field Values

IABHELPER_UNKNOWN_PURCHASE_RESPONSE

public static final int IABHELPER_UNKNOWN_PURCHASE_RESPONSE

See Also:

Constant Field Values

IABHELPER_MISSING_TOKEN

public static final int IABHELPER_MISSING_TOKEN

See Also:

Constant Field Values

IABHELPER_UNKNOWN_ERROR

public static final int IABHELPER_UNKNOWN_ERROR

See Also:

Constant Field Values

IABHELPER_SUBSCRIPTIONS_NOT_AVAILABLE

public static final int IABHELPER_SUBSCRIPTIONS_NOT_AVAILABLE

See Also:

Constant Field Values

IABHELPER_INVALID_CONSUMPTION

public static final int IABHELPER_INVALID_CONSUMPTION

See Also:

Constant Field Values

RESPONSE_CODE

public static final String RESPONSE_CODE

See Also:

Constant Field Values

RESPONSE_GET_SKU_DETAILS_LIST

public static final String RESPONSE_GET_SKU_DETAILS_LIST

See Also:

Constant Field Values

RESPONSE_BUY_INTENT

public static final String RESPONSE_BUY_INTENT

See Also:

Constant Field Values

RESPONSE_INAPP_PURCHASE_DATA

public static final String RESPONSE_INAPP_PURCHASE_DATA

See Also:

Constant Field Values

RESPONSE_INAPP_SIGNATURE

public static final String RESPONSE_INAPP_SIGNATURE

See Also:

Constant Field Values

RESPONSE_INAPP_ITEM_LIST

public static final String RESPONSE_INAPP_ITEM_LIST

See Also:

Constant Field Values

RESPONSE_INAPP_PURCHASE_DATA_LIST

public static final String RESPONSE_INAPP_PURCHASE_DATA_LIST

See Also:

Constant Field Values

RESPONSE_INAPP_SIGNATURE_LIST

public static final String RESPONSE_INAPP_SIGNATURE_LIST

See Also:

Constant Field Values

INAPP_CONTINUATION_TOKEN

public static final String INAPP_CONTINUATION_TOKEN

See Also:

Constant Field Values

ITEM_TYPE_INAPP

public static final String ITEM_TYPE_INAPP

See Also:

Constant Field Values

ITEM_TYPE_SUBS

public static final String ITEM_TYPE_SUBS

See Also:

Constant Field Values

GET_SKU_DETAILS_ITEM_LIST

public static final String GET_SKU_DETAILS_ITEM_LIST

See Also:

Constant Field Values

GET_SKU_DETAILS_ITEM_TYPE_LIST

public static final String GET_SKU_DETAILS_ITEM_TYPE_LIST

See Also:

Constant Field Values

Constructor Detail

IabHelper

public IabHelper(android.content.Context ctx,
         String base64PublicKey)

Creates an instance. After creation, it will not yet be ready to use. You must perform setup by calling startSetup(com.creativemobile.dragracing.payment.google.util.IabHelper.OnIabSetupFinishedListener) and wait for setup to complete. This constructor does not block and is safe to call from a UI thread.

Parameters:

ctx - Your application or Activity context. Needed to bind to the in-app billing service.

base64PublicKey - Your application's public key, encoded in base64. This is used for verification of purchase signatures. You can find your app's base64-encoded public key in your application's page on Google Play Developer Console. Note that this is NOT your "developer public key".

Method Detail

enableDebugLogging

public void enableDebugLogging(boolean enable,
                      String tag)

Enables or disable debug logging through LogCat.

enableDebugLogging

public void enableDebugLogging(boolean enable)

startSetup

public void startSetup(IabHelper.OnIabSetupFinishedListener listener)

Starts the setup process. This will start up the setup process asynchronously. You will be notified through the listener when the setup process is complete. This method is safe to call from a UI thread.

Parameters:

listener - The listener to notify when the setup process is complete.

dispose

public void dispose()

Dispose of object, releasing resources. It's very important to call this method when you are done with this object. It will release any resources used by it such as service connections. Naturally, once the object is disposed of, it can't be used again.

subscriptionsSupported

public boolean subscriptionsSupported()

Returns whether subscriptions are supported.

launchPurchaseFlow

public void launchPurchaseFlow(android.app.Activity act,
                      String sku,
                      int requestCode,
                      IabHelper.OnIabPurchaseFinishedListener listener)

launchPurchaseFlow

public void launchPurchaseFlow(android.app.Activity act,
                      String sku,
                      int requestCode,
                      IabHelper.OnIabPurchaseFinishedListener listener,
                      String extraData)

launchSubscriptionPurchaseFlow

public void launchSubscriptionPurchaseFlow(android.app.Activity act,
                                  String sku,
                                  int requestCode,
                                  IabHelper.OnIabPurchaseFinishedListener listener)

launchSubscriptionPurchaseFlow

public void launchSubscriptionPurchaseFlow(android.app.Activity act,
                                  String sku,
                                  int requestCode,
                                  IabHelper.OnIabPurchaseFinishedListener listener,
                                  String extraData)

launchPurchaseFlow

public void launchPurchaseFlow(android.app.Activity act,
                      String sku,
                      String itemType,
                      int requestCode,
                      IabHelper.OnIabPurchaseFinishedListener listener,
                      String extraData)

Initiate the UI flow for an in-app purchase. Call this method to initiate an in-app purchase, which will involve bringing up the Google Play screen. The calling activity will be paused while the user interacts with Google Play, and the result will be delivered via the activity's Activity.onActivityResult(int, int, android.content.Intent) method, at which point you must call this object's handleActivityResult(int, int, android.content.Intent) method to continue the purchase flow. This method MUST be called from the UI thread of the Activity.

Parameters:

act - The calling activity.

sku - The sku of the item to purchase.

itemType - indicates if it's a product or a subscription (ITEM_TYPE_INAPP or ITEM_TYPE_SUBS)

requestCode - A request code (to differentiate from other responses -- as in Activity.startActivityForResult(android.content.Intent, int)).

listener - The listener to notify when the purchase process finishes

extraData - Extra data (developer payload), which will be returned with the purchase data when the purchase completes. This extra data will be permanently bound to that purchase and will always be returned when the purchase is queried.

handleActivityResult

public boolean handleActivityResult(int requestCode,
                           int resultCode,
                           android.content.Intent data)

Handles an activity result that's part of the purchase flow in in-app billing. If you are calling launchPurchaseFlow(android.app.Activity, java.lang.String, int, com.creativemobile.dragracing.payment.google.util.IabHelper.OnIabPurchaseFinishedListener), then you must call this method from your Activity's android.app.Activity@onActivityResult method. This method MUST be called from the UI thread of the Activity.

Parameters:

requestCode - The requestCode as you received it.

resultCode - The resultCode as you received it.

data - The data (Intent) as you received it.

Returns:

Returns true if the result was related to a purchase flow and was handled; false if the result was not related to a purchase, in which case you should handle it normally.

queryInventory

public Inventory queryInventory(boolean querySkuDetails,
                       List<String> moreSkus)
                         throws IabException

Throws:

IabException

queryInventory

public Inventory queryInventory(boolean querySkuDetails,
                       List<String> moreItemSkus,
                       List<String> moreSubsSkus)
                         throws IabException

Queries the inventory. This will query all owned items from the server, as well as information on additional skus, if specified. This method may block or take long to execute. Do not call from a UI thread. For that, use the non-blocking version #refreshInventoryAsync.

Parameters:

querySkuDetails - if true, SKU details (price, description, etc) will be queried as well as purchase information.

moreItemSkus - additional PRODUCT skus to query information on, regardless of ownership. Ignored if null or if querySkuDetails is false.

moreSubsSkus - additional SUBSCRIPTIONS skus to query information on, regardless of ownership. Ignored if null or if querySkuDetails is false.

Throws:

IabException - if a problem occurs while refreshing the inventory.

queryInventoryAsync

public void queryInventoryAsync(boolean querySkuDetails,
                       List<String> moreSkus,
                       IabHelper.QueryInventoryFinishedListener listener)

Asynchronous wrapper for inventory query. This will perform an inventory query as described in queryInventory(boolean, java.util.List<java.lang.String>), but will do so asynchronously and call back the specified listener upon completion. This method is safe to call from a UI thread.

Parameters:

querySkuDetails - as in queryInventory(boolean, java.util.List<java.lang.String>)

moreSkus - as in queryInventory(boolean, java.util.List<java.lang.String>)

listener - The listener to notify when the refresh operation completes.

queryInventoryAsync

public void queryInventoryAsync(IabHelper.QueryInventoryFinishedListener listener)

queryInventoryAsync

public void queryInventoryAsync(boolean querySkuDetails,
                       IabHelper.QueryInventoryFinishedListener listener)

consumeAsync

public void consumeAsync(Purchase purchase,
                IabHelper.OnConsumeFinishedListener listener)

Asynchronous wrapper to item consumption. Works like consume(com.creativemobile.dragracing.payment.google.util.Purchase), but performs the consumption in the background and notifies completion through the provided listener. This method is safe to call from a UI thread.

Parameters:

purchase - The purchase to be consumed.

listener - The listener to notify when the consumption operation finishes.

consumeAsync

public void consumeAsync(List<Purchase> purchases,
                IabHelper.OnConsumeMultiFinishedListener listener)

Same as consumeAsync, but for multiple items at once.

Parameters:

purchases - The list of PurchaseInfo objects representing the purchases to consume.

listener - The listener to notify when the consumption operation finishes.

getResponseDesc

public static String getResponseDesc(int code)

Returns a human-readable description for the given response code.

Parameters:

code - The response code

Returns:

A human-readable string explaining the result code. It also includes the result code numerically.