BankActionItems()

Class used by the action controller to manage either action or release action items

new BankActionItems()
lib/Bank/ActionItems.js, line 28

Since:
  • 2.2.0
Author:

Extends

Members

protected controller :BankActionController|BankFeedbackController
lib/Bank/ItemsBase.js, line 39

The parent controller
Inherited From:

protected dbKey :string
lib/Bank/ItemsBase.js, line 45

The database to use load/save the items
Inherited From:

debug :debug.Debugger
lib/Bank/ActionItems.js, line 34

The debugger for this class

protected definitions :Object.<string, Array.<BankItemDefinition>>
lib/Bank/ItemsBase.js, line 51

Nested arrays for the definitions from the instances: [instance_id][item_id]
Inherited From:

protected items :Object.<number, Array.<number, Object.<number, BankItem>>>
lib/Bank/ItemsBase.js, line 58

Nested arrays containing the items in the banks: [page][bank][item] Also is the data that is stored to the DB.
Inherited From:

protected logSource :string
lib/Core/Base.js, line 32

The module name to use in UI logs
Inherited From:

protected registry :Registry
lib/Core/Base.js, line 38

the core registry
Inherited From:

protected system :EventEmitter
lib/Core/Base.js, line 44

the application's event smitter
Inherited From:

Methods

addItem(page, bank, item)
lib/Bank/ItemsBase.js, line 82

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:

addItemByClient(client, result, page, bank, item)
lib/Bank/ItemsBase.js, line 118

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:

protected bank() → {BankController}
lib/Core/Base.js, line 62

Returns:
BankController - the core bank controller
Inherited From:

protected checkBankExists(page, bank)
lib/Bank/ItemsBase.js, line 132

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:

checkBankStatus(page, bank, status) → {number}
lib/Bank/ActionItems.js, line 43

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>}
lib/Bank/ItemsBase.js, line 151

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:

protected checkStatus(page, bank, i)
lib/Bank/ItemsBase.js, line 179

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:

protected db() → {Database}
lib/Core/Base.js, line 70

Returns:
Database - the core database library
Inherited From:

deleteInstance(id, checkQueuenullable) → {Array.<string, boolean>}
lib/Bank/ItemsBase.js, line 188

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:

deleteItem(page, bank, index)
lib/Bank/ItemsBase.js, line 219

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:

deleteItemByClient(client, result, page, bank, index)
lib/Bank/ItemsBase.js, line 236

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:

protected elgatoDM() → {DeviceController}
lib/Core/Base.js, line 78

Returns:
DeviceController - the core device controller
Inherited From:

getAll(clone) → {Object}
lib/Bank/ItemsBase.js, line 257

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:

getBank(page, bank, clone) → {Array.<BankItem>}
lib/Bank/ItemsBase.js, line 295

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:

getBankByClient(client, result, page, bank)
lib/Bank/ActionItems.js, line 66

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:

getInstanceItems(id, clone) → {Object}
lib/Bank/ActionItems.js, line 82

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:

getPage(page, clone) → {Array.<number, Array.<BankItem>>}
lib/Bank/ItemsBase.js, line 367

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:

protected graphics() → {Graphics}
lib/Core/Base.js, line 86

Returns:
Graphics - the core graphics controller
Inherited From:

importBank(page, bank, items)
lib/Bank/ItemsBase.js, line 402

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:

protected instance() → {InstanceController}
lib/Core/Base.js, line 94

Returns:
InstanceController - the core instance controller
Inherited From:

protected io() → {InterfaceClient}
lib/Core/Base.js, line 102

Returns:
InterfaceClient - the core interface client
Inherited From:

protected log(level, message)
lib/Core/Base.js, line 112

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:

protected page() → {PageController}
lib/Core/Base.js, line 120

Returns:
PageController - the core page controller
Inherited From:

resetBank(page, bank)
lib/Bank/ItemsBase.js, line 429

Unsubscribe, clear a bank, and save
Parameters:
Name Type Description
page number the bank's page
bank number the bank number
Inherited From:

save()
lib/Bank/ItemsBase.js, line 444

Flag the database to save
Inherited From:

protected schedule() → {ScheduleController}
lib/Core/Base.js, line 128

Returns:
ScheduleController - the core schedule controller
Inherited From:

protected services() → {ServiceController}
lib/Core/Base.js, line 136

Returns:
ServiceController - the core service controller
Inherited From:

setDefinitions(definitions)
lib/Bank/ItemsBase.js, line 455

Set a new definitions array
Parameters:
Name Type Description
definitions Array.<BankItemDefinition> the new definitions
Inherited From:

protected subscribe(item)
lib/Bank/ItemsBase.js, line 464

Find a subscribe function for an item and execute it
Parameters:
Name Type Description
item BankItem the item object
Inherited From:

subscribeBank(page, bank)
lib/Bank/ItemsBase.js, line 483

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:

protected unsubscribe(item)
lib/Bank/ItemsBase.js, line 498

Find an unsubscribe function for an item and execute it
Parameters:
Name Type Description
item BankItem the item object
Inherited From:

unsubscribeBank(page, bank)
lib/Bank/ItemsBase.js, line 517

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:

updateItemDelay(page, bank, item, value)
lib/Bank/ActionItems.js, line 99

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

updateItemOption(page, bank, item, option, value)
lib/Bank/ItemsBase.js, line 536

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:

updateItemOrder(page, bank, oldIndex, newIndex)
lib/Bank/ItemsBase.js, line 564

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:

protected userconfig() → {UserConfig}
lib/Core/Base.js, line 144

Returns:
UserConfig - the core user config manager
Inherited From: