diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md index 419030fc432b2c7cd35820bdf982a3f43e0de9a9..48fc5c6ae62edb1b3506508233c20b6ae004c267 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md @@ -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"]) diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md index f86e52ba55978a868e1fe284b24415794b449c75..a3881d8ac890e776a097828df7825934da8bf6fb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-resultset.md @@ -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"]) diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md index 7331a2a1329c1dc927d960378159c3569e12886b..fcc1b051bf5226b69c314f7dc0357f6a4f4232cc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-storage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-storage.md @@ -32,17 +32,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' @@ -69,13 +69,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' @@ -107,17 +107,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' @@ -148,12 +148,12 @@ deleteStorageSync(path: string): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | path | string | 是 | 应用程序内部数据存储路径。 | -- 示例： +**示例：** ``` dataStorage.deleteStorageSync(path + '/mystore') ``` @@ -167,13 +167,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) { @@ -193,17 +193,17 @@ deleteStorage(path: string): Promise<void> **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | path | string | 是 | 应用程序内部数据存储路径。 | -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<void> | Promise实例，用于异步获取结果。 | -- 示例： +**示例：** ```js let promisedelSt = dataStorage.deleteStorage(path + '/mystore') promisedelSt.then(() => { @@ -224,12 +224,12 @@ removeStorageFromCacheSync(path: string): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | path | string | 是 | 应用程序内部数据存储路径。 | -- 示例： +**示例：** ```js dataStorage.removeStorageFromCacheSync(path + '/mystore') ``` @@ -245,13 +245,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) { @@ -273,17 +273,17 @@ removeStorageFromCache(path: string): Promise<void> **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | path | string | 是 | 应用程序内部数据存储路径。 | -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<void> | Promise实例，用于异步获取结果。 | -- 示例： +**示例：** ```js let promiserevSt = dataStorage.removeStorageFromCache(path + '/mystore') promiserevSt.then(() => { @@ -309,18 +309,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) @@ -337,14 +337,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) { @@ -366,18 +366,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) => { @@ -398,13 +399,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') ``` @@ -420,14 +421,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) { @@ -449,18 +450,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(() => { @@ -481,17 +482,17 @@ hasSync(key: string): boolean **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | key | string | 是 | 要获取的存储key名称，不能为空。 | -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | boolean | true 表示存在，false表示不存在。 | -- 示例： +**示例：** ```js let isExist = storage.hasSync('startup') if (isExist) { @@ -510,18 +511,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) { @@ -545,17 +546,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) => { @@ -578,12 +579,12 @@ deleteSync(key: string): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | key | string | 是 | 要获取的存储key名称。它不能为空。 | -- 示例： +**示例：** ```js storage.deleteSync('startup') ``` @@ -599,13 +600,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) { @@ -627,17 +628,17 @@ delete(key: string): Promise<void> **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | key | string | 是 | 要获取的存储key名称。 | -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<void> | Promise实例，用于异步处理。 | -- 示例： +**示例：** ```js let promisedel = storage.delete('startup') promisedel.then(() => { @@ -658,7 +659,7 @@ flushSync(): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 示例： +**示例：** ```js storage.flushSync() ``` @@ -674,12 +675,12 @@ flush(callback: AsyncCallback<void>): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例： +**示例：** ```js storage.flush(function (err) { if (err) { @@ -701,12 +702,12 @@ flush(): Promise<void> **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<void> | Promise实例，用于异步处理。 | -- 示例： +**示例：** ```js let promiseflush = storage.flush() promiseflush.then(() => { @@ -727,7 +728,7 @@ clearSync(): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 示例： +**示例：** ```js storage.clearSync() ``` @@ -743,12 +744,12 @@ clear(callback: AsyncCallback<void>): void **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例： +**示例：** ```js storage.clear(function (err) { if (err) { @@ -770,12 +771,12 @@ clear(): Promise<void> **系统能力**：SystemCapability.DistributedDataManager.Preferences.Core -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<void> | Promise实例，用于异步处理。 | -- 示例： +**示例：** ```js let promiseclear = storage.clear() promiseclear.then(() => { @@ -794,13 +795,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.") @@ -819,13 +820,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.") diff --git a/zh-cn/application-dev/reference/apis/js-apis-display.md b/zh-cn/application-dev/reference/apis/js-apis-display.md index e69c09110802aa9975bf996b8564168495116096..7ac0763a1eab1b52e65ae741a771c67f1e980106 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-display.md +++ b/zh-cn/application-dev/reference/apis/js-apis-display.md @@ -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。 | + | 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 | 是 | 设置监听类型。
- type为"add"，表示监听增加显示设备。
- type为"remove"，表示监听移除显示设备。
- type为"change"，表示监听改变显示设备。 | | callback | Callback<number> | 是 | 回调返回监听到的显示设备的id。 | -- 示例 +**示例：** ```js var type = "add"; var callback = (data) => { @@ -184,13 +184,13 @@ off(type: 'add'|'remove'|'change', callback?: Callback<number>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置监听类型。
- type为"add"，表示监听增加显示设备。
- type为"remove"，表示监听移除显示设备。
- type为"change"，表示监听改变显示设备。 | | callback | Callback<number> | 否 | 回调返回监听到的显示设备的id。 | -- 示例 +**示例：** ```js var type = "remove"; display.off(type); diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index b7678bac77529d84a3ea70772a1c64a17c45c87b..ca97f8dac20778154dcc2eb9e201d05be7cc2df4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -1,5 +1,7 @@ # 分布式数据管理 +分布式数据管理为应用程序提供不同设备间数据库的分布式协同能力。通过调用分布式数据各个接口，应用程序可将数据保存到分布式数据库中，并可对分布式数据库中的数据进行增/删/改/查等各项操作。 + >![](../../public_sys-resources/icon-note.gif) **说明：** >本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -19,14 +21,14 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> **系统能力**：SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | | config | [KVManagerConfig](#kvmanagerconfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | | callback | AsyncCallback<[KVManager](#kvmanager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | -**示例**： +**示例：** ```js let kvManager; try { @@ -58,19 +60,19 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | | config |[KVManagerConfig](#kvmanager) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | -**返回值**： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<[KVManager](#kvmanager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | -**示例**： +**示例：** ```js let kvManager; @@ -139,7 +141,7 @@ getKVStore<T extends KVStore>(storeId: string, options: Options, callback: **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | @@ -147,7 +149,7 @@ getKVStore<T extends KVStore>(storeId: string, options: Options, callback: | options | [Options](#options) | 是 | 创建KVStore实例的配置信息。 | | callback | AsyncCallback<T>，<T extends [KVStore](#kvstore)> | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | -**示例**： +**示例：** ```js let kvStore; @@ -183,7 +185,7 @@ getKVStore<T extends KVStore>(storeId: string, options: Options): Promise& **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ------- | ---------------------- | ---- | -------------------- | @@ -191,13 +193,13 @@ getKVStore<T extends KVStore>(storeId: string, options: Options): Promise& | options | [Options](#options) | 是 | 创建KVStore实例的配置信息。| -**返回值**： +**返回值：** | 类型 | 说明 | | -------------------------------------- | ------------------------ | | Promise<T> <T extends [KVStore](#kvstore)> | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | -**示例**： +**示例：** ```js let kvStore; @@ -230,7 +232,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | @@ -240,7 +242,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCa | kvStore | [KVStore](#kvstore) | 是 | 要关闭的KVStore数据库。 | | callback | AsyncCallback<void> | 是 | 回调函数，如果数据库关闭成功则返回true，否则返回false。 | -**示例**： +**示例：** ```js let kvStore; @@ -276,7 +278,7 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------------- | @@ -284,13 +286,13 @@ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void& | storeId | string | 是 | 要关闭的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | | kvStore | [KVStore](#kvstore) | 是 | 要关闭的KVStore数据库。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------------- | -------------- | | Promise\ | Promise实例，如果数据库关闭成功则返回true，否则返回false。 | -**示例**： +**示例：** ```js let kvManager; @@ -330,7 +332,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -338,7 +340,7 @@ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void> | storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | | callback | AsyncCallback<void> | 是 | 回调函数，如果成功返回true，否则返回false。 | -**示例**： +**示例：** ```js let kvManager; @@ -373,7 +375,7 @@ deleteKVStore(appId: string, storeId: string): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -381,13 +383,13 @@ deleteKVStore(appId: string, storeId: string): Promise<void> | storeId | string | 是 | 要删除的数据库唯一标识符，长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------------- | -------------- | | Promise<void> | Promise实例，如果成功返回true，否则返回false。 | -**示例**： +**示例：** ```js let kvManager; @@ -427,14 +429,14 @@ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | appId | string | 是 | 所调用数据库方的包名。 | | callback | AsyncCallback<void> | 是 |回调函数，返回所有创建的 KvStore 数据库的 storeId。 | -**示例**： +**示例：** ```js let kvManager; @@ -457,20 +459,20 @@ getAllKVStoreId(appId: string): Promise<string[]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | appId | string | 是 | 所调用数据库方的包名。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------------- | -------------- | | Promise<string[]>| Promise实例，返回所有创建的 KvStore 数据库的 storeId。 | -**示例**： +**示例：** ```js let kvManager; @@ -496,7 +498,7 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): voi **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -528,7 +530,7 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -654,7 +656,7 @@ constructor(name: string) **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ------ | -------- | ---- | --------------- | @@ -668,13 +670,13 @@ appendChild(child: FieldNode): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | child | [FieldNode](#fieldnode8) | 是 | 要附加的域节点。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------------- | -------------- | @@ -716,7 +718,7 @@ getCount(): number **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -749,7 +751,7 @@ getPosition(): number **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -783,7 +785,7 @@ moveToFirst(): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -817,7 +819,7 @@ moveToLast(): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -851,7 +853,7 @@ moveToNext(): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -885,7 +887,7 @@ moveToPrevious(): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -919,13 +921,13 @@ move(offset: number): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | offset | number | 是 | 表示与当前位置的相对偏移量，负偏移表示向后移动，正偏移表示向前移动。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -959,13 +961,13 @@ moveToPosition(position: number): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | position | number | 是 |表示绝对位置。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -999,7 +1001,7 @@ isFirst(): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -1033,7 +1035,7 @@ isLast(): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -1066,7 +1068,7 @@ isBeforeFirst(): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -1100,7 +1102,7 @@ isAfterLast(): boolean **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | -------------- | @@ -1134,7 +1136,7 @@ getEntry(): Entry **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1185,7 +1187,7 @@ reset(): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1215,14 +1217,14 @@ equalTo(field: string, value: number|string|boolean): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | value | number\|string\|boolean | 是 | 表示指定的值。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1250,14 +1252,14 @@ notEqualTo(field: string, value: number|string|boolean): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | value | number\|string\|boolean | 是 | 表示指定的值。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1285,14 +1287,14 @@ greaterThan(field: string, value: number|string|boolean): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | value | number\|string\|boolean | 是 | 表示指定的值。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1320,14 +1322,14 @@ lessThan(field: string, value: number|string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | value | number\|string\|boolean | 是 | 表示指定的值。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1355,14 +1357,14 @@ greaterThanOrEqualTo(field: string, value: number|string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | value | number\|string\|boolean | 是 | 表示指定的值。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1390,14 +1392,14 @@ lessThanOrEqualTo(field: string, value: number|string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | value | number\|string\|boolean | 是 | 表示指定的值。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1426,13 +1428,13 @@ isNull(field: string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1461,14 +1463,14 @@ inNumber(field: string, valueList: number[]): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | valueList | number[] | 是 | 表示指定的值列表。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1496,14 +1498,14 @@ inString(field: string, valueList: string[]): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | valueList | string[] | 是 | 表示指定的字符串值列表。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1531,14 +1533,14 @@ notInNumber(field: string, valueList: number[]): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | valueList | number[] | 是 | 表示指定的值列表。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1566,14 +1568,14 @@ notInString(field: string, valueList: string[]): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | valueList | string[] | 是 | 表示指定的字符串值列表。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1601,14 +1603,14 @@ like(field: string, value: string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | valueList | string | 是 | 表示指定的字符串值。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1636,14 +1638,14 @@ unlike(field: string, value: string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | | valueList | string | 是 | 表示指定的字符串值。| -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1671,7 +1673,7 @@ and(): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1701,7 +1703,7 @@ or(): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1731,13 +1733,13 @@ orderByAsc(field: string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1766,13 +1768,13 @@ orderByDesc(field: string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段，必须以$开头， 并且不能包含' ^ '。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1801,14 +1803,14 @@ limit(total: number, offset: number): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | total | number | 是 |表示指定的结果数。 | | offset | number | 是 |表示起始位置。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1837,13 +1839,13 @@ isNotNull(field: string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | fieId | string | 是 |表示指定字段。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1871,7 +1873,7 @@ beginGroup(): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1901,7 +1903,7 @@ endGroup(): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1931,13 +1933,13 @@ prefixKey(prefix: string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | prefix | string | 是 |表示指定的键前缀。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -1966,13 +1968,13 @@ setSuggestIndex(index: string): Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | index | string | 是 |指示要设置的索引。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2001,14 +2003,14 @@ deviceId(deviceId:string):Query **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId | string | 是 |指示查询的设备 ID。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2035,7 +2037,7 @@ getSqlLike():string **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2068,7 +2070,7 @@ put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncC **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2104,14 +2106,14 @@ put(key: string, value: Uint8Array | string | number | boolean): Promise<void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | key | string | 是 |要添加数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | | value | Uint8Array \| string \| number \| boolean | 是 |要添加数据的value，支持Uint8Array、number 、 string 、boolean，Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#constants)。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2143,7 +2145,7 @@ delete(key: string, callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2185,13 +2187,13 @@ delete(key: string): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | key | string | 是 |要删除数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2228,7 +2230,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotific **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2254,7 +2256,7 @@ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2278,7 +2280,7 @@ off(event:'dataChange', observer?: Callback<ChangeNotification>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2306,7 +2308,7 @@ putBatch(entries: Entry[], callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2353,13 +2355,13 @@ putBatch(entries: Entry[]): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | entries |[Entry](#entry)[] | 是 |表示要批量插入的键值对。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2408,7 +2410,7 @@ deleteBatch(keys: string[], callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2455,13 +2457,13 @@ deleteBatch(keys: string[]): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | keys |string[] | 是 |表示要批量删除的键值对。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2511,7 +2513,7 @@ startTransaction(callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2563,7 +2565,7 @@ startTransaction(): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2598,7 +2600,7 @@ commit(callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2630,7 +2632,7 @@ commit(): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2660,7 +2662,7 @@ rollback(callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2692,7 +2694,7 @@ rollback(): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2722,7 +2724,7 @@ enableSync(enabled: boolean, callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2755,13 +2757,13 @@ enableSync(enabled: boolean): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | enabled |boolean | 是 |指定是否开启同步，ture表示开启同步，false表示不启用同步。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2791,7 +2793,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: Asy **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2823,7 +2825,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<v **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2831,7 +2833,7 @@ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<v | remoteSupportLabels |string[] | 是 |表示要同步数据的设备的同步标签。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -2934,7 +2936,7 @@ get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | numb **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -2972,14 +2974,14 @@ get(key: string): Promise<Uint8Array | string | boolean | number> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | key |string | 是 |要查询数据的key，不能为空且长度不大于[MAX_KEY_LENGTH](#constants)。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3015,7 +3017,7 @@ getEntries(keyPrefix: string, callback: AsyncCallback<Entry[]>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3061,13 +3063,13 @@ getEntries(keyPrefix: string): Promise<Entry[]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | keyPrefix |string | 是 |表示要匹配的键前缀。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3119,7 +3121,7 @@ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3170,13 +3172,13 @@ getEntries(query: Query): Promise<Entry[]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3227,7 +3229,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>) **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3276,13 +3278,13 @@ getResultSet(keyPrefix: string): Promise<KvStoreResultSet> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | keyPrefix |string | 是 |表示要匹配的键前缀。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3336,7 +3338,7 @@ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): voi **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3384,13 +3386,13 @@ getResultSet(query: Query): Promise<KvStoreResultSet> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3440,7 +3442,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>) **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3474,13 +3476,13 @@ closeResultSet(resultSet: KvStoreResultSet): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | resultSet |[KvStoreResultSet](#kvstoreresultset8) | 是 |表示要关闭的 KvStoreResultSet 对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3511,7 +3513,7 @@ getResultSize(query: Query, callback: AsyncCallback<number>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3557,13 +3559,13 @@ getResultSize(query: Query): Promise<number> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3612,7 +3614,7 @@ removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3654,13 +3656,13 @@ removeDeviceData(deviceId: string): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |表示要删除设备的名称。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3703,7 +3705,7 @@ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3739,7 +3741,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]& **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3772,7 +3774,7 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3780,7 +3782,7 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void | mode |[SyncMode](#syncmode) | 是 |同步类型。 | | allowedDelayMs |number | 否 |可选参数，允许延时时间，单位：ms（毫秒）。 | -**示例**： +**示例：** ```js let kvStore; @@ -3795,7 +3797,7 @@ setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback<void>) **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3825,14 +3827,14 @@ setSyncParam(defaultAllowedDelayMs: number): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | defaultAllowedDelayMs |number | 是 |表示数据库同步允许的默认延迟，以毫秒为单位。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3863,7 +3865,7 @@ getSecurityLevel(callback: AsyncCallback<SecurityLevel>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3891,7 +3893,7 @@ getSecurityLevel(): Promise<SecurityLevel> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -3927,7 +3929,7 @@ get(deviceId: string, key: string, callback: AsyncCallback<boolean|string|num **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -3962,14 +3964,14 @@ get(deviceId: string, key: string): Promise<boolean|string|number|Uint8Array& **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |标识要查询其数据的设备。 | | key |string | 是 |表示要查询 key 值的键。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4006,7 +4008,7 @@ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4054,14 +4056,14 @@ getEntries(deviceId: string, keyPrefix: string): Promise<Entry[]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |标识要查询其数据的设备。 | | keyPrefix |string | 是 |表示要匹配的键前缀。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4113,7 +4115,7 @@ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4166,13 +4168,13 @@ getEntries(query: Query): Promise<Entry[]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4224,7 +4226,7 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback<Entry[]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4278,14 +4280,14 @@ getEntries(deviceId: string, query: Query): Promise<Entry[]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |键值对所属的设备ID。 | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4338,7 +4340,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvS **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4373,14 +4375,14 @@ getResultSet(deviceId: string, keyPrefix: string): Promise<KvStoreResultSet&g **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |标识要查询其数据的设备。 | | keyPrefix |string | 是 |表示要匹配的键前缀。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4417,7 +4419,7 @@ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): voi **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4469,13 +4471,13 @@ getResultSet(query: Query): Promise<KvStoreResultSet> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4533,7 +4535,7 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback<KvStoreR **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4585,14 +4587,14 @@ getResultSet(deviceId: string, query: Query): Promise<KvStoreResultSet> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4651,7 +4653,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>) **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4686,13 +4688,13 @@ closeResultSet(resultSet: KvStoreResultSet): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | resultSet |[KvStoreResultSet](#getresultset8) | 是 |指示要关闭的 KvStoreResultSet 对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4724,7 +4726,7 @@ getResultSize(query: Query, callback: AsyncCallback<number>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4771,13 +4773,13 @@ getResultSize(query: Query): Promise<number> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4827,7 +4829,7 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback<number& **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4874,14 +4876,14 @@ getResultSize(deviceId: string, query: Query): Promise<number> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | | query |[Query](#query8) | 是 |表示查询对象。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -4930,7 +4932,7 @@ removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -4972,13 +4974,13 @@ removeDeviceData(deviceId: string): Promise<void> **系统能力**： SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |标识要删除其数据的设备。 | -**返回值**： +**返回值：** | 类型 | 说明 | | ------ | ------- | @@ -5023,7 +5025,7 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -5060,7 +5062,7 @@ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]> **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | @@ -5095,7 +5097,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]& **系统能力**： SystemCapability.DistributedDataManager.KVStore.Core。 -**参数**： +**参数：** | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-screenshot.md b/zh-cn/application-dev/reference/apis/js-apis-screenshot.md index 6bc6496eb99320d9e820b0237e2c0deb241c7a00..911c6faa7656fca84b127044cd0b55e38f66edcb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-screenshot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-screenshot.md @@ -58,14 +58,14 @@ save(options?: ScreenshotOptions, callback: AsyncCallback<image.PixelMap>) **需要权限**：ohos.permission.CAPTURE_SCREEN -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | options | [ScreenshotOptions](#screenshotoptions) | 否 | 该类型的参数包含screenRect，imageSize，rotation三个参数，需要分别设置这三个参数。 | | callback | AsyncCallback<image.PixelMap> | 是 | 回调返回一个PixelMap对象。 | -- 示例 +**示例：** ```js var ScreenshotOptions = { @@ -98,19 +98,19 @@ save(options?: ScreenshotOptions): Promise<image.PixelMap> **需要权限**：ohos.permission.CAPTURE_SCREEN -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | options | [ScreenshotOptions](#screenshotoptions) | 否 | 该类型的参数包含screenRect，imageSize，rotation三个参数，需要分别设置这三个参数。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ----------------------------- | ----------------------------------------------- | | Promise<image.PixelMap> | 以Promise形式返回结果，返回image.PixelMap对象。 | -- 示例 +**示例：** ```js var ScreenshotOptions = { diff --git a/zh-cn/application-dev/reference/apis/js-apis-usb.md b/zh-cn/application-dev/reference/apis/js-apis-usb.md index e1c2299bcbe8a13930ef9e324dd6a09bb14f7187..0965e87e8be781726ae6844252f9f18171bd3602 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-usb.md +++ b/zh-cn/application-dev/reference/apis/js-apis-usb.md @@ -5,7 +5,7 @@ ## 导入模块 -``` +```js import usb from "@ohos.usb"; ``` @@ -17,13 +17,13 @@ getDevices(): Array<Readonly<USBDevice>> **系统能力**: SystemCapability.USB.USBManager -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Array<Readonly<[USBDevice](#usbdevice)>> | 设备信息列表。 | -- 示例： - ``` +**示例：** + ```js let devicesList = usb.getDevices(); console.log(`devicesList = ${JSON.stringify(devicesList)}`); //devicesList 返回的数据结构 @@ -89,18 +89,18 @@ connectDevice(device: USBDevice): Readonly<USBDevicePipe> **系统能力**: SystemCapability.USB.USBManager -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | device | [USBDevice](#usbdevice) | 是 | USB设备信息。 | -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Readonly<[USBDevicePipe](#usbdevicepipe)> | 指定的传输通道对象。 | -- 示例： - ``` +**示例：** + ```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<boolean> **系统能力**: SystemCapability.USB.USBManager -- 参数： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | deviceName | string | 是 | 设备名称。 | -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<boolean> | 获取到true则表示软件包的临时权限已访问成功， 获取到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 ，表示不强制获取。 | -- 返回值： +**返回值：** | 类型 | 说明 | | -------- | -------- | | 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<number> | 获取传输或接收到的数据块大小， 获取到-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<number> | 获取传输或接收到的数据块大小， 获取到-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}`); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-webgl.md b/zh-cn/application-dev/reference/apis/js-apis-webgl.md index 289a71c99f853061b42acf97cbe5412bdbb28703..a75ff297d84a092281fd83f60d067dfd2310094a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-webgl.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webgl.md @@ -11,7 +11,7 @@ WebGL标准图形API，对应OpenGL ES 2.0特性集。更多信息请参考[WebG hml内创建canvas，示例如下： - + ```
@@ -21,8 +21,8 @@ hml内创建canvas，示例如下： js内获取canvas实例，示例如下： - -``` + +```js // 获取canvas组件实例 const el = this.$refs.canvas1; // 从canvas组件实例获取WebGL上下文 diff --git a/zh-cn/application-dev/reference/apis/js-apis-webgl2.md b/zh-cn/application-dev/reference/apis/js-apis-webgl2.md index 1365302250ee39c56de5d8db811a5e67257ba2f7..59f475ff37f45ea7ae8ff4827ee3867d3947e720 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-webgl2.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webgl2.md @@ -11,7 +11,7 @@ WebGL标准图形API，对应OpenGL ES 3.0特性集。更多信息请参考[WebG hml内创建canvas，示例如下： - + ```
@@ -21,8 +21,8 @@ hml内创建canvas，示例如下： js内获取canvas实例，示例如下： - -``` + +```js // 获取canvas组件实例 const el = this.$refs.canvas1; // 从canvas组件实例获取WebGL上下文 diff --git a/zh-cn/application-dev/reference/apis/js-apis-window.md b/zh-cn/application-dev/reference/apis/js-apis-window.md index a2ac5ac264628dd5483a1d7c12a03704121a5be1..ca48b7a7a4b976c2374d920ebda1d016e204d99b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -1,5 +1,7 @@ # 窗口 +窗口提供管理窗口的一些基础能力，包括对窗口的创建、销毁，以及对窗口的属性设置等各项功能。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > @@ -172,7 +174,7 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | -------------------------- | @@ -180,7 +182,7 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi | type | [WindowType](#windowtype) | 是 | 窗口类型。 | | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回创建的子窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -205,20 +207,20 @@ create(id: string, type: WindowType): Promise<Window> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------- | ---- | ---------- | | id | string | 是 | 窗口id。 | | type | [WindowType](#windowtype) | 是 | 窗口类型。 | -- 返回值 +**返回值：** | 类型 | 说明 | | -------------------------------- | ------------------------------------------------- | | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的子窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -241,7 +243,7 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback<Wi **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | @@ -250,7 +252,7 @@ create(ctx: Context, id: string, type: WindowType, callback: AsyncCallback<Wi | type | [WindowType](#windowtype) | 是 | 窗口类型。 | | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -275,7 +277,7 @@ create(ctx: Context, id: string, type: WindowType): Promise<Window> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------- | ---- | ------------------------------------------------------------ | @@ -283,13 +285,13 @@ create(ctx: Context, id: string, type: WindowType): Promise<Window> | id | string | 是 | 窗口id。 | | type | [WindowType](#windowtype) | 是 | 窗口类型。 | -- 返回值 +**返回值：** | 类型 | 说明 | | -------------------------------- | ----------------------------------------------- | | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -310,14 +312,14 @@ find(id: string, callback: AsyncCallback<Window>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ---------------------------- | | id | string | 是 | 窗口id。 | | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前查找的窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -339,19 +341,19 @@ find(id: string): Promise<Window> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------- | | id | string | 是 | 窗口id。 | -- 返回值 +**返回值：** | 类型 | 说明 | | -------------------------------- | ----------------------------------------------- | | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前查找的窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -372,13 +374,13 @@ getTopWindow(callback: AsyncCallback<Window>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | -------------------------------------- | | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前应用内最后显示的窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -400,13 +402,13 @@ getTopWindow(): Promise<Window> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | -------------------------------- | --------------------------------------------------------- | | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前应用内最后显示的窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -427,14 +429,14 @@ getTopWindow(ctx: Context, callback: AsyncCallback<Window>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ------------------------------------------------------------ | | ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。 | | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前应用内最后显示的窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -456,19 +458,19 @@ getTopWindow(ctx: Context): Promise<Window> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------- | ---- | ------------------------------------------------------------ | | ctx | Context | 是 | 当前应用上下文信息。
API version 8的Context定义见[Context](js-apis-Context.md)。
API version 9的Context定义见[Context](js-apis-ability-context.md)。 | -- 返回值 +**返回值：** | 类型 | 说明 | | -------------------------------- | --------------------------------------------------------- | | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前应用内最后显示的窗口对象。 | -- 示例 +**示例：** ```js var windowClass = null; @@ -491,14 +493,14 @@ on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): v **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | | callback | Callback<[SystemBarTintState](#systembartintstate)> | 是 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```js var type = 'systemBarTintChange'; @@ -517,14 +519,14 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >) **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 监听事件，固定为'systemBarTintChange'，即导航栏、状态栏属性变化事件。 | | callback | Callback<[SystemBarTintState](#systembartintstate)> | 否 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```js var type = 'systemBarTintChange'; @@ -545,13 +547,13 @@ hide (callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------- | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.hide((err, data) => { @@ -573,13 +575,13 @@ hide(): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.hide(); @@ -598,13 +600,13 @@ show(callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------- | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.show((err, data) => { @@ -624,13 +626,13 @@ show(): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.show(); @@ -649,13 +651,13 @@ destroy(callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------- | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.destroy((err, data) => { @@ -675,13 +677,13 @@ destroy(): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.destroy(); @@ -700,7 +702,7 @@ moveTo(x: number, y: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | --------------------------------------- | @@ -708,7 +710,7 @@ moveTo(x: number, y: number, callback: AsyncCallback<void>): void | y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.moveTo(300, 300, (err, data)=>{ @@ -729,20 +731,20 @@ moveTo(x: number, y: number): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | --------------------------------------- | | x | number | 是 | 窗口在x轴方向移动的值，值为正表示右移。 | | y | number | 是 | 窗口在y轴方向移动的值，值为正表示下移。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.moveTo(300, 300); @@ -761,7 +763,7 @@ resetSize(width: number, height: number, callback: AsyncCallback<void>): v **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------- | @@ -769,7 +771,7 @@ resetSize(width: number, height: number, callback: AsyncCallback<void>): v | height | number | 是 | 目标窗口的高度。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.resetSize(500, 1000, (err, data) => { @@ -789,20 +791,20 @@ resetSize(width: number, height: number): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------- | | width | number | 是 | 目标窗口的宽度。 | | height | number | 是 | 目标窗口的高度。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.resetSize(500, 1000); @@ -823,14 +825,14 @@ setWindowType(type: WindowType, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------- | | type | [WindowType](#windowtype) | 是 | 窗口类型。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var type = window.TYPE_APP; @@ -853,19 +855,19 @@ setWindowType(type: WindowType): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------- | ---- | ---------- | | type | [WindowType](#windowtype) | 是 | 窗口类型。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var type = window.TYPE_APP; @@ -885,13 +887,13 @@ getProperties(callback: AsyncCallback<WindowProperties>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------------------------- | ---- | ------------------ | | callback | AsyncCallback<[WindowProperties](#windowproperties)> | 是 | 回调返回窗口属性。 | -- 示例 +**示例：** ```js windowClass.getProperties((err, data) => { @@ -911,13 +913,13 @@ getProperties(): Promise<WindowProperties> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | ---------------------------------------------------- | ------------------------------------- | | Promise<[WindowProperties](#windowproperties)> | 以Promise形式返回结果，返回窗口属性。 | -- 示例 +**示例：** ```js let promise = windowClass.getProperties(); @@ -936,14 +938,14 @@ getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): voi **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [AvoidAreaType](#avoidareatype) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 | | callback | AsyncCallback<[AvoidArea](#avoidarea)> | 是 | 回调返回窗口内容规避区域。 | -- 示例 +**示例：** ```js var type = window.AvoidAreaType.TYPE_SYSTEM; @@ -964,19 +966,19 @@ getAvoidArea(type: AvoidAreaType): Promise<AvoidArea> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------- | ---- | ------------------------------------------------------------ | | type | [AvoidAreaType](#avoidareatype) | 是 | 表示规避区类型。type为TYPE_SYSTEM，表示系统默认区域。type为TYPE_CUTOUT，表示刘海屏区域。 | -- 返回值 +**返回值：** | 类型 | 说明 | | -------------------------------------- | --------------------------------------------- | | Promise<[AvoidArea](#avoidarea)> | 以Promise形式返回结果，返回窗口内容规避区域。 | -- 示例 +**示例：** ```js let promise = windowClass.getAvoidArea(); @@ -995,14 +997,14 @@ setFullScreen(isFullScreen: boolean, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------------------------- | ---- | ---------------------------------------------- | | isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var isFullScreen = true; @@ -1023,19 +1025,19 @@ setFullScreen(isFullScreen: boolean): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------- | ---- | ---------------------------------------------- | | isFullScreen | boolean | 是 | 是否设为全屏状态，且全屏状态隐藏状态栏导航栏。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var isFullScreen = true; @@ -1055,14 +1057,14 @@ setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------------ | ------------------------- | ---- | ------------------------------------------------------------ | | isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var isLayoutFullScreen= true; @@ -1083,19 +1085,19 @@ setLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------------ | ------- | ---- | ------------------------------------------------------------ | | isLayoutFullScreen | boolean | 是 | 窗口的布局是否为全屏显示状态，且全屏状态下状态栏、导航栏仍然显示。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var isLayoutFullScreen = true; @@ -1115,14 +1117,14 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallbac **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------------------------------------------ | | names | Array | 是 | 设置状态栏和导航栏是否显示。例如，需全部显示，该参数设置为["status", "navigation"], 不设置，则默认不显示。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var names = ["status", "navigation"]; @@ -1143,19 +1145,19 @@ setSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ----- | ---- | ------------------------------------------------------------ | | names | Array | 是 | 设置状态栏和导航栏是否显示。例如，需全部显示，该参数设置为["status", "navigation"], 不设置，则默认不显示。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var names = ["status", "navigation"]; @@ -1175,14 +1177,14 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: Async **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------------- | ------------------------------------------- | ---- | -------------------- | | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏状态栏的属性。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var SystemBarProperties={ @@ -1212,19 +1214,19 @@ setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<voi **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------------- | ------------------------------------------- | ---- | -------------------- | | SystemBarProperties | [SystemBarProperties](#systembarproperties) | 是 | 导航栏状态栏的属性。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var SystemBarProperties={ @@ -1253,14 +1255,14 @@ loadContent(path: string, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | -------------------- | | path | string | 是 | 设置加载页面的路径。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.loadContent("pages/page2/page2", (err, data) => { @@ -1280,19 +1282,19 @@ loadContent(path: string): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------- | | path | string | 是 | 设置加载页面的路径。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.loadContent("pages/page2/page2"); @@ -1311,13 +1313,13 @@ isShowing(callback: AsyncCallback<boolean>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------- | ---- | -------------------------------- | | callback | AsyncCallback<boolean> | 是 | 回调函数返回是否显示子窗口结果。 | -- 示例 +**示例：** ```js windowClass.isShowing((err, data) => { @@ -1337,13 +1339,13 @@ isShowing(): Promise<boolean> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | ---------------------- | ----------------------------------------------------- | | Promise<boolean> | 以Promise形式返回结果，返回当前窗口是否已显示的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.isShowing(); @@ -1362,14 +1364,14 @@ on(type: 'windowSizeChange', callback: Callback<Size>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------- | ---- | -------------------------------------------------------- | | type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | | callback | Callback<[Size](#size)> | 是 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```js var type = 'windowSizeChange'; @@ -1386,14 +1388,14 @@ off(type: 'windowSizeChange', callback?: Callback<Size >): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------- | ---- | -------------------------------------------------------- | | type | string | 是 | 监听事件，固定为'windowSizeChange'，即窗口尺寸变化事件。 | | callback | Callback<[Size](#size)> | 否 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```js var type = 'windowSizeChange'; @@ -1408,14 +1410,14 @@ on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统窗口规避区变化事件。 | | callback | Callback<[AvoidArea](#avoidarea)> | 是 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```js var type = 'systemAvoidAreaChange'; @@ -1432,14 +1434,14 @@ off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 监听事件，固定为'systemAvoidAreaChange'，即系统窗口规避区变化事件。 | | callback | Callback<[AvoidArea](#avoidarea)> | 否 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```js var type = 'systemAvoidAreaChange'; @@ -1456,14 +1458,14 @@ on(type: 'keyboardHeightChange', callback: Callback<number>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------ | ---- | ------------------------------------------------------------ | | type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | | callback | Callbacknumber> | 是 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```js var type = 'keyboardHeightChange'; @@ -1482,14 +1484,14 @@ off(type: 'keyboardHeightChange', callback?: Callback<number>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 监听事件，固定为'keyboardHeightChange'，即键盘高度变化事件。 | | callback | Callback<number> | 否 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```js var type = 'keyboardHeightChange'; @@ -1504,13 +1506,13 @@ isSupportWideGamut(callback: AsyncCallback<boolean>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------- | ---- | -------------------------------- | | callback | AsyncCallback<boolean> | 是 | 回调函数返回是否支持广色域模式。 | -- 示例 +**示例：** ```js windowClass.isSupportWideGamut((err, data) => { @@ -1530,13 +1532,13 @@ isSupportWideGamut(): Promise<boolean> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | ---------------------- | ------------------------------------------------------------ | | Promise<boolean> | 以Promise形式返回结果，返回当前窗口是否支持广色域模式的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.isSupportWideGamut(); @@ -1555,14 +1557,14 @@ setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------ | | colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.setColorSpace(window.ColorSpace.WIDE_GAMUT, (err, data) => { @@ -1582,19 +1584,19 @@ setColorSpace(colorSpace:ColorSpace): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------ | | colorSpace | [ColorSpace](#colorspace) | 是 | 设置色域模式 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.isSupportWideGamut(window.ColorSpace.WIDE_GAMUT); @@ -1613,13 +1615,13 @@ getColorSpace(callback: AsyncCallback<ColorSpace>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------------- | ---- | -------------------------- | | callback | AsyncCallback<[ColorSpace](#colorspace)> | 是 | 回调函数返回当前色域模式。 | -- 示例 +**示例：** ```js windowClass.getColorSpace((err, data) => { @@ -1639,13 +1641,13 @@ getColorSpace(): Promise<ColorSpace> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | ---------------------------------------- | ----------------------------------------- | | Promise<[ColorSpace](#colorspace)> | 以Promise形式返回结果，返回当前色域模式。 | -- 示例 +**示例：** ```js let promise = windowClass.getColorSpace(); @@ -1666,14 +1668,14 @@ setBackgroundColor(color: string, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------------------------------------------ | | color | string | 是 | 需要设置的背景色，为16进制颜色，例如"#00FF00"或"#FF00FF00"。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var color = '#00ff33'; @@ -1696,19 +1698,19 @@ setBackgroundColor(color: string): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------------------------------ | | color | string | 是 | 需要设置的背景色，为16进制颜色，例如"#00FF00"或"#FF00FF00"。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var color = '#00ff33'; @@ -1730,14 +1732,14 @@ setBrightness(brightness: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------------------------------ | | brightness | number | 是 | 屏幕亮度值，值为0-1之间。1表示最亮。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var brightness = 1; @@ -1760,19 +1762,19 @@ setBrightness(brightness: number): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ------------------------------------ | | brightness | number | 是 | 屏幕亮度值，值为0-1之间。1表示最亮。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var brightness = 1; @@ -1794,14 +1796,14 @@ setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ---- | -------------------------------------------------- | | dimBehindValue | number | 是 | 表示靠后的窗口的暗度值，取值范围为0-1，1表示最暗。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.setDimBehind(0.5, (err, data) => { @@ -1823,19 +1825,19 @@ setDimBehind(dimBehindValue: number): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | -------------------------------------------------- | | dimBehindValue | number | 是 | 表示靠后的窗口的暗度值，取值范围为0-1，1表示最暗。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.setDimBehind(0.5); @@ -1856,14 +1858,14 @@ setFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------- | ---- | ---------------------------- | | isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var isFocusable= true; @@ -1886,19 +1888,19 @@ setFocusable(isFocusable: boolean): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------- | ---- | ---------------------------- | | isFocusable | boolean | 是 | 点击时是否支持切换焦点窗口。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var isFocusable= true; @@ -1920,14 +1922,14 @@ setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): v **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ---- | ------------------------ | | isKeepScreenOn | boolean | 是 | 是否设置为屏幕常亮状态。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var isKeepScreenOn = true; @@ -1950,19 +1952,19 @@ setKeepScreenOn(isKeepScreenOn: boolean): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------- | ---- | ------------------------ | | isKeepScreenOn | boolean | 是 | 是否设置为屏幕常亮状态。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var isKeepScreenOn= true; @@ -1984,14 +1986,14 @@ setOutsideTouchable(touchable: boolean, callback: AsyncCallback<void>): vo **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | ---------------- | | touchable | boolean | 是 | 设置是否可点击。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js windowClass.setOutsideTouchable(true, (err, data) => { @@ -2013,19 +2015,19 @@ setOutsideTouchable(touchable: boolean): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------- | ---- | ---------------- | | touchable | boolean | 是 | 设置是否可点击。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js let promise = windowClass.setOutsideTouchable(true); @@ -2046,14 +2048,14 @@ setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): voi **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------- | ---- | -------------------- | | isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var isPrivacyMode = true; @@ -2077,19 +2079,19 @@ setPrivacyMode(isPrivacyMode: boolean): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------- | ---- | -------------------- | | isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var isPrivacyMode = true; @@ -2111,14 +2113,14 @@ setTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------------------------- | ---- | -------------------- | | isTouchable | boolean | 是 | 窗口是否为可触状态。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```js var isTouchable = true; @@ -2142,19 +2144,19 @@ setTouchable(isTouchable: boolean): Promise<void> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------- | ---- | -------------------- | | isTouchable | boolean | 是 | 窗口是否为可触状态。 | -- 返回值 +**返回值：** | 类型 | 说明 | | ------------------- | ----------------------------------------------- | | Promise<void> | 以Promise形式返回结果，返回当前函数执行的结果。 | -- 示例 +**示例：** ```js var isTouchable = true; @@ -2191,13 +2193,13 @@ getMainWindow(): Promise<Window> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | -------------------------------- | ---------------------------------------------------------- | | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前WindowStage下的主窗口对象。 | -- 示例 +**示例：** ```ts class myAbility extends Ability { @@ -2223,13 +2225,13 @@ getMainWindow(callback: AsyncCallback<Window>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | --------------------------------------- | | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前WindowStage下的主窗口对象。 | -- 示例 +**示例：** ```ts class myAbility extends Ability { @@ -2256,19 +2258,19 @@ createSubWindow(name: string): Promise<Window> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------- | | name | String | 是 | 子窗口的名字。 | -- 返回值 +**返回值：** | 类型 | 说明 | | -------------------------------- | ------------------------------------------------- | | Promise<[Window](#window)> | 以Promise形式返回结果，返回当前创建的子窗口对象。 | -- 示例 +**示例：** ```ts class myAbility extends Ability { @@ -2294,14 +2296,14 @@ createSubWindow(name: string, callback: AsyncCallback<Window>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ------------------------------ | | name | String | 是 | 子窗口的名字。 | | callback | AsyncCallback<[Window](#window)> | 是 | 回调返回当前创建的子窗口对象。 | -- 示例 +**示例：** ```ts class myAbility extends Ability { @@ -2329,13 +2331,13 @@ getSubWindow(): Promise<Array<Window>> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 返回值 +**返回值：** | 类型 | 说明 | | --------------------------------------------- | ------------------------------------------------------------ | | Promise<Array<[Window](#window)>> | 以Promise形式返回结果，返回当前WindowStage下的所有子窗口对象。 | -- 示例 +**示例：** ```ts class myAbility extends Ability { @@ -2361,13 +2363,13 @@ getSubWindow(callback: AsyncCallback<Array<Window>>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------- | ---- | ------------------------------------------- | | callback | AsyncCallback<Array<[Window](#window)>> | 是 | 回调返回当前WindowStage下的所有子窗口对象。 | -- 示例 +**示例：** ```ts class myAbility extends Ability { @@ -2394,14 +2396,14 @@ loadContent(path: string, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.WindowManager.WindowManager.Coretype为'windowSizeChange' -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | -------------------- | | path | string | 是 | 设置加载页面的路径。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | -- 示例 +**示例：** ```ts class myAbility extends Ability { @@ -2426,14 +2428,14 @@ on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType> **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | | callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | 是 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```ts class myAbility extends Ability { @@ -2455,14 +2457,14 @@ off(eventType: 'windowStageEvent', callback?: Callback<WindowStageEventType&g **系统能力**：SystemCapability.WindowManager.WindowManager.Core -- 参数 +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | string | 是 | 监听事件，固定为'windowStageEvent'，即WindowStage生命周期变化事件。 | | callback | Callback<[WindowStageEventType](#windowstageeventtype9)> | 否 | 回调返回监听到的信息。 | -- 示例 +**示例：** ```ts class myAbility extends Ability {