SubscriptionStoreView¶

A view for displaying subscription options.

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.

Properties¶

int	control_style	`0`
String	group_id	`""`
PackedStringArray	product_i_ds	`PackedStringArray()`

Methods¶

void	dismiss()
void	present()

Enumerations¶

enum ControlStyle: 🔗

ControlStyle AUTOMATIC = 0

The system automatically chooses the most appropriate style.

ControlStyle PICKER = 1

A picker style.

ControlStyle BUTTONS = 2

A button-based style.

ControlStyle COMPACT_PICKER = 3

A compact picker style.

ControlStyle PROMINENT_PICKER = 4

A prominent picker style.

ControlStyle PAGED_PICKER = 5

A paged picker style.

ControlStyle PAGED_PROMINENT_PICKER = 6

A prominent paged picker style.

Property Descriptions¶

int control_style = 0 🔗

void set_control_style(value: int)
int get_control_style()

The visual style of the subscription controls. See ControlStyle for options.

String group_id = "" 🔗

void set_group_id(value: String)
String get_group_id()

The identifier of the subscription group to display. If set, this takes precedence over product_i_ds.

PackedStringArray product_i_ds = PackedStringArray() 🔗

void set_product_i_ds(value: PackedStringArray)
PackedStringArray get_product_i_ds()

A list of specific product identifiers to display. Ignored if group_id is set.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.

Method Descriptions¶

void dismiss() 🔗

Dismisses the currently presented view.

void present() 🔗

Presents the subscription store view on top of the current view hierarchy.