Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 c17191bb 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!3913 API样板化相关修改：需同步翻译 

Merge pull request !3913 from 葛亚芳/master
上级 4b24a8e8 1c11e587
展开全部 隐藏空白更改
内联 并排
Showing with 687 addition and 679 deletion
en/application-dev/Readme-EN.md
浏览文件 @ c17191bb
......@@ -8,7 +8,8 @@
- Quick Start
- Getting Started
- [Preparations](start-overview.md)
- [Getting Started with eTS](start-with-ets.md)
- [Getting Started with eTS in the Traditional Coding Approach](quick-start/start-with-ets.md)
- [Getting Started with eTS in the Low-Code Approach](quick-start/start-with-ets-low-code.md)
- [Getting Started with JavaScript in the Traditional Coding Approach](start-with-js.md)
- [Getting Started with JavaScript in the Low-Code Approach](start-with-js-low-code.md)
- Development Fundamentals
......
en/application-dev/website.md
浏览文件 @ c17191bb
......@@ -4,7 +4,8 @@
- Quick Start
- Getting Started
- [Preparations](quick-start/start-overview.md)
- [Getting Started with eTS](quick-start/start-with-ets.md)
- [Getting Started with eTS in the Traditional Coding Approach](quick-start/start-with-ets.md)
- [Getting Started with eTS in the Low-Code Approach](quick-start/start-with-ets-low-code.md)
- [Getting Started with JavaScript in the Traditional Coding Approach](quick-start/start-with-js.md)
- [Getting Started with JavaScript in the Low-Code Approach](quick-start/start-with-js-low-code.md)
- Development Fundamentals
......
zh-cn/application-dev/Readme-CN.md
浏览文件 @ c17191bb
......@@ -7,8 +7,9 @@
- [版本说明](../release-notes/Readme.md)
- 快速开始
- 快速入门
- [前言](quick-start/start-overview.md)
- [使用eTS语言开发](quick-start/start-with-ets.md)
- [开发准备](quick-start/start-overview.md)
- [使用eTS语言开发（传统代码方式）](quick-start/start-with-ets.md)
- [使用eTS语言开发（低代码方式）](quick-start/start-with-ets-low-code.md)
- [使用JS语言开发（传统代码方式）](quick-start/start-with-js.md)
- [使用JS语言开发（低代码方式）](quick-start/start-with-js-low-code.md)
- 开发基础知识
......
zh-cn/application-dev/reference/apis/js-apis-data-ability.md
浏览文件 @ c17191bb
......@@ -21,18 +21,18 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates):
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库表中的表名。 |
| dataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 是 | DataAbility谓词。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| rdb.[RdbPredicates](js-apis-data-rdb.md#rdbpredicates) | 返回RdbPredicates对象。 |
- 示例：
**示例：**
```js
let dataAbilityPredicates = new dataAbility.DataAbilityPredicates()
dataAbilityPredicates.equalTo("NAME", "Rose").between("AGE", 16, 30)
......@@ -55,18 +55,18 @@ equalTo(field: string, value: ValueType): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
......@@ -83,18 +83,18 @@ notEqualTo(field: string, value: ValueType): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.notEqualTo("NAME", "lisi")
......@@ -111,12 +111,12 @@ beginWrap(): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有左括号的DataAbility谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbilitylity.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
......@@ -138,12 +138,12 @@ endWrap(): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有右括号的DataAbility谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
......@@ -165,12 +165,12 @@ or(): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有或条件的DataAbility谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
......@@ -189,12 +189,12 @@ and(): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回带有和条件的DataAbility谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
......@@ -213,18 +213,18 @@ contains(field: string, value: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.contains("NAME", "os")
......@@ -241,18 +241,18 @@ beginsWith(field: string, value: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.beginsWith("NAME", "os")
......@@ -269,18 +269,18 @@ endsWith(field: string, value: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.endsWith("NAME", "se")
......@@ -297,17 +297,17 @@ isNull(field: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.isNull("NAME")
......@@ -324,17 +324,17 @@ isNotNull(field: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.isNotNull("NAME")
......@@ -351,18 +351,18 @@ like(field: string, value: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.like("NAME", "%os%")
......@@ -379,18 +379,18 @@ glob(field: string, value: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | string | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.glob("NAME", "?h*g")
......@@ -407,19 +407,19 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.between("AGE", 10, 50)
......@@ -436,19 +436,19 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 |
| high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.notBetween("AGE", 10, 50)
......@@ -465,18 +465,18 @@ greaterThan(field: string, value: ValueType): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.greaterThan("AGE", 18)
......@@ -493,18 +493,18 @@ lessThan(field: string, value: ValueType): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.lessThan("AGE", 20)
......@@ -521,18 +521,18 @@ greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.greaterThanOrEqualTo("AGE", 18)
......@@ -549,18 +549,18 @@ lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.lessThanOrEqualTo("AGE", 20)
......@@ -577,17 +577,17 @@ orderByAsc(field: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.orderByAsc("NAME")
......@@ -604,17 +604,17 @@ orderByDesc(field: string): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.orderByDesc("AGE")
......@@ -631,12 +631,12 @@ distinct(): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于过滤重复记录的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct("NAME")
......@@ -659,17 +659,17 @@ limitAs(value: number): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | number | 是 | 最大数据记录数。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于设置最大数据记录数的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").limitAs(3)
......@@ -686,17 +686,17 @@ offsetAs(rowOffset: number): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定返回结果起始位置的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").offsetAs(3)
......@@ -713,17 +713,17 @@ groupBy(fields: Array<string>): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| fields | Array<string> | 是 | 指定分组依赖的列名。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回分组查询列的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.groupBy(["AGE", "NAME"])
......@@ -738,17 +738,17 @@ indexedBy(field: string): DataAbilityPredicates
配置谓词以指定索引列。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| indexName | string | 是 | 索引列的名称。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定索引列的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.indexedBy("SALARY_INDEX")
......@@ -765,19 +765,19 @@ in(field: string, value: Array<ValueType>): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array<[ValueType](#valuetype)> | 是 | 以ValueType类型数组形式指定的要匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.in("AGE", [18, 20])
......@@ -794,19 +794,19 @@ notIn(field: string, value: Array<ValueType>): DataAbilityPredicates
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array<[ValueType](#valuetype)> | 是 | 以ValueType类型数组形式指定的要匹配的值。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
**示例：**
```js
let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE")
predicates.notIn("NAME", ["Lisa", "Rose"])
......
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md
浏览文件 @ c17191bb
......@@ -32,14 +32,14 @@ getPreferences(context: Context, name: string, callback: AsyncCallback<Prefer
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback<[Preferences](#preferences)> | 是 | 回调函数。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -77,18 +77,18 @@ getPreferences(context: Context, name: string): Promise<Preferences>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<[Preferences](#preferences)> | Promise实例，用于异步获取结果。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -126,14 +126,14 @@ deletePreferences(context: Context, name: string, callback: AsyncCallback<voi
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -159,18 +159,18 @@ deletePreferences(context: Context, name: string): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步获取结果。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -196,14 +196,14 @@ removePreferencesFromCache(context: Context, name: string, callback: AsyncCallba
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -230,18 +230,18 @@ removePreferencesFromCache(context: Context, name: string): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | [Context](js-apis-Context.md) | 是 | 应用程序或功能的上下文。 |
| name | string | 是 | 应用程序内部数据存储名称。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步获取结果。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -270,14 +270,14 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 |
| callback | AsyncCallback<ValueType> | 是 | 回调函数。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -314,12 +314,12 @@ get(key: string, defValue: ValueType): Promise<ValueType>
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<ValueType> | Promise实例，用于异步获取结果。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -348,14 +348,14 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key，不能为空。 |
| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -386,18 +386,18 @@ put(key: string, value: ValueType): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key，不能为空。 |
| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -426,18 +426,18 @@ has(key: string, callback: AsyncCallback<boolean>): boolean
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要检查的存储key名称，不能为空。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | true表示存在，false表示不存在。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -472,17 +472,17 @@ has(key: string): Promise<boolean>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要检查的存储key名称，不能为空。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<boolean> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -515,13 +515,13 @@ delete(key: string, callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要删除的存储key名称，不能为空。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -552,17 +552,17 @@ delete(key: string): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要删除的存储key名称，不能为空。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -591,12 +591,12 @@ flush(callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -627,12 +627,12 @@ flush(): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -661,12 +661,12 @@ clear(callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -697,12 +697,12 @@ clear(): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -731,13 +731,13 @@ on(type: 'change', callback: Callback<{ key : string }>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| type | string | 事件类型，固定值'change'，表示数据变更。 |
| callback | Callback<{ key : string }> | 回调对象实例。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......@@ -779,13 +779,13 @@ off(type: 'change', callback: Callback<{ key : string }>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| type | string | 事件类型，固定值'change'，表示数据变更。 |
| callback | Callback<{ key : string }> | 需要取消的回调对象实例。 |
- 示例：
**示例：**
```ts
import Ability from '@ohos.application.Ability'
import data_preferences from '@ohos.data.preferences'
......
zh-cn/application-dev/reference/apis/js-apis-data-resultset.md
浏览文件 @ c17191bb
......@@ -48,17 +48,17 @@ getColumnIndex(columnName: string): number
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| columnName | string | 是 | 表示结果集中指定列的名称。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回指定列的索引。 |
- 示例：
**示例：**
```js
resultSet.goToFirstRow()
const id = resultSet.getLong(resultSet.getColumnIndex("ID"))
......@@ -76,17 +76,17 @@ getColumnName(columnIndex: number): string
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| columnIndex | number | 是 | 表示结果集中指定列的索引。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| string | 返回指定列的名称。 |
- 示例：
**示例：**
```js
const id = resultSet.getColumnName(0)
const name = resultSet.getColumnName(1)
......@@ -102,17 +102,17 @@ goTo(offset:number): boolean
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| offset | number | 是 | 表示相对于当前位置的偏移量。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
- 示例：
**示例：**
```js
let predicatesgoto = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoto = rdbStore.query(predicatesgoto, ["ID", "NAME", "AGE", "SALARY", "CODES"])
......@@ -133,17 +133,17 @@ goToRow(position: number): boolean
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| position | number | 是 | 表示要移动到的指定位置。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
- 示例：
**示例：**
```js
let predicatesgotorow = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygotorow = rdbStore.query(predicatesgotorow, ["ID", "NAME", "AGE", "SALARY", "CODES"])
......@@ -165,12 +165,12 @@ goToFirstRow(): boolean
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
- 示例：
**示例：**
```js
let predicatesgoFirst = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoFirst = rdbStore.query(predicatesgoFirst, ["ID", "NAME", "AGE", "SALARY", "CODES"])
......@@ -191,12 +191,12 @@ goToLastRow(): boolean
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
- 示例：
**示例：**
```js
let predicatesgoLast = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoLast = rdbStore.query(predicatesgoLast, ["ID", "NAME", "AGE", "SALARY", "CODES"])
......@@ -217,12 +217,12 @@ goToNextRow(): boolean
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
- 示例：
**示例：**
```js
let predicatesgoNext = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoNext = rdbStore.query(predicatesgoNext, ["ID", "NAME", "AGE", "SALARY", "CODES"])
......@@ -243,12 +243,12 @@ goToPreviousRow(): boolean
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果成功移动结果集，则为true；否则返回false。 |
- 示例：
**示例：**
```js
let predicatesgoPrev = new dataRdb.RdbPredicates("EMPLOYEE")
let promisequerygoPrev = rdbStore.query(predicatesgoPrev, ["ID", "NAME", "AGE", "SALARY", "CODES"])
......@@ -269,17 +269,17 @@ getBlob(columnIndex: number): Uint8Array
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Uint8Array | 以字节数组的形式返回指定列的值。 |
- 示例：
**示例：**
```js
const codes = resultSet.getBlob(resultSet.getColumnIndex("CODES"))
```
......@@ -293,17 +293,17 @@ getString(columnIndex: number): string
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| string | 以字符串形式返回指定列的值。 |
- 示例：
**示例：**
```js
const name = resultSet.getString(resultSet.getColumnIndex("NAME"))
```
......@@ -317,17 +317,17 @@ getLong(columnIndex: number): number
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 以Long形式返回指定列的值。 |
- 示例：
**示例：**
```js
const age = resultSet.getLong(resultSet.getColumnIndex("AGE"))
```
......@@ -341,17 +341,17 @@ getDouble(columnIndex: number): number
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 以double形式返回指定列的值。 |
- 示例：
**示例：**
```js
const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY"))
```
......@@ -365,17 +365,17 @@ isColumnNull(columnIndex: number): boolean
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| columnIndex | number | 是 | 指定的列索引，从0开始。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果当前行中指定列的值为null，则返回true，否则返回false。 |
- 示例：
**示例：**
```js
const isColumnNull = resultSet.isColumnNull(resultSet.getColumnIndex("CODES"))
```
......@@ -389,7 +389,7 @@ close(): void
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
- 示例：
**示例：**
```js
let predicatesClose = new dataRdb.RdbPredicates("EMPLOYEE")
let promiseClose = rdbStore.query(predicatesClose, ["ID", "NAME", "AGE", "SALARY", "CODES"])
......
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
浏览文件 @ c17191bb
......@@ -34,17 +34,17 @@ getStorageSync(path: string): Storage
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [Storage](#storage) | 获取到要操作的Storage实例，用于进行数据存储操作。 |
- 示例：
**示例：**
```js
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
......@@ -71,13 +71,13 @@ getStorage(path: string, callback: AsyncCallback<Storage>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
| callback | AsyncCallback<[Storage](#storage)> | 是 | 回调函数。 |
- 示例：
**示例：**
```js
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
......@@ -109,17 +109,17 @@ getStorage(path: string): Promise<Storage>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<[Storage](#storage)> | Promise实例，用于异步获取结果。 |
- 示例：
**示例：**
```js
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
......@@ -150,13 +150,13 @@ deleteStorageSync(path: string): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
- 示例：
```
**示例：**
```js
dataStorage.deleteStorageSync(path + '/mystore')
```
......@@ -169,13 +169,13 @@ deleteStorage(path: string, callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```js
dataStorage.deleteStorage(path + '/mystore', function (err) {
if (err) {
......@@ -195,17 +195,17 @@ deleteStorage(path: string): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步获取结果。 |
- 示例：
**示例：**
```js
let promisedelSt = dataStorage.deleteStorage(path + '/mystore')
promisedelSt.then(() => {
......@@ -226,12 +226,12 @@ removeStorageFromCacheSync(path: string): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
- 示例：
**示例：**
```js
dataStorage.removeStorageFromCacheSync(path + '/mystore')
```
......@@ -247,13 +247,13 @@ removeStorageFromCache(path: string, callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```js
dataStorage.removeStorageFromCache(path + '/mystore', function (err) {
if (err) {
......@@ -275,17 +275,17 @@ removeStorageFromCache(path: string): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| path | string | 是 | 应用程序内部数据存储路径。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步获取结果。 |
- 示例：
**示例：**
```js
let promiserevSt = dataStorage.removeStorageFromCache(path + '/mystore')
promiserevSt.then(() => {
......@@ -311,18 +311,18 @@ getSync(key: string, defValue: ValueType): ValueType
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 给定key的存储不存在，则要返回的默认值。支持number、string、boolean。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ValueType | 键对应的值，如果值为null或者非默认值类型，返回默认数据。 |
- 示例：
**示例：**
```js
let value = storage.getSync('startup', 'default')
console.info("The value of startup is " + value)
......@@ -339,14 +339,14 @@ get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>):
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 |
| callback | AsyncCallback<ValueType> | 是 | 回调函数。 |
- 示例：
**示例：**
```js
storage.get('startup', 'default', function(err, value) {
if (err) {
......@@ -368,18 +368,19 @@ get(key: string, defValue: ValueType): Promise<ValueType>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| defValue | [ValueType](#valuetype) | 是 | 默认返回值。支持number、string、boolean。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<ValueType> | Promise实例，用于异步获取结果。 |
- 示例：
**示例：**
```js
let promiseget = storage.get('startup', 'default')
promiseget.then((value) => {
......@@ -400,13 +401,13 @@ putSync(key: string, value: ValueType): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key，不能为空。 |
| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 |
- 示例：
**示例：**
```js
storage.putSync('startup', 'auto')
```
......@@ -422,14 +423,14 @@ put(key: string, value: ValueType, callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key，不能为空。 |
| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```js
storage.put('startup', 'auto', function (err) {
if (err) {
......@@ -451,18 +452,18 @@ put(key: string, value: ValueType): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key，不能为空。 |
| value | [ValueType](#valuetype) | 是 | 存储的新值。支持number、string、boolean。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```js
let promiseput = storage.put('startup', 'auto')
promiseput.then(() => {
......@@ -483,17 +484,17 @@ hasSync(key: string): boolean
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | true 表示存在，false表示不存在。 |
- 示例：
**示例：**
```js
let isExist = storage.hasSync('startup')
if (isExist) {
......@@ -512,18 +513,18 @@ has(key: string, callback: AsyncCallback<boolean>): boolean
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| callback | AsyncCallback<boolean> | 是 | 回调函数。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | true表示存在，false表示不存在。 |
- 示例：
**示例：**
```js
storage.has('startup', function (err, isExist) {
if (err) {
......@@ -547,17 +548,17 @@ has(key: string): Promise<boolean>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<boolean> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```js
let promisehas = storage.has('startup')
promisehas.then((isExist) => {
......@@ -580,12 +581,12 @@ deleteSync(key: string): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
- 示例：
**示例：**
```js
storage.deleteSync('startup')
```
......@@ -601,13 +602,13 @@ delete(key: string, callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```js
storage.delete('startup', function (err) {
if (err) {
......@@ -629,17 +630,17 @@ delete(key: string): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```js
let promisedel = storage.delete('startup')
promisedel.then(() => {
......@@ -660,7 +661,7 @@ flushSync(): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 示例：
**示例：**
```js
storage.flushSync()
```
......@@ -676,12 +677,12 @@ flush(callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```js
storage.flush(function (err) {
if (err) {
......@@ -703,12 +704,12 @@ flush(): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```js
let promiseflush = storage.flush()
promiseflush.then(() => {
......@@ -729,7 +730,7 @@ clearSync(): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 示例：
**示例：**
```js
storage.clearSync()
```
......@@ -745,12 +746,12 @@ clear(callback: AsyncCallback<void>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
- 示例：
**示例：**
```js
storage.clear(function (err) {
if (err) {
......@@ -772,12 +773,12 @@ clear(): Promise<void>
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise实例，用于异步处理。 |
- 示例：
**示例：**
```js
let promiseclear = storage.clear()
promiseclear.then(() => {
......@@ -796,13 +797,13 @@ on(type: 'change', callback: Callback<StorageObserver>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| type | string | 事件类型，固定值'change'，表示数据变更。 |
| callback | Callback<[StorageObserver](#storageobserver)> | 回调对象实例。 |
- 示例：
**示例：**
```js
var observer = function (key) {
console.info("The key of " + key + " changed.")
......@@ -821,13 +822,13 @@ off(type: 'change', callback: Callback<StorageObserver>): void
**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core
- 参数：
**参数：**
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| type | string | 事件类型，固定值'change'，表示数据变更。 |
| callback | Callback<[StorageObserver](#storageobserver)> | 需要取消的回调对象实例。 |
- 示例：
**示例：**
```js
var observer = function (key) {
console.info("The key of " + key + " changed.")
......
zh-cn/application-dev/reference/apis/js-apis-display.md
浏览文件 @ c17191bb
......@@ -58,12 +58,12 @@ getDefaultDisplay(callback: AsyncCallback<Display>): void
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<[Display](#display)> | 是 | 回调返回当前默认的display对象。 |
- 示例
**示例：**
```js
var displayClass = null;
display.getDefaultDisplay((err, data) => {
......@@ -84,13 +84,13 @@ getDefaultDisplay(): Promise<Display>
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 返回值
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ---------------------------------------------- |
| Promise<[Display](#display)> | 以Promise形式返回结果，返回默认的display对象。 |
- 示例
**示例：**
```js
let promise = display.getDefaultDisplay();
......@@ -109,13 +109,13 @@ getAllDisplay(callback: AsyncCallback<Array<Display>>): void
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback<Array<[Display](#display)>> | 是 | 回调返回当前所有的display对象。 |
- 示例
**示例：**
```js
display.getAllDisplay((err, data) => {
......@@ -135,13 +135,13 @@ getAllDisplay(): Promise<Array<Display>>
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 返回值
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------------- |
| Promise<Array<[Display](#display)>> | 以Promise形式返回结果，返回包含所有Display对象的Array。 |
- 示例
**示例：**
```js
let promise = display.getAllDisplay();
......@@ -160,13 +160,13 @@ on(type: 'add'|'remove'|'change', callback: Callback<number>): void
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置监听类型。<br/>-&nbsp;type为"add"，表示监听增加显示设备。<br/>-&nbsp;type为"remove"，表示监听移除显示设备。<br/>-&nbsp;type为"change"，表示监听改变显示设备。 |
| callback | Callback&lt;number&gt; | 是 | 回调返回监听到的显示设备的id。 |
- 示例
**示例：**
```js
var type = "add";
var callback = (data) => {
......@@ -184,13 +184,13 @@ off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置监听类型。<br/>-&nbsp;type为"add"，表示监听增加显示设备。<br/>-&nbsp;type为"remove"，表示监听移除显示设备。<br/>-&nbsp;type为"change"，表示监听改变显示设备。 |
| callback | Callback&lt;number&gt; | 否 | 回调返回监听到的显示设备的id。 |
- 示例
**示例：**
```js
var type = "remove";
display.off(type);
......
zh-cn/application-dev/reference/apis/js-apis-screenshot.md
浏览文件 @ c17191bb
......@@ -58,14 +58,14 @@ save(options?: ScreenshotOptions, callback: AsyncCallback&lt;image.PixelMap&gt;)
**需要权限**：ohos.permission.CAPTURE_SCREEN
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [ScreenshotOptions](#screenshotoptions) | 否 | 该类型的参数包含screenRect，imageSize，rotation三个参数，需要分别设置这三个参数。 |
| callback | AsyncCallback&lt;image.PixelMap&gt; | 是 | 回调返回一个PixelMap对象。 |
- 示例
**示例：**
```js
var ScreenshotOptions = {
......@@ -98,19 +98,19 @@ save(options?: ScreenshotOptions): Promise&lt;image.PixelMap&gt;
**需要权限**：ohos.permission.CAPTURE_SCREEN
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [ScreenshotOptions](#screenshotoptions) | 否 | 该类型的参数包含screenRect，imageSize，rotation三个参数，需要分别设置这三个参数。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| ----------------------------- | ----------------------------------------------- |
| Promise&lt;image.PixelMap&gt; | 以Promise形式返回结果，返回image.PixelMap对象。 |
- 示例
**示例：**
```js
var ScreenshotOptions = {
......
zh-cn/application-dev/reference/apis/js-apis-usb.md
浏览文件 @ c17191bb
......@@ -5,7 +5,7 @@
## 导入模块
```
```js
import usb from "@ohos.usb";
```
......@@ -17,13 +17,13 @@ getDevices(): Array&lt;Readonly&lt;USBDevice&gt;&gt;
**系统能力**: SystemCapability.USB.USBManager
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Array&lt;Readonly&lt;[USBDevice](#usbdevice)&gt;&gt; | 设备信息列表。 |
- 示例：
```
**示例：**
```js
let devicesList = usb.getDevices();
console.log(`devicesList = ${JSON.stringify(devicesList)}`);
//devicesList 返回的数据结构
......@@ -89,18 +89,18 @@ connectDevice(device: USBDevice): Readonly&lt;USBDevicePipe&gt;
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| device | [USBDevice](#usbdevice) | 是 | USB设备信息。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Readonly&lt;[USBDevicePipe](#usbdevicepipe)&gt; | 指定的传输通道对象。 |
- 示例：
```
**示例：**
```js
let devicepipe= usb.connectDevice(device);
console.log(`devicepipe = ${JSON.stringify(devicepipe)}`);
```
......@@ -114,18 +114,18 @@ hasRight(deviceName: string): boolean
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceName | string | 是 | 设备名称。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | true表示有访问设备的权限，false表示没有访问设备的权限。 |
- 示例：
```
**示例：**
```js
let divicesName="1-1";
let bool = usb.hasRight(divicesName);
console.log(bool);
......@@ -140,18 +140,18 @@ requestRight(deviceName: string): Promise&lt;boolean&gt;
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceName | string | 是 | 设备名称。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 获取到true则表示软件包的临时权限已访问成功，&nbsp;获取到false则表示软件包的临时权限已访问失败。 |
- 示例：
```
**示例：**
```js
let divicesName="1-1";
usb.requestRight(divicesName).then((ret) => {
console.log(`requestRight = ${JSON.stringify(ret)}`);
......@@ -169,20 +169,20 @@ claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): numbe
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
| iface | [USBInterface](#usbinterface) | 是 | 用于确定需要获取接口的索引。 |
| force | boolean | 否 | 可选参数，是否强制获取。默认值false&nbsp;，表示不强制获取。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 注册通信接口成功返回0；注册通信接口失败返回其他错误码。 |
- 示例：
```
**示例：**
```js
let ret = usb.claimInterface(devicepipe, interfaces);
console.log(`claimInterface = ${ret}`);
```
......@@ -198,19 +198,19 @@ releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
| iface | [USBInterface](#usbinterface) | 是 | 用于确定需要释放接口的索引。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 释放接口成功返回0；释放接口失败返回其他错误码。 |
- 示例：
```
**示例：**
```js
let ret = usb.releaseInterface(devicepipe, interfaces);
console.log(`releaseInterface = ${ret}`);
```
......@@ -226,19 +226,19 @@ setConfiguration(pipe: USBDevicePipe, config: USBConfig): number
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
| config | [USBConfig](#usbconfig) | 是 | 用于确定需要设置的配置。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 设置设备配置成功返回0；设置设备配置失败返回其他错误码。 |
- 示例：
```
**示例：**
```js
let ret = usb.setConfiguration(devicepipe, config);
console.log(`setConfiguration = ${ret}`);
```
......@@ -254,19 +254,19 @@ setInterface(pipe: USBDevicePipe, iface: USBInterface): number
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
| iface | [USBInterface](#usbinterface) | 是 | 用于确定需要设置的接口。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 设置设备接口成功返回0；设置设备接口失败返回其他错误码。 |
- 示例：
```
**示例：**
```js
let ret = usb.setInterface(devicepipe, interfaces);
console.log(`setInterface = ${ret}`);
```
......@@ -282,18 +282,18 @@ getRawDescriptor(pipe: USBDevicePipe): Uint8Array
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Uint8Array | 返回获取的原始数据。 |
- 示例：
```
**示例：**
```js
let ret = usb.getRawDescriptor(devicepipe);
```
......@@ -308,7 +308,7 @@ getFileDescriptor(pipe: USBDevicePipe): number
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
......@@ -318,8 +318,8 @@ getFileDescriptor(pipe: USBDevicePipe): number
| -------- | -------- |
| number | 返回设备对应的文件描述符。 |
- 示例：
```
**示例：**
```js
let ret = usb.getFileDescriptor(devicepipe);
```
......@@ -334,20 +334,20 @@ controlTransfer(pipe: USBDevicePipe, contrlparam: USBControlParams, timeout?: nu
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定设备。 |
| contrlparam | [USBControlParams](#usbcontrolparams) | 是 | 控制传输参数。 |
| timeout | number | 否 | 超时时间，可选参数，默认为0不超时。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;number&gt; | 获取传输或接收到的数据块大小，&nbsp;获取到-1则表示异常。 |
- 示例：
```
**示例：**
```js
usb.controlTransfer(devicepipe, USBControlParams).then((ret) => {
console.log(`controlTransfer = ${JSON.stringify(ret)}`);
})
......@@ -364,7 +364,7 @@ bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, tim
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定设备。 |
......@@ -372,13 +372,13 @@ bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, tim
| buffer | Uint8Array | 是 | 用于写入或读取的缓冲区。 |
| timeout | number | 否 | 超时时间，可选参数，默认为0不超时。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;number&gt; | 获取传输或接收到的数据块大小，&nbsp;获取到-1则表示异常。 |
- 示例：
```
**示例：**
```js
//usb.getDevices 接口返回数据集合，取其中一个设备对象，并获取权限 。
//把获取到的设备对象作为参数传入usb.connectDevice;当usb.connectDevice接口成功返回之后；
//才可以调用第三个接口usb.claimInterface.当usb.claimInterface 调用成功以后,再调用该接口。
......@@ -398,18 +398,18 @@ closePipe(pipe: USBDevicePipe): number
**系统能力**: SystemCapability.USB.USBManager
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定USB设备消息控制通道。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 关闭设备消息控制通道成功返回0；关闭设备消息控制通道失败返回其他错误码。 |
- 示例：
```
**示例：**
```js
let ret = usb.closePipe(devicepipe);
console.log(`closePipe = ${ret}`);
```
......
zh-cn/application-dev/reference/apis/js-apis-webgl.md
浏览文件 @ c17191bb
......@@ -11,7 +11,7 @@ WebGL标准图形API，对应OpenGL ES 2.0特性集。更多信息请参考[WebG
hml内创建canvas，示例如下：
```
<div class="container">
<canvas ref="canvas1" style="width : 400px; height : 200px; background-color : lightyellow;"></canvas>
......@@ -21,8 +21,8 @@ hml内创建canvas，示例如下：
js内获取canvas实例，示例如下：
```
```js
// 获取canvas组件实例
const el = this.$refs.canvas1;
// 从canvas组件实例获取WebGL上下文
......
zh-cn/application-dev/reference/apis/js-apis-webgl2.md
浏览文件 @ c17191bb
......@@ -11,7 +11,7 @@ WebGL标准图形API，对应OpenGL ES 3.0特性集。更多信息请参考[WebG
hml内创建canvas，示例如下：
```
<div class="container">
<canvas ref="canvas1" style="width : 400px; height : 200px; background-color : lightyellow;"></canvas>
......@@ -21,8 +21,8 @@ hml内创建canvas，示例如下：
js内获取canvas实例，示例如下：
```
```js
// 获取canvas组件实例
const el = this.$refs.canvas1;
// 从canvas组件实例获取WebGL上下文
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或