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