Interface RealtimeInterfaceEvents

Describes the events fired by the BasicRealtimeDataContainer and the DetailedRealtimeDataContainer.

Hierarchy

RealtimeInterfaceEvents

Index

Properties

newListener pause removeListener start update valid-update

Properties

newListener

newListener: ((eventName, listener) => void)

Type declaration

- (eventName, listener): void
- Inherited event. Fires when a new event listener is added. See here.
  Parameters
  - eventName: string
  - listener: Function
  Returns void

pause

pause: (() => void)

Type declaration

- (): void
- Fires when the realtime data container's update cycle is paused..
  
  Returns void

removeListener

removeListener: ((eventName, listener) => void)

Type declaration

- (eventName, listener): void
- Inherited event. Fires when a event listener is removed. See here.
  Parameters
  - eventName: string
  - listener: Function
  Returns void

start

start: (() => void)

Type declaration

- (): void
- Fires when the realtime data container's update cycle is started or resumed.
  
  Returns void

update

update: ((err?) => void)

Type declaration

- (err?): void
- Fires when the realtime data container is updated. If an error occurrs while updating an error object is supplied. If you only want to listen for valid updates consider listening for the "valid-update" event.
  Parameters
  - Optional err: any
  Returns void

valid-update

valid-update: (() => void)

Type declaration

- (): void
- Fires when the realtime interface is updated successfully.
  
  Returns void

Generated using TypeDoc