Class MissionInvite

constructor

• new MissionInvite(api: TAKAPI): MissionInvite

  Parameters

  • api: TAKAPI

  Returns MissionInvite

schema

cli

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

  Parameters

  • args: ParsedArgs

  Returns Promise<string | object>

get

• get(
      missionName: string,
      opts?: { token?: string },
  ): Promise<
      {
          data: {
              createTime?: string;
              creatorUid?: string;
              invitee?: string;
              missionGuid?: string;
              missionName?: string;
              role?: { description?: string; name?: string; permissions?: string[] };
              token?: string;
              type?: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  Get Mission Invitations

  TAK Server Docs.

  Parameters

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

  Returns Promise<
      {
          data: {
              createTime?: string;
              creatorUid?: string;
              invitee?: string;
              missionGuid?: string;
              missionName?: string;
              role?: { description?: string; name?: string; permissions?: string[] };
              token?: string;
              type?: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

invite

• invite(
      missionName: string,
      type: MissionInviteType,
      invitee: string,
      query: { creatorUid: string; role?: MissionSubscriberRole },
      opts?: { token?: string },
  ): Promise<void>

  Invite a user/group to a mission

  TAK Server Docs.

  Parameters

  • missionName: string
  • type: MissionInviteType
  • invitee: string
  • query: { creatorUid: string; role?: MissionSubscriberRole }
  • Optionalopts: { token?: string }

  Returns Promise<void>

list

• list(
      clientUid: string,
      opts?: { token?: string },
  ): Promise<
      {
          data: {
              createTime?: string;
              creatorUid?: string;
              invitee?: string;
              missionGuid?: string;
              missionName?: string;
              role?: { description?: string; name?: string; permissions?: string[] };
              token?: string;
              type?: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  List all Invitations for missions

  TAK Server Docs.

  Parameters

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

  Returns Promise<
      {
          data: {
              createTime?: string;
              creatorUid?: string;
              invitee?: string;
              missionGuid?: string;
              missionName?: string;
              role?: { description?: string; name?: string; permissions?: string[] };
              token?: string;
              type?: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

uninvite

• uninvite(
      missionName: string,
      type: MissionInviteType,
      invitee: string,
      query: { creatorUid: string },
      opts?: { token?: string },
  ): Promise<void>

  Uninvite a user/group from a mission

  TAK Server Docs.

  Parameters

  • missionName: string
  • type: MissionInviteType
  • invitee: string
  • query: { creatorUid: string }
  • Optionalopts: { token?: string }

  Returns Promise<void>