Class Files

constructor

• new Files(api: Api): Files

  Parameters

  • api: Api

  Returns Files

Readonlyurl

associate

• associate(
      fileIds: number | number[],
      slice: number,
      row: number,
      field: string,
      execute?: true,
  ): Promise<any>

  Associate an existing file with an existing row

  Parameters

  • fileIds: number | number[]

    Existing files to associate
  • slice: number

    Target slice
  • row: number

    Target slice record
  • field: string

    Record filed file should be added to
  • Optionalexecute: true

    Will run request by default, passing false will return the API request instead

  Returns Promise<any>

  The API response by default, or the raw API request if execute is false
• associate(
      fileIds: number | number[],
      slice: number,
      row: number,
      field: string,
      execute: false,
  ): {
      "!/tools/file/update": {
          field: string;
          ids: number[];
          row: number;
          slice: number;
      };
  }

  Associate an existing file with an existing row

  Parameters

  • fileIds: number | number[]

    Existing files to associate
  • slice: number

    Target slice
  • row: number

    Target slice record
  • field: string

    Record filed file should be added to
  • execute: false

    Will run request by default, passing false will return the API request instead

  Returns {
      "!/tools/file/update": {
          field: string;
          ids: number[];
          row: number;
          slice: number;
      };
  }

  The API response by default, or the raw API request if execute is false

get

• get(id: number, ignoreToken?: boolean): string

  Get an authenticated URL to fetch files from

  Parameters

  • id: number

    File ID
  • OptionalignoreToken: boolean

    Ignore authentication

  Returns string

  URL file can be viewed at

upload

• upload(
      files: File | FileList | File[],
      associate?: { field: string; pk?: string; row: any; slice: number },
  ): Promise<UploadedFile[]>

  Upload file(s) to the API & optionally associate them with a row

  Parameters

  • files: File | FileList | File[]

    Files to be uploaded
  • Optionalassociate: { field: string; pk?: string; row: any; slice: number }

    Row to associate with

  Returns Promise<UploadedFile[]>