@ohos.data.cloudData (端云服务)

导入模块

import { cloudData } from '@kit.ArkData';

StrategyType

云同步策略类型枚举。

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

NetWorkStrategy

网络策略参数枚举。

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

AutoSyncTriggerModeBeta

自动同步触发模式枚举。

起始版本： 26.0.0

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

模型约束： 此接口仅可在Stage模型下使用。

AutoSyncTriggerInfoBeta

自动同步触发信息。

起始版本： 26.0.0

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

模型约束： 此接口仅可在Stage模型下使用。

cloudData.setCloudStrategy

setCloudStrategy(strategy: StrategyType, param?: Array<commonType.ValueType>): Promise<void>

设置应用自身的云同步策略，使用Promise异步回调。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码。

样例：

import { BusinessError } from '@kit.BasicServicesKit';

// 仅WIFI同步
cloudData.setCloudStrategy(cloudData.StrategyType.NETWORK, [cloudData.NetWorkStrategy.WIFI]).then(() => {
    console.info('Succeeded in setting the cloud strategy');
}).catch((err: BusinessError) => {
    console.error(`Failed to set cloud strategy. Code: ${err.code}, message: ${err.message}`);
});

cloudData.onAutoSyncTriggerBeta

onAutoSyncTrigger(observer: Callback<AutoSyncTriggerInfo>): void

在已打开端云同步，并且应用关闭自动同步条件下，注册自动同步触发事件通知，自动同步进行时调用回调。

起始版本： 26.0.0

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

模型约束： 此接口仅可在Stage模型下使用。

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import { cloudData } from '@kit.ArkData';

function autoSyncTriggerObserver(info: cloudData.AutoSyncTriggerInfo) {
  console.info(`Auto sync triggered, mode: ${info.mode}`);
}

cloudData.onAutoSyncTrigger(autoSyncTriggerObserver);

cloudData.offAutoSyncTriggerBeta

offAutoSyncTrigger(observer?: Callback<AutoSyncTriggerInfo>): void

取消订阅自动同步触发事件通知。

起始版本： 26.0.0

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

模型约束： 此接口仅可在Stage模型下使用。

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import { cloudData } from '@kit.ArkData';

function autoSyncTriggerObserver(info: cloudData.AutoSyncTriggerInfo) {
  console.info(`Auto sync triggered, mode: ${info.mode}`);
}

// 订阅
cloudData.onAutoSyncTrigger(autoSyncTriggerObserver);

// 取消指定订阅
cloudData.offAutoSyncTrigger(autoSyncTriggerObserver);

// 取消所有订阅
cloudData.offAutoSyncTrigger();