com.badlogic.gdx.pay.PurchaseObserver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gdx-pay-client Show documentation
Gdx Payment library
There is a newer version: 1.3.7
/*******************************************************************************
 * Copyright 2011 See AUTHORS file.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/

package com.badlogic.gdx.pay;

/**
 * Observer interface to wait for the purchase manager to initialize as well as to handle restored/refunded
 * transactions.
 * Calling thread of callback methods might not be libGDX main loop thread!
 *
 * @author noblemaster
 */
public interface PurchaseObserver {

	/** Called when the purchase manager has successfully initialized.
	 *
	 * The in-app purchase service has been connected, and in-app products have been successfully
	 * retrieved from the in-app payment service. 
	 *
	 * Calling thread might not be Libgdx main loop thread!
	 */
	void handleInstall();

	/** Called when the installation of the purchase manager failed.
	 * 
	 * @param e The error, e.g. network outage, invalid keys, etc.
	 *
	 * Calling thread might not be libGDX main loop thread!
	 */
	void handleInstallError(Throwable e);

	/** Called when purchases have been restored. The "valid" parameter will indicate if the purchase was successful (true) or was
	 * aborted or refunded by the user (false).
	 *
	 * Calling thread might not be libGDX main loop thread!
	 *
	 * @param transactions The restored purchases. */
	void handleRestore(Transaction[] transactions);

	/** Called when a restore failed for unexpected reasons.
	 * 
	 * @param e The error, e.g. network outage, invalid identifier, etc.
	 *
	 * Calling thread might not be libGDX main loop thread!
	 */
	void handleRestoreError(Throwable e);
	
	/** The item that was purchased. The "valid" parameter will indicate if the purchase was successful (true) or was aborted or
	 * refunded by the user (false).
	 * 
	 * @param transaction The purchased item information.
	 * Calling thread might not be libGDX main loop thread!
	 * */
	void handlePurchase(Transaction transaction);

	/** Called when a purchase failed for unexpected reasons.
	 * 
	 * @param e The error, e.g. network outage, invalid identifier, etc.
	 * Calling thread might not be libGDX main loop thread!
	 * */
	void handlePurchaseError(Throwable e);
	
	/** Called when a purchase is canceled by the user.
	 *
	 * Calling thread might not be libGDX main loop thread!
	 */
	void handlePurchaseCanceled();
}