提交 1f426317 编写于 作者: G ge-yafang

update docs

Signed-off-by: Nge-yafang <geyafang@huawei.com>
上级 58b41f4f
......@@ -19,9 +19,10 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates):
从DataAabilityPredicates对象创建RdbPredicates对象。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库表中的表名。 |
......@@ -53,7 +54,7 @@ equalTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -81,7 +82,7 @@ notEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -109,7 +110,7 @@ beginWrap(): DataAbilityPredicates
向谓词添加左括号。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
......@@ -136,7 +137,7 @@ endWrap(): DataAbilityPredicates
向谓词添加右括号。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
......@@ -163,7 +164,7 @@ or(): DataAbilityPredicates
将或条件添加到谓词中。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
......@@ -187,7 +188,7 @@ and(): DataAbilityPredicates
将和条件添加到谓词中。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
......@@ -211,7 +212,7 @@ contains(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且value包含指定值的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -239,7 +240,7 @@ beginsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值以指定字符串开头的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -267,7 +268,7 @@ endsWith(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -295,7 +296,7 @@ isNull(field: string): DataAbilityPredicates
配置谓词以匹配值为null的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -322,7 +323,7 @@ isNotNull(field: string): DataAbilityPredicates
配置谓词以匹配值不为null的指定字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -349,7 +350,7 @@ like(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -377,7 +378,7 @@ glob(field: string, value: string): DataAbilityPredicates
配置谓词以匹配数据类型为string的指定字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -405,7 +406,7 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value在指定范围内的指定字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -434,7 +435,7 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate
配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -463,7 +464,7 @@ greaterThan(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -491,7 +492,7 @@ lessThan(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为valueType且value小于指定值的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -519,7 +520,7 @@ greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -547,7 +548,7 @@ lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -575,7 +576,7 @@ orderByAsc(field: string): DataAbilityPredicates
配置谓词以匹配其值按升序排序的列。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -602,7 +603,7 @@ orderByDesc(field: string): DataAbilityPredicates
配置谓词以匹配其值按降序排序的列。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -629,7 +630,7 @@ distinct(): DataAbilityPredicates
配置谓词以过滤重复记录并仅保留其中一个。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**返回值:**
| 类型 | 说明 |
......@@ -657,7 +658,7 @@ limitAs(value: number): DataAbilityPredicates
设置最大数据记录数的谓词。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -684,7 +685,7 @@ offsetAs(rowOffset: number): DataAbilityPredicates
配置谓词以指定返回结果的起始位置。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -711,7 +712,7 @@ groupBy(fields: Array&lt;string&gt;): DataAbilityPredicates
配置谓词按指定列分组查询结果。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -763,7 +764,7 @@ in(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -792,7 +793,7 @@ notIn(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -816,7 +817,7 @@ notIn(field: string, value: Array&lt;ValueType&gt;): DataAbilityPredicates
用于表示允许的数据字段类型。
**系统能力:**SystemCapability.DistributedDataManager.DataShare.Core。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core。
| 名称 | 说明 |
| ------- | -------------------- |
......
......@@ -17,7 +17,7 @@ createDistributedObject(source: object): DistributedObject
创建一个分布式对象。
**系统能力:**SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -44,7 +44,7 @@ genSessionId(): string
随机创建一个sessionId。
**系统能力:**SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**返回值:**
| 类型 | 说明 |
......@@ -68,7 +68,7 @@ setSessionId(sessionId?: string): boolean
设置同步的sessionId,当可信组网中有多个设备时,多个设备间的对象如果设置为同一个sessionId,就能自动同步。
**系统能力:**SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**参数:**
......@@ -101,7 +101,7 @@ on(type: 'change', callback: Callback<{ sessionId: string, fields: Array&lt;stri
监听分布式对象的变更。
**系统能力:**SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -130,7 +130,7 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array&lt;st
当不再进行数据变更监听时,使用此接口删除对象的变更监听。
**系统能力:**SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -161,7 +161,7 @@ on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, st
监听分布式对象的上下线。
**系统能力:**SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -186,7 +186,7 @@ off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, s
当不再进行对象上下线监听时,使用此接口删除对象的上下线监听。
**系统能力:**SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......
......@@ -25,7 +25,7 @@ promise.then((resultSet) => {
### 属性
**系统能力:**以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
......@@ -46,7 +46,7 @@ getColumnIndex(columnName: string): number
根据指定的列名获取列索引。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -74,7 +74,7 @@ getColumnName(columnIndex: number): string
根据指定的列索引获取列名。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -100,7 +100,7 @@ goTo(offset:number): boolean
向前或向后转至结果集的指定行,相对于其当前位置偏移。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -131,7 +131,7 @@ goToRow(position: number): boolean
转到结果集的指定行。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -163,7 +163,7 @@ goToFirstRow(): boolean
转到结果集的第一行。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值:**
| 类型 | 说明 |
......@@ -189,7 +189,7 @@ goToLastRow(): boolean
转到结果集的最后一行。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值:**
| 类型 | 说明 |
......@@ -215,7 +215,7 @@ goToNextRow(): boolean
转到结果集的下一行。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值:**
| 类型 | 说明 |
......@@ -241,7 +241,7 @@ goToPreviousRow(): boolean
转到结果集的上一行。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**返回值:**
| 类型 | 说明 |
......@@ -267,7 +267,7 @@ getBlob(columnIndex: number): Uint8Array
以字节数组的形式获取当前行中指定列的值。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -291,7 +291,7 @@ getString(columnIndex: number): string
以字符串形式获取当前行中指定列的值。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -315,7 +315,7 @@ getLong(columnIndex: number): number
以Long形式获取当前行中指定列的值。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -339,7 +339,7 @@ getDouble(columnIndex: number): number
以double形式获取当前行中指定列的值。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -363,7 +363,7 @@ isColumnNull(columnIndex: number): boolean
检查当前行中指定列的值是否为null。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -387,7 +387,7 @@ close(): void
关闭结果集。
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core。
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core。
**示例:**
```js
......
......@@ -3,7 +3,7 @@
轻量级存储为应用提供key-value键值型的文件数据处理能力,支持应用对数据进行轻量级存储及查询。数据存储形式为键值对,键的类型为字符串型,值的存储数据类型包括数字型、字符型、布尔型。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
......@@ -18,7 +18,7 @@ import dataStorage from '@ohos.data.storage';
## 常量
**系统能力:**以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
......@@ -32,7 +32,7 @@ getStorageSync(path: string): Storage
读取指定文件,将数据加载到Storage实例,用于数据操作。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -69,7 +69,7 @@ getStorage(path: string, callback: AsyncCallback&lt;Storage&gt;): void
读取指定文件,将数据加载到Storage实例,用于数据操作,使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -107,7 +107,7 @@ getStorage(path: string): Promise&lt;Storage&gt;
读取指定文件,将数据加载到Storage实例,用于数据操作,使用Promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -148,7 +148,7 @@ deleteStorageSync(path: string): void
从内存中移除指定文件对应的Storage单实例,并删除指定文件及其备份文件、损坏文件。删除指定文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -167,7 +167,7 @@ deleteStorage(path: string, callback: AsyncCallback&lt;void&gt;): void
从内存中移除指定文件对应的Storage单实例,并删除指定文件及其备份文件、损坏文件。删除指定文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -193,7 +193,7 @@ deleteStorage(path: string): Promise&lt;void&gt;
从内存中移除指定文件对应的Storage单实例,并删除指定文件及其备份文件、损坏文件。删除指定文件时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题,使用promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -222,7 +222,7 @@ removeStorageFromCacheSync(path: string): void
从内存中移除指定文件对应的Storage单实例。移除Storage单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -241,7 +241,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback&lt;void&gt;): void
从内存中移除指定文件对应的Storage单实例。移除Storage单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题。使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -267,7 +267,7 @@ removeStorageFromCache(path: string): Promise&lt;void&gt;
从内存中移除指定文件对应的Storage单实例。移除Storage单实例时,应用不允许再使用该实例进行数据操作,否则会出现数据一致性问题。使用Promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -301,7 +301,7 @@ getSync(key: string, defValue: ValueType): ValueType
获取键对应的值,如果值为null或者非默认值类型,返回默认数据。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -327,7 +327,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback&lt;ValueType&gt;):
获取键对应的值,如果值为null或者非默认值类型,返回默认数据。使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -354,7 +354,7 @@ get(key: string, defValue: ValueType): Promise&lt;ValueType&gt;
获取键对应的值,如果值为null或者非默认值类型,返默认数据。使用Promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
......@@ -385,7 +385,7 @@ putSync(key: string, value: ValueType): void
首先获取指定文件对应的Storage实例,然后借助Storage API将数据写入Storage实例,通过flush或者flushSync将Storage实例持久化。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -405,7 +405,7 @@ put(key: string, value: ValueType, callback: AsyncCallback&lt;void&gt;): void
首先获取指定文件对应的Storage实例,然后借助Storage API将数据写入Storage实例,通过flush或者flushSync将Storage实例持久化。使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -432,7 +432,7 @@ put(key: string, value: ValueType): Promise&lt;void&gt;
首先获取指定文件对应的Storage实例,然后借助Storage API将数据写入Storage实例,通过flush或者flushSync将Storage实例持久化。使用Promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -462,7 +462,7 @@ hasSync(key: string): boolean
检查存储对象是否包含名为给定key的存储。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -489,7 +489,7 @@ has(key: string, callback: AsyncCallback&lt;boolean&gt;): boolean
检查存储对象是否包含名为给定key的存储。使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -522,7 +522,7 @@ has(key: string): Promise&lt;boolean&gt;
检查存储对象是否包含名为给定key的存储。使用Promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -553,7 +553,7 @@ deleteSync(key: string): void
从存储对象中删除名为给定key的存储。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -572,7 +572,7 @@ delete(key: string, callback: AsyncCallback&lt;void&gt;): void
从存储对象中删除名为给定key的存储。使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -598,7 +598,7 @@ delete(key: string): Promise&lt;void&gt;
从存储对象删除名为给定key的存储。使用Promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -627,7 +627,7 @@ flushSync(): void
将当前storage对象中的修改保存到当前的storage,并同步存储到文件中。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**示例:**
```js
......@@ -641,7 +641,7 @@ flush(callback: AsyncCallback&lt;void&gt;): void
将当前storage对象中的修改保存到当前的storage,并异步存储到文件中。使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -666,7 +666,7 @@ flush(): Promise&lt;void&gt;
将当前storage对象中的修改保存到当前的storage,并异步存储到文件中。使用Promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**返回值:**
| 类型 | 说明 |
......@@ -690,7 +690,7 @@ clearSync(): void
清除此存储对象中的所有存储。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**示例:**
```js
......@@ -704,7 +704,7 @@ clear(callback: AsyncCallback&lt;void&gt;): void
清除此存储对象中的所有存储。使用callback方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -729,7 +729,7 @@ clear(): Promise&lt;void&gt;
清除此存储对象中的所有存储。使用Promise方式返回结果,此方法为异步方法。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**返回值:**
| 类型 | 说明 |
......@@ -753,7 +753,7 @@ on(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
订阅数据变更者类需要实现StorageObserver接口,订阅的key的值发生变更后,在执行flush/flushSync方法后,callback方法会被回调。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 说明 |
......@@ -778,7 +778,7 @@ off(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
当不再进行订阅数据变更时,使用此接口取消订阅。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
| 参数名 | 类型 | 说明 |
......@@ -797,7 +797,7 @@ off(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
## StorageObserver
**系统能力:**以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
......@@ -807,7 +807,7 @@ off(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
用于表示允许的数据字段类型。
**系统能力:**SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
| 名称 | 说明 |
| ------- | -------------------- |
......
......@@ -14,7 +14,7 @@ import display from '@ohos.display';
用于表示显示设备的状态。
**系统能力:**以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
......@@ -31,7 +31,7 @@ import display from '@ohos.display';
描述display对象的属性。
**系统能力:**以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
......@@ -56,7 +56,7 @@ getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void
获取当前默认的display对象。
**系统能力:**SystemCapability.WindowManager.WindowManager.Core
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -82,7 +82,7 @@ getDefaultDisplay(): Promise&lt;Display&gt;
获取当前默认的display对象。
**系统能力:**SystemCapability.WindowManager.WindowManager.Core
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
**返回值:**
......@@ -107,7 +107,7 @@ getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void
获取当前所有的display对象。
**系统能力:**SystemCapability.WindowManager.WindowManager.Core
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
**参数:**
......@@ -133,7 +133,7 @@ getAllDisplay(): Promise&lt;Array&lt;Display&gt;&gt;
获取当前所有的display对象。
**系统能力:**SystemCapability.WindowManager.WindowManager.Core
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
**返回值:**
......@@ -158,7 +158,7 @@ on(type: 'add'|'remove'|'change', callback: Callback&lt;number&gt;): void
开启监听。
**系统能力:**SystemCapability.WindowManager.WindowManager.Core
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -182,7 +182,7 @@ off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void
关闭监听。
**系统能力:**SystemCapability.WindowManager.WindowManager.Core
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......
......@@ -13,7 +13,7 @@ import screenshot from '@ohos.screenshot';
设置截取图像的信息。
**系统能力:**以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
| 参数名 | 类型 | 必填 | 说明 |
......@@ -27,7 +27,7 @@ import screenshot from '@ohos.screenshot';
表示截取图像的区域。
**系统能力:**以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
......@@ -41,7 +41,7 @@ import screenshot from '@ohos.screenshot';
表示截取图像的大小。
**系统能力:**以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.WindowManager.WindowManager.Core。
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
......@@ -54,7 +54,7 @@ save(options?: ScreenshotOptions, callback: AsyncCallback&lt;image.PixelMap&gt;)
获取屏幕截图。
**系统能力:**SystemCapability.WindowManager.WindowManager.Core
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
**需要权限**:ohos.permission.CAPTURE_SCREEN
......@@ -94,7 +94,7 @@ save(options?: ScreenshotOptions): Promise&lt;image.PixelMap&gt;
获取屏幕截图。
**系统能力:**SystemCapability.WindowManager.WindowManager.Core
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
**需要权限**:ohos.permission.CAPTURE_SCREEN
......
......@@ -21,7 +21,7 @@ get(Object): void
通过索引读取缓存中存储的值。
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
......@@ -61,7 +61,7 @@ set(Object): void
修改缓存中索引对应的值。
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
......@@ -99,7 +99,7 @@ clear(Object): void
清空缓存中存储的键值对。
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
......@@ -133,7 +133,7 @@ delete(Object): void
删除缓存中索引对应的键值对。
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**系统能力:** SystemCapability.DistributedDataManager.Preferences.Core
**参数:**
......
......@@ -15,7 +15,7 @@ getDevices(): Array&lt;Readonly&lt;USBDevice&gt;&gt;
获取USB设备列表。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**返回值:**
......@@ -88,7 +88,7 @@ connectDevice(device: USBDevice): Readonly&lt;USBDevicePipe&gt;
需要调用[usb.getDevices](#usbgetdevices)获取设备信息以及device;再调用[usb.requestRight](#usbrequestright)获取设备请求权限。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -113,7 +113,7 @@ hasRight(deviceName: string): boolean
判断是否有权访问该设备。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -139,7 +139,7 @@ requestRight(deviceName: string): Promise&lt;boolean&gt;
请求软件包的临时权限以访问设备。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -168,7 +168,7 @@ claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): numbe
需要调用[usb.getDevices](#usbgetdevices)获取设备信息以及interfaces;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)接口得到devicepipe作为参数。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -197,7 +197,7 @@ releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number
需要调用[usb.claimInterface](#usbclaiminterface)先获取接口,才能使用此方法释放接口。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -225,7 +225,7 @@ setConfiguration(pipe: USBDevicePipe, config: USBConfig): number
需要调用[usb.getDevices](#usbgetdevices)获取设备信息以及config;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)得到devicepipe作为参数。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -253,7 +253,7 @@ setInterface(pipe: USBDevicePipe, iface: USBInterface): number
需要调用[usb.getDevices](#usbgetdevices)获取设备列表以及interfaces;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)得到devicepipe作为参数。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -281,7 +281,7 @@ getRawDescriptor(pipe: USBDevicePipe): Uint8Array
需要调用[usb.getDevices](#usbgetdevices)获取设备列表;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)接口得到devicepipe作为参数。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -307,7 +307,7 @@ getFileDescriptor(pipe: USBDevicePipe): number
需要调用[usb.getDevices](#usbgetdevices)获取设备列表;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)接口得到devicepipe作为参数。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -334,7 +334,7 @@ controlTransfer(pipe: USBDevicePipe, contrlparam: USBControlParams, timeout?: nu
需要调用[usb.getDevices](#usbgetdevices)获取设备列表;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)接口得到devicepipe作为参数。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -364,7 +364,7 @@ bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, tim
需要调用[usb.getDevices](#usbgetdevices)获取设备信息列表以及endpoint;再调用[usb.requestRight](#usbrequestright)获取设备请求权限;然后调用[usb.connectDevice](#usbconnectdevice)接口得到返回数据devicepipe之后,再次获取接口[usb.claimInterface](#usbclaiminterface);再调用usb.bulkTransfer接口。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -398,7 +398,7 @@ closePipe(pipe: USBDevicePipe): number
需要调用[usb.getDevices](#usbgetdevices)获取设备列表;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)得到devicepipe作为参数。
**系统能力:** SystemCapability.USB.USBManager
**系统能力:** SystemCapability.USB.USBManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
......
......@@ -34,7 +34,7 @@ gl.clearColor(0.0, 0.0, 0.0, 1.0);
## Type
**系统能力:**以下各项对应的系统能力均为 SystemCapability.Graphic.Graphic2D.WebGL。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.Graphic.Graphic2D.WebGL。
**表1** Type
......@@ -62,7 +62,7 @@ gl.clearColor(0.0, 0.0, 0.0, 1.0);
## Interface
**系统能力:**以下各项对应的系统能力均为 SystemCapability.Graphic.Graphic2D.WebGL。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.Graphic.Graphic2D.WebGL。
**表2** Interface
......
......@@ -34,7 +34,7 @@ gl.clearColor(0.0, 0.0, 0.0, 1.0);
## Type
**系统能力:**以下各项对应的系统能力均为 SystemCapability.Graphic.Graphic2D.WebGL2。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.Graphic.Graphic2D.WebGL2。
**表1** Type
......@@ -48,7 +48,7 @@ gl.clearColor(0.0, 0.0, 0.0, 1.0);
## Interface
**系统能力:**以下各项对应的系统能力均为 SystemCapability.Graphic.Graphic2D.WebGL2。
**系统能力:** 以下各项对应的系统能力均为 SystemCapability.Graphic.Graphic2D.WebGL2。
**表2** Interface
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册