@ohos.file.cloudSync (端云同步能力)

该模块向应用提供端云同步能力，包括启动/停止端云同步以及启动/停止原图下载功能。

说明：

本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import cloudSync from '@ohos.file.cloudSync';

State¹¹⁺

云文件下载状态，为枚举类型。

系统能力: SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

DownloadProgress¹¹⁺

云文件下载过程。

系统能力: SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

CloudFileCache¹¹⁺

云盘文件缓存对象，用来支撑文件管理应用原文件下载流程。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

construct¹¹⁺

constructor()

云盘文件缓存流程的构造函数，用于获取CloudFileCache类的实例。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

错误码：

示例：

let fileCache = new cloudSync.CloudFileCache();

on¹¹⁺

on(event: 'progress', callback: Callback<DownloadProgress>): void

添加云盘文件缓存过程事件监听。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

参数：

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

示例：

let fileCache = new cloudSync.CloudFileCache();
let callback = (pg: cloudSync.DownloadProgress) => {
  console.info("download state：" + pg.state);
};

fileCache.on('progress', callback);

off¹¹⁺

off(event: 'progress', callback?: Callback<DownloadProgress>): void

移除云盘文件缓存过程事件监听。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

参数：

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

示例：

let fileCache = new cloudSync.CloudFileCache();

let callback = (pg: cloudSync.DownloadProgress) => {
  console.info("download state：" + pg.state);
}

fileCache.on('progress', callback);

fileCache.off('progress', callback);

start¹¹⁺

start(uri: string): Promise<void>

异步方法启动云盘文件缓存, 以Promise形式返回结果。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
import fileUri from '@ohos.file.fileuri';
let fileCache = new cloudSync.CloudFileCache();
let path = "/data/storage/el2/cloud/1.txt";
let uri = fileUri.getUriFromPath(path);

fileCache.on('progress', (pg: cloudSync.DownloadProgress) => {
  console.info("download state:" + pg.state);
});

fileCache.start(uri).then(() => {
  console.info("start download successfully");
}).catch((err: BusinessError) => {
  console.info("start download failed with error message: " + err.message + ", error code: " + err.code);
});

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

start¹¹⁺

start(uri: string, callback: AsyncCallback<void>): void

异步方法启动云盘文件缓存, 以callback形式返回结果。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

参数：

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

示例：

import { BusinessError } from '@ohos.base';
import fileUri from '@ohos.file.fileuri';
let fileCache = new cloudSync.CloudFileCache();
let path = "/data/storage/el2/cloud/1.txt";
let uri = fileUri.getUriFromPath(path);

fileCache.start(uri, (err: BusinessError) => {
  if (err) {
    console.info("start download failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("start download successfully");
  }
});

stop¹¹⁺

stop(uri: string): Promise<void>

异步方法停止云盘文件缓存, 以Promise形式返回结果。

调用stop接口, 当前文件下载流程会终止, 缓存文件会被删除, 再次调用start接口会重新开始下载。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

示例：

import { BusinessError } from '@ohos.base';
import fileUri from '@ohos.file.fileuri';
let fileCache = new cloudSync.CloudFileCache();
let path = "/data/storage/el2/cloud/1.txt";
let uri = fileUri.getUriFromPath(path);

fileCache.stop(uri).then(() => {
  console.info("stop download successfully");
}).catch((err: BusinessError) => {
  console.info("stop download failed with error message: " + err.message + ", error code: " + err.code);
});

stop¹¹⁺

stop(uri: string, callback: AsyncCallback<void>): void

异步方法停止云盘文件缓存, 以callback形式返回结果。

调用stop接口, 当前文件下载流程会终止, 缓存文件会被删除, 再次调用start接口会重新开始下载。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSync.Core

参数：

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

示例：

import { BusinessError } from '@ohos.base';
import fileUri from '@ohos.file.fileuri';
let fileCache = new cloudSync.CloudFileCache();
let path = "/data/storage/el2/cloud/1.txt";
let uri = fileUri.getUriFromPath(path);

fileCache.stop(uri, (err: BusinessError) => {
  if (err) {
    console.info("stop download failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("stop download successfully");
  }
});

DownloadErrorType¹¹⁺

端云下载错误类型，为枚举类型。

系统能力: SystemCapability.FileManagement.DistributedFileService.CloudSync.Core