Class FileShare

Convert to and from an XML CoT message

Param: cot

A string/buffer containing the XML representation or the xml-js object tree

Hierarchy (view full)

default
- FileShare

Constructors

constructor

new FileShare(fileshare): FileShare
Parameters
- fileshare: {
      filename: string;
      name: string;
      senderCallsign: string;
      senderUid: string;
      senderUrl: string;
      sha256: string;
      sizeInBytes: number;
  }
  - filename: string
  - name: string
  - senderCallsign: string
  - senderUid: string
  - senderUrl: string
  - sha256: string
  - sizeInBytes: number
Returns FileShare
Overrides default.constructor
- Defined in lib/fileshare.ts:8

Properties

metadata

metadata: Record<string, unknown>

raw

raw: {
    event: {
        _attributes: {
            access?: string;
            how?: string;
            opex?: string;
            qos?: string;
            stale: string;
            start: string;
            time: string;
            type: string;
            uid: string;
            version: string;
        };
        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;
                };
            };
            __video?: {
                _attributes?: {
                    sensor?: string;
                    spi?: string;
                    url?: 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: string;
                };
            };
            bearingUnits?: {
                _attributes: {
                    value: string;
                };
            };
            color?: {
                _attributes?: {
                    argb?: string;
                };
            };
            contact?: {
                _attributes: {
                    callsign: string;
                    endpoint?: string;
                    name?: string;
                    phone?: string;
                };
            };
            fileshare?: {
                _attributes: {
                    filename: string;
                    name: string;
                    senderCallsign: string;
                    senderUid: string;
                    senderUrl: string;
                    sha256: string;
                    sizeInBytes: number;
                };
            };
            fillColor?: {
                _attributes?: {
                    value?: string;
                };
            };
            inclination?: {
                _attributes: {
                    value: string;
                };
            };
            labels_on?: {
                _attributes?: {
                    value?: string;
                };
            };
            link?: {
                _attributes: {
                    mime?: string;
                    parent_callsign?: string;
                    point?: string;
                    production_time?: string;
                    relation?: string;
                    remarks?: string;
                    type?: string;
                    uid?: string;
                    url?: string;
                };
            } | {
                _attributes: {
                    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;
                    type?: string;
                };
            };
            marti?: {
                _attributes?: {};
                dest?: {
                    _attributes: {
                        after?: string;
                        callsign?: string;
                        mission?: string;
                        path?: string;
                        uid?: string;
                    };
                } | {
                    _attributes: {
                        after?: (...) | (...);
                        callsign?: (...) | (...);
                        mission?: (...) | (...);
                        path?: (...) | (...);
                        uid?: (...) | (...);
                    };
                }[];
            };
            mission?: {
                _attributes?: {
                    authorUid?: string;
                    guid?: string;
                    name?: string;
                    tool?: string;
                    type?: string;
                };
                MissionChanges?: {
                    MissionChange: {
                        contentUid: {
                            _text: ...;
                        };
                        creatorUid: {
                            _text: ...;
                        };
                        details: {
                            _attributes: ...;
                            location?: ...;
                        };
                        isFederatedChange: {
                            _text: ...;
                        };
                        missionName: {
                            _text: ...;
                        };
                        timestamp: {
                            _text: ...;
                        };
                        type: {
                            _text: ...;
                        };
                    } | {
                        contentUid: ...;
                        creatorUid: ...;
                        details: ...;
                        isFederatedChange: ...;
                        missionName: ...;
                        timestamp: ...;
                        type: ...;
                    }[];
                };
                missionLayer?: {
                    name?: {
                        _text: string;
                    };
                    parentUid?: {
                        _text: string;
                    };
                    type?: {
                        _text: string;
                    };
                    uid?: {
                        _text: string;
                    };
                };
            };
            northRef?: {
                _attributes: {
                    value: string;
                };
            };
            precisionlocation?: {
                _attributes: {
                    altsrc?: string;
                    geopointsrc?: string;
                };
            };
            range?: {
                _attributes: {
                    value: string;
                };
            };
            rangeUnits?: {
                _attributes: {
                    value: string;
                };
            };
            remarks?: {
                _attributes?: {
                    source?: string;
                    time?: string;
                    to?: string;
                };
                _text?: string;
            };
            sensor?: {
                _attributes: {
                    azimuth?: string;
                    elevation?: string;
                    fov?: string;
                    model?: string;
                    north?: string;
                    range?: string;
                    roll?: string;
                    type?: string;
                    version?: string;
                    vfov?: string;
                };
            };
            shape?: {
                ellipse?: {
                    _attributes: {
                        angle: number;
                        major: number;
                        minor: number;
                    };
                };
                polyline?: {
                    _attributes?: {
                        closed?: (...) | (...) | (...);
                        color?: (...) | (...);
                        fillColor?: (...) | (...);
                    };
                    vertex: {
                        _attributes: {
                            lat: ...;
                            lon: ...;
                        };
                    } | {
                        _attributes: ...;
                    }[];
                };
            };
            status?: {
                _attributes: {
                    battery?: string;
                    readiness?: string;
                };
            };
            strokeColor?: {
                _attributes?: {
                    value?: string;
                };
            };
            strokeStyle?: {
                _attributes?: {
                    value?: string;
                };
            };
            strokeWeight?: {
                _attributes?: {
                    value?: string;
                };
            };
            TakControl?: {
                TakProtocolSupport?: {
                    _attributes?: {
                        version?: (...) | (...);
                    };
                };
                TakServerVersionInfo?: {
                    _attributes?: {
                        serverVersion?: (...) | (...);
                    };
                };
            };
            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;
                };
            };
        };
        point: {
            _attributes: {
                ce: string | number;
                hae: string | number;
                lat: string | number;
                le: string | number;
                lon: string | number;
            };
        };
    };
}

Raw XML-JS representation of CoT

Methods

addDest

addDest(dest): void
Add a given Dest tag to a CoT
Parameters
- dest: {
      after?: string;
      callsign?: string;
      mission?: string;
      path?: string;
      uid?: string;
  }
  - Optionalafter?: string
  - Optionalcallsign?: string
  - Optionalmission?: string
  - Optionalpath?: string
  - Optionaluid?: string
Returns void
Inherited from default.addDest
- Defined in lib/cot.ts:147

addLink

addLink(link): void
Parameters
- link: {
      mime?: string;
      parent_callsign?: string;
      point?: string;
      production_time?: string;
      relation?: string;
      remarks?: string;
      type?: string;
      uid?: string;
      url?: string;
  }
  - Optionalmime?: string
  - Optionalparent_callsign?: string
  - Optionalpoint?: string
  - Optionalproduction_time?: string
  - Optionalrelation?: string
  - Optionalremarks?: string
  - Optionaltype?: string
  - Optionaluid?: string
  - Optionalurl?: string
Returns void
Inherited from default.addLink
- Defined in lib/cot.ts:163

is_airborne

is_airborne(): boolean
Determines if the CoT message represents an Airborne Element

Returns boolean
Inherited from default.is_airborne
- Defined in lib/cot.ts:970

is_assumed

is_assumed(): boolean
Determines if the CoT message represents an Assumed Element

Returns boolean
Inherited from default.is_assumed
- Defined in lib/cot.ts:916

is_atom

is_atom(): boolean
Determines if the CoT message represents an Element

Returns boolean
Inherited from default.is_atom
- Defined in lib/cot.ts:961

is_chat

is_chat(): boolean
Determines if the CoT message represents a Chat Message

Returns boolean
Inherited from default.is_chat
- Defined in lib/cot.ts:871

is_equipment

is_equipment(): boolean
Determines if the CoT message represents Equipment

Returns boolean
Inherited from default.is_equipment
- Defined in lib/cot.ts:1006

is_faker

is_faker(): boolean
Determines if the CoT message represents a Faker Element

Returns boolean
Inherited from default.is_faker
- Defined in lib/cot.ts:952

is_friend

is_friend(): boolean
Determines if the CoT message represents a Friendly Element

Returns boolean
Inherited from default.is_friend
- Defined in lib/cot.ts:880

is_ground

is_ground(): boolean
Determines if the CoT message represents a Ground Element

Returns boolean
Inherited from default.is_ground
- Defined in lib/cot.ts:979

is_hostile

is_hostile(): boolean
Determines if the CoT message represents a Hostile Element

Returns boolean
Inherited from default.is_hostile
- Defined in lib/cot.ts:889

is_installation

is_installation(): boolean
Determines if the CoT message represents an Installation

Returns boolean
Inherited from default.is_installation
- Defined in lib/cot.ts:988

is_joker

is_joker(): boolean
Determines if the CoT message represents a Joker Element

Returns boolean
Inherited from default.is_joker
- Defined in lib/cot.ts:943

is_neutral

is_neutral(): boolean
Determines if the CoT message represents a Neutral Element

Returns boolean
Inherited from default.is_neutral
- Defined in lib/cot.ts:925

is_pending

is_pending(): boolean
Determines if the CoT message represents a Pending Element

Returns boolean
Inherited from default.is_pending
- Defined in lib/cot.ts:907

is_subsurface

is_subsurface(): boolean
Determines if the CoT message represents a Subsurface Element

Returns boolean
Inherited from default.is_subsurface
- Defined in lib/cot.ts:1024

is_surface

is_surface(): boolean
Determines if the CoT message represents a Surface Element

Returns boolean
Inherited from default.is_surface
- Defined in lib/cot.ts:1015

is_suspect

is_suspect(): boolean
Determines if the CoT message represents a Suspect Element

Returns boolean
Inherited from default.is_suspect
- Defined in lib/cot.ts:934

is_tasking

is_tasking(): boolean
Determines if the CoT message represents a Tasking Message

Returns boolean
Inherited from default.is_tasking
- Defined in lib/cot.ts:862

is_uav

is_uav(): boolean
Determines if the CoT message represents a UAV Element

Returns boolean
Inherited from default.is_uav
- Defined in lib/cot.ts:1033

is_unknown

is_unknown(): boolean
Determines if the CoT message represents a Unknown Element

Returns boolean
Inherited from default.is_unknown
- Defined in lib/cot.ts:898

is_vehicle

is_vehicle(): boolean
Determines if the CoT message represents a Vehicle

Returns boolean
Inherited from default.is_vehicle
- Defined in lib/cot.ts:997

isDiff

isDiff(cot, opts?): boolean
Detect difference between CoT messages Note: This diffs based on GeoJSON Representation of message So if unknown properties are present they will be excluded from the diff
Parameters
- cot: default
- opts: {
      diffDest: boolean;
      diffFlow: boolean;
      diffMetadata: boolean;
      diffStaleStartTime: boolean;
  } = ...
  - diffDest: boolean
  - diffFlow: boolean
  - diffMetadata: boolean
  - diffStaleStartTime: boolean
Returns boolean
Inherited from default.isDiff
- Defined in lib/cot.ts:95

to_geojson

to_geojson(): {
    geometry: {
        coordinates: number[];
        type: "Point";
    } | {
        coordinates: number[][];
        type: "LineString";
    } | {
        coordinates: number[][][];
        type: "Polygon";
    };
    id: string;
    properties: {
        ackrequest?: {
            ackrequested: boolean;
            tag: string;
            uid: string;
        };
        archived?: boolean;
        attachments?: string[];
        callsign: string;
        center: number[];
        chat?: {
            chatgrp: any;
            chatroom: string;
            groupOwner?: string;
            id: string;
            messageId?: string;
            parent?: string;
            senderCallsign: string;
        };
        contact?: {
            endpoint?: string;
            phone?: string;
        };
        course?: number;
        dest?: {
            after?: string;
            callsign?: string;
            mission?: string;
            path?: string;
            uid?: string;
        } | {
            after?: string;
            callsign?: string;
            mission?: string;
            path?: string;
            uid?: string;
        }[];
        droid?: string;
        fileshare?: {
            filename: string;
            name: string;
            senderCallsign: string;
            senderUid: string;
            senderUrl: string;
            sha256: string;
            sizeInBytes: number;
        };
        fill?: string;
        fill-opacity?: number;
        flow?: {};
        geofence?: {
            boundingSphere?: number;
            elevationMonitored?: string;
            maxElevation?: string;
            minElevation?: string;
            monitor?: string;
            tracking?: string;
            trigger?: string;
        };
        group?: {
            name: string;
            role: string;
        };
        how: string;
        icon?: string;
        links?: {
            mime?: string;
            parent_callsign?: string;
            point?: string;
            production_time?: string;
            relation?: string;
            remarks?: string;
            type?: string;
            uid?: string;
            url?: string;
        }[];
        marker-color?: string;
        marker-opacity?: number;
        metadata?: {};
        mission?: {
            authorUid?: string;
            guid?: string;
            missionChanges?: {
                contentUid: string;
                creatorUid: string;
                details: {
                    callsign: string;
                    color: string;
                    lat: string;
                    lon: string;
                    type: string;
                };
                isFederatedChange: string;
                missionName: string;
                timestamp: string;
                type: string;
            }[];
            missionLayer?: {
                name?: string;
                parentUid?: string;
                type?: string;
                uid?: string;
            };
            name?: string;
            tool?: string;
            type?: string;
        };
        precisionlocation?: {
            altsrc?: string;
            geopointsrc?: string;
        };
        remarks?: string;
        sensor?: {
            azimuth?: string;
            elevation?: string;
            fov?: string;
            model?: string;
            north?: string;
            range?: string;
            roll?: string;
            type?: string;
            version?: string;
            vfov?: string;
        };
        shape?: {
            ellipse?: {
                angle: number;
                major: number;
                minor: number;
            };
        };
        slope?: number;
        speed?: number;
        stale: string;
        start: string;
        status?: {
            battery?: string;
            readiness?: string;
        };
        stroke?: string;
        stroke-opacity?: number;
        stroke-style?: string;
        stroke-width?: number;
        takv?: {
            device?: string;
            os?: string;
            platform?: string;
            version?: string;
        };
        time: string;
        track?: {
            course?: string;
            eCourse?: string;
            eSlope?: string;
            eSpeed?: string;
            slope?: string;
            speed?: string;
        };
        type: string;
        video?: {
            sensor?: string;
            spi?: string;
            url?: string;
        };
    };
    type: string;
}
Return a GeoJSON Feature from an XML CoT message

Returns {
    geometry: {
        coordinates: number[];
        type: "Point";
    } | {
        coordinates: number[][];
        type: "LineString";
    } | {
        coordinates: number[][][];
        type: "Polygon";
    };
    id: string;
    properties: {
        ackrequest?: {
            ackrequested: boolean;
            tag: string;
            uid: string;
        };
        archived?: boolean;
        attachments?: string[];
        callsign: string;
        center: number[];
        chat?: {
            chatgrp: any;
            chatroom: string;
            groupOwner?: string;
            id: string;
            messageId?: string;
            parent?: string;
            senderCallsign: string;
        };
        contact?: {
            endpoint?: string;
            phone?: string;
        };
        course?: number;
        dest?: {
            after?: string;
            callsign?: string;
            mission?: string;
            path?: string;
            uid?: string;
        } | {
            after?: string;
            callsign?: string;
            mission?: string;
            path?: string;
            uid?: string;
        }[];
        droid?: string;
        fileshare?: {
            filename: string;
            name: string;
            senderCallsign: string;
            senderUid: string;
            senderUrl: string;
            sha256: string;
            sizeInBytes: number;
        };
        fill?: string;
        fill-opacity?: number;
        flow?: {};
        geofence?: {
            boundingSphere?: number;
            elevationMonitored?: string;
            maxElevation?: string;
            minElevation?: string;
            monitor?: string;
            tracking?: string;
            trigger?: string;
        };
        group?: {
            name: string;
            role: string;
        };
        how: string;
        icon?: string;
        links?: {
            mime?: string;
            parent_callsign?: string;
            point?: string;
            production_time?: string;
            relation?: string;
            remarks?: string;
            type?: string;
            uid?: string;
            url?: string;
        }[];
        marker-color?: string;
        marker-opacity?: number;
        metadata?: {};
        mission?: {
            authorUid?: string;
            guid?: string;
            missionChanges?: {
                contentUid: string;
                creatorUid: string;
                details: {
                    callsign: string;
                    color: string;
                    lat: string;
                    lon: string;
                    type: string;
                };
                isFederatedChange: string;
                missionName: string;
                timestamp: string;
                type: string;
            }[];
            missionLayer?: {
                name?: string;
                parentUid?: string;
                type?: string;
                uid?: string;
            };
            name?: string;
            tool?: string;
            type?: string;
        };
        precisionlocation?: {
            altsrc?: string;
            geopointsrc?: string;
        };
        remarks?: string;
        sensor?: {
            azimuth?: string;
            elevation?: string;
            fov?: string;
            model?: string;
            north?: string;
            range?: string;
            roll?: string;
            type?: string;
            version?: string;
            vfov?: string;
        };
        shape?: {
            ellipse?: {
                angle: number;
                major: number;
                minor: number;
            };
        };
        slope?: number;
        speed?: number;
        stale: string;
        start: string;
        status?: {
            battery?: string;
            readiness?: string;
        };
        stroke?: string;
        stroke-opacity?: number;
        stroke-style?: string;
        stroke-width?: number;
        takv?: {
            device?: string;
            os?: string;
            platform?: string;
            version?: string;
        };
        time: string;
        track?: {
            course?: string;
            eCourse?: string;
            eSlope?: string;
            eSpeed?: string;
            slope?: string;
            speed?: string;
        };
        type: string;
        video?: {
            sensor?: string;
            spi?: string;
            url?: string;
        };
    };
    type: string;
}
- geometry: {
      coordinates: number[];
      type: "Point";
  } | {
      coordinates: number[][];
      type: "LineString";
  } | {
      coordinates: number[][][];
      type: "Polygon";
  }
- id: string
- properties: {
      ackrequest?: {
          ackrequested: boolean;
          tag: string;
          uid: string;
      };
      archived?: boolean;
      attachments?: string[];
      callsign: string;
      center: number[];
      chat?: {
          chatgrp: any;
          chatroom: string;
          groupOwner?: string;
          id: string;
          messageId?: string;
          parent?: string;
          senderCallsign: string;
      };
      contact?: {
          endpoint?: string;
          phone?: string;
      };
      course?: number;
      dest?: {
          after?: string;
          callsign?: string;
          mission?: string;
          path?: string;
          uid?: string;
      } | {
          after?: string;
          callsign?: string;
          mission?: string;
          path?: string;
          uid?: string;
      }[];
      droid?: string;
      fileshare?: {
          filename: string;
          name: string;
          senderCallsign: string;
          senderUid: string;
          senderUrl: string;
          sha256: string;
          sizeInBytes: number;
      };
      fill?: string;
      fill-opacity?: number;
      flow?: {};
      geofence?: {
          boundingSphere?: number;
          elevationMonitored?: string;
          maxElevation?: string;
          minElevation?: string;
          monitor?: string;
          tracking?: string;
          trigger?: string;
      };
      group?: {
          name: string;
          role: string;
      };
      how: string;
      icon?: string;
      links?: {
          mime?: string;
          parent_callsign?: string;
          point?: string;
          production_time?: string;
          relation?: string;
          remarks?: string;
          type?: string;
          uid?: string;
          url?: string;
      }[];
      marker-color?: string;
      marker-opacity?: number;
      metadata?: {};
      mission?: {
          authorUid?: string;
          guid?: string;
          missionChanges?: {
              contentUid: string;
              creatorUid: string;
              details: {
                  callsign: string;
                  color: string;
                  lat: string;
                  lon: string;
                  type: string;
              };
              isFederatedChange: string;
              missionName: string;
              timestamp: string;
              type: string;
          }[];
          missionLayer?: {
              name?: string;
              parentUid?: string;
              type?: string;
              uid?: string;
          };
          name?: string;
          tool?: string;
          type?: string;
      };
      precisionlocation?: {
          altsrc?: string;
          geopointsrc?: string;
      };
      remarks?: string;
      sensor?: {
          azimuth?: string;
          elevation?: string;
          fov?: string;
          model?: string;
          north?: string;
          range?: string;
          roll?: string;
          type?: string;
          version?: string;
          vfov?: string;
      };
      shape?: {
          ellipse?: {
              angle: number;
              major: number;
              minor: number;
          };
      };
      slope?: number;
      speed?: number;
      stale: string;
      start: string;
      status?: {
          battery?: string;
          readiness?: string;
      };
      stroke?: string;
      stroke-opacity?: number;
      stroke-style?: string;
      stroke-width?: number;
      takv?: {
          device?: string;
          os?: string;
          platform?: string;
          version?: string;
      };
      time: string;
      track?: {
          course?: string;
          eCourse?: string;
          eSlope?: string;
          eSpeed?: string;
          slope?: string;
          speed?: string;
      };
      type: string;
      video?: {
          sensor?: string;
          spi?: string;
          url?: string;
      };
  }
  - Optionalackrequest?: {
        ackrequested: boolean;
        tag: string;
        uid: string;
    }
    - ackrequested: boolean
    - tag: string
    - uid: string
  - Optionalarchived?: boolean
  - Optionalattachments?: string[]
  - callsign: string
  - center: number[]
  - Optionalchat?: {
        chatgrp: any;
        chatroom: string;
        groupOwner?: string;
        id: string;
        messageId?: string;
        parent?: string;
        senderCallsign: string;
    }
    - chatgrp: any
    - chatroom: string
    - OptionalgroupOwner?: string
    - id: string
    - OptionalmessageId?: string
    - Optionalparent?: string
    - senderCallsign: string
  - Optionalcontact?: {
    endpoint?: string;
    phone?: string;
    }
    - Optionalendpoint?: string
    - Optionalphone?: string
  - Optionalcourse?: number
  - Optionaldest?: {
        after?: string;
        callsign?: string;
        mission?: string;
        path?: string;
        uid?: string;
    } | {
        after?: string;
        callsign?: string;
        mission?: string;
        path?: string;
        uid?: string;
    }[]
  - Optionaldroid?: string
  - Optionalfileshare?: {
        filename: string;
        name: string;
        senderCallsign: string;
        senderUid: string;
        senderUrl: string;
        sha256: string;
        sizeInBytes: number;
    }
    - filename: string
    - name: string
    - senderCallsign: string
    - senderUid: string
    - senderUrl: string
    - sha256: string
    - sizeInBytes: number
  - Optionalfill?: string
  - Optionalfill-opacity?: number
  - Optionalflow?: {}
  - Optionalgeofence?: {
        boundingSphere?: number;
        elevationMonitored?: string;
        maxElevation?: string;
        minElevation?: string;
        monitor?: string;
        tracking?: string;
        trigger?: string;
    }
    - OptionalboundingSphere?: number
    - OptionalelevationMonitored?: string
    - OptionalmaxElevation?: string
    - OptionalminElevation?: string
    - Optionalmonitor?: string
    - Optionaltracking?: string
    - Optionaltrigger?: string
  - Optionalgroup?: {
    name: string;
    role: string;
    }
    - name: string
    - role: string
  - how: string
  - Optionalicon?: string
  - Optionallinks?: {
        mime?: string;
        parent_callsign?: string;
        point?: string;
        production_time?: string;
        relation?: string;
        remarks?: string;
        type?: string;
        uid?: string;
        url?: string;
    }[]
  - Optionalmarker-color?: string
  - Optionalmarker-opacity?: number
  - Optionalmetadata?: {}
  - Optionalmission?: {
        authorUid?: string;
        guid?: string;
        missionChanges?: {
            contentUid: string;
            creatorUid: string;
            details: {
                callsign: string;
                color: string;
                lat: string;
                lon: string;
                type: string;
            };
            isFederatedChange: string;
            missionName: string;
            timestamp: string;
            type: string;
        }[];
        missionLayer?: {
            name?: string;
            parentUid?: string;
            type?: string;
            uid?: string;
        };
        name?: string;
        tool?: string;
        type?: string;
    }
    - OptionalauthorUid?: string
    - Optionalguid?: string
    - OptionalmissionChanges?: {
          contentUid: string;
          creatorUid: string;
          details: {
              callsign: string;
              color: string;
              lat: string;
              lon: string;
              type: string;
          };
          isFederatedChange: string;
          missionName: string;
          timestamp: string;
          type: string;
      }[]
    - OptionalmissionLayer?: {
          name?: string;
          parentUid?: string;
          type?: string;
          uid?: string;
      }
      - Optionalname?: string
      - OptionalparentUid?: string
      - Optionaltype?: string
      - Optionaluid?: string
    - Optionalname?: string
    - Optionaltool?: string
    - Optionaltype?: string
  - Optionalprecisionlocation?: {
    altsrc?: string;
    geopointsrc?: string;
    }
    - Optionalaltsrc?: string
    - Optionalgeopointsrc?: string
  - Optionalremarks?: string
  - Optionalsensor?: {
        azimuth?: string;
        elevation?: string;
        fov?: string;
        model?: string;
        north?: string;
        range?: string;
        roll?: string;
        type?: string;
        version?: string;
        vfov?: string;
    }
    - Optionalazimuth?: string
    - Optionalelevation?: string
    - Optionalfov?: string
    - Optionalmodel?: string
    - Optionalnorth?: string
    - Optionalrange?: string
    - Optionalroll?: string
    - Optionaltype?: string
    - Optionalversion?: string
    - Optionalvfov?: string
  - Optionalshape?: {
        ellipse?: {
            angle: number;
            major: number;
            minor: number;
        };
    }
    - Optionalellipse?: {
          angle: number;
          major: number;
          minor: number;
      }
      - angle: number
      - major: number
      - minor: number
  - Optionalslope?: number
  - Optionalspeed?: number
  - stale: string
  - start: string
  - Optionalstatus?: {
    battery?: string;
    readiness?: string;
    }
    - Optionalbattery?: string
    - Optionalreadiness?: string
  - Optionalstroke?: string
  - Optionalstroke-opacity?: number
  - Optionalstroke-style?: string
  - Optionalstroke-width?: number
  - Optionaltakv?: {
        device?: string;
        os?: string;
        platform?: string;
        version?: string;
    }
    - Optionaldevice?: string
    - Optionalos?: string
    - Optionalplatform?: string
    - Optionalversion?: string
  - time: string
  - Optionaltrack?: {
        course?: string;
        eCourse?: string;
        eSlope?: string;
        eSpeed?: string;
        slope?: string;
        speed?: string;
    }
    - Optionalcourse?: string
    - OptionaleCourse?: string
    - OptionaleSlope?: string
    - OptionaleSpeed?: string
    - Optionalslope?: string
    - Optionalspeed?: string
  - type: string
  - Optionalvideo?: {
        sensor?: string;
        spi?: string;
        url?: string;
    }
    - Optionalsensor?: string
    - Optionalspi?: string
    - Optionalurl?: string
- type: string
Inherited from default.to_geojson
- Defined in lib/cot.ts:536

to_proto

to_proto(version?): Uint8Array
Return an ATAK Compliant Protobuf
Parameters
- version: number = 1
Returns Uint8Array
Inherited from default.to_proto
- Defined in lib/cot.ts:439

to_xml

to_xml(): string
Returns string
Inherited from default.to_xml
- Defined in lib/cot.ts:840

uid

uid(uid?): string
Returns or sets the UID of the CoT
Parameters
- Optionaluid: string
Returns string
Inherited from default.uid
- Defined in lib/cot.ts:139

`Static`from_geojson

from_geojson(feature): default
Return an CoT Message given a GeoJSON Feature
Parameters
- feature: {
      geometry: {
          coordinates: number[];
          type: "Point";
      } | {
          coordinates: number[][];
          type: "LineString";
      } | {
          coordinates: number[][][];
          type: "Polygon";
      };
      id?: string;
      properties: {
          ackrequest?: {
              ackrequested: boolean;
              tag: string;
              uid: string;
          };
          archived?: boolean;
          attachments?: string[];
          callsign?: string;
          center?: number[];
          chat?: {
              chatgrp: any;
              chatroom: string;
              groupOwner?: string;
              id: string;
              messageId?: string;
              parent?: string;
              senderCallsign: string;
          };
          contact?: {
              endpoint?: string;
              phone?: string;
          };
          course?: number;
          dest?: {
              after?: string;
              callsign?: string;
              mission?: string;
              path?: string;
              uid?: string;
          } | {
              after?: string;
              callsign?: string;
              mission?: string;
              path?: string;
              uid?: string;
          }[];
          droid?: string;
          fileshare?: {
              filename: string;
              name: string;
              senderCallsign: string;
              senderUid: string;
              senderUrl: string;
              sha256: string;
              sizeInBytes: number;
          };
          fill?: string;
          fill-opacity?: number;
          flow?: {};
          geofence?: {
              boundingSphere?: number;
              elevationMonitored?: string;
              maxElevation?: string;
              minElevation?: string;
              monitor?: string;
              tracking?: string;
              trigger?: string;
          };
          group?: {
              name: string;
              role: string;
          };
          how?: string;
          icon?: string;
          links?: {
              mime?: string;
              parent_callsign?: string;
              point?: string;
              production_time?: string;
              relation?: string;
              remarks?: string;
              type?: string;
              uid?: string;
              url?: string;
          }[];
          marker-color?: string;
          marker-opacity?: number;
          metadata?: {};
          mission?: {
              authorUid?: string;
              guid?: string;
              missionChanges?: {
                  contentUid: string;
                  creatorUid: string;
                  details: {
                      callsign: string;
                      color: string;
                      lat: string;
                      lon: string;
                      type: string;
                  };
                  isFederatedChange: string;
                  missionName: string;
                  timestamp: string;
                  type: string;
              }[];
              missionLayer?: {
                  name?: string;
                  parentUid?: string;
                  type?: string;
                  uid?: string;
              };
              name?: string;
              tool?: string;
              type?: string;
          };
          precisionlocation?: {
              altsrc?: string;
              geopointsrc?: string;
          };
          remarks?: string;
          sensor?: {
              azimuth?: string;
              elevation?: string;
              fov?: string;
              model?: string;
              north?: string;
              range?: string;
              roll?: string;
              type?: string;
              version?: string;
              vfov?: string;
          };
          shape?: {
              ellipse?: {
                  angle: number;
                  major: number;
                  minor: number;
              };
          };
          slope?: number;
          speed?: number;
          stale?: string | number;
          start?: string;
          status?: {
              battery?: string;
              readiness?: string;
          };
          stroke?: string;
          stroke-opacity?: number;
          stroke-style?: string;
          stroke-width?: number;
          takv?: {
              device?: string;
              os?: string;
              platform?: string;
              version?: string;
          };
          time?: string;
          track?: {
              course?: string;
              eCourse?: string;
              eSlope?: string;
              eSpeed?: string;
              slope?: string;
              speed?: string;
          };
          type?: string;
          video?: {
              sensor?: string;
              spi?: string;
              url?: string;
          };
      };
      type: string;
  }
  GeoJSON Point Feature
  - geometry: {
        coordinates: number[];
        type: "Point";
    } | {
        coordinates: number[][];
        type: "LineString";
    } | {
        coordinates: number[][][];
        type: "Polygon";
    }
  - Optionalid?: string
  - properties: {
        ackrequest?: {
            ackrequested: boolean;
            tag: string;
            uid: string;
        };
        archived?: boolean;
        attachments?: string[];
        callsign?: string;
        center?: number[];
        chat?: {
            chatgrp: any;
            chatroom: string;
            groupOwner?: string;
            id: string;
            messageId?: string;
            parent?: string;
            senderCallsign: string;
        };
        contact?: {
            endpoint?: string;
            phone?: string;
        };
        course?: number;
        dest?: {
            after?: string;
            callsign?: string;
            mission?: string;
            path?: string;
            uid?: string;
        } | {
            after?: string;
            callsign?: string;
            mission?: string;
            path?: string;
            uid?: string;
        }[];
        droid?: string;
        fileshare?: {
            filename: string;
            name: string;
            senderCallsign: string;
            senderUid: string;
            senderUrl: string;
            sha256: string;
            sizeInBytes: number;
        };
        fill?: string;
        fill-opacity?: number;
        flow?: {};
        geofence?: {
            boundingSphere?: number;
            elevationMonitored?: string;
            maxElevation?: string;
            minElevation?: string;
            monitor?: string;
            tracking?: string;
            trigger?: string;
        };
        group?: {
            name: string;
            role: string;
        };
        how?: string;
        icon?: string;
        links?: {
            mime?: string;
            parent_callsign?: string;
            point?: string;
            production_time?: string;
            relation?: string;
            remarks?: string;
            type?: string;
            uid?: string;
            url?: string;
        }[];
        marker-color?: string;
        marker-opacity?: number;
        metadata?: {};
        mission?: {
            authorUid?: string;
            guid?: string;
            missionChanges?: {
                contentUid: string;
                creatorUid: string;
                details: {
                    callsign: string;
                    color: string;
                    lat: string;
                    lon: string;
                    type: string;
                };
                isFederatedChange: string;
                missionName: string;
                timestamp: string;
                type: string;
            }[];
            missionLayer?: {
                name?: string;
                parentUid?: string;
                type?: string;
                uid?: string;
            };
            name?: string;
            tool?: string;
            type?: string;
        };
        precisionlocation?: {
            altsrc?: string;
            geopointsrc?: string;
        };
        remarks?: string;
        sensor?: {
            azimuth?: string;
            elevation?: string;
            fov?: string;
            model?: string;
            north?: string;
            range?: string;
            roll?: string;
            type?: string;
            version?: string;
            vfov?: string;
        };
        shape?: {
            ellipse?: {
                angle: number;
                major: number;
                minor: number;
            };
        };
        slope?: number;
        speed?: number;
        stale?: string | number;
        start?: string;
        status?: {
            battery?: string;
            readiness?: string;
        };
        stroke?: string;
        stroke-opacity?: number;
        stroke-style?: string;
        stroke-width?: number;
        takv?: {
            device?: string;
            os?: string;
            platform?: string;
            version?: string;
        };
        time?: string;
        track?: {
            course?: string;
            eCourse?: string;
            eSlope?: string;
            eSpeed?: string;
            slope?: string;
            speed?: string;
        };
        type?: string;
        video?: {
            sensor?: string;
            spi?: string;
            url?: string;
        };
    }
    - Optionalackrequest?: {
          ackrequested: boolean;
          tag: string;
          uid: string;
      }
      ackrequested: boolean
      tag: string
      uid: string
    - Optionalarchived?: boolean
    - Optionalattachments?: string[]
    - Optionalcallsign?: string
    - Optionalcenter?: number[]
    - Optionalchat?: {
          chatgrp: any;
          chatroom: string;
          groupOwner?: string;
          id: string;
          messageId?: string;
          parent?: string;
          senderCallsign: string;
      }
      chatgrp: any
      chatroom: string
      OptionalgroupOwner?: string
      id: string
      OptionalmessageId?: string
      Optionalparent?: string
      senderCallsign: string
    - Optionalcontact?: {
      endpoint?: string;
      phone?: string;
      }
      Optionalendpoint?: string
      Optionalphone?: string
    - Optionalcourse?: number
    - Optionaldest?: {
          after?: string;
          callsign?: string;
          mission?: string;
          path?: string;
          uid?: string;
      } | {
          after?: string;
          callsign?: string;
          mission?: string;
          path?: string;
          uid?: string;
      }[]
    - Optionaldroid?: string
    - Optionalfileshare?: {
          filename: string;
          name: string;
          senderCallsign: string;
          senderUid: string;
          senderUrl: string;
          sha256: string;
          sizeInBytes: number;
      }
      filename: string
      name: string
      senderCallsign: string
      senderUid: string
      senderUrl: string
      sha256: string
      sizeInBytes: number
    - Optionalfill?: string
    - Optionalfill-opacity?: number
    - Optionalflow?: {}
    - Optionalgeofence?: {
          boundingSphere?: number;
          elevationMonitored?: string;
          maxElevation?: string;
          minElevation?: string;
          monitor?: string;
          tracking?: string;
          trigger?: string;
      }
      OptionalboundingSphere?: number
      OptionalelevationMonitored?: string
      OptionalmaxElevation?: string
      OptionalminElevation?: string
      Optionalmonitor?: string
      Optionaltracking?: string
      Optionaltrigger?: string
    - Optionalgroup?: {
      name: string;
      role: string;
      }
      name: string
      role: string
    - Optionalhow?: string
    - Optionalicon?: string
    - Optionallinks?: {
          mime?: string;
          parent_callsign?: string;
          point?: string;
          production_time?: string;
          relation?: string;
          remarks?: string;
          type?: string;
          uid?: string;
          url?: string;
      }[]
    - Optionalmarker-color?: string
    - Optionalmarker-opacity?: number
    - Optionalmetadata?: {}
    - Optionalmission?: {
          authorUid?: string;
          guid?: string;
          missionChanges?: {
              contentUid: string;
              creatorUid: string;
              details: {
                  callsign: string;
                  color: string;
                  lat: string;
                  lon: string;
                  type: string;
              };
              isFederatedChange: string;
              missionName: string;
              timestamp: string;
              type: string;
          }[];
          missionLayer?: {
              name?: string;
              parentUid?: string;
              type?: string;
              uid?: string;
          };
          name?: string;
          tool?: string;
          type?: string;
      }
      OptionalauthorUid?: string
      Optionalguid?: string
      OptionalmissionChanges?: {
          contentUid: string;
          creatorUid: string;
          details: {
              callsign: string;
              color: string;
              lat: string;
              lon: string;
              type: string;
          };
          isFederatedChange: string;
          missionName: string;
          timestamp: string;
          type: string;
      }[]
      OptionalmissionLayer?: {
          name?: string;
          parentUid?: string;
          type?: string;
          uid?: string;
      }
      Optionalname?: string
      OptionalparentUid?: string
      Optionaltype?: string
      Optionaluid?: string
      Optionalname?: string
      Optionaltool?: string
      Optionaltype?: string
    - Optionalprecisionlocation?: {
      altsrc?: string;
      geopointsrc?: string;
      }
      Optionalaltsrc?: string
      Optionalgeopointsrc?: string
    - Optionalremarks?: string
    - Optionalsensor?: {
          azimuth?: string;
          elevation?: string;
          fov?: string;
          model?: string;
          north?: string;
          range?: string;
          roll?: string;
          type?: string;
          version?: string;
          vfov?: string;
      }
      Optionalazimuth?: string
      Optionalelevation?: string
      Optionalfov?: string
      Optionalmodel?: string
      Optionalnorth?: string
      Optionalrange?: string
      Optionalroll?: string
      Optionaltype?: string
      Optionalversion?: string
      Optionalvfov?: string
    - Optionalshape?: {
          ellipse?: {
              angle: number;
              major: number;
              minor: number;
          };
      }
      Optionalellipse?: {
          angle: number;
          major: number;
          minor: number;
      }
      angle: number
      major: number
      minor: number
    - Optionalslope?: number
    - Optionalspeed?: number
    - Optionalstale?: string | number
    - Optionalstart?: string
    - Optionalstatus?: {
      battery?: string;
      readiness?: string;
      }
      Optionalbattery?: string
      Optionalreadiness?: string
    - Optionalstroke?: string
    - Optionalstroke-opacity?: number
    - Optionalstroke-style?: string
    - Optionalstroke-width?: number
    - Optionaltakv?: {
          device?: string;
          os?: string;
          platform?: string;
          version?: string;
      }
      Optionaldevice?: string
      Optionalos?: string
      Optionalplatform?: string
      Optionalversion?: string
    - Optionaltime?: string
    - Optionaltrack?: {
          course?: string;
          eCourse?: string;
          eSlope?: string;
          eSpeed?: string;
          slope?: string;
          speed?: string;
      }
      Optionalcourse?: string
      OptionaleCourse?: string
      OptionaleSlope?: string
      OptionaleSpeed?: string
      Optionalslope?: string
      Optionalspeed?: string
    - Optionaltype?: string
    - Optionalvideo?: {
          sensor?: string;
          spi?: string;
          url?: string;
      }
      Optionalsensor?: string
      Optionalspi?: string
      Optionalurl?: string
  - type: string
Returns default
Inherited from default.from_geojson
- Defined in lib/cot.ts:185

`Static`from_proto

from_proto(raw, version?): default
Parse an ATAK compliant Protobuf to a JS Object
Parameters
- raw: Uint8Array
- version: number = 1
Returns default
Inherited from default.from_proto
- Defined in lib/cot.ts:477

`Static`ping

ping(): default
Return a CoT Message

Returns default
Inherited from default.ping
- Defined in lib/cot.ts:847

Class FileShare

Param: cot

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

filename: string

name: string

senderCallsign: string

senderUid: string

senderUrl: string

sha256: string

sizeInBytes: number

Returns FileShare

Properties

metadata

raw

Methods

addDest

Parameters

Optionalafter?: string

Optionalcallsign?: string

Optionalmission?: string

Optionalpath?: string

Optionaluid?: string

Returns void

addLink

Parameters

Optionalmime?: string

Optionalparent_callsign?: string

Optionalpoint?: string

Optionalproduction_time?: string

Optionalrelation?: string

Optionalremarks?: string

Optionaltype?: string

Optionaluid?: string

Optionalurl?: string

Returns void

is_airborne

Returns boolean

is_assumed

Returns boolean

is_atom

Returns boolean

is_chat

Returns boolean

is_equipment

Returns boolean

is_faker

Returns boolean

is_friend

Returns boolean

is_ground

Returns boolean

is_hostile

Returns boolean

is_installation

Returns boolean

is_joker

Returns boolean

is_neutral

Returns boolean

is_pending

Returns boolean

is_subsurface

Returns boolean

is_surface

Returns boolean

is_suspect

Returns boolean

is_tasking

Returns boolean

is_uav

Returns boolean

is_unknown

Returns boolean

`Optional`after?: string

`Optional`callsign?: string

`Optional`mission?: string

`Optional`path?: string

`Optional`uid?: string

`Optional`mime?: string

`Optional`parent_callsign?: string

`Optional`point?: string

`Optional`production_time?: string

`Optional`relation?: string

`Optional`remarks?: string

`Optional`type?: string

`Optional`uid?: string

`Optional`url?: string

geometry: {
coordinates: number[];
type: "Point";
} | {
coordinates: number[][];
type: "LineString";
} | {
coordinates: number[][][];
type: "Polygon";
}

`Optional`ackrequest?: {
ackrequested: boolean;
tag: string;
uid: string;
}

`Optional`archived?: boolean

`Optional`attachments?: string[]

`Optional`chat?: {
chatgrp: any;
chatroom: string;
groupOwner?: string;
id: string;
messageId?: string;
parent?: string;
senderCallsign: string;
}

`Optional`groupOwner?: string

`Optional`messageId?: string

`Optional`parent?: string

`Optional`contact?: {
endpoint?: string;
phone?: string;
}

`Optional`endpoint?: string

`Optional`phone?: string

`Optional`course?: number

`Optional`dest?: {
after?: string;
callsign?: string;
mission?: string;
path?: string;
uid?: string;
} | {
after?: string;
callsign?: string;
mission?: string;
path?: string;
uid?: string;
}[]

`Optional`droid?: string

`Optional`fileshare?: {
filename: string;
name: string;
senderCallsign: string;
senderUid: string;
senderUrl: string;
sha256: string;
sizeInBytes: number;
}

`Optional`fill?: string

`Optional`fill-opacity?: number

`Optional`flow?: {}

`Optional`geofence?: {
boundingSphere?: number;
elevationMonitored?: string;
maxElevation?: string;
minElevation?: string;
monitor?: string;
tracking?: string;
trigger?: string;
}

`Optional`boundingSphere?: number

`Optional`elevationMonitored?: string

`Optional`maxElevation?: string

`Optional`minElevation?: string

`Optional`monitor?: string

`Optional`tracking?: string

`Optional`trigger?: string

`Optional`group?: {
name: string;
role: string;
}

`Optional`icon?: string

`Optional`links?: {
mime?: string;
parent_callsign?: string;
point?: string;
production_time?: string;
relation?: string;
remarks?: string;
type?: string;
uid?: string;
url?: string;
}[]

`Optional`marker-color?: string

`Optional`marker-opacity?: number

`Optional`metadata?: {}

`Optional`authorUid?: string

`Optional`guid?: string

`Optional`missionChanges?: {
contentUid: string;
creatorUid: string;
details: {
callsign: string;
color: string;
lat: string;
lon: string;
type: string;
};
isFederatedChange: string;
missionName: string;
timestamp: string;
type: string;
}[]

`Optional`missionLayer?: {
name?: string;
parentUid?: string;
type?: string;
uid?: string;
}

`Optional`name?: string