Class MissionProperty

constructor

• new MissionProperty(api: TAKAPI): MissionProperty

  Parameters

  • api: TAKAPI

  Returns MissionProperty

schema

cli

• cli(): Promise<string | object>

  Returns Promise<string | object>

delete

• delete(
      mission: string,
      key: string,
      creatorUid: string,
      opts?: { token?: string },
  ): Promise<void>

  Delete a single property on a Mission Sync

  Parameters

  • mission: string
  • key: string
  • creatorUid: string
  • Optionalopts: { token?: string }

  Returns Promise<void>

deleteAll

• deleteAll(
      mission: string,
      creatorUid: string,
      opts?: { token?: string },
  ): Promise<void>

  Delete all properties on a Mission Sync

  Parameters

  • mission: string
  • creatorUid: string
  • Optionalopts: { token?: string }

  Returns Promise<void>

get

• get(
      mission: string,
      key: string,
      opts?: { token?: string },
  ): Promise<
      {
          data: { key: string; value: string };
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  Get a single property on a Mission Sync

  Parameters

  • mission: string
  • key: string
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          data: { key: string; value: string };
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

list

• list(
      mission: string,
      query?: { prefix?: string },
      opts?: { token?: string },
  ): Promise<
      {
          data: { key: string; value: string }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  List properties on a Mission Sync, optionally filtered by key prefix

  Parameters

  • mission: string
  • query: { prefix?: string } = {}
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          data: { key: string; value: string }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

set

• set(
      mission: string,
      body: { creatorUid: string; key: string; value: string },
      opts?: { token?: string },
  ): Promise<
      {
          data: { key: string; value: string };
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  Create or update (upsert) a property on a Mission Sync

  Parameters

  • mission: string
  • body: { creatorUid: string; key: string; value: string }
  • Optionalopts: { token?: string }

  Returns Promise<
      {
          data: { key: string; value: string };
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >