Class Mission

constructor

• new Mission(api: TAKAPI): Mission

  Parameters

  • api: TAKAPI

  Returns Mission

schema

access

• access(name: string, opts?: { token?: string }): Promise<boolean>

  Check if you have access to a given mission

  Parameters

  • name: string
  • Optionalopts: { token?: string }

  Returns Promise<boolean>

attachContents

• attachContents(
      name: string,
      body: { hashes?: string[]; uids?: string[] },
      opts?: { token?: string },
  ): Promise<any>

  Attach a file resource by hash from the TAK Server file manager

  TAK Server Docs.

  Parameters

  • name: string
  • body: { hashes?: string[]; uids?: string[] }
  • Optionalopts: { token?: string }

  Returns Promise<any>

changes

• changes(
      name: string,
      query: {
          end?: string;
          secago?: number;
          squashed?: boolean;
          start?: string;
      },
      opts?: { token?: string },
  ): Promise<
      {
          data: {
              contentResource?: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              contentUid?: string;
              creatorUid?: string;
              details?: {
                  callsign: string;
                  color?: string;
                  location: { lat: number; lon: number };
                  type: string;
              };
              isFederatedChange: boolean;
              missionName: string;
              serverTime: string;
              timestamp: string;
              type: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  Return Mission Sync changes in a given time range

  TAK Server Docs.

  Parameters

  • name: string
  • query: { end?: string; secago?: number; squashed?: boolean; start?: string }
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          data: {
              contentResource?: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              contentUid?: string;
              creatorUid?: string;
              details?: {
                  callsign: string;
                  color?: string;
                  location: { lat: number; lon: number };
                  type: string;
              };
              isFederatedChange: boolean;
              missionName: string;
              serverTime: string;
              timestamp: string;
              type: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

cli

• cli(args: ParsedArgs): Promise<string | object>

  Parameters

  • args: ParsedArgs

  Returns Promise<string | object>

contacts

• contacts(name: string, opts?: { token?: string }): Promise<any>

  Return users associated with this mission

  TAK Server Docs.

  Parameters

  • name: string
  • Optionalopts: { token?: string }

  Returns Promise<any>

create

• create(
      body: {
          allowDupe?: boolean;
          baseLayer?: string;
          bbox?: string;
          boundingPolygon?: string[];
          chatRoom?: string;
          classification?: string;
          creatorUid: string;
          defaultRole?: string;
          description?: string;
          expiration?: number;
          group?: string | string[];
          inviteOnly?: boolean;
          keywords?: string[];
          name: string;
          password?: string;
          path?: string;
          tool?: string;
      },
  ): Promise<
      {
          baseLayer?: string;
          bbox?: string;
          chatRoom?: string;
          classification?: string;
          contents: {
              creatorUid?: string;
              data: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              timestamp: string;
          }[];
          createTime: string;
          creatorUid?: string;
          description: string;
          expiration: number;
          externalData: unknown[];
          feeds: unknown[];
          groups?: string
          | string[];
          guid: string;
          inviteOnly: boolean;
          keywords: string[];
          logs?: {
              content: string;
              contentHashes: unknown[];
              created: string;
              creatorUid: string;
              dtg?: string;
              id: string;
              keywords: string[];
              missionNames: string[];
              servertime: string;
          }[];
          mapLayers: unknown[];
          missionChanges?: {
              contentResource?: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              contentUid?: string;
              creatorUid?: string;
              details?: {
                  callsign: string;
                  color?: string;
                  location: { lat: number; lon: number };
                  type: string;
              };
              isFederatedChange: boolean;
              missionName: string;
              serverTime: string;
              timestamp: string;
              type: string;
          }[];
          name: string;
          ownerRole?: { permissions: string[]; type: MissionSubscriberRole };
          passwordProtected: boolean;
          path?: string;
          token?: string;
          tool: string;
          uids: unknown[];
      },
  >

  Create a new mission

  TAK Server Docs.

  Parameters

  • body: {
        allowDupe?: boolean;
        baseLayer?: string;
        bbox?: string;
        boundingPolygon?: string[];
        chatRoom?: string;
        classification?: string;
        creatorUid: string;
        defaultRole?: string;
        description?: string;
        expiration?: number;
        group?: string | string[];
        inviteOnly?: boolean;
        keywords?: string[];
        name: string;
        password?: string;
        path?: string;
        tool?: string;
    }

  Returns Promise<
      {
          baseLayer?: string;
          bbox?: string;
          chatRoom?: string;
          classification?: string;
          contents: {
              creatorUid?: string;
              data: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              timestamp: string;
          }[];
          createTime: string;
          creatorUid?: string;
          description: string;
          expiration: number;
          externalData: unknown[];
          feeds: unknown[];
          groups?: string
          | string[];
          guid: string;
          inviteOnly: boolean;
          keywords: string[];
          logs?: {
              content: string;
              contentHashes: unknown[];
              created: string;
              creatorUid: string;
              dtg?: string;
              id: string;
              keywords: string[];
              missionNames: string[];
              servertime: string;
          }[];
          mapLayers: unknown[];
          missionChanges?: {
              contentResource?: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              contentUid?: string;
              creatorUid?: string;
              details?: {
                  callsign: string;
                  color?: string;
                  location: { lat: number; lon: number };
                  type: string;
              };
              isFederatedChange: boolean;
              missionName: string;
              serverTime: string;
              timestamp: string;
              type: string;
          }[];
          name: string;
          ownerRole?: { permissions: string[]; type: MissionSubscriberRole };
          passwordProtected: boolean;
          path?: string;
          token?: string;
          tool: string;
          uids: unknown[];
      },
  >

delete

• delete(
      name: string,
      query: { creatorUid?: string; deepDelete?: boolean },
      opts?: { token?: string },
  ): Promise<any>

  Delete a mission

  TAK Server Docs.

  Parameters

  • name: string
  • query: { creatorUid?: string; deepDelete?: boolean }
  • Optionalopts: { token?: string }

  Returns Promise<any>

detachContents

• detachContents(
      name: string,
      body: { hash?: string; uid?: string },
      opts?: { token?: string },
  ): Promise<any>

  Remove a file from the mission

  TAK Server Docs.

  Parameters

  • name: string
  • body: { hash?: string; uid?: string }
  • Optionalopts: { token?: string }

  Returns Promise<any>

get

• get(
      name: string,
      query: {
          changes?: boolean;
          end?: string;
          logs?: boolean;
          password?: string;
          secago?: number;
          start?: string;
      },
      opts?: { token?: string },
  ): Promise<
      {
          baseLayer?: string;
          bbox?: string;
          chatRoom?: string;
          classification?: string;
          contents: {
              creatorUid?: string;
              data: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              timestamp: string;
          }[];
          createTime: string;
          creatorUid?: string;
          description: string;
          expiration: number;
          externalData: unknown[];
          feeds: unknown[];
          groups?: string
          | string[];
          guid: string;
          inviteOnly: boolean;
          keywords: string[];
          logs?: {
              content: string;
              contentHashes: unknown[];
              created: string;
              creatorUid: string;
              dtg?: string;
              id: string;
              keywords: string[];
              missionNames: string[];
              servertime: string;
          }[];
          mapLayers: unknown[];
          missionChanges?: {
              contentResource?: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              contentUid?: string;
              creatorUid?: string;
              details?: {
                  callsign: string;
                  color?: string;
                  location: { lat: number; lon: number };
                  type: string;
              };
              isFederatedChange: boolean;
              missionName: string;
              serverTime: string;
              timestamp: string;
              type: string;
          }[];
          name: string;
          ownerRole?: { permissions: string[]; type: MissionSubscriberRole };
          passwordProtected: boolean;
          path?: string;
          token?: string;
          tool: string;
          uids: unknown[];
      },
  >

  Get mission by its Name

  TAK Server Docs.

  Parameters

  • name: string
  • query: {
        changes?: boolean;
        end?: string;
        logs?: boolean;
        password?: string;
        secago?: number;
        start?: string;
    }
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          baseLayer?: string;
          bbox?: string;
          chatRoom?: string;
          classification?: string;
          contents: {
              creatorUid?: string;
              data: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              timestamp: string;
          }[];
          createTime: string;
          creatorUid?: string;
          description: string;
          expiration: number;
          externalData: unknown[];
          feeds: unknown[];
          groups?: string
          | string[];
          guid: string;
          inviteOnly: boolean;
          keywords: string[];
          logs?: {
              content: string;
              contentHashes: unknown[];
              created: string;
              creatorUid: string;
              dtg?: string;
              id: string;
              keywords: string[];
              missionNames: string[];
              servertime: string;
          }[];
          mapLayers: unknown[];
          missionChanges?: {
              contentResource?: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              contentUid?: string;
              creatorUid?: string;
              details?: {
                  callsign: string;
                  color?: string;
                  location: { lat: number; lon: number };
                  type: string;
              };
              isFederatedChange: boolean;
              missionName: string;
              serverTime: string;
              timestamp: string;
              type: string;
          }[];
          name: string;
          ownerRole?: { permissions: string[]; type: MissionSubscriberRole };
          passwordProtected: boolean;
          path?: string;
          token?: string;
          tool: string;
          uids: unknown[];
      },
  >

getArchive

• getArchive(name: string, opts?: { token?: string }): Promise<Readable>

  Return Zip archive of Mission Sync

  TAK Server Docs.

  Parameters

  • name: string
  • Optionalopts: { token?: string }

  Returns Promise<Readable>

getGuid

• getGuid(
      guid: string,
      query: {
          changes?: boolean;
          end?: string;
          logs?: boolean;
          password?: string;
          secago?: number;
          start?: string;
      },
      opts?: { token?: string },
  ): Promise<
      {
          baseLayer?: string;
          bbox?: string;
          chatRoom?: string;
          classification?: string;
          contents: {
              creatorUid?: string;
              data: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              timestamp: string;
          }[];
          createTime: string;
          creatorUid?: string;
          description: string;
          expiration: number;
          externalData: unknown[];
          feeds: unknown[];
          groups?: string
          | string[];
          guid: string;
          inviteOnly: boolean;
          keywords: string[];
          logs?: {
              content: string;
              contentHashes: unknown[];
              created: string;
              creatorUid: string;
              dtg?: string;
              id: string;
              keywords: string[];
              missionNames: string[];
              servertime: string;
          }[];
          mapLayers: unknown[];
          missionChanges?: {
              contentResource?: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              contentUid?: string;
              creatorUid?: string;
              details?: {
                  callsign: string;
                  color?: string;
                  location: { lat: number; lon: number };
                  type: string;
              };
              isFederatedChange: boolean;
              missionName: string;
              serverTime: string;
              timestamp: string;
              type: string;
          }[];
          name: string;
          ownerRole?: { permissions: string[]; type: MissionSubscriberRole };
          passwordProtected: boolean;
          path?: string;
          token?: string;
          tool: string;
          uids: unknown[];
      },
  >

  Get mission by its GUID

  TAK Server Docs.

  Parameters

  • guid: string
  • query: {
        changes?: boolean;
        end?: string;
        logs?: boolean;
        password?: string;
        secago?: number;
        start?: string;
    }
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          baseLayer?: string;
          bbox?: string;
          chatRoom?: string;
          classification?: string;
          contents: {
              creatorUid?: string;
              data: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              timestamp: string;
          }[];
          createTime: string;
          creatorUid?: string;
          description: string;
          expiration: number;
          externalData: unknown[];
          feeds: unknown[];
          groups?: string
          | string[];
          guid: string;
          inviteOnly: boolean;
          keywords: string[];
          logs?: {
              content: string;
              contentHashes: unknown[];
              created: string;
              creatorUid: string;
              dtg?: string;
              id: string;
              keywords: string[];
              missionNames: string[];
              servertime: string;
          }[];
          mapLayers: unknown[];
          missionChanges?: {
              contentResource?: {
                  creatorUid?: string;
                  expiration: number;
                  hash: string;
                  keywords: string[];
                  mimeType?: string;
                  name: string;
                  size: number;
                  submissionTime: string;
                  submitter?: string;
                  uid: string;
              };
              contentUid?: string;
              creatorUid?: string;
              details?: {
                  callsign: string;
                  color?: string;
                  location: { lat: number; lon: number };
                  type: string;
              };
              isFederatedChange: boolean;
              missionName: string;
              serverTime: string;
              timestamp: string;
              type: string;
          }[];
          name: string;
          ownerRole?: { permissions: string[]; type: MissionSubscriberRole };
          passwordProtected: boolean;
          path?: string;
          token?: string;
          tool: string;
          uids: unknown[];
      },
  >

latestCots

• latestCots(name: string, opts?: { token?: string }): Promise<string>

  Return all current features in the Data Sync as CoT GeoJSON Features

  TAK Server Docs.

  Parameters

  • name: string
  • Optionalopts: { token?: string }

  Returns Promise<string>

latestFeats

• latestFeats(
      name: string,
      opts?: { token?: string },
  ): Promise<
      {
          geometry: | { coordinates: number[]; type: "Point" }
          | { coordinates: number[][]; type: "LineString" }
          | { coordinates: number[][][]; type: "Polygon" };
          id: string;
          path?: string;
          properties: {
              ackrequest?: { ackrequested: boolean; tag: string; uid: string };
              archived?: boolean;
              attachments?: string[];
              bearing?: number;
              callsign: string;
              center: number[];
              chat?: {
                  chatgrp: any;
                  chatroom: string;
                  groupOwner?: string;
                  id: string;
                  messageId?: string;
                  parent?: string;
                  senderCallsign: string;
              };
              contact?: {
                  callsign?: string;
                  endpoint?: string;
                  name?: string;
                  phone?: string;
              };
              course?: number;
              creator?: { callsign: string; time?: string; type: string; uid: string };
              dest?:
                  | {
                      after?: string;
                      callsign?: string;
                      group?: string;
                      mission?: string;
                      "mission-guid"?: string;
                      path?: string;
                      uid?: string;
                  }
                  | {
                      after?: string;
                      callsign?: string;
                      group?: string;
                      mission?: string;
                      "mission-guid"?: 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?: { [key: string]: string };
              geofence?: {
                  boundingSphere?: number;
                  elevationMonitored?: string;
                  maxElevation?: string;
                  minElevation?: string;
                  monitor?: string;
                  tracking?: string;
                  trigger?: string;
              };
              group?: { name: string; role: string };
              how: string;
              icon?: string;
              labels?: boolean;
              links?: {
                  callsign?: string;
                  mime?: string;
                  mission?: 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;
              maxzoom?: number;
              metadata?: { [key: string]: unknown };
              milicon?: { id: string };
              milsym?: { id: string };
              minzoom?: number;
              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 };
              range?: number;
              remarks?: string;
              rotate?: boolean;
              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;
              };
              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?: {
                  connection?: {
                      address: string;
                      alias?: string;
                      bufferTime?: number;
                      ignoreEmbeddedKLV?: boolean;
                      networkTimeout?: number;
                      path?: string;
                      port?: number;
                      protocol?: string;
                      roverPort?: number;
                      rtspReliable?: number;
                      uid: string;
                  };
                  sensor?: string;
                  spi?: string;
                  uid?: string;
                  url?: string;
              };
          };
          type: "Feature";
      }[],
  >

  Return all current features in the Data Sync as CoT GeoJSON Features

  Parameters

  • name: string
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          geometry: | { coordinates: number[]; type: "Point" }
          | { coordinates: number[][]; type: "LineString" }
          | { coordinates: number[][][]; type: "Polygon" };
          id: string;
          path?: string;
          properties: {
              ackrequest?: { ackrequested: boolean; tag: string; uid: string };
              archived?: boolean;
              attachments?: string[];
              bearing?: number;
              callsign: string;
              center: number[];
              chat?: {
                  chatgrp: any;
                  chatroom: string;
                  groupOwner?: string;
                  id: string;
                  messageId?: string;
                  parent?: string;
                  senderCallsign: string;
              };
              contact?: {
                  callsign?: string;
                  endpoint?: string;
                  name?: string;
                  phone?: string;
              };
              course?: number;
              creator?: { callsign: string; time?: string; type: string; uid: string };
              dest?:
                  | {
                      after?: string;
                      callsign?: string;
                      group?: string;
                      mission?: string;
                      "mission-guid"?: string;
                      path?: string;
                      uid?: string;
                  }
                  | {
                      after?: string;
                      callsign?: string;
                      group?: string;
                      mission?: string;
                      "mission-guid"?: 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?: { [key: string]: string };
              geofence?: {
                  boundingSphere?: number;
                  elevationMonitored?: string;
                  maxElevation?: string;
                  minElevation?: string;
                  monitor?: string;
                  tracking?: string;
                  trigger?: string;
              };
              group?: { name: string; role: string };
              how: string;
              icon?: string;
              labels?: boolean;
              links?: {
                  callsign?: string;
                  mime?: string;
                  mission?: 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;
              maxzoom?: number;
              metadata?: { [key: string]: unknown };
              milicon?: { id: string };
              milsym?: { id: string };
              minzoom?: number;
              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 };
              range?: number;
              remarks?: string;
              rotate?: boolean;
              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;
              };
              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?: {
                  connection?: {
                      address: string;
                      alias?: string;
                      bufferTime?: number;
                      ignoreEmbeddedKLV?: boolean;
                      networkTimeout?: number;
                      path?: string;
                      port?: number;
                      protocol?: string;
                      roverPort?: number;
                      rtspReliable?: number;
                      uid: string;
                  };
                  sensor?: string;
                  spi?: string;
                  uid?: string;
                  url?: string;
              };
          };
          type: "Feature";
      }[],
  >

list

• list(
      query: {
          defaultRole?: boolean;
          passwordProtected?: boolean;
          tool?: string;
      },
  ): Promise<
      {
          data: {
              baseLayer?: string;
              bbox?: string;
              chatRoom?: string;
              classification?: string;
              contents: {
                  creatorUid?: string;
                  data: {
                      creatorUid?: string;
                      expiration: number;
                      hash: string;
                      keywords: string[];
                      mimeType?: string;
                      name: string;
                      size: number;
                      submissionTime: string;
                      submitter?: string;
                      uid: string;
                  };
                  timestamp: string;
              }[];
              createTime: string;
              creatorUid?: string;
              description: string;
              expiration: number;
              externalData: unknown[];
              feeds: unknown[];
              groups?: string
              | string[];
              guid: string;
              inviteOnly: boolean;
              keywords: string[];
              logs?: {
                  content: string;
                  contentHashes: unknown[];
                  created: string;
                  creatorUid: string;
                  dtg?: string;
                  id: string;
                  keywords: string[];
                  missionNames: string[];
                  servertime: string;
              }[];
              mapLayers: unknown[];
              missionChanges?: {
                  contentResource?: {
                      creatorUid?: string;
                      expiration: number;
                      hash: string;
                      keywords: string[];
                      mimeType?: string;
                      name: string;
                      size: number;
                      submissionTime: string;
                      submitter?: string;
                      uid: string;
                  };
                  contentUid?: string;
                  creatorUid?: string;
                  details?: {
                      callsign: string;
                      color?: string;
                      location: { lat: number; lon: number };
                      type: string;
                  };
                  isFederatedChange: boolean;
                  missionName: string;
                  serverTime: string;
                  timestamp: string;
                  type: string;
              }[];
              name: string;
              ownerRole?: { permissions: string[]; type: MissionSubscriberRole };
              passwordProtected: boolean;
              path?: string;
              token?: string;
              tool: string;
              uids: unknown[];
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  List missions in currently active channels

  TAK Server Docs.

  Parameters

  • query: { defaultRole?: boolean; passwordProtected?: boolean; tool?: string }

  Returns Promise<
      {
          data: {
              baseLayer?: string;
              bbox?: string;
              chatRoom?: string;
              classification?: string;
              contents: {
                  creatorUid?: string;
                  data: {
                      creatorUid?: string;
                      expiration: number;
                      hash: string;
                      keywords: string[];
                      mimeType?: string;
                      name: string;
                      size: number;
                      submissionTime: string;
                      submitter?: string;
                      uid: string;
                  };
                  timestamp: string;
              }[];
              createTime: string;
              creatorUid?: string;
              description: string;
              expiration: number;
              externalData: unknown[];
              feeds: unknown[];
              groups?: string
              | string[];
              guid: string;
              inviteOnly: boolean;
              keywords: string[];
              logs?: {
                  content: string;
                  contentHashes: unknown[];
                  created: string;
                  creatorUid: string;
                  dtg?: string;
                  id: string;
                  keywords: string[];
                  missionNames: string[];
                  servertime: string;
              }[];
              mapLayers: unknown[];
              missionChanges?: {
                  contentResource?: {
                      creatorUid?: string;
                      expiration: number;
                      hash: string;
                      keywords: string[];
                      mimeType?: string;
                      name: string;
                      size: number;
                      submissionTime: string;
                      submitter?: string;
                      uid: string;
                  };
                  contentUid?: string;
                  creatorUid?: string;
                  details?: {
                      callsign: string;
                      color?: string;
                      location: { lat: number; lon: number };
                      type: string;
                  };
                  isFederatedChange: boolean;
                  missionName: string;
                  serverTime: string;
                  timestamp: string;
                  type: string;
              }[];
              name: string;
              ownerRole?: { permissions: string[]; type: MissionSubscriberRole };
              passwordProtected: boolean;
              path?: string;
              token?: string;
              tool: string;
              uids: unknown[];
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

role

• role(
      name: string,
      opts?: { token?: string },
  ): Promise<
      {
          hibernateLazyInitializer?: any;
          permissions: string[];
          type: MissionSubscriberRole;
      },
  >

  Return Role associated with a given mission if subscribed

  TAK Server Docs.

  Parameters

  • name: string
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          hibernateLazyInitializer?: any;
          permissions: string[];
          type: MissionSubscriberRole;
      },
  >

setRole

• setRole(
      name: string,
      query: {
          clientUid: string;
          role: {
              hibernateLazyInitializer?: any;
              permissions: string[];
              type: MissionSubscriberRole;
          };
          username: string;
      },
      opts?: { token?: string },
  ): Promise<
      {
          hibernateLazyInitializer?: any;
          permissions: string[];
          type: MissionSubscriberRole;
      },
  >

  Return Role associated with a given mission if subscribed

  TAK Server Docs.

  Parameters

  • name: string
  • query: {
        clientUid: string;
        role: {
            hibernateLazyInitializer?: any;
            permissions: string[];
            type: MissionSubscriberRole;
        };
        username: string;
    }
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          hibernateLazyInitializer?: any;
          permissions: string[];
          type: MissionSubscriberRole;
      },
  >

subscribe

• subscribe(
      name: string,
      query: {
          end?: string;
          password?: string;
          secago?: number;
          start?: string;
          uid: string;
      },
      opts?: { token?: string },
  ): Promise<
      {
          data: {
              clientUid: string;
              createTime: string;
              role: {
                  hibernateLazyInitializer?: any;
                  permissions: string[];
                  type: MissionSubscriberRole;
              };
              token?: string;
              username: string;
          };
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  Subscribe to a mission

  TAK Server Docs.

  Parameters

  • name: string
  • query: {
        end?: string;
        password?: string;
        secago?: number;
        start?: string;
        uid: string;
    }
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          data: {
              clientUid: string;
              createTime: string;
              role: {
                  hibernateLazyInitializer?: any;
                  permissions: string[];
                  type: MissionSubscriberRole;
              };
              token?: string;
              username: string;
          };
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

subscription

• subscription(
      name: string,
      query: { uid: string },
      opts?: { token?: string },
  ): Promise<
      {
          clientUid: string;
          createTime: string;
          role: {
              hibernateLazyInitializer?: any;
              permissions: string[];
              type: MissionSubscriberRole;
          };
          token?: string;
          username: string;
      },
  >

  Return subscription associated with a given mission if subscribed

  TAK Server Docs.

  Parameters

  • name: string
  • query: { uid: string }
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          clientUid: string;
          createTime: string;
          role: {
              hibernateLazyInitializer?: any;
              permissions: string[];
              type: MissionSubscriberRole;
          };
          token?: string;
          username: string;
      },
  >

subscriptionRoles

• subscriptionRoles(
      name: string,
      opts?: { token?: string },
  ): Promise<
      {
          data: {
              clientUid: string;
              createTime: string;
              role: {
                  hibernateLazyInitializer?: any;
                  permissions: string[];
                  type: MissionSubscriberRole;
              };
              token?: string;
              username: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  Return permissions associated with any subscribed users

  TAK Server Docs.

  Parameters

  • name: string
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          data: {
              clientUid: string;
              createTime: string;
              role: {
                  hibernateLazyInitializer?: any;
                  permissions: string[];
                  type: MissionSubscriberRole;
              };
              token?: string;
              username: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >