Class Fleet

Device context and query helpers for embedded custom modules. Not related to the admin-api /fleets resource (removed).

Constructors

constructor

Properties

defaultDeviceId getAnalyticsRows getDevices getEvent getLatestTelemetry getOnlineDevices getStreams getViews groupDevices knownContext patchView queryDevices queryTelemetry

Methods

getCurrentDevice getDevice getGroupDevices getGroupDevicesAsDeviceInstances getPeerDevice setDefaultDevice setGroupDevices

Constructors

constructor

Properties

Static defaultDeviceId

defaultDeviceId: undefined | string

Static getAnalyticsRows

getAnalyticsRows: ((query) => Promise<any>) = getAnalyticsRows

Type declaration

    • (query): Promise<any>

    • Retrieves all rows sqlQuery is required

      Parameters

      Returns Promise<any>

Static getDevices

getDevices: (() => Promise<Device[]>) = getDevices

Type declaration

Static getEvent

getEvent: ((uuid) => Promise<IEvent>) = getEvent

Type declaration

    • (uuid): Promise<IEvent>

    • Parameters

      • uuid: string

      Returns Promise<IEvent>

Static getLatestTelemetry

getLatestTelemetry: ((...ids) => Promise<IStreamCurrentValue<keyof IStreamTypeMap>[]>) = getLatestTelemetry

Type declaration

Static getOnlineDevices

getOnlineDevices: (() => Promise<Device[]>) = getOnlineDevices

Type declaration

Static getStreams

getStreams: (() => Promise<IStream[]>) = getStreams

Type declaration

Static getViews

getViews: (() => Promise<IView[]>) = getViews

Type declaration

Static groupDevices

groupDevices: undefined | IDevice[]

Static knownContext

knownContext: WeakRef<Device>[] = []

Static patchView

patchView: ((view) => Promise<IView>) = patchView

Type declaration

Static queryDevices

queryDevices: ((query) => Promise<Device[]>) = queryDevices

Type declaration

Static queryTelemetry

queryTelemetry: ((query) => Promise<IStreamData<keyof IStreamTypeMap>[]>) = queryTelemetry

Type declaration

Methods

Static getCurrentDevice

Static getDevice

Static getGroupDevices

Static getGroupDevicesAsDeviceInstances

Static getPeerDevice

Static setDefaultDevice

  • setDefaultDevice(deviceId): Promise<void>

  • Parameters

    • deviceId: string

    Returns Promise<void>

Static setGroupDevices

Settings

Member Visibility

Theme

On This Page

constructordefaultDeviceIdgetAnalyticsRowsgetDevicesgetEventgetLatestTelemetrygetOnlineDevicesgetStreamsgetViewsgroupDevicesknownContextpatchViewqueryDevicesqueryTelemetrygetCurrentDevicegetDevicegetGroupDevicesgetGroupDevicesAsDeviceInstancesgetPeerDevicesetDefaultDevicesetGroupDevices