Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GatewaysSnapshot

The GatewaysSnapshot class is used to retrieve a per-gateway summary of connection and bandwidth statistics. By default, access to gateway data requires administrator privileges.

GatewaysSnapshot represents a one-time snapshot of the state of the server, and is not kept up to date after it is loaded.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly target

target: EventDispatcher

Methods

addEventListener

  • addEventListener(type: string, listener: Function, thisArg: any, priority?: number): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any
    • Default value priority: number = 0

    Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

getGateways

  • Returns an array of Gateway objects providing information about the gateways on the server.

    Returns Gateway[] | null

getListeners

  • getListeners(type: string): EventListener[]

  • Parameters

    • type: string

    Returns EventListener[]

getStatus

  • getStatus(): Status | undefined

  • Returns the status of the most recent snapshot load-operation. If a load operation is currently in progress, getStatus() returns null. The possible return values of getStatus() depend on the snapshot type.

    Returns Status | undefined

hasListener

  • hasListener(type: string, listener: Function, thisArg: any): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: Function, thisArg: any): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

updateInProgress

  • updateInProgress(): boolean | undefined

  • Indicates whether the snapshot is currently loading data. While an update is in progress, further requests to update the snapshot are ignored.

    Returns boolean | undefined