• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.data.cloudData (端云服务)
2<!--Kit: ArkData-->
3<!--Subsystem: DistributedDataManager-->
4<!--Owner: @lvcong_oh-->
5<!--Designer: @lvcong_oh-->
6<!--Tester: @ltttjs; @logic42-->
7<!--Adviser: @ge-yafang-->
8
9端云服务提供端云协同、端云共享和端云策略。
10
11端云协同提供结构化数据(RDB Store)端云同步的能力。即:云作为数据的中心节点,通过与云的数据同步,实现数据云备份、同账号设备间的数据一致性。
12端云配置提供端云同步策略配置的能力。
13
14> **说明:**
15>
16> - 本模块首批接口从API version 12开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
17
18## 导入模块
19
20```ts
21import { cloudData } from '@kit.ArkData';
22```
23
24## StrategyType
25
26云同步策略类型枚举。
27
28**系统能力:** SystemCapability.DistributedDataManager.CloudSync.Client
29
30| 名称      | 值 | 说明        |
31| --------- |---|-----------|
32| NETWORK | 0 | 通过网络同步策略。 |
33
34## NetWorkStrategy
35
36网络策略参数枚举。
37
38**系统能力:** SystemCapability.DistributedDataManager.CloudSync.Client
39
40| 名称      | 值 | 说明        |
41| --------- |---|-----------|
42| WIFI | 1 | WIFI网络策略。 |
43| CELLULAR | 2 | 蜂窝网络策略。   |
44
45## cloudData.setCloudStrategy
46setCloudStrategy(strategy: StrategyType, param?: Array&lt;commonType.ValueType&gt;): Promise&lt;void&gt;
47
48<!--RP1-->
49设置应用自身的云同步策略,若未设置,则执行全局策略[setGlobalCloudStrategy](js-apis-data-cloudData-sys.md#setglobalcloudstrategy12),全局策略若未设置,默认使用WIFI和蜂窝策略。使用Promise异步回调。<!--RP1End-->
50
51**系统能力:** SystemCapability.DistributedDataManager.CloudSync.Client
52
53**参数:**
54
55| 参数名     | 类型                                                                          | 必填 | 说明                             |
56| ---------- |-----------------------------------------------------------------------------| ---- | -------------------------------- |
57| strategy  | [StrategyType](#strategytype)                                               | 是   | 配置的策略类型。             |
58| param | Array&lt;[commonType.ValueType](js-apis-data-commonType.md#valuetype)&gt; | 否   | 策略参数。不填写取消所有配置。 |
59
60**返回值:**
61
62| 类型                | 说明                      |
63| ------------------- | ------------------------- |
64| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
65
66**错误码:**
67
68以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
69
70| **错误码ID** | **错误信息**                                                 |
71|-----------| ------------------------------------------------------------ |
72| 401       | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
73| 801       | Capability not supported.|
74
75**样例:**
76
77```ts
78import { BusinessError } from '@kit.BasicServicesKit';
79
80// 仅WIFI同步
81cloudData.setCloudStrategy(cloudData.StrategyType.NETWORK, [cloudData.NetWorkStrategy.WIFI]).then(() => {
82    console.info('Succeeded in setting the cloud strategy');
83}).catch((err: BusinessError) => {
84    console.error(`Failed to set cloud strategy. Code: ${err.code}, message: ${err.message}`);
85});
86
87```
88<!--no_check-->
89