1# @ohos.file.cloudSyncManager (端云同步管理能力) 2<!--Kit: Core File Kit--> 3<!--Subsystem: FileManagement--> 4<!--Owner: @zsyztt; @Hermits; @reminder2352--> 5<!--Designer: @yunlanying--> 6<!--Tester: @liuhonggang123--> 7<!--Adviser: @foryourself--> 8 9该模块向云空间应用提供端云同步管理能力：包括使能/去使能端云协同能力、修改应用同步开关，云端数据变化通知以及账号退出清理/保留云相关文件等。 10 11> **说明：** 12> 13> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 14 15## 导入模块 16 17```ts 18import { cloudSyncManager } from '@kit.CoreFileKit'; 19``` 20## DownloadStopReason<sup>20+</sup> 21 22降级下载停止原因的枚举，默认值为NO_STOP。 23 24**系统能力**：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager 25 26| 名称 | 值 | 说明 | 27| ------------------- | --- | ------------------------------------------------------ | 28| NO_STOP | 0 | 下载中未停止。 | 29| NETWORK_UNAVAILABLE | 1 | 下载过程中，移动数据网络和WIFI均不可用。 | 30| LOCAL_STORAGE_FULL | 2 | 下载过程中，当前设备空间不足。 | 31| TEMPERATURE_LIMIT | 3 | 下载过程中，设备温度过高。 | 32| USER_STOPPED | 4 | 下载过程中，客户端主动停止下载。 | 33| APP_UNLOAD | 5 | 下载过程中，云文件所属应用被卸载。 | 34| OTHER_REASON | 6 | 下载过程中，因其他原因停止下载，如：云服务器未响应等。 | 35 36## DownloadState<sup>20+</sup> 37 38降级下载任务状态的枚举。 39 40**系统能力**：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager 41 42| 名称 | 值 | 说明 | 43| --------- | --- | ---------- | 44| RUNNING | 0 | 下载中。 | 45| COMPLETED | 1 | 下载完成。 | 46| STOPPED | 2 | 下载停止。 | 47 48## DownloadProgress<sup>20+</sup> 49 50降级下载任务的进度信息。 51 52**系统能力**：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager 53 54### 属性 55 56| 名称 | 类型 | 只读 | 可选 | 说明 | 57| --------------- | ------------------------------------------- | ---- | ---- | ----------------------------------------------------------------------------- | 58| state | [DownloadState](#downloadstate20) | 否 | 否 | 下载任务的状态。 | 59| successfulCount | number | 否 | 否 | 已下载的文件个数，取值范围[0, INT32_MAX]，单位：个。进度异常时返回-1。 | 60| failedCount | number | 否 | 否 | 下载失败的文件个数，取值范围[0, INT32_MAX]，单位：个。进度异常时返回-1。 | 61| totalCount | number | 否 | 否 | 待下载文件总个数，取值范围[0, INT32_MAX]，单位：个。进度异常时返回-1。 | 62| downloadedSize | number | 否 | 否 | 已下载数据大小，取值范围[0, INT64_MAX)，单位：Byte。进度异常时返回INT64_MAX。 | 63| totalSize | number | 否 | 否 | 需要下载文件的总大小，取值范围[0, INT64_MAX)，单位：Byte。进度异常时返回INT64_MAX。 | 64| stopReason | [DownloadStopReason](#downloadstopreason20) | 否 | 否 | 下载停止的原因。 | 65 66## CloudFileInfo<sup>20+</sup> 67 68应用本地和云端文件个数以及大小信息。 69 70**系统能力**：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager 71 72### 属性 73 74| 名称 | 类型 | 只读 | 可选 | 说明 | 75| ------------------ | ------ | ---- | ---- | ---------------------------------------------------------------- | 76| cloudFileCount | number | 否 | 否 | 本地未下载的云端文件总个数，取值范围[0, INT32_MAX]，单位：个。 | 77| cloudFileTotalSize | number | 否 | 否 | 本地未下载的云端文件总大小，取值范围[0, INT64_MAX]，单位：Byte。 | 78| localFileCount | number | 否 | 否 | 本地未上传云端的文件总个数，取值范围[0, INT32_MAX]，单位：个。 | 79| localFileTotalSize | number | 否 | 否 | 本地未上传云端的文件总大小，取值范围[0, INT64_MAX]，单位：Byte。 | 80| bothFileCount | number | 否 | 否 | 本地已上传云端的文件总个数，取值范围[0, INT32_MAX]，单位：个。 | 81| bothFileTotalSize | number | 否 | 否 | 本地已上传云端的文件总大小，取值范围[0, INT64_MAX]，单位：Byte。 | 82