: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/ProductView.xml. .. _class_ProductView: ProductView =========== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` A view that displays a single product from the App Store. .. rst-class:: classref-introduction-group Description ----------- This class represents a view that displays a single product from the App Store. It allows you to configure the product to display, the style of the view, and the icon to use. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+--------------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`prefers_promotional_icon` | ``false`` | +-----------------------------+--------------------------------------------------------------------------------------+------------+ | :ref:`String` | :ref:`product_id` | ``""`` | +-----------------------------+--------------------------------------------------------------------------------------+------------+ | :ref:`int` | :ref:`style` | ``0`` | +-----------------------------+--------------------------------------------------------------------------------------+------------+ | :ref:`String` | :ref:`system_icon_name` | ``"cart"`` | +-----------------------------+--------------------------------------------------------------------------------------+------------+ .. 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_ProductView_ViewStyle: .. rst-class:: classref-enumeration enum **ViewStyle**: :ref:`🔗` .. _class_ProductView_constant_automatic: .. rst-class:: classref-enumeration-constant :ref:`ViewStyle` **automatic** = ``0`` The system automatically chooses the most appropriate style. .. _class_ProductView_constant_compact: .. rst-class:: classref-enumeration-constant :ref:`ViewStyle` **compact** = ``1`` A compact style that displays minimal information. .. _class_ProductView_constant_large: .. rst-class:: classref-enumeration-constant :ref:`ViewStyle` **large** = ``2`` A large style that displays more detailed information. .. _class_ProductView_constant_regular: .. rst-class:: classref-enumeration-constant :ref:`ViewStyle` **regular** = ``3`` The regular style. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ProductView_property_prefers_promotional_icon: .. rst-class:: classref-property :ref:`bool` **prefers_promotional_icon** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_prefers_promotional_icon**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_prefers_promotional_icon**\ (\ ) Whether the view prefers to show the promotional icon for the product. .. rst-class:: classref-item-separator ---- .. _class_ProductView_property_product_id: .. rst-class:: classref-property :ref:`String` **product_id** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_product_id**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_product_id**\ (\ ) The product identifier of the product to display. .. rst-class:: classref-item-separator ---- .. _class_ProductView_property_style: .. rst-class:: classref-property :ref:`int` **style** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_style**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_style**\ (\ ) The style of the product view. See :ref:`ViewStyle` for available options. .. rst-class:: classref-item-separator ---- .. _class_ProductView_property_system_icon_name: .. rst-class:: classref-property :ref:`String` **system_icon_name** = ``"cart"`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_system_icon_name**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_system_icon_name**\ (\ ) The name of the system icon to use as a placeholder while the product icon loads. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ProductView_method_dismiss: .. rst-class:: classref-method |void| **dismiss**\ (\ ) :ref:`🔗` Dismisses the currently presented view. .. rst-class:: classref-item-separator ---- .. _class_ProductView_method_present: .. rst-class:: classref-method |void| **present**\ (\ ) :ref:`🔗` Presents the product 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.)`