Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type Aliases

UploadOptions: { chunkSize?: number; contentType?: string; dashboard?: string; fieldId?: string; isPublic?: boolean; maxTriesForEachChunk?: number; timeoutForEachFailedChunk?: number; widget?: string; onCancelToken?: any; onProgress?: any }

Type declaration

  • Optional chunkSize?: number

    the byte size of each chunk sent to TagoIO. This will influence how many requests this function will perform

  • Optional contentType?: string

    The file's content type. This is optional

  • Optional dashboard?: string

    Dashboard ID.

    Uploading files from a widget requires dashboard, widget, and fieldId to be provided.

  • Optional fieldId?: string

    ID of the field from the widget where the file is selected.

    Uploading files from a widget requires dashboard, widget, and fieldId to be provided.

  • Optional isPublic?: boolean

    if the file can be accessed by anybody with a link or not

  • Optional maxTriesForEachChunk?: number

    the maximum amount of tries to upload each chunk to TagoIO. After this many unsuccessful tries of a single chunk, the upload is aborted

  • Optional timeoutForEachFailedChunk?: number

    timeout before trying to upload the same chunk if the request failed

  • Optional widget?: string

    Widget ID.

    Uploading files from a widget requires dashboard, widget, and fieldId to be provided.

  • onCancelToken?:function
    • onCancelToken(cancel: (() => void)): any
  • onProgress?:function
    • onProgress(percentage: number): any