Properties Static
add Device To Fleet add Device To Fleet : ( ( deviceId , fleetId ) => Promise < any > ) = addDeviceToFleet
Type declaration ( deviceId , fleetId ) : Promise < any > Parameters deviceId : string fleetId : string Returns Promise < any > Static
aggregate Telemetry Static
create Fleet create Fleet : ( ( fleet ) => Promise < IFleet > ) = createFleet Static
create Share Link create Share Link : ( ( share , view ) => Promise < null | string > ) = createShareLink
Type declaration ( share , view ) : Promise < null | string > Returns Promise < null | string > Static
default Device Id default Device Id : undefined | string
Static
delete Fleet delete Fleet : ( ( id ) => Promise < void > ) = deleteFleet
Type declaration ( id ) : Promise < void > Returns Promise < void > Static
events Counter events Counter : ( ( eventTypes ,
timeFrame ,
range ,
time ,
query ? ) => Promise < { date : string ; events : IEvent [] ; } [] > ) = eventsCounter Type declaration ( eventTypes , timeFrame , range , time , query ? ) : Promise < { date : string ; events : IEvent [] ; } [] > Parameters eventTypes : ( "custom" | "annotation" | "triggered-event" | "datapoint-event" | "device-online" | "device-offline" | "intervention-request" | "teleop-session-record" | "port-forwarding-session-record" | "command-request" | "command-response" | "command-delivery" | "intervention-response" | "comment" | "system" | "task-summary" | "stateful" ) [] timeFrame : AggregateLevel range : number time : number Optional
query : IEventQuery Returns Promise < { date : string ; events : IEvent [] ; } [] > Static
get All Event Trigger Group get All Event Trigger Group : ( ( ) => Promise < IEventTriggerGroup [] > ) = getAllEventTriggerGroup
Type declaration ( ) : Promise < IEventTriggerGroup [] > Returns Promise < IEventTriggerGroup [] > Static
get Analytic Streams get Analytic Streams : ( ( ) => Promise < IStreamColumn [] > ) = getAnalyticStreams Static
get Analytics Modules Static
get Analytics Rows get Analytics Rows : ( ( query ) => Promise < any > ) = getAnalyticsRows
Type declaration ( query ) : Promise < any > Returns Promise < any > Static
get Annotation Count get Annotation Count : ( ( query , tagKey ) => Promise < { [key : string ]: number ; } > ) = getAnnotationCount
Type declaration ( query , tagKey ) : Promise < { [key : string ]: number ; } > Returns Promise < { [key : string ]: number ; } > Static
get Annotation Count By Intervals get Annotation Count By Intervals : ( ( query , tagKey , aggregate ) => Promise < { annotations : { [key : string ]: number ; } ; date : string ; } [] > ) = getAnnotationCountByIntervals
Type declaration ( query , tagKey , aggregate ) : Promise < { annotations : { [key : string ]: number ; } ; date : string ; } [] > Returns Promise < { annotations : { [key : string ]: number ; } ; date : string ; } [] > Static
get Current Group get Current Group : ( ( ) => Promise < Device [] | undefined > ) = getCurrentGroup Type declaration ( ) : Promise < Device [] | undefined > Returns Promise < Device [] | undefined > Static
get Devices get Devices : ( ( ) => Promise < Device [] > ) = getDevices Static
get Event get Event : ( ( uuid ) => Promise < IEvent > ) = getEvent Static
get Event Trigger Group get Event Trigger Group : ( ( id ) => Promise < IEventTriggerGroup > ) = getEventTriggerGroup
Type declaration ( id ) : Promise < IEventTriggerGroup > Returns Promise < IEventTriggerGroup > Static
get File Url get File Url : ( ( uuid ) => Promise < string > ) = getFileUrl
Type declaration ( uuid ) : Promise < string > Returns Promise < string > Static
get Fleet get Fleet : ( ( id ) => Promise < IFleet > ) = getFleet Static
get Fleet Devices get Fleet Devices : ( ( id ) => Promise < void > ) = getFleetDevices
Type declaration ( id ) : Promise < void > Returns Promise < void > Static
get Interventions get Interventions : ( ( ) => Promise < IEvent [] > ) = getInterventions Static
get Latest Telemetry Static
get Online Devices get Online Devices : ( ( ) => Promise < Device [] > ) = getOnlineDevices Static
get Peers get Peers : ( ( ) => Promise < IRtcPeer [] > ) = getPeers
Type declaration ( ) : Promise < IRtcPeer [] > Returns Promise < IRtcPeer [] > Static
get Realtime Devices get Realtime Devices : ( ( ) => Promise < Device [] > ) = getRealtimeDevices Static
get Realtime Sessions get Realtime Sessions : ( ( ) => Promise < { [ key in string ] : string [] } > ) = getRealtimeSessions
Type declaration ( ) : Promise < { [ key in string ] : string [] } > Returns Promise < { [ key in string ] : string [] } > Static
get Streams get Streams : ( ( ) => Promise < IStream [] > ) = getStreams Static
get Task Report Rows get Task Report Rows : ( ( query ) => Promise < any > ) = getTaskReportRows
Type declaration ( query ) : Promise < any > Returns Promise < any > Static
get Task Report Tables Static
get Telemetry get Telemetry : ( ( deviceIdOrDeviceIds ,
streamNameOrStreamNames ,
start ,
end ,
tags ? ,
latestOnly ? ) => Promise < TelemetryResult [] > ) = getTelemetry Type declaration ( deviceIdOrDeviceIds , streamNameOrStreamNames , start , end , tags ? , latestOnly ? ) : Promise < TelemetryResult [] > Parameters deviceIdOrDeviceIds : string | string [] streamNameOrStreamNames : string | string [] start : Date end : Date Optional
tags : {} Optional
latestOnly : boolean Static
get Views get Views : ( ( ) => Promise < IView [] > ) = getViews Static
known Context known Context : WeakRef < Device > [] = [] Static
list Fleets list Fleets : ( ( ) => Promise < IFleet [] > ) = listFleets Static
patch Event Triggergroup patch Event Triggergroup : ( ( id , eventTrigger ) => Promise < IEventTriggerGroup > ) = patchEventTriggerGroup
Type declaration ( id , eventTrigger ) : Promise < IEventTriggerGroup > Parameters id : string eventTrigger : Partial < IEventTriggerGroup > Returns Promise < IEventTriggerGroup > Static
patch Fleet patch Fleet : ( ( id ,
role ) => Promise < IFleet > ) = patchFleet Type declaration ( id , role ) : Promise < IFleet > Parameters id : string role : Partial < IFleet > Returns Promise < IFleet > Static
patch Stream patch Stream : ( ( stream ) => Promise < IStream > ) = patchStream Static
patch View patch View : ( ( view ) => Promise < IView > ) = patchView Static
query Analytics query Analytics : ( ( query ) => Promise < ISqlResult > ) = queryAnalytics Static
query Devices query Devices : ( ( query ) => Promise < Device [] > ) = queryDevices Static
query Events query Events : ( ( query ) => Promise < IEvent [] > ) = queryEvents
View name