Scripts¶
Methods¶
Scripts.AddScript¶
ADMIN
Add a script
Parameters:
| Field | Type | Notes |
|---|---|---|
content |
String |
|
name |
String |
Returns:
| Field | Type | Notes |
|---|---|---|
errors |
StringList |
optional |
script |
Script | optional |
scriptError |
ScriptError |
Scripts.EditScript¶
ADMIN
Edit a script
Parameters:
| Field | Type | Notes |
|---|---|---|
id |
Uuid |
|
content |
String |
optional |
name |
String |
optional |
Returns:
| Field | Type | Notes |
|---|---|---|
errors |
StringList |
optional |
scriptError |
ScriptError |
Scripts.GetScriptContent¶
ADMIN
Get a scripts content.
Parameters:
| Field | Type | Notes |
|---|---|---|
id |
Uuid |
Returns:
| Field | Type | Notes |
|---|---|---|
content |
String |
optional |
scriptError |
ScriptError |
Scripts.GetScripts¶
ADMIN
Get all script, that is, their names and properties, but no content.
Parameters:
No parameters.
Returns:
| Field | Type | Notes |
|---|---|---|
scripts |
Scripts |
Scripts.RemoveScript¶
ADMIN
remove a script
Parameters:
| Field | Type | Notes |
|---|---|---|
id |
Uuid |
Returns:
| Field | Type | Notes |
|---|---|---|
scriptError |
ScriptError |
Notifications¶
Scripts.ScriptAdded¶
Emitted when a script has been added to the system.
Parameters:
| Field | Type | Notes |
|---|---|---|
script |
Script |
Scripts.ScriptChanged¶
Emitted when a script has been changed in the system (e.g. renamed).
Parameters:
| Field | Type | Notes |
|---|---|---|
name |
String |
|
scriptId |
Uuid |
Scripts.ScriptContentChanged¶
Emitted when a script's content has been changed in the system.
Parameters:
| Field | Type | Notes |
|---|---|---|
scriptId |
Uuid |
Scripts.ScriptLogMessage¶
Emitted when a script produces a console message.
Parameters:
| Field | Type | Notes |
|---|---|---|
message |
String |
|
scriptId |
Uuid |
|
type |
ScriptMessageType |
Scripts.ScriptRemoved¶
Emitted when a script has been removed from the system.
Parameters:
| Field | Type | Notes |
|---|---|---|
id |
Uuid |