@ohos.data.cloudData (端云协同)

端云协同提供结构化数据（RDB Store）端云同步的能力。即：云作为数据的中心节点，通过与云的数据同步，实现数据云备份、同帐号设备间的数据一致性。

该模块提供以下端云协同相关的常用功能：

• Config：提供配置端云协同的方法，包括云同步打开、关闭、清理数据、数据变化通知。

说明：

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

• 本模块接口为系统接口。

导入模块

import cloudData from '@ohos.data.cloudData';

ClearAction

清除本地下载的云端数据的行为枚举。

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

Config

提供配置端云协同的方法，包括云同步打开、关闭、清理数据、数据变化通知。

enableCloud

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

打开端云协同，使用callback异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

参数：

示例：

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

let account = 'test_id';
let switches: Record<string, boolean> = { 'test_bundleName1': true, 'test_bundleName2': false };
try {
  cloudData.Config.enableCloud(account, switches, (err) => {
    if (err === undefined) {
      console.info('Succeeded in enabling cloud');
    } else {
      console.error(`Failed to enable.Code: ${err.code}, message: ${err.message}`);
    }
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

enableCloud

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

打开端云协同，使用Promise异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

参数：

返回值：

示例：

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

let account = 'test_id';
let switches: Record<string, boolean> = { 'test_bundleName1': true, 'test_bundleName2': false };
try {
  cloudData.Config.enableCloud(account, switches).then(() => {
    console.info('Succeeded in enabling cloud');
  }).catch((err: BusinessError) => {
    console.error(`Failed to enable.Code: ${err.code}, message: ${err.message}`);
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

disableCloud

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

关闭端云协同，使用callback异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

参数：

示例：

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

let account = 'test_id';
try {
  cloudData.Config.disableCloud(account, (err) => {
    if (err === undefined) {
      console.info('Succeeded in disabling cloud');
    } else {
      console.error(`Failed to disableCloud. Code: ${err.code}, message: ${err.message}`);
    }
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

disableCloud

static disableCloud(accountId: string): Promise<void>

关闭端云协同，使用Promise异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

参数：

返回值：

示例：

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

let account = 'test_id';
try {
  cloudData.Config.disableCloud(account).then(() => {
    console.info('Succeeded in disabling cloud');
  }).catch((err: BusinessError) => {
    console.error(`Failed to disableCloud. Code: ${err.code}, message: ${err.message}`);
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

changeAppCloudSwitch

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

修改单个应用端云协同开关，使用callback异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

参数：

示例：

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

let account = 'test_id';
let bundleName = 'test_bundleName';
try {
  cloudData.Config.changeAppCloudSwitch(account, bundleName, true, (err) => {
    if (err === undefined) {
      console.info('Succeeded in changing App cloud switch');
    } else {
      console.error(`Failed to change App cloud switch. Code: ${err.code}, message: ${err.message}`);
    }
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

changeAppCloudSwitch

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

修改单个应用端云协同开关，使用Promise异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

参数：

返回值：

示例：

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

let account = 'test_id';
let bundleName = 'test_bundleName';
try {
  cloudData.Config.changeAppCloudSwitch(account, bundleName, true).then(() => {
    console.info('Succeeded in changing App cloud switch');
  }).catch((err: BusinessError) => {
    console.error(`Failed to change App cloud switch. Code is ${err.code}, message is ${err.message}`);
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

notifyDataChange

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

通知云端的数据变更，使用callback异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Server

参数：

示例：

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

let account = 'test_id';
let bundleName = 'test_bundleName';
try {
  cloudData.Config.notifyDataChange(account, bundleName, (err) => {
    if (err === undefined) {
      console.info('Succeeded in notifying the change of data');
    } else {
      console.error(`Failed to notify the change of data. Code: ${err.code}, message: ${err.message}`);
    }
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

notifyDataChange

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

通知云端的数据变更，使用Promise异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Server

参数：

返回值：

示例：

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

let account = 'test_id';
let bundleName = 'test_bundleName';
try {
  cloudData.Config.notifyDataChange(account, bundleName).then(() => {
    console.info('Succeeded in notifying the change of data');
  }).catch((err: BusinessError) => {
    console.error(`Failed to notify the change of data. Code: ${err.code}, message: ${err.message}`);
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

clear

static clear(accountId: string, appActions: {[bundleName: string]: ClearAction}, callback: AsyncCallback<void>):void

清除本地下载的云端数据，使用callback异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

参数：

示例：

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

let action = cloudData.ClearAction;
let account = "test_id";
type dataType = Record<string, cloudData.ClearAction>
let appActions: dataType = {
  'test_bundleName1': action.CLEAR_CLOUD_INFO,
  'test_bundleName2': action.CLEAR_CLOUD_DATA_AND_INFO
};
try {
  cloudData.Config.clear(account, appActions, (err) => {
    if (err === undefined) {
      console.info('Succeeding in clearing cloud data');
    } else {
      console.error(`Failed to clear cloud data. Code: ${err.code}, message: ${err.message}`);
    }
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

clear

static clear(accountId: string, appActions: {[bundleName: string]: ClearAction}): Promise<void>

清除本地下载的云端数据，使用Promise异步回调。

需要权限：ohos.permission.CLOUDDATA_CONFIG

系统能力： SystemCapability.DistributedDataManager.CloudSync.Config

参数：

返回值：

示例：

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

let action = cloudData.ClearAction;
let account = "test_id";
type dataType = Record<string, cloudData.ClearAction>;
let appActions: dataType = {
  'test_bundleName1': action.CLEAR_CLOUD_INFO,
  'test_bundleName2': action.CLEAR_CLOUD_DATA_AND_INFO
};
try {
  cloudData.Config.clear(account, appActions).then(() => {
    console.info('Succeeding in clearing cloud data');
  }).catch((err: BusinessError) => {
    console.error(`Failed to clear cloud data. Code: ${err.code}, message: ${err.message}`);
  });
} catch (e) {
  let error = e as BusinessError;
  console.error(`An unexpected error occurred. Code: ${error.code}, message: ${error.message}`);
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)