• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.data.commonType (数据通用类型)
2<!--Kit: ArkData-->
3<!--Subsystem: DistributedDataManager-->
4<!--Owner: @lvcong_oh-->
5<!--Designer: @hollokin; @yuchaozhng-->
6<!--Tester: @lj_liujing; @yippo; @logic42-->
7<!--Adviser: @ge-yafang-->
8
9数据通用类型(commonType)是数据管理中通用的数据类型。
10
11> **说明:**
12>
13> 本模块首批接口从API version 11开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
14
15## 导入模块
16
17```ts
18import { commonType } from '@kit.ArkData';
19```
20
21## AssetStatus
22
23描述资产附件的状态枚举。请使用枚举名称而非枚举值。
24
25**系统能力:** SystemCapability.DistributedDataManager.CommonType
26
27| 名称              | 值  | 说明                         |
28| ----------------- | --- | ---------------------------- |
29| ASSET_NORMAL      | 1   | 表示资产状态正常。           |
30| ASSET_INSERT      | 2   | 表示资产需要插入到云端。     |
31| ASSET_UPDATE      | 3   | 表示资产需要更新到云端。     |
32| ASSET_DELETE      | 4   | 表示资产需要在云端删除。     |
33| ASSET_ABNORMAL    | 5   | 表示资产状态异常。           |
34| ASSET_DOWNLOADING | 6   | 表示资产正在下载到本地设备。 |
35
36## Asset
37
38记录资产附件(文件、图片、视频等类型文件)的相关信息,相关示例见[在跨端迁移中使用分布式数据对象迁移数据](../../database/data-sync-of-distributed-data-object.md#在跨端迁移中使用分布式数据对象迁移数据)的示例代码。
39
40**系统能力:** SystemCapability.DistributedDataManager.CommonType
41
42| 名称       | 类型                        | 必填 | 说明                               |
43| ---------- | --------------------------- | ---- | ---------------------------------- |
44| name       | string                      | 是   | 资产的名称。                       |
45| uri        | string                      | 是   | 资产的uri,在系统里的绝对路径。    |
46| path       | string                      | 是   | 资产在应用沙箱里的路径。           |
47| createTime | string                      | 是   | 资产被创建出来的时间。             |
48| modifyTime | string                      | 是   | 资产最后一次被修改的时间。         |
49| size       | string                      | 是   | 资产占用空间的大小。               |
50| status     | [AssetStatus](#assetstatus) | 否   | 资产的状态,默认值为ASSET_NORMAL。 |
51
52## Assets
53
54type Assets = Array\<Asset>
55
56表示[Asset](#asset)类型的数组。
57
58**系统能力:** SystemCapability.DistributedDataManager.CommonType
59
60| 类型                         | 说明                  |
61| ---------------------------- | --------------------- |
62| Array&lt;[Asset](#asset)&gt; | 表示Asset类型的数组。 |
63
64## ValueType
65
66type ValueType = null | number | string | boolean | Uint8Array | Asset | Assets
67
68用于表示允许的数据字段类型,接口参数具体类型根据其功能而定。
69
70**系统能力:** SystemCapability.DistributedDataManager.CommonType
71
72| 类型       | 说明                                    |
73| ---------- | --------------------------------------- |
74| null       | 表示值类型为空。                        |
75| number     | 表示值类型为数字。                      |
76| string     | 表示值类型为字符串。                    |
77| boolean    | 表示值类型为布尔值。                    |
78| Uint8Array | 表示值类型为Uint8类型的数组。           |
79| Asset      | 表示值类型为附件[Asset](#asset)。       |
80| Assets     | 表示值类型为附件数组[Assets](#assets)。 |
81
82## ValuesBucket
83
84type ValuesBucket = Record<string, ValueType>
85
86用于存储键值对的类型。该类型不是多线程安全的,如果应用中存在多线程同时操作该类派生出的实例,注意加锁保护。
87
88**系统能力:** SystemCapability.DistributedDataManager.CommonType
89
90| 类型 | 说明                  |
91| ------ | ----------------------- |
92| Record<string, [ValueType](#valuetype)> | 表示键值对类型。键的类型为string,值的类型为[ValueType](#valuetype)。|
93