Global

Members

DataTypestring

Enum string values.

Properties:

Name	Type	Default	Description
STRING	string	STRING
NUMBER	string	NUMBER
CUSTOM	string	CUSTOM
CHECKBOX	string	CHECKBOX

Type Definitions

GadgetSettingObject

Properties:

Name	Type	Argument	Description
name	String		The techincal name of the setting
def	String | Number		The default value to be used if no value is specified. If a number is specified the default value will be the value from the enum array with the given index.
type	String		The type of the setting. (string | boolean | number)
enum	Array		An Array of values i.e. ["A", "B"] that the user can choose from. Or an Array of key value pairs i.e. [[0, "A"], [1, "B"]]. The values must be of the type defined in type.
desc	String	<optional>	The description of this setting

ListActionObject

Properties:

Name	Type	Argument	Description
name	string		Unique name of the action
label	string		Label to display for this action
type	string		Type of the action ("button" or "list") default: "button"
action	string		Action to be executed, e.g., ("runScript:myScript&myParam=value")
imageFile	string	<optional>	The action is displayed with the referenced icon (entypo: or ionicons: syntax is supported). Only for type button
tooltip	string	<optional>	Optional tooltip
clientAction	string	<optional>	[ONLY USEABLE IN GADGET CONTEXT] Register a client function that is called with an array of ids if showCheckboxes is enabled
gadgetAction	string	<optional>	[ONLY USEABLE IN GADGET CONTEXT] Register a gadget action belonging to the same gadgetScript to be executed on click

SystemUserobject

The Portalscript SystemUser