config¶
Configuration the script runs with.
Contains information about the configuration the script is currently being run under.
runsInApp¶
Read-only.
Whether the script is running in the app.
runsInApp: bool
runsInActionExtension¶
Read-only.
Whether the script is running in the action extension.
runsInActionExtension: bool
runsWithSiri¶
Read-only.
Whether the script is running with Siri.
runsWithSiri: bool
runsInWidget¶
Read-only.
Whether the script is running in a widget.
This is true both when running in a widget on the Home Screen and when running in a widget on the Lock Screen.
runsInWidget: bool
runsInAccessoryWidget¶
Read-only.
Whether the script is running in a widget.
This is true when running in an accessory widget. These widgets can appear on the Lock Screen. Accessory widgets are only available starting from iOS 16.
runsInAccessoryWidget: bool
runsInNotification¶
Read-only.
Whether the script is running in a notification.
runsInNotification: bool
runsFromHomeScreen¶
Read-only.
Whether the script was run from the home screen. You can add a script to the home screen from the script settings.
runsFromHomeScreen: bool
widgetFamily¶
Read-only.
The size of the widget the script is running in.
Possible values are: small, medium, large, extraLarge, accessoryRectangular, accessoryInline, accessoryCircular, and null. The value is null when the script is not running in a widget.
extraLarge is only available on iPads running iPadOS 15. accessoryRectangular, accessoryInline, and accessoryCircular are only available starting from iOS 16.
widgetFamily: string