Methods

api.downloadFile()

Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates

Parameters DownloadFileParams:

Parameters

Interface

Name	Type	Description
`fileId`	`number`	Identifier of the file to download
`priority`	`number`	Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile was called will be downloaded first
`offset`	`number`	The starting position from which the file needs to be downloaded
`limit`	`number`	Number of bytes which need to be downloaded starting from the "offset" position before the download will automatically be canceled; use 0 to download without a limit
`synchronous`	`boolean`	If false, this request returns file state just after the download has been started. If true, this request returns file state only after the download has succeeded, has failed, has been canceled or a new downloadFile request with different offset/limit parameters was sent

Returns ApiResponse interface:

interface ApiResponse {
  _: 'downloadFile' | 'error'
  airgram: Airgram
  request: {
    method: 'downloadFile'
    params: DownloadFileParams
  }
  response: FileUnion
 | Error
  setState: (nextState: Record<string, unknown>) => void
  getState: () => Record<string, unknown>
}