@ concessor/ file- transfer

File Transfer API提供了下载和上传文件的机制.

安装

npm install @capacitor/file-transfer
npx cap sync

示例

下载

import { FileTransfer } from '@capacitor/file-transfer';
import { Filesystem, Directory } from '@capacitor/filesystem';

// First get the full file path using Filesystem
const fileInfo = await Filesystem.getUri({
  directory: Directory.Data,
  path: 'downloaded-file.pdf'
});

try {
    // Then use the FileTransfer plugin to download
    await FileTransfer.downloadFile({
        url: 'https://example.com/file.pdf',
        path: fileInfo.uri,
        progress: true
    });
} catch(error) {
    if (error.code === 'OS-PLUG-FLTR-0010') {
      // HTTP error - see `FileTransferError` for details on fields available in `errorData`
      let errorData = error.data;
      this.showError('Upload failed: ' + errorData.httpStatus + '; ' + errorData.body);
    } else {
      // other errors - use `error.code` and `error.message` for more information.
      this.showError('Upload failed: ' + error.code + '; ' + error.message);
    }
}

// Progress events
FileTransfer.addListener('progress', (progress) => {
  console.log(`Downloaded ${progress.bytes} of ${progress.contentLength}`);
});

上传

import { FileTransfer } from '@capacitor/file-transfer';
import { Filesystem, Directory } from '@capacitor/filesystem';

// First get the full file path using Filesystem
const fileInfo = await Filesystem.getUri({
  directory: Directory.Cache,
  path: 'image_upload.png'
});

try {
    // Then use the FileTransfer plugin to upload
    const result = await FileTransfer.uploadFile({
        url: 'https://example.com/upload_api',
        path: fileInfo.uri,
        chunkedMode: true,
        headers: {
            // Upload uses `multipart/form-data` by default.
            // If you want to avoid that, you can set the 'Content-Type' header explicitly.
            'Content-Type': 'application/octet-stream',
        },
        progress: false
    });
    // get server response and other info from result - see `UploadFileResult` interface
} catch(error) {
    if (error.code === 'OS-PLUG-FLTR-0010') {
      // HTTP error - see `FileTransferError` for details on fields available in `errorData`
      let errorData = error.data;
      this.showError('Upload failed: ' + errorData.httpStatus + '; ' + errorData.body);
    } else {
      // other errors - use `error.code` and `error.message` for more information.
      this.showError('Upload failed: ' + error.code + '; ' + error.message);
    }
}

API 密码

• downloadFile(...)
• uploadFile(...)
• addListener('progress', ...)
• removeAllListeners()
• 接口

注:一些输入选项来自 HttpOptions 内 @capacitor/core,但插件没有使用来自 HttpOptions兹将所使用的标准说明如下.

现有错误代码列表参见 错误。 。 。 .

下载文件(...)

downloadFile(options: DownloadFileOptions) => Promise<DownloadFileResult>

向服务器执行 HTTP 请求,并将文件下载到指定的目的地 .

如果服务器返回 HTTP 错误( 如 404, 500等), 则承诺会被拒绝 . 要获得Android和iOS运行时HTTP错误响应的信息(不适用于网络),请使用 FileTransferError 接口可用 error.data 属性.

回返情况: Promise<DownloadFileResult>

自: 1.0.0 (单位:千美元)

上传文件(...)

uploadFile(options: UploadFileOptions) => Promise<UploadFileResult>

执行 HTTP 上传文件到服务器的请求 .

如果服务器返回 HTTP 错误( 如 404, 500等), 则承诺会被拒绝 . 要获得运行Android和iOS(不适用于网络)时HTTP错误响应的信息,请使用 FileTransferError 接口可用 error.data 属性.

回返情况: Promise<UploadFileResult>

自: 1.0.0 (单位:千美元)

添加倾听器( “ 进度 ” ,...)

addListener(eventName: "progress", listenerFunc: (progress: ProgressStatus) => void) => Promise<PluginListenerHandle>

在文件传输(下載或上傳)进度事件上添加一个收听器.

回返情况: Promise<PluginListenerHandle>

自: 1.0.0 (单位:千美元)

删除所有收听器( )

removeAllListeners() => Promise<void>

删除此插件的所有听众 .

自: 1.0.0 (单位:千美元)

接口

下载文件

下载文件选项

图片

Http 信头

上传文件

上传文件选项

插件听筒

进展现状

文件传输错误

错误

插件返回以下带有iOS、Android和Web特定代码的错误:

在处理应用程序中的错误时,您可以检查错误代码以确定具体的问题. 错误对象通常包含额外信息,例如:

• code: 错误代码(如上表所示)
• message: 对错误的可读描述
• source: 传输源(文件路径或 URL)
• target: 传输的目标(文件路径或 URL)
• httpStatus: HTTP 状态代码(用于 HTTP 错误)
• body: 响应正体(用于 HTTP 错误)
• headers: 响应头 (用于 HTTP 错误)