Interface IAnnotationQuery

interface IAnnotationQuery {
    aggregate?: AggregateLevel;
    annotationName?: string;
    annotationTemplateIds?: string[];
    count?: number;
    deviceIds?: string[];
    disableNullMatches?: boolean;
    end?: string;
    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")[];
    id?: string;
    keyword?: string;
    message?: string;
    names?: string[];
    notNames?: string[];
    notificationEnabled?: boolean;
    offset?: number;
    severities?: ("error" | "info" | "warning" | "critical")[];
    sort?: IEventSort;
    start?: string;
    tagKey?: string;
    tags?: ITagSets;
    types?: (keyof IStreamTypeMap)[];
    userIds?: string[];
    viewed?: boolean;
}

Hierarchy (view full)

Properties

aggregate? annotationName? annotationTemplateIds? count? deviceIds? disableNullMatches? end? eventTypes? id? keyword? message? names? notNames? notificationEnabled? offset? severities? sort? start? tagKey? tags? types? userIds? viewed?

Properties

Optional aggregate

aggregate?: AggregateLevel

Optional annotationName

annotationName?: string

Optional annotationTemplateIds

annotationTemplateIds?: string[]

Optional count

count?: number

Optional deviceIds

deviceIds?: string[]

Optional disableNullMatches

disableNullMatches?: boolean

Optional end

end?: string

Optional eventTypes

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")[]

Optional id

id?: string

Optional keyword

keyword?: string

Optional message

message?: string

Optional names

names?: string[]

Optional notNames

notNames?: string[]

Optional notificationEnabled

notificationEnabled?: boolean

Optional offset

offset?: number

Optional severities

severities?: ("error" | "info" | "warning" | "critical")[]

Optional sort

sort?: IEventSort

Optional start

start?: string

Optional tagKey

tagKey?: string

Optional tags

tags?: ITagSets

Optional types

types?: (keyof IStreamTypeMap)[]

Optional userIds

userIds?: string[]

Optional viewed

viewed?: boolean

Settings

Member Visibility

Theme

On This Page

aggregateannotationNameannotationTemplateIdscountdeviceIdsdisableNullMatchesendeventTypesidkeywordmessagenamesnotNamesnotificationEnabledoffsetseveritiessortstarttagKeytagstypesuserIdsviewed

Generated using TypeDoc