Class DirectChat

metadata

path

raw

addDest

• addDest(
      dest: {
          after?: string;
          callsign?: string;
          group?: string;
          mission?: string;
          "mission-guid"?: string;
          path?: string;
          uid?: string;
      },
  ): default

  Add a given Dest tag to a CoT

  Parameters

  • dest: {
        after?: string;
        callsign?: string;
        group?: string;
        mission?: string;
        "mission-guid"?: string;
        path?: string;
        uid?: string;
    }

  Returns default

addLink

• addLink(
      link: {
          callsign?: string;
          mime?: string;
          parent_callsign?: string;
          point?: string;
          production_time?: string;
          relation?: string;
          remarks?: string;
          type?: string;
          uid?: string;
          url?: string;
      },
  ): default

  Parameters

  • link: {
        callsign?: string;
        mime?: string;
        parent_callsign?: string;
        point?: string;
        production_time?: string;
        relation?: string;
        remarks?: string;
        type?: string;
        uid?: string;
        url?: string;
    }

  Returns default

addVideo

• addVideo(
      video: { sensor?: string; spi?: string; uid?: string; url?: string },
      connection?: {
          address: string;
          alias?: string;
          bufferTime?: number;
          ignoreEmbeddedKLV?: boolean;
          networkTimeout?: number;
          path?: string;
          port?: number;
          protocol?: string;
          roverPort?: number;
          rtspReliable?: number;
          uid: string;
      },
  ): default

  Parameters

  • video: { sensor?: string; spi?: string; uid?: string; url?: string }
  • Optionalconnection: {
        address: string;
        alias?: string;
        bufferTime?: number;
        ignoreEmbeddedKLV?: boolean;
        networkTimeout?: number;
        path?: string;
        port?: number;
        protocol?: string;
        roverPort?: number;
        rtspReliable?: number;
        uid: string;
    }

  Returns default

archived

• archived(archived?: boolean): boolean

  Returns or sets the Archived State of the CoT

  Parameters

  • Optionalarchived: boolean

  Returns boolean

callsign

• callsign(callsign?: string): string

  Returns or sets the Callsign of the CoT

  Parameters

  • Optionalcallsign: string

    Optional Callsign to set

  Returns string

creator

• creator(
      creator?: {
          callsign: string;
          time: undefined | string | Date;
          type: string;
          uid: string;
      },
  ): undefined
  | { callsign: string; time: string; type: string; uid: string }

  Parameters

  • Optionalcreator: { callsign: string; time: undefined | string | Date; type: string; uid: string }

  Returns undefined | { callsign: string; time: string; type: string; uid: string }

detail

• detail(): {
      __chat?: {
          _attributes: {
              chatroom: string;
              groupOwner?: string;
              id: string;
              messageId?: string;
              parent?: string;
              senderCallsign: string;
          };
          chatgrp: any;
      };
      __forcedelete?: {};
      __geofence?: {
          _attributes: {
              boundingSphere?: number;
              elevationMonitored?: string;
              maxElevation?: string;
              minElevation?: string;
              monitor?: string;
              tracking?: string;
              trigger?: string;
          };
      };
      __group?: { _attributes?: { name: string; role: string } };
      __milsym?: {
          _attributes: { id: string };
          unitmodifier?:
              | { _attributes: { code: string }; _text?: string }
              | { _attributes: { code: string }; _text?: string }[];
      };
      __routeinfo?: {
          __navcues: {
              __navcue: | {
                  _attributes: { id: string; text: string; voice: string };
                  trigger: { _attributes: { mode: string; value: string } };
              }[]
              | {
                  _attributes: { id: string; text: string; voice: string };
                  trigger: { _attributes: { mode: string; value: string } };
              };
          };
      };
      __shapeExtras?: { _attributes: { cpvis?: boolean; editable?: boolean } };
      __video?: {
          _attributes?: {
              sensor?: string;
              spi?: string;
              uid?: string;
              url?: string;
          };
          ConnectionEntry?: {
              _attributes: {
                  address: string;
                  alias?: string;
                  bufferTime?: number;
                  ignoreEmbeddedKLV?: boolean;
                  networkTimeout?: number;
                  path?: string;
                  port?: number;
                  protocol?: string;
                  roverPort?: number;
                  rtspReliable?: number;
                  uid: string;
              };
          };
      };
      "_flow-tags_"?: any;
      ackrequest?: {
          _attributes: { ackrequested: boolean; tag: string; uid: string };
      };
      archive?: | { _attributes?: { value?: string } }
      | { _attributes?: { value?: string } }[];
      attachment_list?: { _attributes: { hashes: string } };
      bearing?: { _attributes: { value: number } };
      bearingUnits?: { _attributes: { value: number } };
      color?:
          | { _attributes?: { argb?: number; value?: number } }[]
          | { _attributes?: { argb?: number; value?: number } };
      contact?: {
          _attributes: {
              callsign?: string;
              endpoint?: string;
              name?: string;
              phone?: string;
          };
      };
      creator?: {
          _attributes: {
              callsign: string;
              time: string;
              type: string;
              uid: string;
          };
      };
      emergency?: {
          _attributes: { cancel?: boolean; type?: string };
          _text: string;
      };
      fileshare?: {
          _attributes: {
              filename: string;
              name: string;
              senderCallsign: string;
              senderUid: string;
              senderUrl: string;
              sha256: string;
              sizeInBytes: number;
          };
      };
      fillColor?: { _attributes?: { value?: number } };
      inclination?: { _attributes: { value: number } };
      labels_on?: { _attributes?: { value?: boolean } };
      link?:
          | {
              _attributes: {
                  callsign?: string;
                  mime?: string;
                  parent_callsign?: string;
                  point?: string;
                  production_time?: string;
                  relation?: string;
                  remarks?: string;
                  type?: string;
                  uid?: string;
                  url?: string;
              };
          }
          | {
              _attributes: {
                  callsign?: string;
                  mime?: string;
                  parent_callsign?: string;
                  point?: string;
                  production_time?: string;
                  relation?: string;
                  remarks?: string;
                  type?: string;
                  uid?: string;
                  url?: string;
              };
          }[];
      link_attr?: {
          _attributes: {
              color?: number;
              direction?: "Infil"
              | "Exfil";
              method: "Driving" | "Walking" | "Flying" | "Swimming" | "Watercraft";
              order: "Ascending Check Points" | "Descending Check Points";
              planningmethod?: "Infil" | "Exfil";
              prefix: string;
              routetype: "Primary" | "Secondary";
              stroke?: string;
              style?: string;
              type?: string;
          };
      };
      marti?: {
          _attributes?: {};
          dest?: | {
              _attributes: {
                  after?: string;
                  callsign?: string;
                  group?: string;
                  mission?: string;
                  "mission-guid"?: string;
                  path?: string;
                  uid?: string;
              };
          }
          | {
              _attributes: {
                  after?: string;
                  callsign?: string;
                  group?: string;
                  mission?: string;
                  "mission-guid"?: string;
                  path?: string;
                  uid?: string;
              };
          }[];
      };
      mission?: {
          _attributes?: {
              authorUid?: string;
              guid?: string;
              name?: string;
              tool?: string;
              type?: string;
          };
          MissionChanges?: {
              MissionChange: | {
                  contentUid: { _text: string };
                  creatorUid: { _text?: string };
                  details: {
                      _attributes: { callsign?: string; color?: string; type: string };
                      location?: { _attributes: { lat: ...; lon: ... } };
                  };
                  isFederatedChange: { _text: string };
                  missionName: { _text: string };
                  timestamp: { _text: string };
                  type: { _text: string };
              }
              | {
                  contentUid: { _text: string };
                  creatorUid: { _text?: string };
                  details: {
                      _attributes: {
                          callsign?: (...) | (...);
                          color?: (...) | (...);
                          type: string;
                      };
                      location?: { _attributes: ... };
                  };
                  isFederatedChange: { _text: string };
                  missionName: { _text: string };
                  timestamp: { _text: string };
                  type: { _text: string };
              }[];
          };
          missionLayer?: {
              name?: { _text: string };
              parentUid?: { _text: string };
              type?: { _text: string };
              uid?: { _text: string };
          };
      };
      northRef?: { _attributes: { value: number } };
      precisionlocation?: {
          _attributes: { altsrc?: string; geopointsrc?: string };
      };
      range?: { _attributes: { value: number } };
      rangeUnits?: { _attributes: { value: number } };
      remarks?: {
          _attributes?: { source?: string; time?: string; to?: string };
          _text?: string;
      };
      sensor?: {
          _attributes: {
              azimuth?: number;
              displayMagneticReference?: number;
              elevation?: number;
              fov?: number;
              fovAlpha?: number;
              fovBlue?: number;
              fovGreen?: number;
              fovRed?: number;
              hideFov?: boolean;
              model?: string;
              north?: number;
              range?: number;
              rangeLines?: number;
              rangeLineStrokeColor?: number;
              rangeLineStrokeWeight?: number;
              roll?: number;
              strokeColor?: number;
              strokeWeight?: number;
              type?: string;
              version?: string;
              vfov?: number;
          };
      };
      shape?: {
          ellipse?: {
              _attributes: { angle: number; major: number; minor: number };
          };
          link?: | {
              _attributes: { relation?: string; type?: string; uid?: string };
              Style?: {
                  LineStyle?: { color?: (...) | (...); width?: (...) | (...) };
                  PolyStyle?: { color?: (...) | (...); width?: (...) | (...) };
              };
          }[]
          | {
              _attributes: { relation?: string; type?: string; uid?: string };
              Style?: {
                  LineStyle?: { color?: { _text: ... }; width?: { _text: ... } };
                  PolyStyle?: { color?: { _text: ... }; width?: { _text: ... } };
              };
          };
          polyline?: {
              _attributes?: { closed?: boolean; color?: string; fillColor?: string };
              vertex?:
                  | { _attributes: { lat: number; lon: number } }
                  | { _attributes: { lat: number; lon: number } }[];
          };
      };
      status?: { _attributes: { battery?: string; readiness?: string } };
      strokeColor?: { _attributes?: { value?: number } };
      strokeStyle?: { _attributes?: { value?: string } };
      strokeWeight?: { _attributes?: { value?: number } };
      TakControl?: {
          TakProtocolSupport?: { _attributes?: { version?: string } };
          TakServerVersionInfo?: { _attributes?: { serverVersion?: string } };
      };
      takv?: {
          _attributes: {
              device?: string;
              os?: string;
              platform?: string;
              version?: string;
          };
      };
      tog?: { _attributes?: { enabled?: string } };
      track?: {
          _attributes?: {
              course?: string;
              eCourse?: string;
              eSlope?: string;
              eSpeed?: string;
              slope?: string;
              speed?: string;
          };
      };
      uid?: { _attributes: { Droid: string } };
      usericon?: { _attributes: { iconsetpath: string } };
  }

  Return Detail Object of CoT or create one if it doesn't yet exist and pass a reference

  Returns {
      __chat?: {
          _attributes: {
              chatroom: string;
              groupOwner?: string;
              id: string;
              messageId?: string;
              parent?: string;
              senderCallsign: string;
          };
          chatgrp: any;
      };
      __forcedelete?: {};
      __geofence?: {
          _attributes: {
              boundingSphere?: number;
              elevationMonitored?: string;
              maxElevation?: string;
              minElevation?: string;
              monitor?: string;
              tracking?: string;
              trigger?: string;
          };
      };
      __group?: { _attributes?: { name: string; role: string } };
      __milsym?: {
          _attributes: { id: string };
          unitmodifier?:
              | { _attributes: { code: string }; _text?: string }
              | { _attributes: { code: string }; _text?: string }[];
      };
      __routeinfo?: {
          __navcues: {
              __navcue: | {
                  _attributes: { id: string; text: string; voice: string };
                  trigger: { _attributes: { mode: string; value: string } };
              }[]
              | {
                  _attributes: { id: string; text: string; voice: string };
                  trigger: { _attributes: { mode: string; value: string } };
              };
          };
      };
      __shapeExtras?: { _attributes: { cpvis?: boolean; editable?: boolean } };
      __video?: {
          _attributes?: {
              sensor?: string;
              spi?: string;
              uid?: string;
              url?: string;
          };
          ConnectionEntry?: {
              _attributes: {
                  address: string;
                  alias?: string;
                  bufferTime?: number;
                  ignoreEmbeddedKLV?: boolean;
                  networkTimeout?: number;
                  path?: string;
                  port?: number;
                  protocol?: string;
                  roverPort?: number;
                  rtspReliable?: number;
                  uid: string;
              };
          };
      };
      "_flow-tags_"?: any;
      ackrequest?: {
          _attributes: { ackrequested: boolean; tag: string; uid: string };
      };
      archive?: | { _attributes?: { value?: string } }
      | { _attributes?: { value?: string } }[];
      attachment_list?: { _attributes: { hashes: string } };
      bearing?: { _attributes: { value: number } };
      bearingUnits?: { _attributes: { value: number } };
      color?:
          | { _attributes?: { argb?: number; value?: number } }[]
          | { _attributes?: { argb?: number; value?: number } };
      contact?: {
          _attributes: {
              callsign?: string;
              endpoint?: string;
              name?: string;
              phone?: string;
          };
      };
      creator?: {
          _attributes: {
              callsign: string;
              time: string;
              type: string;
              uid: string;
          };
      };
      emergency?: {
          _attributes: { cancel?: boolean; type?: string };
          _text: string;
      };
      fileshare?: {
          _attributes: {
              filename: string;
              name: string;
              senderCallsign: string;
              senderUid: string;
              senderUrl: string;
              sha256: string;
              sizeInBytes: number;
          };
      };
      fillColor?: { _attributes?: { value?: number } };
      inclination?: { _attributes: { value: number } };
      labels_on?: { _attributes?: { value?: boolean } };
      link?:
          | {
              _attributes: {
                  callsign?: string;
                  mime?: string;
                  parent_callsign?: string;
                  point?: string;
                  production_time?: string;
                  relation?: string;
                  remarks?: string;
                  type?: string;
                  uid?: string;
                  url?: string;
              };
          }
          | {
              _attributes: {
                  callsign?: string;
                  mime?: string;
                  parent_callsign?: string;
                  point?: string;
                  production_time?: string;
                  relation?: string;
                  remarks?: string;
                  type?: string;
                  uid?: string;
                  url?: string;
              };
          }[];
      link_attr?: {
          _attributes: {
              color?: number;
              direction?: "Infil"
              | "Exfil";
              method: "Driving" | "Walking" | "Flying" | "Swimming" | "Watercraft";
              order: "Ascending Check Points" | "Descending Check Points";
              planningmethod?: "Infil" | "Exfil";
              prefix: string;
              routetype: "Primary" | "Secondary";
              stroke?: string;
              style?: string;
              type?: string;
          };
      };
      marti?: {
          _attributes?: {};
          dest?: | {
              _attributes: {
                  after?: string;
                  callsign?: string;
                  group?: string;
                  mission?: string;
                  "mission-guid"?: string;
                  path?: string;
                  uid?: string;
              };
          }
          | {
              _attributes: {
                  after?: string;
                  callsign?: string;
                  group?: string;
                  mission?: string;
                  "mission-guid"?: string;
                  path?: string;
                  uid?: string;
              };
          }[];
      };
      mission?: {
          _attributes?: {
              authorUid?: string;
              guid?: string;
              name?: string;
              tool?: string;
              type?: string;
          };
          MissionChanges?: {
              MissionChange: | {
                  contentUid: { _text: string };
                  creatorUid: { _text?: string };
                  details: {
                      _attributes: { callsign?: string; color?: string; type: string };
                      location?: { _attributes: { lat: ...; lon: ... } };
                  };
                  isFederatedChange: { _text: string };
                  missionName: { _text: string };
                  timestamp: { _text: string };
                  type: { _text: string };
              }
              | {
                  contentUid: { _text: string };
                  creatorUid: { _text?: string };
                  details: {
                      _attributes: {
                          callsign?: (...) | (...);
                          color?: (...) | (...);
                          type: string;
                      };
                      location?: { _attributes: ... };
                  };
                  isFederatedChange: { _text: string };
                  missionName: { _text: string };
                  timestamp: { _text: string };
                  type: { _text: string };
              }[];
          };
          missionLayer?: {
              name?: { _text: string };
              parentUid?: { _text: string };
              type?: { _text: string };
              uid?: { _text: string };
          };
      };
      northRef?: { _attributes: { value: number } };
      precisionlocation?: {
          _attributes: { altsrc?: string; geopointsrc?: string };
      };
      range?: { _attributes: { value: number } };
      rangeUnits?: { _attributes: { value: number } };
      remarks?: {
          _attributes?: { source?: string; time?: string; to?: string };
          _text?: string;
      };
      sensor?: {
          _attributes: {
              azimuth?: number;
              displayMagneticReference?: number;
              elevation?: number;
              fov?: number;
              fovAlpha?: number;
              fovBlue?: number;
              fovGreen?: number;
              fovRed?: number;
              hideFov?: boolean;
              model?: string;
              north?: number;
              range?: number;
              rangeLines?: number;
              rangeLineStrokeColor?: number;
              rangeLineStrokeWeight?: number;
              roll?: number;
              strokeColor?: number;
              strokeWeight?: number;
              type?: string;
              version?: string;
              vfov?: number;
          };
      };
      shape?: {
          ellipse?: {
              _attributes: { angle: number; major: number; minor: number };
          };
          link?: | {
              _attributes: { relation?: string; type?: string; uid?: string };
              Style?: {
                  LineStyle?: { color?: (...) | (...); width?: (...) | (...) };
                  PolyStyle?: { color?: (...) | (...); width?: (...) | (...) };
              };
          }[]
          | {
              _attributes: { relation?: string; type?: string; uid?: string };
              Style?: {
                  LineStyle?: { color?: { _text: ... }; width?: { _text: ... } };
                  PolyStyle?: { color?: { _text: ... }; width?: { _text: ... } };
              };
          };
          polyline?: {
              _attributes?: { closed?: boolean; color?: string; fillColor?: string };
              vertex?:
                  | { _attributes: { lat: number; lon: number } }
                  | { _attributes: { lat: number; lon: number } }[];
          };
      };
      status?: { _attributes: { battery?: string; readiness?: string } };
      strokeColor?: { _attributes?: { value?: number } };
      strokeStyle?: { _attributes?: { value?: string } };
      strokeWeight?: { _attributes?: { value?: number } };
      TakControl?: {
          TakProtocolSupport?: { _attributes?: { version?: string } };
          TakServerVersionInfo?: { _attributes?: { serverVersion?: string } };
      };
      takv?: {
          _attributes: {
              device?: string;
              os?: string;
              platform?: string;
              version?: string;
          };
      };
      tog?: { _attributes?: { enabled?: string } };
      track?: {
          _attributes?: {
              course?: string;
              eCourse?: string;
              eSlope?: string;
              eSpeed?: string;
              slope?: string;
              speed?: string;
          };
      };
      uid?: { _attributes: { Droid: string } };
      usericon?: { _attributes: { iconsetpath: string } };
  }

is_airborne

• is_airborne(): boolean

  Determines if the CoT message represents an Airborne Element

  Returns boolean

is_assumed

• is_assumed(): boolean

  Determines if the CoT message represents an Assumed Element

  Returns boolean

is_atom

• is_atom(): boolean

  Determines if the CoT message represents an Element

  Returns boolean

is_chat

• is_chat(): boolean

  Determines if the CoT message represents a Chat Message

  Returns boolean

is_equipment

• is_equipment(): boolean

  Determines if the CoT message represents Equipment

  Returns boolean

is_faker

• is_faker(): boolean

  Determines if the CoT message represents a Faker Element

  Returns boolean

is_friend

• is_friend(): boolean

  Determines if the CoT message represents a Friendly Element

  Returns boolean

is_ground

• is_ground(): boolean

  Determines if the CoT message represents a Ground Element

  Returns boolean

is_hostile

• is_hostile(): boolean

  Determines if the CoT message represents a Hostile Element

  Returns boolean

is_installation

• is_installation(): boolean

  Determines if the CoT message represents an Installation

  Returns boolean

is_joker

• is_joker(): boolean

  Determines if the CoT message represents a Joker Element

  Returns boolean

is_neutral

• is_neutral(): boolean

  Determines if the CoT message represents a Neutral Element

  Returns boolean

is_pending

• is_pending(): boolean

  Determines if the CoT message represents a Pending Element

  Returns boolean

is_stale

• is_stale(): boolean

  Returns boolean

is_subsurface

• is_subsurface(): boolean

  Determines if the CoT message represents a Subsurface Element

  Returns boolean

is_surface

• is_surface(): boolean

  Determines if the CoT message represents a Surface Element

  Returns boolean

is_suspect

• is_suspect(): boolean

  Determines if the CoT message represents a Suspect Element

  Returns boolean

is_tasking

• is_tasking(): boolean

  Determines if the CoT message represents a Tasking Message

  Returns boolean

is_uav

• is_uav(): boolean

  Determines if the CoT message represents a UAV Element

  Returns boolean

is_unknown

• is_unknown(): boolean

  Determines if the CoT message represents a Unknown Element

  Returns boolean

is_vehicle

• is_vehicle(): boolean

  Determines if the CoT message represents a Vehicle

  Returns boolean

position

• position(position?: number[]): number[]

  Parameters

  • Optionalposition: number[]

  Returns number[]

sensor

• sensor(
      sensor?: {
          azimuth?: number;
          displayMagneticReference?: number;
          elevation?: number;
          fov?: number;
          fovAlpha?: number;
          fovBlue?: number;
          fovGreen?: number;
          fovRed?: number;
          hideFov?: boolean;
          model?: string;
          north?: number;
          range?: number;
          rangeLines?: number;
          rangeLineStrokeColor?: number;
          rangeLineStrokeWeight?: number;
          roll?: number;
          strokeColor?: number;
          strokeWeight?: number;
          type?: string;
          version?: string;
          vfov?: number;
      },
  ): null
  | { coordinates: number[][][]; type: "Polygon" }

  Parameters

  • Optionalsensor: {
        azimuth?: number;
        displayMagneticReference?: number;
        elevation?: number;
        fov?: number;
        fovAlpha?: number;
        fovBlue?: number;
        fovGreen?: number;
        fovRed?: number;
        hideFov?: boolean;
        model?: string;
        north?: number;
        range?: number;
        rangeLines?: number;
        rangeLineStrokeColor?: number;
        rangeLineStrokeWeight?: number;
        roll?: number;
        strokeColor?: number;
        strokeWeight?: number;
        type?: string;
        version?: string;
        vfov?: number;
    }

  Returns null | { coordinates: number[][][]; type: "Polygon" }

type

• type(type?: string): string

  Returns or sets the Callsign of the CoT

  Parameters

  • Optionaltype: string

  Returns string

uid

• uid(uid?: string): string

  Returns or sets the UID of the CoT

  Parameters

  • Optionaluid: string

  Returns string

Staticping

• ping(): default

  Return a CoT Message

  Returns default