docs.unity3d.com
    Show / Hide Table of Contents

    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
    IAPButton
    Namespace: UnityEngine.Purchasing
    Syntax
    public class IAPButton : MonoBehaviour

    Fields

    buttonType

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

    Declaration
    public IAPButton.ButtonType buttonType
    Field Value
    Type Description
    IAPButton.ButtonType

    consumePurchase

    Consume the product immediately after a successful purchase.

    Declaration
    public bool consumePurchase
    Field Value
    Type Description
    Boolean

    descriptionText

    Displays the localized description from the app store.

    Declaration
    public Text descriptionText
    Field Value
    Type Description
    Text

    onPurchaseComplete

    Event fired after a successful purchase of this product.

    Declaration
    public IAPButton.OnPurchaseCompletedEvent onPurchaseComplete
    Field Value
    Type Description
    IAPButton.OnPurchaseCompletedEvent

    onPurchaseFailed

    Event fired after a failed purchase of this product.

    Declaration
    public IAPButton.OnPurchaseFailedEvent onPurchaseFailed
    Field Value
    Type Description
    IAPButton.OnPurchaseFailedEvent

    priceText

    Displays the localized price from the app store.

    Declaration
    public Text priceText
    Field Value
    Type Description
    Text

    productId

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

    Declaration
    public string productId
    Field Value
    Type Description
    String

    titleText

    Displays the localized title from the app store.

    Declaration
    public Text titleText
    Field Value
    Type Description
    Text

    Methods

    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

    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

    See Also

    CodelessIAPStoreListener
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023