: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/SubscriptionStoreView.xml. .. _class_SubscriptionStoreView: SubscriptionStoreView ===================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` A view for displaying subscription options. .. rst-class:: classref-introduction-group Description ----------- This class presents a standard StoreKit subscription view. It can be configured to show a specific subscription group or a list of specific products. The visual style of the controls is also customizable. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------+--------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`control_style` | ``0`` | +---------------------------------------------------+--------------------------------------------------------------------------+-------------------------+ | :ref:`String` | :ref:`group_id` | ``""`` | +---------------------------------------------------+--------------------------------------------------------------------------+-------------------------+ | :ref:`PackedStringArray` | :ref:`product_i_ds` | ``PackedStringArray()`` | +---------------------------------------------------+--------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------+------------------------------------------------------------------+ | |void| | :ref:`dismiss`\ (\ ) | +--------+------------------------------------------------------------------+ | |void| | :ref:`present`\ (\ ) | +--------+------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_SubscriptionStoreView_ControlStyle: .. rst-class:: classref-enumeration enum **ControlStyle**: :ref:`🔗` .. _class_SubscriptionStoreView_constant_automatic: .. rst-class:: classref-enumeration-constant :ref:`ControlStyle` **automatic** = ``0`` The system automatically chooses the most appropriate style. .. _class_SubscriptionStoreView_constant_picker: .. rst-class:: classref-enumeration-constant :ref:`ControlStyle` **picker** = ``1`` A picker style. .. _class_SubscriptionStoreView_constant_buttons: .. rst-class:: classref-enumeration-constant :ref:`ControlStyle` **buttons** = ``2`` A button-based style. .. _class_SubscriptionStoreView_constant_compactPicker: .. rst-class:: classref-enumeration-constant :ref:`ControlStyle` **compactPicker** = ``3`` A compact picker style. .. _class_SubscriptionStoreView_constant_prominentPicker: .. rst-class:: classref-enumeration-constant :ref:`ControlStyle` **prominentPicker** = ``4`` A prominent picker style. .. _class_SubscriptionStoreView_constant_pagedPicker: .. rst-class:: classref-enumeration-constant :ref:`ControlStyle` **pagedPicker** = ``5`` A paged picker style. .. _class_SubscriptionStoreView_constant_pagedProminentPicker: .. rst-class:: classref-enumeration-constant :ref:`ControlStyle` **pagedProminentPicker** = ``6`` A prominent paged picker style. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SubscriptionStoreView_property_control_style: .. rst-class:: classref-property :ref:`int` **control_style** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_control_style**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_control_style**\ (\ ) The visual style of the subscription controls. See :ref:`ControlStyle` for options. .. rst-class:: classref-item-separator ---- .. _class_SubscriptionStoreView_property_group_id: .. rst-class:: classref-property :ref:`String` **group_id** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_group_id**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_group_id**\ (\ ) The identifier of the subscription group to display. If set, this takes precedence over :ref:`product_i_ds`. .. rst-class:: classref-item-separator ---- .. _class_SubscriptionStoreView_property_product_i_ds: .. rst-class:: classref-property :ref:`PackedStringArray` **product_i_ds** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_product_i_ds**\ (\ value\: :ref:`PackedStringArray`\ ) - :ref:`PackedStringArray` **get_product_i_ds**\ (\ ) A list of specific product identifiers to display. Ignored if :ref:`group_id` is set. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SubscriptionStoreView_method_dismiss: .. rst-class:: classref-method |void| **dismiss**\ (\ ) :ref:`🔗` Dismisses the currently presented view. .. rst-class:: classref-item-separator ---- .. _class_SubscriptionStoreView_method_present: .. rst-class:: classref-method |void| **present**\ (\ ) :ref:`🔗` Presents the subscription store view on top of the current view hierarchy. .. |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.)`