@ohos.file.cloudSyncManager (端云同步管理能力)

该模块向云空间应用提供端云同步管理能力，包括使能/去使能端云协同能力、修改应用同步开关，云端数据变化通知以及帐号退出清理/保留云相关文件等。

说明：

• 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本模块接口为系统接口，三方应用不支持调用。

导入模块

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

cloudSyncManager.changeAppCloudSwitch

changeAppCloudSwitch(accountId: string, bundleName: string, status: boolean): Promise<void>

异步方法修改应用的端云文件同步开关，以Promise形式返回结果。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
let bundleName: string = "com.example.bundle";
cloudSyncManager.changeAppCloudSwitch(accountId, bundleName, true).then(() => {
  console.info("changeAppCloudSwitch successfully");
}).catch((err: BusinessError) => {
  console.info("changeAppCloudSwitch failed with error message: " + err.message + ", error code: " + err.code);
});

cloudSyncManager.changeAppCloudSwitch

changeAppCloudSwitch(accountId: string, bundleName: string, status: boolean, callback: AsyncCallback<void>): void

异步方法修改应用的端云文件同步开关，以callback形式返回结果。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
let bundleName: string = "com.example.bundle";
cloudSyncManager.changeAppCloudSwitch(accountId, bundleName, true, (err: BusinessError) => {
  if (err) {
    console.info("changeAppCloudSwitch failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("changeAppCloudSwitch successfully");
  }
});

cloudSyncManager.notifyDataChange

notifyDataChange(accountId: string, bundleName: string): Promise<void>

异步方法通知端云服务应用的云数据变更，以Promise形式返回结果。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
let bundleName: string = "com.example.bundle";
cloudSyncManager.notifyDataChange(accountId, bundleName).then(() => {
  console.info("notifyDataChange successfully");
}).catch((err: BusinessError) => {
  console.info("notifyDataChange failed with error message: " + err.message + ", error code: " + err.code);
});

cloudSyncManager.notifyDataChange

notifyDataChange(accountId: string, bundleName: string, callback: AsyncCallback<void>): void

异步方法通知端云服务应用的云数据变更，以callback形式返回结果。

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
let bundleName: string = "com.example.bundle";
cloudSyncManager.notifyDataChange(accountId, bundleName, (err: BusinessError) => {
  if (err) {
    console.info("notifyDataChange failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("notifyDataChange successfully");
  }
});

cloudSyncManager.enableCloud

enableCloud(accountId: string, switches: { [bundleName: string]: boolean }): Promise<void>

异步方法使能端云协同能力，以Promise形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC_MANAGER

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
let switches: Record<string, boolean> = {
  'com.example.bundleName1': true,
  'com.example.bundleName2': false
}
cloudSyncManager.enableCloud(accountId, switches).then(() => {
  console.info("enableCloud successfully");
}).catch((err: BusinessError) => {
  console.info("enableCloud failed with error message: " + err.message + ", error code: " + err.code);
});

cloudSyncManager.enableCloud

enableCloud(accountId: string, switches: { [bundleName: string]: boolean }, callback: AsyncCallback<void>): void

异步方法使能端云协同能力，以callback形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC_MANAGER

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
let switches: Record<string, boolean> = {
  'com.example.bundleName1': true,
  'com.example.bundleName2': false
}
cloudSyncManager.enableCloud(accountId, switches, (err: BusinessError) => {
  if (err) {
    console.info("enableCloud failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("enableCloud successfully");
  }
});

cloudSyncManager.disableCloud

disableCloud(accountId: string): Promise<void>

异步方法去使能端云协同能力，以Promise形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC_MANAGER

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
cloudSyncManager.disableCloud(accountId).then(() => {
  console.info("disableCloud successfully");
}).catch((err: BusinessError) => {
  console.info("disableCloud failed with error message: " + err.message + ", error code: " + err.code);
});

cloudSyncManager.disableCloud

disableCloud(accountId: string, callback: AsyncCallback<void>): void

异步方法去使能端云协同能力，以callback形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC_MANAGER

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
cloudSyncManager.disableCloud(accountId, (err: BusinessError) => {
  if (err) {
    console.info("disableCloud failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("disableCloud successfully");
  }
});

Action

清理本地云相关数据时的Action，为枚举类型。

需要权限：ohos.permission.CLOUDFILE_SYNC_MANAGER

系统能力: SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

cloudSyncManager.clean

clean(accountId: string, appActions: { [bundleName: string]: Action }): Promise<void>

异步方法清理本地云相关数据，以Promise形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC_MANAGER

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

返回值：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
let appActions: Record<string, cloudSyncManager.Action> = {
  'com.example.bundleName1': cloudSyncManager.Action.RETAIN_DATA,
  'com.example.bundleName2': cloudSyncManager.Action.CLEAR_DATA
};
cloudSyncManager.clean(accountId, appActions).then(() => {
  console.info("clean successfully");
}).catch((err: BusinessError) => {
  console.info("clean failed with error message: " + err.message + ", error code: " + err.code);
});

cloudSyncManager.clean

clean(accountId: string, appActions: { [bundleName: string]: Action }, callback: AsyncCallback<void>): void

异步方法清理本地云相关数据，以callback形式返回结果。

需要权限：ohos.permission.CLOUDFILE_SYNC_MANAGER

系统能力：SystemCapability.FileManagement.DistributedFileService.CloudSyncManager

参数：

错误码：

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

示例：

import { BusinessError } from '@ohos.base';
let accountId: string = "testAccount";
  let appActions: Record<string, cloudSyncManager.Action> = {
  'com.example.bundleName1': cloudSyncManager.Action.RETAIN_DATA,
  'com.example.bundleName2': cloudSyncManager.Action.CLEAR_DATA
};
cloudSyncManager.clean(accountId, appActions, (err: BusinessError) => {
  if (err) {
    console.info("clean failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("clean successfully");
  }
});