A GUI component for exposing the current price and allow purchasing of In-App Purchases. Exposes configurable
elements through the Inspector.
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)
[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
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
Consume the product immediately after a successful purchase.
Declaration
[Tooltip("Consume the product immediately after a successful purchase.")]
public bool consumePurchase
Field Value
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
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
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
Event fired after a restore transactions.
Declaration
[Tooltip("Event fired after a restore transactions.")]
public IAPButton.OnTransactionsRestoredEvent onTransactionsRestored
Field Value
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
Which product identifier to represent. Note this is not a store-specific identifier.
Declaration
[HideInInspector]
public string productId
Field Value
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
Methods
Declaration
protected override void AddButtonToCodelessListener()
Overrides
Declaration
protected override Button GetPurchaseButton()
Returns
Overrides
Declaration
protected override bool IsARestoreButton()
Returns
Overrides
Declaration
protected override void OnPurchaseComplete(Product purchasedProduct)
Parameters
Type |
Name |
Description |
Product |
purchasedProduct |
|
Overrides
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
|
Declaration
protected override void OnTransactionsRestored(bool success, string error)
Parameters
Overrides
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
Declaration
protected override void RemoveButtonToCodelessListener()
Overrides
Declaration
protected override bool ShouldConsumePurchase()
Returns
Overrides
See Also
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.