Class IAPButton

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
BaseIAPButton
IAPButton
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
Namespace: UnityEngine.Purchasing
Syntax
[Obsolete("IAPButton is deprecated, please use CodelessIAPButton instead.", false)]
[RequireComponent(typeof(Button))]
[AddComponentMenu("In-App Purchasing/IAP Button (legacy)", 2147483647)]
[HelpURL("https://docs.unity3d.com/Manual/UnityIAP.html")]
public class IAPButton : BaseIAPButton

Fields

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 IAPButton.ButtonType buttonType
Field Value
Type Description
IAPButton.ButtonType

consumePurchase

Consume the product immediately after a successful purchase.

Declaration
[Tooltip("Consume the product immediately after a successful purchase.")]
public bool consumePurchase
Field Value
Type Description
Boolean

descriptionText

Displays the localized description from the app store.

Declaration
[Tooltip("[Optional] Displays the localized description from the app store.")]
public Text descriptionText
Field Value
Type Description
Text

onPurchaseComplete

Event fired after a successful purchase of this product.

Declaration
[Tooltip("Event fired after a successful purchase of this product.")]
public IAPButton.OnPurchaseCompletedEvent onPurchaseComplete
Field Value
Type Description
IAPButton.OnPurchaseCompletedEvent

onPurchaseFailed

Event fired after a failed purchase of this product.

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

onTransactionsRestored

Event fired after a restore transactions.

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

priceText

Displays the localized price from the app store.

Declaration
[Tooltip("[Optional] Displays the localized price from the app store.")]
public Text priceText
Field Value
Type Description
Text

productId

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

Declaration
[HideInInspector]
public string productId
Field Value
Type Description
String

titleText

Displays the localized title from the app store.

Declaration
[Tooltip("[Optional] Displays the localized title from the app store.")]
public Text titleText
Field Value
Type Description
Text

Methods

AddButtonToCodelessListener()

Declaration
protected override void AddButtonToCodelessListener()
Overrides

GetPurchaseButton()

Declaration
protected override Button GetPurchaseButton()
Returns
Type Description
Button
Overrides

IsARestoreButton()

Declaration
protected override bool IsARestoreButton()
Returns
Type Description
Boolean
Overrides

OnPurchaseComplete(Product)

Declaration
protected override void OnPurchaseComplete(Product purchasedProduct)
Parameters
Type Name Description
Product purchasedProduct
Overrides

OnPurchaseFailed(Product, PurchaseFailureReason)

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

Declaration
public void OnPurchaseFailed(Product product, PurchaseFailureReason reason)
Parameters
Type Name Description
Product product

The Product which failed to purchase
PurchaseFailureReason reason

Information to help developers recover from this failure

OnTransactionsRestored(Boolean, String)

Declaration
protected override void OnTransactionsRestored(bool success, string error)
Parameters
Type Name Description
Boolean success
String error
Overrides

ProcessPurchase(PurchaseEventArgs)

Invoke to process a successful purchase of the product associated with this button.

Declaration
public PurchaseProcessingResult ProcessPurchase(PurchaseEventArgs e)
Parameters
Type Name Description
PurchaseEventArgs e

The successful PurchaseEventArgs for the purchase event.

Returns
Type Description
PurchaseProcessingResult

The result of the successful purchase

RemoveButtonToCodelessListener()

Declaration
protected override void RemoveButtonToCodelessListener()
Overrides

ShouldConsumePurchase()

Declaration
protected override bool ShouldConsumePurchase()
Returns
Type Description
Boolean
Overrides

See Also