Class Mission

Hierarchy

default
- Mission

Index

Constructors

constructor

Properties

api schema

Constructors

constructor

new Mission(api: TAKAPI): Mission
Parameters
- api: TAKAPI
Returns Mission
Inherited from Commands.constructor
- Defined in lib/commands.ts:45

Properties

api

api: TAKAPI

schema

schema: {
    list: {
        description: string;
        formats: CommandOutputFormat[];
        params: TObject<{}>;
        query: TObject<{}>;
    };
} = ...

Methods

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>
- Defined in lib/api/mission.ts:750

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>
- Defined in lib/api/mission.ts:490

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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            missionName: string;
            serverTime: string;
            timestamp: string;
            type: string;
        }[];
        messages?: string[];
        nodeId?: string;
        type: string;
        version: string;
    },
>
- Defined in lib/api/mission.ts:315

children

children(
    name: string,
    opts?: { token?: 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: string[];
                created: string;
                creatorUid: string;
                dtg?: string;
                entryUid?: string;
                id: string;
                keywords: string[];
                missionNames: string[];
                servertime: string;
            }[];
            mapLayers: unknown[];
            missionChanges?: {
                contentResource?: {
                    creatorUid?: string;
                    expiration?: number;
                    hash: string;
                    keywords?: (...)[];
                    mimeType?: string;
                    name?: string;
                    size?: number;
                    submissionTime?: string;
                    submitter?: string;
                    uid?: string;
                };
                contentUid?: string;
                creatorUid?: string;
                details?: {
                    attachments?: (...)[];
                    callsign?: string;
                    category?: string;
                    color?: string;
                    iconsetPath?: string;
                    location?: { lat: ...; lon: ... };
                    name?: string;
                    title?: string;
                    type: string;
                };
                isFederatedChange: boolean;
                missionGuid?: string;
                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;
    },
>
Return children associated with this mission

TAK Server Docs.
Parameters
- name: string
- Optionalopts: { token?: 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: string[];
                created: string;
                creatorUid: string;
                dtg?: string;
                entryUid?: string;
                id: string;
                keywords: string[];
                missionNames: string[];
                servertime: string;
            }[];
            mapLayers: unknown[];
            missionChanges?: {
                contentResource?: {
                    creatorUid?: string;
                    expiration?: number;
                    hash: string;
                    keywords?: (...)[];
                    mimeType?: string;
                    name?: string;
                    size?: number;
                    submissionTime?: string;
                    submitter?: string;
                    uid?: string;
                };
                contentUid?: string;
                creatorUid?: string;
                details?: {
                    attachments?: (...)[];
                    callsign?: string;
                    category?: string;
                    color?: string;
                    iconsetPath?: string;
                    location?: { lat: ...; lon: ... };
                    name?: string;
                    title?: string;
                    type: string;
                };
                isFederatedChange: boolean;
                missionGuid?: string;
                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;
    },
>
- Defined in lib/api/mission.ts:418

cli

cli(args: ParsedArgs): Promise<string | object>
Parameters
- args: ParsedArgs
Returns Promise<string | object>
Overrides Commands.cli
- Defined in lib/api/mission.ts:246

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>
- Defined in lib/api/mission.ts:399

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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
- Defined in lib/api/mission.ts:882

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>
- Defined in lib/api/mission.ts:991

deleteKeyword

deleteKeyword(
    name: string,
    keyword: string,
    opts?: { token?: string },
    creatorUid?: 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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
Remove a single keyword from a Mission.

TAK Server Docs.
Parameters
- name: string
- keyword: string
- Optionalopts: { token?: string }
- OptionalcreatorUid: 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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
- Defined in lib/api/mission.ts:962

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>
- Defined in lib/api/mission.ts:467

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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
- Defined in lib/api/mission.ts:851

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>
- Defined in lib/api/mission.ts:296

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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
- Defined in lib/api/mission.ts:723

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>
- Defined in lib/api/mission.ts:380

latestFeats

latestFeats(
    name: string,
    opts?: { token?: string },
): Promise<
    {
        features: {
            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;
                biosensordetail?: {
                    measurement?: {
                        bioClass?: (...) | (...);
                        channel?: (...) | (...);
                        concentration?: (...) | (...);
                        confidence?: (...) | (...);
                        confirmationLevel?: (...) | (...);
                        dose: number;
                        doseTime?: (...) | (...);
                        harmful?: (...) | (...) | (...);
                        level?: (...) | (...);
                        persistency?: (...) | (...);
                        sampleId?: (...) | (...);
                        time: string;
                        type?: (...) | (...);
                    }[];
                    sensor_data: {
                        attachedUid?: string;
                        batterylevel?: number;
                        callsign?: string;
                        manufacturer: string;
                        model: string;
                        ordinal?: number;
                        revision?: number;
                        serialnumber: string;
                        simulated?: boolean;
                        status?: string;
                    };
                };
                callsign: string;
                center: number[];
                chat?: {
                    chatgrp: any;
                    chatroom: string;
                    groupOwner?: string;
                    id?: string;
                    messageId?: string;
                    parent?: string;
                    senderCallsign: string;
                };
                chemsensordetail?: {
                    detection?: {
                        agent: string;
                        alarm: number;
                        class?: (...)
                        | (...);
                        concentration?: (...) | (...);
                        confidence?: (...) | (...);
                        id?: (...) | (...);
                        massfraction?: (...) | (...);
                        percent?: (...) | (...);
                        quantity: number;
                        quantityunits: string;
                        time: string;
                    }[];
                    sensor_data: {
                        attachedUid?: string;
                        batterylevel?: number;
                        callsign?: string;
                        manufacturer: string;
                        model: string;
                        ordinal?: number;
                        revision?: number;
                        serialnumber: string;
                        simulated?: boolean;
                        status?: 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 };
                forcedelete?: boolean;
                geofence?: {
                    boundingSphere?: number;
                    elevationMonitored?: boolean;
                    maxElevation?: string;
                    minElevation?: string;
                    monitor?: string;
                    tracking?: boolean;
                    trigger?: string;
                };
                group?: { name: string; role: string };
                how: string;
                icon?: string;
                labels?: boolean;
                links?: {
                    callsign?: string;
                    event?: 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;
                marti_archive?: boolean;
                maxzoom?: number;
                metadata?: { [key: string]: unknown };
                milicon?: { id: string };
                milsym?: { id: string };
                minzoom?: number;
                mission?: {
                    authorUid?: string;
                    guid?: string;
                    missionChanges?: {
                        contentResource?: (...) | (...);
                        contentUid?: (...) | (...);
                        creatorUid: string;
                        details?: (...) | (...);
                        isFederatedChange: boolean;
                        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 };
                radsensordetail?: {
                    command_permissions?: { all: boolean; contact_list: string };
                    data_permissions?: { all: boolean; contact_list: string };
                    isotope?: { confidence: number; name: string; type: string }[];
                    physical_module?: {
                        gamma_alarm: number;
                        gamma_cps: number;
                        gamma_dose_rate: number;
                        location: (...) | (...) | (...) | (...) | (...);
                    }[];
                    radmeasurement?: {
                        alarm: number;
                        measurement: number;
                        nalarmstddev: number;
                        name: (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    }[];
                    search_algorithm?: {
                        gamma_loc: number;
                        gamma_loc_alarm: number;
                        gamma_loc_alarm_value: number;
                        neutron_loc: number;
                        neutron_loc_alarm: number;
                        neutron_loc_alarm_value: number;
                    };
                    sensor_data: {
                        alarm_algorithm?: string;
                        attachedUid?: string;
                        batterylevel?: number;
                        callsign?: string;
                        detector_number?: number;
                        gammastatus: string;
                        heading?: number;
                        id_algorithm?: string;
                        manufacturer: string;
                        master_sensor_manufacturer?: string;
                        master_sensor_serial?: string;
                        measurement_ref?: number;
                        mission_acquired_uR?: number;
                        mission_stay_time_sec?: number;
                        mission_total_mR?: number;
                        model: string;
                        module_location?: string;
                        neutronstatus: string;
                        ordinal?: number;
                        relay_type?: string;
                        search_algorithm?: string;
                        sensor_temp_deg_c?: number;
                        serialnumber: string;
                        simulated?: boolean;
                        source_bearing?: number;
                        source_distance?: | "MOVE_MUCH_CLOSER"
                        | "MOVE_CLOSER"
                        | "OPTIMAL"
                        | "MOVE_AWAY"
                        | "MOVE_FAR_AWAY";
                        source_strength?: number;
                        subchannel?: string;
                        time: string;
                    };
                    spectrum?: {
                        channeldata: string;
                        crystal_id?: (...)
                        | (...);
                        livetime_ms: string;
                        realtime_ms: string;
                        type: string;
                        zerocompression: number;
                    }[];
                };
                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;
                        swapAxis?: boolean;
                    };
                };
                slope?: number;
                spatial?: {
                    attitude: {
                        ePitch?: number;
                        eRoll?: number;
                        eYaw?: number;
                        pitch: number;
                        roll: number;
                        yaw?: number;
                    };
                    spin: {
                        ePitch?: number;
                        eRoll?: number;
                        eYaw?: number;
                        pitch: number;
                        roll: number;
                        yaw?: number;
                    };
                    version?: 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";
        }[];
        invalid: { error: string; feature: unknown }[];
    },
>
Return all current features in the Data Sync as CoT GeoJSON Features

Each CoT in the TAK Server response is parsed & validated individually - those that fail are returned in the invalid array so a single poisoned CoT doesn't prevent the valid features from being returned
Parameters
- name: string
- Optionalopts: { token?: string }
Returns Promise<
    {
        features: {
            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;
                biosensordetail?: {
                    measurement?: {
                        bioClass?: (...) | (...);
                        channel?: (...) | (...);
                        concentration?: (...) | (...);
                        confidence?: (...) | (...);
                        confirmationLevel?: (...) | (...);
                        dose: number;
                        doseTime?: (...) | (...);
                        harmful?: (...) | (...) | (...);
                        level?: (...) | (...);
                        persistency?: (...) | (...);
                        sampleId?: (...) | (...);
                        time: string;
                        type?: (...) | (...);
                    }[];
                    sensor_data: {
                        attachedUid?: string;
                        batterylevel?: number;
                        callsign?: string;
                        manufacturer: string;
                        model: string;
                        ordinal?: number;
                        revision?: number;
                        serialnumber: string;
                        simulated?: boolean;
                        status?: string;
                    };
                };
                callsign: string;
                center: number[];
                chat?: {
                    chatgrp: any;
                    chatroom: string;
                    groupOwner?: string;
                    id?: string;
                    messageId?: string;
                    parent?: string;
                    senderCallsign: string;
                };
                chemsensordetail?: {
                    detection?: {
                        agent: string;
                        alarm: number;
                        class?: (...)
                        | (...);
                        concentration?: (...) | (...);
                        confidence?: (...) | (...);
                        id?: (...) | (...);
                        massfraction?: (...) | (...);
                        percent?: (...) | (...);
                        quantity: number;
                        quantityunits: string;
                        time: string;
                    }[];
                    sensor_data: {
                        attachedUid?: string;
                        batterylevel?: number;
                        callsign?: string;
                        manufacturer: string;
                        model: string;
                        ordinal?: number;
                        revision?: number;
                        serialnumber: string;
                        simulated?: boolean;
                        status?: 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 };
                forcedelete?: boolean;
                geofence?: {
                    boundingSphere?: number;
                    elevationMonitored?: boolean;
                    maxElevation?: string;
                    minElevation?: string;
                    monitor?: string;
                    tracking?: boolean;
                    trigger?: string;
                };
                group?: { name: string; role: string };
                how: string;
                icon?: string;
                labels?: boolean;
                links?: {
                    callsign?: string;
                    event?: 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;
                marti_archive?: boolean;
                maxzoom?: number;
                metadata?: { [key: string]: unknown };
                milicon?: { id: string };
                milsym?: { id: string };
                minzoom?: number;
                mission?: {
                    authorUid?: string;
                    guid?: string;
                    missionChanges?: {
                        contentResource?: (...) | (...);
                        contentUid?: (...) | (...);
                        creatorUid: string;
                        details?: (...) | (...);
                        isFederatedChange: boolean;
                        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 };
                radsensordetail?: {
                    command_permissions?: { all: boolean; contact_list: string };
                    data_permissions?: { all: boolean; contact_list: string };
                    isotope?: { confidence: number; name: string; type: string }[];
                    physical_module?: {
                        gamma_alarm: number;
                        gamma_cps: number;
                        gamma_dose_rate: number;
                        location: (...) | (...) | (...) | (...) | (...);
                    }[];
                    radmeasurement?: {
                        alarm: number;
                        measurement: number;
                        nalarmstddev: number;
                        name: (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    }[];
                    search_algorithm?: {
                        gamma_loc: number;
                        gamma_loc_alarm: number;
                        gamma_loc_alarm_value: number;
                        neutron_loc: number;
                        neutron_loc_alarm: number;
                        neutron_loc_alarm_value: number;
                    };
                    sensor_data: {
                        alarm_algorithm?: string;
                        attachedUid?: string;
                        batterylevel?: number;
                        callsign?: string;
                        detector_number?: number;
                        gammastatus: string;
                        heading?: number;
                        id_algorithm?: string;
                        manufacturer: string;
                        master_sensor_manufacturer?: string;
                        master_sensor_serial?: string;
                        measurement_ref?: number;
                        mission_acquired_uR?: number;
                        mission_stay_time_sec?: number;
                        mission_total_mR?: number;
                        model: string;
                        module_location?: string;
                        neutronstatus: string;
                        ordinal?: number;
                        relay_type?: string;
                        search_algorithm?: string;
                        sensor_temp_deg_c?: number;
                        serialnumber: string;
                        simulated?: boolean;
                        source_bearing?: number;
                        source_distance?: | "MOVE_MUCH_CLOSER"
                        | "MOVE_CLOSER"
                        | "OPTIMAL"
                        | "MOVE_AWAY"
                        | "MOVE_FAR_AWAY";
                        source_strength?: number;
                        subchannel?: string;
                        time: string;
                    };
                    spectrum?: {
                        channeldata: string;
                        crystal_id?: (...)
                        | (...);
                        livetime_ms: string;
                        realtime_ms: string;
                        type: string;
                        zerocompression: number;
                    }[];
                };
                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;
                        swapAxis?: boolean;
                    };
                };
                slope?: number;
                spatial?: {
                    attitude: {
                        ePitch?: number;
                        eRoll?: number;
                        eYaw?: number;
                        pitch: number;
                        roll: number;
                        yaw?: number;
                    };
                    spin: {
                        ePitch?: number;
                        eRoll?: number;
                        eYaw?: number;
                        pitch: number;
                        roll: number;
                        yaw?: number;
                    };
                    version?: 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";
        }[];
        invalid: { error: string; feature: unknown }[];
    },
>
- Defined in lib/api/mission.ts:346

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: string[];
                created: string;
                creatorUid: string;
                dtg?: string;
                entryUid?: string;
                id: string;
                keywords: string[];
                missionNames: string[];
                servertime: string;
            }[];
            mapLayers: unknown[];
            missionChanges?: {
                contentResource?: {
                    creatorUid?: string;
                    expiration?: number;
                    hash: string;
                    keywords?: (...)[];
                    mimeType?: string;
                    name?: string;
                    size?: number;
                    submissionTime?: string;
                    submitter?: string;
                    uid?: string;
                };
                contentUid?: string;
                creatorUid?: string;
                details?: {
                    attachments?: (...)[];
                    callsign?: string;
                    category?: string;
                    color?: string;
                    iconsetPath?: string;
                    location?: { lat: ...; lon: ... };
                    name?: string;
                    title?: string;
                    type: string;
                };
                isFederatedChange: boolean;
                missionGuid?: string;
                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: string[];
                created: string;
                creatorUid: string;
                dtg?: string;
                entryUid?: string;
                id: string;
                keywords: string[];
                missionNames: string[];
                servertime: string;
            }[];
            mapLayers: unknown[];
            missionChanges?: {
                contentResource?: {
                    creatorUid?: string;
                    expiration?: number;
                    hash: string;
                    keywords?: (...)[];
                    mimeType?: string;
                    name?: string;
                    size?: number;
                    submissionTime?: string;
                    submitter?: string;
                    uid?: string;
                };
                contentUid?: string;
                creatorUid?: string;
                details?: {
                    attachments?: (...)[];
                    callsign?: string;
                    category?: string;
                    color?: string;
                    iconsetPath?: string;
                    location?: { lat: ...; lon: ... };
                    name?: string;
                    title?: string;
                    type: string;
                };
                isFederatedChange: boolean;
                missionGuid?: string;
                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;
    },
>
- Defined in lib/api/mission.ts:703

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;
    },
>
- Defined in lib/api/mission.ts:599

setKeywords

setKeywords(
    name: string,
    keywords: string[],
    opts?: { token?: string },
    creatorUid?: 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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
Replace the full list of keywords on a Mission.

TAK Server Docs.
Parameters
- name: string
- keywords: string[]
- Optionalopts: { token?: string }
- OptionalcreatorUid: 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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
- Defined in lib/api/mission.ts:932

setParent

setParent(
    child: string,
    parent: string,
    opts?: { token?: string },
): Promise<any>
Set the parent mission for a child mission

TAK Server Docs.
Parameters
- child: string
- parent: string
- Optionalopts: { token?: string }
Returns Promise<any>
- Defined in lib/api/mission.ts:437

setRole

setRole(
    name: string,
    query: { clientUid: string; role: MissionSubscriberRole; username: string },
    opts?: { token?: string },
): Promise<void>
Set the Role of a given user on a Mission

TAK Server Docs.
Parameters
- name: string
- query: { clientUid: string; role: MissionSubscriberRole; username: string }
- Optionalopts: { token?: string }
Returns Promise<void>
- Defined in lib/api/mission.ts:572

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;
    },
>
- Defined in lib/api/mission.ts:649

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;
    },
>
- Defined in lib/api/mission.ts:620

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;
    },
>
- Defined in lib/api/mission.ts:553

subscriptions

subscriptions(
    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 UIDs 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;
    },
>
- Defined in lib/api/mission.ts:534

unsubscribe

unsubscribe(
    name: string,
    query: { disconnectOnly?: boolean; uid: string },
    opts?: { token?: string },
): Promise<any>
Unsubscribe from a mission

TAK Server Docs.
Parameters
- name: string
- query: { disconnectOnly?: boolean; uid: string }
- Optionalopts: { token?: string }
Returns Promise<any>
- Defined in lib/api/mission.ts:676

update

update(
    name: string,
    body: {
        allowGroupChange?: boolean;
        baseLayer?: string;
        bbox?: string;
        chatRoom?: string;
        classification?: string;
        creatorUid?: string;
        description?: string;
        expiration?: number;
        group?: string | string[];
        inviteOnly?: boolean;
        keywords?: string[];
        path?: string;
        tool?: 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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
Update Mission

TAK Server Docs.
Parameters
- name: string
- body: {
      allowGroupChange?: boolean;
      baseLayer?: string;
      bbox?: string;
      chatRoom?: string;
      classification?: string;
      creatorUid?: string;
      description?: string;
      expiration?: number;
      group?: string | string[];
      inviteOnly?: boolean;
      keywords?: string[];
      path?: string;
      tool?: 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: string[];
            created: string;
            creatorUid: string;
            dtg?: string;
            entryUid?: 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?: {
                attachments?: string[];
                callsign?: string;
                category?: string;
                color?: string;
                iconsetPath?: string;
                location?: { lat: number; lon: number };
                name?: string;
                title?: string;
                type: string;
            };
            isFederatedChange: boolean;
            missionGuid?: string;
            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[];
    },
>
- Defined in lib/api/mission.ts:777

upload

upload(
    name: string,
    creatorUid: string,
    body: Readable,
    opts?: { token?: string },
): Promise<any>
Upload a Mission Package

TAK Server Docs.
Parameters
- name: string
- creatorUid: string
- body: Readable
- Optionalopts: { token?: string }
Returns Promise<any>
- Defined in lib/api/mission.ts:511

Class Mission

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Mission

Properties

api

schema

Methods

access

Parameters

Returns Promise<boolean>

attachContents

Parameters

Returns Promise<any>

changes

Parameters

children

Parameters

cli

Parameters

Returns Promise<string | object>

contacts

Parameters

Returns Promise<any>

create

Parameters

delete

Parameters

Returns Promise<any>

deleteKeyword

Parameters

detachContents

Parameters

Returns Promise<any>

get

Parameters

getArchive

Parameters

Returns Promise<Readable>

getGuid

Parameters

latestCots

Parameters

Returns Promise<string>

latestFeats

Parameters

list

Parameters

role

Parameters

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

setKeywords

Parameters

setParent

Parameters

Returns Promise<any>

setRole

Parameters

Returns Promise<void>

subscribe

Parameters

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

Parameters

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

subscriptionRoles

Parameters

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; },>

subscriptions

Parameters

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; },>

unsubscribe

Parameters

Returns Promise<any>

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

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;
},
>

Returns Promise<
{
clientUid: string;
createTime: string;
role: {
hibernateLazyInitializer?: any;
permissions: string[];
type: MissionSubscriberRole;
};
token?: string;
username: 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;
},
>

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;
},
>