Class CodelessIAPButton

A GUI component for exposing the current price and allow purchasing of In-App Purchases. Exposes configurable elements through the Inspector.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
CodelessIAPButton
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 Button")]
[HelpURL("https://docs.unity.com/ugs/en-us/manual/iap/manual/overview")]
public class CodelessIAPButton : MonoBehaviour

Fields

automaticallyConfirmTransaction

Consume the product immediately after a successful purchase.

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

button

Button that triggers purchase.

Declaration
[Tooltip("Button that triggers purchase.")]
public Button? button
Field Value
Type Description
Button
See Also

buttonType

The type of this button, can be either a purchase or a restore button.

Declaration
[Tooltip("The type of this button, can be either a purchase or a restore button.")]
public CodelessButtonType buttonType
Field Value
Type Description
CodelessButtonType
See Also

onOrderConfirmed

Event fired after a confirmed order.

Declaration
[Tooltip("Event fired after a confirmed order.")]
public CodelessIAPButton.OnOrderConfirmedEvent? onOrderConfirmed
Field Value
Type Description
CodelessIAPButton.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 for this product.")]
public CodelessIAPButton.OnOrderDeferredEvent? onOrderDeferred
Field Value
Type Description
CodelessIAPButton.OnOrderDeferredEvent
See Also

onOrderPending

Event fired after a pending order.

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

onProductFetchFailed

Event fired after failing to fetch a product.

Declaration
[Tooltip("Event fired after failing to fetch a product.")]
public CodelessIAPButton.OnProductFetchFailedEvent? onProductFetchFailed
Field Value
Type Description
CodelessIAPButton.OnProductFetchFailedEvent
See Also

onProductFetched

Event fired after fetching a product.

Declaration
[Tooltip("Event fired after fetching a product.")]
public CodelessIAPButton.OnProductFetchedEvent? onProductFetched
Field Value
Type Description
CodelessIAPButton.OnProductFetchedEvent
See Also

onPurchaseCompleteLegacy

Event fired after a successful purchase of this product.

Declaration
[Header("Obsolete Events (for backward compatibility only)")]
[FormerlySerializedAs("onPurchaseComplete")]
[Tooltip("Event fired after a successful purchase of this product.")]
[Obsolete]
public CodelessIAPButton.OnPurchaseCompletedLegacyEvent? onPurchaseCompleteLegacy
Field Value
Type Description
CodelessIAPButton.OnPurchaseCompletedLegacyEvent
See Also

onPurchaseFailed

Event fired after a failed purchase of this product.

Declaration
[Tooltip("Event fired after a failed purchase of this product.")]
public CodelessIAPButton.OnPurchaseFailedEvent? onPurchaseFailed
Field Value
Type Description
CodelessIAPButton.OnPurchaseFailedEvent
See Also

onPurchaseFailedLegacy

Event fired after a failed purchase of this product.

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

onPurchaseFetched

Event fired after fetching a purchase.

Declaration
[Tooltip("Event fired after fetching a purchase.")]
public CodelessIAPButton.OnPurchaseFetchedEvent? onPurchaseFetched
Field Value
Type Description
CodelessIAPButton.OnPurchaseFetchedEvent
See Also

onTransactionsRestored

Event fired after a restore transactions.

Declaration
[Tooltip("Event fired after a restore transactions.")]
public CodelessIAPButton.OnTransactionsRestoredEvent? onTransactionsRestored
Field Value
Type Description
CodelessIAPButton.OnTransactionsRestoredEvent
See Also

productId

Which product identifier to represent. Note this is not a store-specific identifier.

Declaration
[HideInInspector]
public string? productId
Field Value
Type Description
string
See Also

Methods

OnOrderConfirmed(ConfirmedOrder)

Invoked on a failed purchase of the product associated with this button

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

The Product which failed to purchase
See Also

OnOrderDeferred(DeferredOrder)

Invoked on a deferred order associated with this button

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

The DeferredOrder that was deferred
See Also

OnOrderPending(PendingOrder)

Invoked on a failed purchase of the product associated with this button

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

The Product which failed to purchase
See Also

OnProductFetchFailed(ProductDefinition, string)

Invoked for each failed fetch product.

Declaration
public void OnProductFetchFailed(ProductDefinition product, string failureReason)
Parameters
Type Name Description
ProductDefinition product

The product that failed to be fetched.
string failureReason

The reason the fetch product failed.
See Also

OnProductFetched(Product)

Invoked for each fetched product.

Declaration
public void OnProductFetched(Product product)
Parameters
Type Name Description
Product product

The fetched product.
See Also

OnPurchaseFailed(FailedOrder)

Invoked on a failed order associated with this button

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

The Order which failed to purchase
See Also

OnPurchaseFetched(Order)

Invoked for each fetched purchase.

Declaration
public void OnPurchaseFetched(Order order)
Parameters
Type Name Description
Order order

The fetched purchase.
See Also

OnTransactionsRestored(bool, string?)

Invoked on transactions restored.

Declaration
public void OnTransactionsRestored(bool success, string? error)
Parameters
Type Name Description
bool success

Indicates if the restore transaction was successful.
string error

When unsuccessful, the error message.
See Also

See Also