PurchaseClient

public abstract class BillingClient extends Object

java.lang.Object
    ↳ com.gaa.sdk.iap.PurchaseClient

It is a default interface for communication between library and user application codes.

All methods are processed as asynchronous ones and should be called up in the UI thread, and all callbacks are returned to the UI thread.

To set up connection after instantiating this class, call up the startConnection(PurchaseClientStateListener method, and once the setup completes, you could receive notifications through listener.

class YourPurchaseManager implements PurchaseClientStateListener { private PurchaseClient mPurchaseClient; public YourPurchaseManager() { mPurchaseClient = PurchaseClient.newBuilder(activity) .setBase64PublicKey(/* your public key */) .setListener(this) .build(); } ... }

In general, after the setup completes, call up the purchase history check and in-app product details. Refer to queryPurchasesAsync(String, PurchasesListener) and queryProductDetailsAsync(ProductDetailsParams, ProductDetailsListener).

Never forget to call endConnection() when you exit the application after completing all tasks with this object. All the connections with billing modules must be disconnected and resources must be removed. The recommended location is Activity.onDestroy().

To check the detailed logs of library, input android.util.Log.VERBOSE in android.util.Log.VERBOSE and then call them up.

Logger.setLogLevel(int) MUST be removed before launching a release version of an application.

Summary

---

Nested classes
@interface	PurchaseClient.ResponseCode
@interface	PurchaseClient.ProductType
@interface	PurchaseClient.RecurringAction
class	PurchaseClient.Builder It is a builder for easy creation of the PurchaseClient instances.

Public methods

---

newBuilder

@UiThread
public static  newBuilder(Context context)

It generates a builder for creating the PurchaseClient instances.

Parameters:
context	It is used for the connection with billing modules by using applicationContext.
Returns:
PurchaseClient.Builder

startConnection

@UiThread
public abstract void startConnection( listener)

It initiates the PurchaseClient setup process asynchronously.

It receives responses through PurchaseClientStateListener once completed.

Parameters:
listener	It receives a response when the PurchaseClient setup and payment module connection is complete.

endConnection

@UiThread
public abstract void endConnection()

It cuts the connection with billing modules and removes the resources retained by PurchaseClient.

launchUpdateOrInstallFlow

@UiThread
public abstract void launchUpdateOrInstallFlow(Activity activity,  listener)

When PurchaseClient.ResponseCode.RESULT_NEED_UPDATE occurs, the value of IapResult.getResponseCode() should be called for the update or installation of billing modules.

Parameters:
activity	Activity: refer to the activity to understand the update and flow of billing modules.
listener	IapResultListener

launchPurchaseFlow

@UiThread
public abstract  launchPurchaseFlow(Activity activity,  params)

It starts purchasing in-app products.

The purchase screen will be displayed, and the result will be received through PurchasesUpdatedListener, which has been specified when initializing PurchaseClient.

Parameters:
activity	Activity: refer to the activity to understand the billing flow.
params	PurchaseFlowParams
Returns:
IapResult

consumeAsync

@UiThread
public abstract void consumeAsync( params,  listener)

It consumes purchased in-app products.

Consumption is available only for the in-app product you own, and if the in-app has already been consumed, it is required to be purchased again.

When it comes to API v6 and later, if ‘consume’ or ‘acknowledge’ is not made with 3 days after purchase, refund will be made.

Parameters:
params	ConsumeParams
listener	It receives the result of the ConsumeListener consumption work.

acknowledgeAsync

@UiThread
public abstract void acknowledgeAsync( acknowledgeParams,  listener)

It checks purchased in-app products.

Consumption is available only for the in-app product you own, and if the in-app you checked is not consumed, it cannot be purchased again.

It can be applied to both Managed product and Monthly auto-renewal product. In particular, Managed product can be used as ‘Non-renewable’ in which the purchase is acknowledged and then the in-app is consumed after a certain time.

When it comes to API v6 and later, if ‘consume’ or ‘acknowledge’ is not made with 3 days after purchase, refund will be made.

Parameters:
acknowledgeParams	AcknowledgeParams
listener	It receives the result of the AcknowledgeListener check work.

queryPurchasesAsync

@UiThread
public abstract void queryPurchasesAsync(String productType,  listener)

It imports the purchase information of all in-app products purchased on apps.

Parameters:
productType	Specify the type of the PurchaseClient.ProductType in-app.
listener	It receives the result of the PurchasesListener purchase history.

queryProductDetailsAsync

@UiThread
public abstract void queryProductDetailsAsync( params,  listener)

It imports the details of in-app products registered on Developer Center.

Parameters:
params	ProductDetailsParams
listener	It receives the result of the PurchasesListener in-app details.

manageRecurringProductAsync

@UiThread
public abstract void manageRecurringProductAsync( recurringProductParams,  listener)

It changes Monthly auto-renewal product status.

It performs the action either to cancel automatic payment every month or to resume the cancelled automatic payment.

Parameters:
recurringProductParams	RecurringProductParams
listener	It imports the result of the RecurringProductListener Monthly auto-renewal product status change.

launchLoginFlowAsync

@UiThread
public abstract void launchLoginFlowAsync(Activity activity,  listener)

When PurchaseClient.ResponseCode.RESULT_NEED_LOGIN occurs, the value of IapResult.getResponseCode() performs ONE store login.

Parameters:
activity	Activity: refer to the activity to understand ONE store login flow.
listener	IapResultListener

getStoreInfoAsync

@UiThread
public abstract void getStoreInfoAsync( listener)

It imports market identification codes.

This is the value required for using a server to server API.

Parameters:
listener	It receives the StoreInfoListener market identification code.