-
-
Add an item to a bank
Parameters:
Name |
Type |
Description |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
item |
string
|
item information in form: `"instance_id:type"` |
- Inherited From:
-
-
Add item to a bank via a client socket
Parameters:
Name |
Type |
Description |
client |
IO.Socket
|
the client socket sending the request |
result |
string
|
the name of the call to send the results back to the client |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
item |
string
|
item information in form: `"instance_id:type"` |
- Inherited From:
-
-
- Inherited From:
-
-
Check if a bank exists and initialize it if it doesn't
Parameters:
Name |
Type |
Description |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
- Inherited From:
-
-
Check all the actions' instances for their status number and report the highest
Parameters:
Name |
Type |
Description |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
status |
number
|
incoming value to update if the value checked is higher |
Returns:
number
- the final status
-
checkInstanceStatus(id, type, checkQueuenullable) → {Array.<string, boolean>}
-
Scan the page/bank array to find items for an instance or just specific types and populate an array with the findings
Parameters:
Name |
Type |
Attributes |
Description |
id |
string
|
|
the instance ID to check for |
type |
string
|
|
the item type to check for |
checkQueue |
Array.<string, boolean>
|
<nullable>
|
array of flagged banks with keys of `[page_bank]`; empty by default but can have a populated version passed to be added to |
Returns:
Array.<string, boolean>
- the populated `checkQueue`
- Inherited From:
-
-
Check an item's status
Parameters:
Name |
Type |
Description |
page |
number
|
the item's page |
bank |
number
|
the item's bank |
i |
number
|
the item's index |
- Inherited From:
-
-
Returns:
Database
- the core database library
- Inherited From:
-
deleteInstance(id, checkQueuenullable) → {Array.<string, boolean>}
-
Scan the page/bank array for items from an instance and delete them
Parameters:
Name |
Type |
Attributes |
Description |
id |
string
|
|
the instance ID to delete |
checkQueue |
Array.<string, boolean>
|
<nullable>
|
array of changed banks with keys of `[page_bank]`; empty by default but can have a populated version passed to be added to |
Returns:
Array.<string, boolean>
- the populated `checkQueue`
- Inherited From:
-
-
Delete an item
Parameters:
Name |
Type |
Description |
page |
number
|
the item's page |
bank |
number
|
the item's bank |
index |
number
|
the item's index |
- Inherited From:
-
-
Delete an item from a bank via a client socket
Parameters:
Name |
Type |
Description |
client |
IO.Socket
|
the client socket sending the request |
result |
string
|
the name of the call to send the results back to the client |
page |
number
|
the item's page |
bank |
number
|
the item's bank |
index |
string
|
the item's id (`item.id`) |
- Inherited From:
-
-
Returns:
DeviceController
- the core device controller
- Inherited From:
-
-
Get the entire items array
Parameters:
Name |
Type |
Default |
Description |
clone |
boolean
|
false
|
whether or not the return should be a deep clone |
Returns:
Object
- the array in the form `[page][bank][item]`
- Inherited From:
-
-
Get the items in a bank
Parameters:
Name |
Type |
Default |
Description |
page |
number
|
|
the bank's page |
bank |
number
|
|
the bank number |
clone |
boolean
|
false
|
whether or not the return should be a deep clone |
Returns:
Array.<BankItem>
- the items array
- Inherited From:
-
-
Get the items in a bank via a client socket
Parameters:
Name |
Type |
Description |
client |
IO.Socket
|
the client socket sending the request |
result |
string
|
the name of the call to send the results back to the client |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
- Overrides:
-
-
Get all the items for a specific instance
Parameters:
Name |
Type |
Default |
Description |
id |
string
|
|
the instance id |
clone |
boolean
|
false
|
whether or not the return should be a deep clone |
Returns:
Object
- the items array
- Overrides:
-
-
Get the items on a page
Parameters:
Name |
Type |
Default |
Description |
page |
number
|
|
the page number |
clone |
boolean
|
false
|
whether or not the return should be a deep clone |
Returns:
Array.<number, Array.<BankItem>>
- the array in the form `[bank][item]`
- Inherited From:
-
-
Returns:
Graphics
- the core graphics controller
- Inherited From:
-
-
Import and subscribe items to a bank
Parameters:
Name |
Type |
Description |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
items |
Array.<BankItem>
|
the items to import |
- Inherited From:
-
-
Returns:
InstanceController
- the core instance controller
- Inherited From:
-
-
- Inherited From:
-
-
Send a log message to the UI
Parameters:
Name |
Type |
Description |
level |
string
|
'debug' | 'info' | 'warn' | 'error' |
message |
atring
|
the message to print |
- Inherited From:
-
-
Returns:
PageController
- the core page controller
- Inherited From:
-
-
Unsubscribe, clear a bank, and save
Parameters:
Name |
Type |
Description |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
- Inherited From:
-
-
Flag the database to save
- Inherited From:
-
-
- Inherited From:
-
-
Returns:
ServiceController
- the core service controller
- Inherited From:
-
-
Set a new definitions array
- Inherited From:
-
-
Find a subscribe function for an item and execute it
Parameters:
Name |
Type |
Description |
item |
BankItem
|
the item object |
- Inherited From:
-
-
Execute subscribes for all the items in a bank
Parameters:
Name |
Type |
Description |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
- Inherited From:
-
-
Find an unsubscribe function for an item and execute it
Parameters:
Name |
Type |
Description |
item |
BankItem
|
the item object |
- Inherited From:
-
-
Execute unsubscribes for all the items in a bank
Parameters:
Name |
Type |
Description |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
- Inherited From:
-
-
Update the delay for an item and save
Parameters:
Name |
Type |
Description |
page |
number
|
the item's page |
bank |
number
|
the item's bank |
item |
string
|
the item's id (`item.id`) |
value |
number
|
the new delay value |
-
-
Update an option for an item, subscribe, and save
Parameters:
Name |
Type |
Description |
page |
number
|
the item's page |
bank |
number
|
the item's bank |
item |
string
|
the item's id (`item.id`) |
option |
string
|
the option id/key |
value |
string
|
Array.<string>
|
number
|
boolean
|
the new value |
- Inherited From:
-
-
Update a bank item order by swapping two keys
Parameters:
Name |
Type |
Description |
page |
number
|
the bank's page |
bank |
number
|
the bank number |
oldIndex |
number
|
the moving item's index |
newIndex |
number
|
the other index to swap with |
- Inherited From:
-
-
Returns:
UserConfig
- the core user config manager
- Inherited From: