Extends

• BankItemsBase

Members

protected controller :BankActionController|BankFeedbackController

lib/Bank/ItemsBase.js, line 39

The parent controller

Overrides:

• BankItemsBase#controller

protected dbKey :string

lib/Bank/ItemsBase.js, line 45

The database to use load/save the items

Overrides:

• BankItemsBase#dbKey

debug :debug.Debugger

lib/Bank/FeedbackItems.js, line 36

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]

Overrides:

• BankItemsBase#definitions

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.

Overrides:

• BankItemsBase#items

protected logSource :string

lib/Core/Base.js, line 32

The module name to use in UI logs

Overrides:

• BankItemsBase#logSource

protected registry :Registry

lib/Core/Base.js, line 38

the core registry

Overrides:

• BankItemsBase#registry

protected system :EventEmitter

lib/Core/Base.js, line 44

the application's event smitter

Overrides:

• BankItemsBase#system

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"`

Overrides:

• BankItemsBase#addItem

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"`

Overrides:

• BankItemsBase#addItemByClient

protected bank() → {BankController}

lib/Core/Base.js, line 62

Returns:

BankController - the core bank controller

Overrides:

• BankItemsBase#bank

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

Overrides:

• BankItemsBase#checkBankExists

checkBankStatus(page, bank)

lib/Bank/FeedbackItems.js, line 55

Scrub a bank's feedback items to process the current status/style

Parameters:

Name	Type	Description
page	number	the bank's page
bank	number	the bank number

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`

Overrides:

• BankItemsBase#checkInstanceStatus

checkStatus(page, bank, index)

lib/Bank/FeedbackItems.js, line 71

Check an item's status and update its style

Parameters:

Name	Type	Description
page	number	the item's page
bank	number	the item's bank
index	number	the item's index

Overrides:

• BankItemsBase#checkStatus

protected db() → {Database}

lib/Core/Base.js, line 70

Returns:

Database - the core database library

Overrides:

• BankItemsBase#db

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`

Overrides:

• BankItemsBase#deleteInstance

deleteItem(page, bank, index)

lib/Bank/FeedbackItems.js, line 115

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

Overrides:

• BankItemsBase#deleteItem

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`)

Overrides:

• BankItemsBase#deleteItemByClient

protected elgatoDM() → {DeviceController}

lib/Core/Base.js, line 78

Returns:

DeviceController - the core device controller

Overrides:

• BankItemsBase#elgatoDM

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]`

Overrides:

• BankItemsBase#getAll

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

Overrides:

• BankItemsBase#getBank

getBankByClient(client, result, page, bank)

lib/Bank/FeedbackItems.js, line 133

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:

• BankItemsBase#getBankByClient

getBankStyles(page, bank, clone) → {Array.<BankStyle>}

lib/Bank/FeedbackItems.js, line 151

Get the current style for a bank's items

Parameters:

Name	Type	Default	Description
page	number		the item's page
bank	number		the item bank
clone	boolean	false	whether or not the return should be a deep clone

Returns:

Array.<BankStyle> - the bank array

getInstanceItems(id, clone) → {Object}

lib/Bank/FeedbackItems.js, line 173

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:

• BankItemsBase#getInstanceItems

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]`

Overrides:

• BankItemsBase#getPage

getStyle(page, bank, index, clone) → {BankStyle}

lib/Bank/FeedbackItems.js, line 192

Get the current style for an item

Parameters:

Name	Type	Default	Description
page	number		the item's page
bank	number		the item's bank
index	number		the item's index
clone	boolean	false	whether or not the return should be a deep clone

Returns:

BankStyle - the items array

protected graphics() → {Graphics}

lib/Core/Base.js, line 86

Returns:

Graphics - the core graphics controller

Overrides:

• BankItemsBase#graphics

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

Overrides:

• BankItemsBase#importBank

protected instance() → {InstanceController}

lib/Core/Base.js, line 94

Returns:

InstanceController - the core instance controller

Overrides:

• BankItemsBase#instance

protected io() → {InterfaceClient}

lib/Core/Base.js, line 102

Returns:

InterfaceClient - the core interface client

Overrides:

• BankItemsBase#io

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

Overrides:

• BankItemsBase#log

protected page() → {PageController}

lib/Core/Base.js, line 120

Returns:

PageController - the core page controller

Overrides:

• BankItemsBase#page

resetBank(page, bank)

lib/Bank/FeedbackItems.js, line 213

Unsubscribe, clear a bank, and save

Parameters:

Name	Type	Description
page	number	the bank's page
bank	number	the bank number

Overrides:

• BankItemsBase#resetBank

save()

lib/Bank/ItemsBase.js, line 444

Flag the database to save

Overrides:

• BankItemsBase#save

protected schedule() → {ScheduleController}

lib/Core/Base.js, line 128

Returns:

ScheduleController - the core schedule controller

Overrides:

• BankItemsBase#schedule

protected services() → {ServiceController}

lib/Core/Base.js, line 136

Returns:

ServiceController - the core service controller

Overrides:

• BankItemsBase#services

setDefinitions(definitions)

lib/Bank/ItemsBase.js, line 455

Set a new definitions array

Parameters:

Name	Type	Description
definitions	Array.<BankItemDefinition>	the new definitions

Overrides:

• BankItemsBase#setDefinitions

protected setStyle(page, bank, index, style)

lib/Bank/FeedbackItems.js, line 229

Save the current return style from a feedback

Parameters:

Name	Type	Description
page	number	the item's page
bank	number	the item's bank
index	number	the item's index
style	BankStyle	the current style

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

Overrides:

• BankItemsBase#subscribe

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

Overrides:

• BankItemsBase#subscribeBank

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

Overrides:

• BankItemsBase#unsubscribe

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

Overrides:

• BankItemsBase#unsubscribeBank

updateItemOption(page, bank, item, option, value)

lib/Bank/FeedbackItems.js, line 254

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

Overrides:

• BankItemsBase#updateItemOption

updateItemOrder(page, bank, oldIndex, newIndex)

lib/Bank/FeedbackItems.js, line 279

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

Overrides:

• BankItemsBase#updateItemOrder

protected userconfig() → {UserConfig}

lib/Core/Base.js, line 144

Returns:

UserConfig - the core user config manager

Overrides:

• BankItemsBase#userconfig