@ohos.file.cloudSync (端云同步能力)(系统接口)

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

说明：

• 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.file.cloudSync (端云同步能力)。

导入模块

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

SyncState

端云同步状态，为枚举类型。

说明：

以下同步状态发生变更时，如果应用注册了同步过程事件监听，则通过回调通知应用。

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

系统接口： 该接口为系统接口。

ErrorType

端云同步失败类型，为枚举类型。

• 当前阶段，同步过程中，当移动数据网络和WIFI均不可用时，才会返回NETWORK_UNAVAILABLE；若有一种类型网络可用，则能正常同步。
• 同步过程中，非充电场景下，电量低于15%，完成当前批上行同步后停止同步，返回低电量；电量低于10%，完成当前批上行同步后停止同步，返回告警电量。
• 触发同步时，非充电场景下，若电量低于15%，则不允许同步，start接口返回对应错误。
• 上行时，若云端空间不足，则文件上行失败，云端无该文件记录。
• 下行时，若本地空间不足，则文件下行失败，本地空间释放后再次同步会重新下行。

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

系统接口： 该接口为系统接口。

SyncProgress

端云同步过程。

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

系统接口： 该接口为系统接口。

GallerySync

云图同步对象，用来支撑图库应用媒体资源端云同步流程。在使用前，需要先创建GallerySync实例。

constructor

constructor()

端云同步流程的构造函数，用于获取GallerySync类的实例。

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

系统接口： 该接口为系统接口。

示例：

let gallerySync = new cloudSync.GallerySync()

on

on(evt: 'progress', callback: (pg: SyncProgress) => void): void

添加同步过程事件监听。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

let gallerySync = new cloudSync.GallerySync();

gallerySync.on('progress', (pg: cloudSync.SyncProgress) => {
  console.info("syncState：" + pg.state);
});

off

off(evt: 'progress', callback: (pg: SyncProgress) => void): void

移除同步过程事件监听。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

let gallerySync = new cloudSync.GallerySync();

let callback = (pg: cloudSync.SyncProgress) => {
  console.info("gallery sync state：" + pg.state + "error type:" + pg.error);
}

gallerySync.on('progress', callback);

gallerySync.off('progress', callback);

off

off(evt: 'progress'): void

移除同步过程事件监听。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

let gallerySync = new cloudSync.GallerySync();

gallerySync.on('progress', (pg: cloudSync.SyncProgress) => {
    console.info("syncState：" + pg.state);
});

gallerySync.off('progress');

start

start(): Promise<void>

异步方法启动端云同步, 以Promise形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let gallerySync = new cloudSync.GallerySync();

gallerySync.on('progress', (pg: cloudSync.SyncProgress) => {
    console.info("syncState：" + pg.state);
});

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

start

start(callback: AsyncCallback<void>): void

异步方法启动端云同步, 以callback形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let gallerySync = new cloudSync.GallerySync();

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

stop

stop(): Promise<void>

异步方法停止端云同步, 以Promise形式返回结果。

说明：

调用stop接口，同步流程会停止。再次调用start接口会继续同步。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let gallerySync = new cloudSync.GallerySync();

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

stop

stop(callback: AsyncCallback<void>): void

异步方法停止端云同步, 以callback形式返回结果。

说明：

调用stop接口，同步流程会停止。再次调用start接口会继续同步。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let gallerySync = new cloudSync.GallerySync();

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

Download

云文件下载对象，用来支撑图库应用原图文件下载流程。在使用前，需要先创建Download实例。

constructor

constructor()

云文件下载流程的构造函数，用于获取Download类的实例。

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

系统接口： 该接口为系统接口。

示例：

let download = new cloudSync.Download()

on

on(evt: 'progress', callback: (pg: DownloadProgress) => void): void

添加云文件下载过程事件监听。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

let download = new cloudSync.Download();

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

off

off(evt: 'progress', callback: (pg: DownloadProgress) => void): void

移除云文件下载过程事件监听。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

let download = new cloudSync.Download();

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

download.on('progress', callback);

download.off('progress', callback);

off

off(evt: 'progress'): void

移除云文件下载过程事件监听。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

let download = new cloudSync.Download();

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

download.off('progress');

start

start(uri: string): Promise<void>

异步方法启动云文件下载, 以Promise形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';
let download = new cloudSync.Download();
let uri: string = "file:///media/Photo/1";

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

download.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形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let download = new cloudSync.Download();
let uri: string = "file:///media/Photo/1";

download.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接口会重新开始下载

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let download = new cloudSync.Download();
let uri: string = "file:///media/Photo/1";

download.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接口会重新开始下载

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let download = new cloudSync.Download();
let uri: string = "file:///media/Photo/1";

download.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");
  }
});

FileSync¹¹⁺

云盘同步对象，用于支撑文件管理器应用完成云盘文件的端云同步流程。在使用前，需要先创建FileSync实例。

constructor¹¹⁺

constructor()

端云同步流程的构造函数，用于获取FileSync类的实例。

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

系统接口： 该接口为系统接口。

错误码：

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

示例：

let fileSync = new cloudSync.FileSync()

on¹¹⁺

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

添加同步过程事件监听。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

let fileSync = new cloudSync.FileSync();
let callback = (pg: cloudSync.SyncProgress) => {
  console.info("file sync state：" + pg.state + "error type:" + pg.error);
}

fileSync.on('progress', callback);

off¹¹⁺

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

移除同步过程事件监听。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

let fileSync = new cloudSync.FileSync();

let callback = (pg: cloudSync.SyncProgress) => {
  console.info("file sync state：" + pg.state + "error type:" + pg.error);
}

fileSync.on('progress', callback);

fileSync.off('progress', callback);

start¹¹⁺

start(): Promise<void>

异步方法启动云盘端云同步, 以Promise形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let fileSync = new cloudSync.FileSync();

let callback = (pg: cloudSync.SyncProgress) => {
  console.info("file sync state：" + pg.state + "error type:" + pg.error);
}

fileSync.on('progress', callback);

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

start¹¹⁺

start(callback: AsyncCallback<void>): void

异步方法启动云盘端云同步, 以callback形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let fileSync = new cloudSync.FileSync();

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

stop¹¹⁺

stop(): Promise<void>

异步方法停止云盘端云同步, 以Promise形式返回结果。

调用stop接口，同步流程会停止。再次调用start接口会继续同步。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let fileSync = new cloudSync.FileSync();

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

stop¹¹⁺

stop(callback: AsyncCallback<void>): void

异步方法停止云盘端云同步, 以callback形式返回结果。

调用stop接口，同步流程会停止。再次调用start接口会继续同步。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let fileSync = new cloudSync.FileSync();

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

getLastSyncTime¹¹⁺

getLastSyncTime(): Promise<number>

异步方法获取上次同步时间, 以promise形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let fileSync = new cloudSync.FileSync();

fileSync.getLastSyncTime().then((timeStamp: number) => {
  let date = new Date(timeStamp);
  console.info("get last sync time successfully:"+ date);
}).catch((err: BusinessError) => {
    console.info("get last sync time failed with error message: " + err.message + ", error code: " + err.code);
});

getLastSyncTime¹¹⁺

getLastSyncTime(callback: AsyncCallback<number>): void;

异步方法获取上次同步时间, 以callback形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let fileSync = new cloudSync.FileSync();

fileSync.getLastSyncTime((err: BusinessError, timeStamp: number) => {
  if (err) {
    console.info("get last sync time with error message: " + err.message + ", error code: " + err.code);
  } else {
    let date = new Date(timeStamp);
    console.info("get last sync time successfully:"+ date);
  }
});

CloudFileCache¹¹⁺

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

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

cleanCache¹¹⁺

cleanCache(uri: string): void;

同步方法删除文件缓存

需要权限：ohos.permission.CLOUDFILE_SYNC

系统能力：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);

try {
  fileCache.cleanCache(uri);
} catch (err) {
  let error:BusinessError = err as BusinessError;
  console.info("clean cache failed with error message: " + err.message + ", error code: " + err.code);
} 

cloudSync.getFileSyncState¹¹⁺

getFileSyncState(uri: Array<string>): Promise<Array<FileSyncState>>

异步方法获取文件同步状态, 以promise形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';

let uris: Array<string> = ["file://uri"];
cloudSync.getFileSyncState(uris).then(function(syncStates: Array<cloudSync.FileSyncState>) {
  for(let i = 0, len = syncStates.length; i < len; i++){
      console.info("get file sync state successfully" + syncStates[i]);
  }
}).catch((err: BusinessError) => {
    console.info("get file sync state failed with error message: " + err.message + ", error code: " + err.code);
});

cloudSync.getFileSyncState¹¹⁺

getFileSyncState(uri: Array<string>, callback: AsyncCallback<Array<FileSyncState>>): void

异步方法获取文件同步状态, 以callback形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC

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

系统接口： 该接口为系统接口。

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';

let uris: Array<string> = ["file://uri"];
cloudSync.getFileSyncState(uris, (err: BusinessError, syncStates: Array<cloudSync.FileSyncState>) => {
  if (err) {
    console.info("get file sync state with error message: " + err.message + ", error code: " + err.code);
  } else {
    for(let i = 0, len = syncStates.length; i < len; i++){
      console.info("get file sync state successfully" + syncStates[i]);
  }
  }
});

FileSyncState¹¹⁺

端云文件同步状态，为枚举类型。

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

系统接口： 该接口为系统接口。