:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/../../GodotApplePlugins/doc_classes/SubscriptionOfferView.xml.

.. _class_SubscriptionOfferView:

SubscriptionOfferView
=====================

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A view for redeeming subscription offers.

.. rst-class:: classref-introduction-group

Description
-----------

This class provides a view for users to redeem subscription offer codes. It handles the UI flow for entering and verifying offer codes.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-----------------------------+----------------------------------------------------------+--------------------------+
   | :ref:`String<class_String>` | :ref:`title<class_SubscriptionOfferView_property_title>` | ``"Redeeming Offer..."`` |
   +-----------------------------+----------------------------------------------------------+--------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +--------+--------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`dismiss<class_SubscriptionOfferView_method_dismiss>`\ (\ )                                             |
   +--------+--------------------------------------------------------------------------------------------------------------+
   | |void| | :ref:`present<class_SubscriptionOfferView_method_present>`\ (\ callback\: :ref:`Callable<class_Callable>`\ ) |
   +--------+--------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_SubscriptionOfferView_signal_error:

.. rst-class:: classref-signal

**error**\ (\ arg1\: :ref:`String<class_String>`\ ) :ref:`🔗<class_SubscriptionOfferView_signal_error>`

Emitted when the offer redemption fails. `arg1` contains the error message.

.. rst-class:: classref-item-separator

----

.. _class_SubscriptionOfferView_signal_success:

.. rst-class:: classref-signal

**success**\ (\ ) :ref:`🔗<class_SubscriptionOfferView_signal_success>`

Emitted when the offer redemption is successful.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_SubscriptionOfferView_property_title:

.. rst-class:: classref-property

:ref:`String<class_String>` **title** = ``"Redeeming Offer..."`` :ref:`🔗<class_SubscriptionOfferView_property_title>`

.. rst-class:: classref-property-setget

- |void| **set_title**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_title**\ (\ )

The title displayed on the view.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_SubscriptionOfferView_method_dismiss:

.. rst-class:: classref-method

|void| **dismiss**\ (\ ) :ref:`🔗<class_SubscriptionOfferView_method_dismiss>`

Dismisses the currently presented view.

.. rst-class:: classref-item-separator

----

.. _class_SubscriptionOfferView_method_present:

.. rst-class:: classref-method

|void| **present**\ (\ callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_SubscriptionOfferView_method_present>`

Presents the offer code redemption view. note: The `callback` parameter is currently unused; use the :ref:`success<class_SubscriptionOfferView_signal_success>` and :ref:`error<class_SubscriptionOfferView_signal_error>` signals to handle the result.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`