RTKStore

This module represents a single global store. The store can be accessed from the meeting.stores module.

Returns: An instance of RTKStore.
Example

const handRaiseStore = meeting.stores.stores.get('handRaise');

• RTKStore ⇒
  • .set(key, value, [sync], [emit]) ⇒ Promise.<void>
  • .bulkSet(data) ⇒ Promise.<void>
  • .update(key, value, [sync]) ⇒ Promise.<void>
  • .delete(key, [sync], [emit]) ⇒ Promise.<void>
  • .bulkDelete(data) ⇒ Promise.<void>
  • .get(key) ⇒ any
  • .getAll() ⇒ RTKStoreData
  • .clear()
  • .updateRateLimits(num, period)
  • .updateBulkRateLimits(num, period)
  • .subscribe(key, cb) ⇒ void
  • .unsubscribe(key, [cb]) ⇒ void
  • .populate(data)

Sets a value in the store.

Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.

Sets multiple values in the store.

Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.

Updates an already existing value in the store. If the value stored is ['a', 'b'], the operation store.update(key, ['c']) will modify the value to ['a','b','c'].

Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.

Deletes a key value pair form the store.

Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.

Deletes multiple values from the store.

Kind: instance method of RTKStore
Returns: Promise.<void> - A promise.

Returns value for the given key.

Kind: instance method of RTKStore
Returns: any - Value for the given key.

Returns the entire store.

Kind: instance method of RTKStore
Returns: RTKStoreData - An instance of RTKStoreData.

Clears all data in the store.

Kind: instance method of RTKStore

Kind: instance method of RTKStore

Kind: instance method of RTKStore

Listens for data change on a store key.

Kind: instance method of RTKStore
Returns: void - void

Removes all listeners for a key on the store.

Kind: instance method of RTKStore
Returns: void - void

Kind: instance method of RTKStore