Class Files

constructor

• new Files(api: TAKAPI): Files

  Parameters

  • api: TAKAPI

  Returns Files

schema

adminDelete

• adminDelete(hash: string): Promise<any>

  Parameters

  • hash: string

  Returns Promise<any>

cli

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

  Parameters

  • args: ParsedArgs

  Returns Promise<string | object>

config

• config(): Promise<{ uploadSizeLimit: number }>

  Returns Promise<{ uploadSizeLimit: number }>

count

• count(): Promise<any>

  Returns Promise<any>

delete

• delete(hash: string): Promise<any>

  Parameters

  • hash: string

  Returns Promise<any>

download

• download(hash: string): Promise<Readable>

  Parameters

  • hash: string

  Returns Promise<Readable>

list

• list(): Promise<
      {
          data: {
              filename: string;
              keywords: string[];
              mimeType: string;
              name: string;
              size: number;
              submissionTime: string;
              submitter: string;
              uid: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  Returns Promise<
      {
          data: {
              filename: string;
              keywords: string[];
              mimeType: string;
              name: string;
              size: number;
              submissionTime: string;
              submitter: string;
              uid: string;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

meta

• meta(hash: string): Promise<string>

  Parameters

  • hash: string

  Returns Promise<string>

update

• update(
      hash: string,
      opts: { expiration?: number; keywords?: string[] },
  ): Promise<void>

  Parameters

  • hash: string
  • opts: { expiration?: number; keywords?: string[] }

  Returns Promise<void>

upload

• upload(
      opts: {
          altitude?: string;
          contentLength: number;
          contentType?: string;
          creatorUid: string;
          keywords: string[];
          latitude?: string;
          longitude?: string;
          name: string;
          uid?: string;
      },
      body: Buffer<ArrayBufferLike> | Readable,
  ): Promise<
      {
          CreatorUid: string;
          Hash: string;
          Keywords: string[];
          MIMEType: string;
          Name: string;
          PrimaryKey: string;
          SubmissionDateTime: string;
          SubmissionUser: string;
          UID: string;
      },
  >

  Update a Package that will not appear in the Public Data Packages List used primarily for sharing files between TAK clients

  Parameters

  • opts: {
        altitude?: string;
        contentLength: number;
        contentType?: string;
        creatorUid: string;
        keywords: string[];
        latitude?: string;
        longitude?: string;
        name: string;
        uid?: string;
    }

    • Optionalaltitude?: string

    • contentLength: number

    • OptionalcontentType?: string

    • creatorUid: string

    • keywords: string[]

    • Optionallatitude?: string

    • Optionallongitude?: string

    • name: string

    • Optionaluid?: string

      UID metadata - TAK clients treat a Mission file whose UID matches a map item as an attachment of that item

  • body: Buffer<ArrayBufferLike> | Readable

  Returns Promise<
      {
          CreatorUid: string;
          Hash: string;
          Keywords: string[];
          MIMEType: string;
          Name: string;
          PrimaryKey: string;
          SubmissionDateTime: string;
          SubmissionUser: string;
          UID: string;
      },
  >

uploadPackage

• uploadPackage(
      opts: {
          creatorUid: string;
          groups?: string[];
          hash: string;
          keywords?: string[];
          mimetype?: string;
          name: string;
      },
      body: Buffer<ArrayBufferLike> | Readable,
  ): Promise<string>

  Update a Package that should appear in the Public Data Packages List

  Parameters

  • opts: {
        creatorUid: string;
        groups?: string[];
        hash: string;
        keywords?: string[];
        mimetype?: string;
        name: string;
    }
  • body: Buffer<ArrayBufferLike> | Readable

  Returns Promise<string>