Class IAPListener

An invisible GUI component for initializing Unity IAP and processing lifecycle events.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
IAPListener
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Purchasing
Assembly: Unity.Purchasing.Codeless.dll
Syntax
[AddComponentMenu("In-App Purchasing/IAP Listener")]
[HelpURL("https://docs.unity.com/ugs/en-us/manual/iap/manual/overview")]
public class IAPListener : MonoBehaviour

Fields

automaticallyConfirmTransaction

Consume successful purchases immediately.

Declaration
[Tooltip("Automatically confirm the transaction immediately after a successful purchase.")]
public bool automaticallyConfirmTransaction
Field Value
Type Description
bool
See Also

dontDestroyOnLoad

Preserve this GameObject when a new scene is loaded.

Declaration
[Tooltip("Preserve this GameObject when a new scene is loaded.")]
public bool dontDestroyOnLoad
Field Value
Type Description
bool
See Also

onOrderConfirmed

Event fired after updating a confirmed order.

Declaration
[Tooltip("Event fired after updating a confirmed order.")]
public IAPListener.OnOrderConfirmedEvent onOrderConfirmed
Field Value
Type Description
IAPListener.OnOrderConfirmedEvent
See Also

onOrderDeferred

Event fired after deferring to purchase an order.

Declaration
[Tooltip("Event fired after the payment of a purchase was delayed or postponed.")]
public IAPListener.OnOrderDeferredEvent onOrderDeferred
Field Value
Type Description
IAPListener.OnOrderDeferredEvent
See Also

onOrderPending

Event fired after updating a pending order.

Declaration
[Tooltip("Event fired after updating a pending order.")]
public IAPListener.OnOrderPendingEvent onOrderPending
Field Value
Type Description
IAPListener.OnOrderPendingEvent
See Also

onProductsFetchFailed

Event fired after failing to fetch products.

Declaration
[Tooltip("Event fired after failing to fetch products.")]
public IAPListener.OnProductsFetchFailedEvent onProductsFetchFailed
Field Value
Type Description
IAPListener.OnProductsFetchFailedEvent
See Also

onProductsFetched

Event fired after fetching products.

Declaration
[Tooltip("Event fired after fetching products.")]
public IAPListener.OnProductsFetchedEvent onProductsFetched
Field Value
Type Description
IAPListener.OnProductsFetchedEvent
See Also

onProductsFetchedLegacy

Legacy event for fetching products, deprecated in favor of OnProductsFetchedEvent.

Declaration
[Header("Obsolete Events (for backward compatibility only)")]
[FormerlySerializedAs("onProductsFetched")]
[Tooltip("Event fired after a successful fetching the products from the store.")]
[Obsolete]
public IAPListener.OnProductsFetchedLegacyEvent onProductsFetchedLegacy
Field Value
Type Description
IAPListener.OnProductsFetchedLegacyEvent
See Also

onPurchaseCompleteLegacy

Legacy event for purchase completion, deprecated in favor of OnPurchasesFetchedEvent.

Declaration
[FormerlySerializedAs("onPurchaseComplete")]
[Tooltip("Event fired after a successful purchase of this product.")]
[Obsolete]
public IAPListener.OnPurchaseCompletedLegacyEvent onPurchaseCompleteLegacy
Field Value
Type Description
IAPListener.OnPurchaseCompletedLegacyEvent
See Also

onPurchaseDetailedFailedLegacy

Legacy event for detailed purchase failure, deprecated in favor of OnPurchaseFailedEvent.

Declaration
[FormerlySerializedAs("onPurchaseDetailedFailedEvent")]
[Tooltip("Event fired after failing to purchase an order.")]
[Obsolete]
public IAPListener.OnPurchaseDetailedFailedLegacyEvent onPurchaseDetailedFailedLegacy
Field Value
Type Description
IAPListener.OnPurchaseDetailedFailedLegacyEvent
See Also

onPurchaseFailed

Event fired after failing to purchase an order.

Declaration
[Tooltip("Event fired after failing to purchase an order.")]
public IAPListener.OnPurchaseFailedEvent onPurchaseFailed
Field Value
Type Description
IAPListener.OnPurchaseFailedEvent
See Also

onPurchaseFailedLegacy

Legacy event for purchase failure, deprecated in favor of OnPurchaseFailedEvent.

Declaration
[FormerlySerializedAs("onPurchaseFailed")]
[Tooltip("Event fired after failing to purchase an order.")]
[Obsolete]
public IAPListener.OnPurchaseFailedLegacyEvent onPurchaseFailedLegacy
Field Value
Type Description
IAPListener.OnPurchaseFailedLegacyEvent
See Also

onPurchasesFetchFailure

Event fired after failing to fetch purchases.

Declaration
[Tooltip("Event fired after failing to fetch purchases.")]
public IAPListener.OnPurchasesFetchFailureEvent onPurchasesFetchFailure
Field Value
Type Description
IAPListener.OnPurchasesFetchFailureEvent
See Also

onPurchasesFetched

Event fired after fetching purchases.

Declaration
[Tooltip("Event fired after fetching purchases.")]
public IAPListener.OnPurchasesFetchedEvent onPurchasesFetched
Field Value
Type Description
IAPListener.OnPurchasesFetchedEvent
See Also

Methods

OnOrderConfirmed(ConfirmedOrder)

Invoked when updating a confirmed order.

Declaration
public void OnOrderConfirmed(ConfirmedOrder confirmedOrder)
Parameters
Type Name Description
ConfirmedOrder confirmedOrder

The ConfirmedOrder that was updated
See Also

OnOrderDeferred(DeferredOrder)

Invoked on deferring to purchase an order.

Declaration
public void OnOrderDeferred(DeferredOrder deferredOrder)
Parameters
Type Name Description
DeferredOrder deferredOrder

The DeferredOrder that was deferred
See Also

OnOrderPending(PendingOrder)

Invoked when updating a pending order

Declaration
public void OnOrderPending(PendingOrder pendingOrder)
Parameters
Type Name Description
PendingOrder pendingOrder

The PendingOrder that was updated
See Also

OnProductsFetchFailed(ProductFetchFailed)

Invoked when failing to fetch products

Declaration
public void OnProductsFetchFailed(ProductFetchFailed productFetchFailed)
Parameters
Type Name Description
ProductFetchFailed productFetchFailed

The productFetchFailed containing details about the product fetch failure
See Also

OnProductsFetched(List<Product>)

Invoked when fetching products

Declaration
public void OnProductsFetched(List<Product> products)
Parameters
Type Name Description
List<Product> products

The Product which were fetched
See Also

OnPurchaseFailed(FailedOrder)

Invoked on failing to purchase an order.

Declaration
public void OnPurchaseFailed(FailedOrder failedOrder)
Parameters
Type Name Description
FailedOrder failedOrder

The FailedOrder which failed to purchase
See Also

OnPurchasesFetchFailure(PurchasesFetchFailureDescription)

Invoked when failing to fetch purchases

Declaration
public void OnPurchasesFetchFailure(PurchasesFetchFailureDescription purchasesFetchFailureDescription)
Parameters
Type Name Description
PurchasesFetchFailureDescription purchasesFetchFailureDescription

The PurchasesFetchFailureDescription containing details about the purchases fetch failure
See Also

OnPurchasesFetched(Orders)

Invoked when fetching purchases

Declaration
public void OnPurchasesFetched(Orders orders)
Parameters
Type Name Description
Orders orders

The fetched purchase Orders
See Also

See Also