diff --git a/zh-cn/application-dev/database/database-mdds-guidelines.md b/zh-cn/application-dev/database/database-mdds-guidelines.md index 5c75f819a34ed8add1552ec558806a5e4be36b70..132176bdee91d4a7af7fc18ce844407b7711b33f 100644 --- a/zh-cn/application-dev/database/database-mdds-guidelines.md +++ b/zh-cn/application-dev/database/database-mdds-guidelines.md @@ -11,15 +11,17 @@ OpenHarmony系统中的分布式数据服务模块为开发者提供下面几种 **表1** 分布式数据服务关键API功能介绍 -| 功能分类 | 接口名称 | 描述 | -| -------- | -------- | -------- | -| 分布式数据库创建。 | createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void
createKVManager(config: KVManagerConfig): Promise<KVManager> | 创建一个KVManager对象实例，用于管理数据库对象。 | -| getKVStore<T extends KVStore>(storeId: string, options: Options, callback: AsyncCallback<T>): void
getKVStore<T extends KVStore>(storeId: string, options: Options): Promise<T> | 指定Options和storeId，创建并获取KVStore数据库。 | -| 分布式数据增、删、改、查。 | put(key: string, value: Uint8Array \| string \| number \| boolean, callback: AsyncCallback<void>): void
put(key: string, value: Uint8Array \| string \| number \| boolean): Promise<void> | 插入和更新数据。 | -| delete(key: string, callback: AsyncCallback<void>): void
delete(key: string): Promise<void> | 删除数据。 | -| get(key: string, callback: AsyncCallback<Uint8Array \| string \| boolean \| number>): void
get(key: string): Promise<Uint8Array \| string \| boolean \| number> | 查询数据。 | -| 订阅分布式数据变化。 | on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void
on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void | 订阅数据库中数据的变化。 | -| 分布式数据同步。 | sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void | 在手动模式下，触发数据库同步。 | +| 功能分类 | 接口名称 | 描述 | +| -------------------------- | ------------------------------------------------------------ | ----------------------------------------------- | +| 分布式数据库创建。 | createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void
createKVManager(config: KVManagerConfig): Promise<KVManager> | 创建一个KVManager对象实例，用于管理数据库对象。 | +| 分布式数据库创建。 | getKVStore<T extends KVStore>(storeId: string, options: Options, callback: AsyncCallback<T>): void
getKVStore<T extends KVStore>(storeId: string, options: Options): Promise<T> | 指定Options和storeId，创建并获取KVStore数据库。 | +| 分布式数据增、删、改、查。 | put(key: string, value: Uint8Array \| string \| number \| boolean, callback: AsyncCallback<void>): void
put(key: string, value: Uint8Array \| string \| number \| boolean): Promise<void> | 插入和更新数据。 | +| 分布式数据增、删、改、查。 | delete(key: string, callback: AsyncCallback<void>): void
delete(key: string): Promise<void> | 删除数据。 | +| 分布式数据增、删、改、查。 | get(key: string, callback: AsyncCallback<Uint8Array \| string \| boolean \| number>): void
get(key: string): Promise<Uint8Array \| string \| boolean \| number> | 查询数据。 | +| 订阅分布式数据变化。 | on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void
on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void | 订阅数据库中数据的变化。 | +| 分布式数据同步。 | sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void | 在手动模式下，触发数据库同步。 | + + ## 开发步骤 diff --git a/zh-cn/application-dev/database/database-relational-guidelines.md b/zh-cn/application-dev/database/database-relational-guidelines.md index 6a9b5a120988cda65a5157118505664a469499cb..b22dab6fdaecefca78d102abd8e66c5029e79d96 100644 --- a/zh-cn/application-dev/database/database-relational-guidelines.md +++ b/zh-cn/application-dev/database/database-relational-guidelines.md @@ -7,7 +7,7 @@ ## 接口说明 -**数据库的创建和删除** +### 数据库的创建和删除 关系型数据库提供了数据库创建方式，以及对应的删除接口，涉及的API如下所示。 @@ -20,46 +20,58 @@ |deleteRdbStore(name: string, callback: AsyncCallback<void>): void | 删除数据库，结果以callback形式返回。
- name：数据库名称。
- callback：指定callback回调函数。如果数据库已删除，则为true；否则返回false。 | | deleteRdbStore(name: string): Promise<void> | 使用指定的数据库文件配置删除数据库，结果以Promise形式返回。
- name：数据库名称。 | -**数据库的增删改查** +### 数据库的增删改查 关系型数据库提供对本地数据增删改查操作的能力，相关API如下所示。 - **新增** - 关系型数据库提供了插入数据的接口，通过ValuesBucket输入要存储的数据，通过返回值判断是否插入成功，插入成功时返回最新插入数据所在的行号，失败时则返回-1。 + + + 关系型数据库提供了插入数据的接口，通过ValuesBucket输入要存储的数据，通过返回值判断是否插入成功，插入成功时返回最新插入数据所在的行号，失败时则返回-1。 + **表2** 数据库插入API | 类名 | 接口名 | 描述 | - | -------- | -------- | -------- | +| -------- | -------- | -------- | | RdbStore | insert(name: string, values: ValuesBucket, callback: AsyncCallback<number>):void | 向目标表中插入一行数据，结果以callback形式返回。
- name：指定的目标表名。
- values：表示要插入到表中的数据行。
- callback：指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 | | RdbStore | insert(name: string, values: ValuesBucket): Promise<number> | 向目标表中插入一行数据，结果以Promise形式返回。
- name：指定的目标表名。
- values：表示要插入到表中的数据行。 | - + - **更新** - 调用更新接口，传入要更新的数据，并通过RdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败，则返回0。 + + + 调用更新接口，传入要更新的数据，并通过RdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败，则返回0。 + **表3** 数据库更新API | 类名 | 接口名 | 描述 | - | -------- | -------- | -------- | +| -------- | -------- | -------- | | RdbStore | update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以callback形式返回。
- values：以ValuesBucket存储的要更新的数据。
- rdbPredicates：表示RdbPredicates的实例对象指定的更新条件。
- callback：指定的callback回调方法。返回受影响的行数。 | | RdbStore | update(values: ValuesBucket, rdbPredicates: RdbPredicates): Promise | 根据RdbPredicates的指定实例对象更新数据库中的数据，结果以Promise形式返回。
- values：以ValuesBucket存储的要更新的数据。
- rdbPredicates：表示RdbPredicates的实例对象指定的更新条件。 | - + - **删除** - 调用删除接口，通过RdbPredicates指定删除条件。该接口的返回值表示删除的数据行数，可根据此值判断是否删除成功。如果删除失败，则返回0。 + + + 调用删除接口，通过RdbPredicates指定删除条件。该接口的返回值表示删除的数据行数，可根据此值判断是否删除成功。如果删除失败，则返回0。 + **表4** 数据库删除API | 类名 | 接口名 | 描述 | - | -------- | -------- | -------- | +| -------- | -------- | -------- | | RdbStore | delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据rdbPredicates的指定实例对象从数据库中删除数据，结果以callback形式返回。
- rdbPredicates：RdbPredicates的实例对象指定的删除条件。
- callback：指定callback回调函数。返回受影响的行数。 | | RdbStore | delete(rdbPredicates: RdbPredicates): Promise | 根据rdbPredicates的指定实例对象从数据库中删除数据，结果以Promise形式返回。
- rdbPredicates：RdbPredicates的实例对象指定的删除条件。 | - + - **查询** + + + 关系型数据库提供了两种查询数据的方式： - 直接调用查询接口。使用该接口，会将包含查询条件的谓词自动拼接成完整的SQL语句进行查询操作，无需用户传入原生的SQL语句。 - 执行原生的SQL语句进行查询操作。 - + **表5** 数据库查询API | 类名 | 接口名 | 描述 | @@ -69,7 +81,7 @@ | RdbStore | querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<ResultSet>):void | 根据指定SQL语句查询数据库中的数据，结果以callback形式返回。
- sql：指定要查询的SQL语句。
- bindArgs：SQL语句中参数的值。
- callback：指定callback回调函数。如果操作成功，则返回ResultSet对象。 | | RdbStore | querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> | 根据指定SQL语句查询数据库中的数据，结果以Promise形式返回。
- sql：指定要查询的SQL语句。
- bindArgs：SQL语句中参数的值。 | -**数据库谓词的使用** +### 数据库谓词的使用 关系型数据库提供了用于设置数据库操作条件的谓词RdbPredicates，该类确定RDB中条件表达式的值是true还是false。 @@ -108,12 +120,12 @@ | RdbPredicates | in(field: string, value: Array<ValueType>): RdbPredicates | 配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
- field：数据库表中的列名。
- value：以ValueType型数组形式指定的要匹配的值。
- RdbPredicates：返回与指定字段匹配的谓词。 | | RdbPredicates | notIn(field: string, value: Array<ValueType>): RdbPredicates | 将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
- field：数据库表中的列名。
- value：以ValueType型数组形式指定的要匹配的值。
- RdbPredicates：返回与指定字段匹配的谓词。 | -**查询结果集的使用** +### 查询结果集的使用 关系型数据库提供了查询返回的结果集ResultSet，其指向查询结果中的一行数据，供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。 > ![icon-notice.gif](public_sys-resources/icon-notice.gif) **须知：** -> **注：结果集使用完后，请一定要调用close方法显式关闭。** +> **结果集使用完后，请一定要调用close方法显式关闭。** **表7** 结果集API @@ -135,49 +147,48 @@ -**设置分布式列表。** +### 设置分布式列表 -用户可以对当前数据库中的列表设置为分布式列表。 +**设置分布式列表** -**表9** 设置分布式列表 +**表8** 设置分布式列表 | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | | RdbStore | setDistributedTables(tables: Array, callback: AsyncCallback): void;| 设置分布式列表，结果以callback形式返回。
- tables：要设置的分布式列表表名。
- callback：指定callback回调函数。 | | RdbStore | setDistributedTables(tables: Array): Promise; | 设置分布式列表，结果以Promise形式返回。
- tables：要设置的分布式列表表名。 | -**根据本地表名获取指定远程设备的分布式表名。** +**根据本地表名获取指定远程设备的分布式表名** 用户根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名。 -**表10** 根据本地表名获取指定远程设备的分布式表名 +**表9** 根据本地表名获取指定远程设备的分布式表名 | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | | RdbStore | obtainDistributedTableName(device: string, table: string, callback: AsyncCallback): void; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callbck形式返回。
- device：远程设备。
- table：本地表名。
- callback：指定的callback回调函数，如果操作成功，返回远程设备的分布式表名。 | | RdbStore | obtainDistributedTableName(device: string, table: string): Promise; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。
- device：远程设备。
- table：本地表名。 | -**在设备之间同步数据。** +**在设备之间同步数据** -**表11** 在设备之间同步数据 +**表10** 在设备之间同步数据 | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | | RdbStore | sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback>): void;| 在设备之间同步数据，结果以callback形式返回。
- mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates：约束同步数据和设备。
- callback：指定的callback回调函数，string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | | RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise>;| 在设备之间同步数据，结果以Promise形式返回。
- mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates：约束同步数据和设备。 | +**注册数据库的观察者** -**注册数据库的观察者。** - -**表12** 注册数据库的观察者 +**表11** 注册数据库的观察者 | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | | RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback>): void;| 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
- type：指在{@code SubscribeType}中定义的订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer：指分布式数据库中数据更改事件的观察者。 | -**从数据库中删除指定类型的指定观察者。** +**从数据库中删除指定类型的指定观察者** -**表13** 从数据库中删除指定类型的指定观察者 +**表12** 从数据库中删除指定类型的指定观察者 | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/database/database-relational-overview.md b/zh-cn/application-dev/database/database-relational-overview.md index f9a84f85a03efcda86bac16424ecb82bfbe108de..fab1d7256a4524bd8f51d58bc4b7f578c1341d58 100644 --- a/zh-cn/application-dev/database/database-relational-overview.md +++ b/zh-cn/application-dev/database/database-relational-overview.md @@ -30,8 +30,8 @@ ## 默认配置 -- 如果不指定数据库的日志模式，那么系统默认日志方式是WAL（Write Ahead Log）模式。 -- 如果不指定数据库的落盘模式，那么系统默认落盘方式是FULL模式。 +- 系统默认日志方式是WAL（Write Ahead Log）模式。 +- 系统默认落盘方式是FULL模式。 - OpenHarmony数据库使用的共享内存默认大小是2MB。 ## 约束与限制 diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md index 111b564daa5e518ea9496185f0c9c01ea5c6fde9..df3026dea839627fe0c98b2eff1d9c41dc2eccc8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md @@ -127,11 +127,11 @@ deleteRdbStore(context?: Context, name: string, callback: AsyncCallback<void& **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | context8+ | Context | 否 | 应用程序或功能的上下文 | - | name | string | 是 | 数据库名称。 | - | callback | AsyncCallback<void> | 是 | 指定callback回调函数。如果数据库已删除，则为true；否则返回false。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| context8+ | Context | 否 | 应用程序或功能的上下文 | +| name | string | 是 | 数据库名称。 | +| callback | AsyncCallback<void> | 是 | 指定callback回调函数。如果数据库已删除，则为true；否则返回false。 | **示例**： ``` @@ -162,15 +162,15 @@ deleteRdbStore(context?: Context, name: string): Promise<void> **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | context8+ | Context | 否 | 应用程序或功能的上下文 | - | name | string | 是 | 数据库名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| context8+ | Context | 否 | 应用程序或功能的上下文 | +| name | string | 是 | 数据库名称。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 指定Promise回调函数。如果数据库已删除，则为true；否则返回false。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 指定Promise回调函数。如果数据库已删除，则为true；否则返回false。 | **示例**： ``` @@ -213,16 +213,16 @@ constructor(name: string) **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | name | string | 是 | 数据库表名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| name | string | 是 | 数据库表名。 | **示例**： ``` let predicates = new data_rdb.RdbPredicates("EMPLOYEE") ``` -### inDevices +### inDevices8+ inDevices(devices: Array<string>): RdbPredicates @@ -232,14 +232,14 @@ inDevices(devices: Array<string>): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | devices | Array<string> | 是 | 指定的组网内的远程设备ID。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| devices | Array<string> | 是 | 指定的组网内的远程设备ID。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -257,9 +257,9 @@ inAllDevices(): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -277,15 +277,15 @@ equalTo(field: string, value: ValueType): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -304,15 +304,15 @@ notEqualTo(field: string, value: ValueType): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -331,9 +331,9 @@ beginWrap(): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回带有左括号的Rdb谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回带有左括号的Rdb谓词。 | **示例**： ``` @@ -357,9 +357,9 @@ endWrap(): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回带有右括号的Rdb谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回带有右括号的Rdb谓词。 | **示例**： ``` @@ -383,9 +383,9 @@ or(): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 | **示例**： ``` @@ -406,9 +406,9 @@ and(): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回带有和条件的Rdb谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回带有和条件的Rdb谓词。 | **示例**： ``` @@ -428,15 +428,15 @@ contains(field: string, value: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | string | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | string | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -455,15 +455,15 @@ beginsWith(field: string, value: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | string | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | string | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -482,15 +482,15 @@ endsWith(field: string, value: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | string | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | string | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -509,14 +509,14 @@ isNull(field: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | - 示例 ``` @@ -535,14 +535,14 @@ isNotNull(field: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -561,15 +561,15 @@ like(field: string, value: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | string | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | string | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -588,15 +588,15 @@ glob(field: string, value: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | string | 是 | 指示要与谓词匹配的值。
支持通配符，*表示0个、1个或多个数字或字符，?表示1个数字或字符。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | string | 是 | 指示要与谓词匹配的值。
支持通配符，*表示0个、1个或多个数字或字符，?表示1个数字或字符。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -615,16 +615,16 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 | - | high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 | +| high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -643,16 +643,16 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 | - | high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| low | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最小值。 | +| high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -670,15 +670,15 @@ greaterThan(field: string, value: ValueType): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -697,15 +697,15 @@ lessThan(field: string, value: ValueType): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -725,15 +725,15 @@ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -753,15 +753,15 @@ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -781,14 +781,14 @@ orderByAsc(field: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -808,14 +808,14 @@ orderByDesc(field: string): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -834,9 +834,9 @@ distinct(): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 | **示例**： ``` @@ -862,14 +862,14 @@ limitAs(value: number): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | value | number | 是 | 最大数据记录数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | number | 是 | 最大数据记录数。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 | **示例**： ``` @@ -888,14 +888,14 @@ offsetAs(rowOffset: number): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 | **示例**： ``` @@ -914,14 +914,14 @@ groupBy(fields: Array<string>): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | fields | Array<string> | 是 | 指定分组依赖的列名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| fields | Array<string> | 是 | 指定分组依赖的列名。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 | **示例**： ``` @@ -932,21 +932,22 @@ groupBy(fields: Array<string>): RdbPredicates ### indexedBy -indexedBy(indexName: string): RdbPredicates +indexedBy(field: string): RdbPredicates 配置RdbPredicates以指定索引列。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | indexName | string | 是 | 索引列的名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 索引列的名称。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 | + +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 | **示例**： ``` @@ -965,16 +966,16 @@ in(field: string, value: Array<ValueType>): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | Array<[ValueType](#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -993,16 +994,16 @@ notIn(field: string, value: Array<ValueType>): RdbPredicates **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | field | string | 是 | 数据库表中的列名。 | - | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType数组形式指定的要匹配的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| field | string | 是 | 数据库表中的列名。 | +| value | Array<[ValueType](#valuetype)> | 是 | 以ValueType数组形式指定的要匹配的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | +| 类型 | 说明 | +| -------- | -------- | +| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例**： ``` @@ -1025,11 +1026,11 @@ insert(name: string, values: ValuesBucket, callback: AsyncCallback<number> **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | name | string | 是 | 指定的目标表名。 | - | values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 | - | callback | AsyncCallback<number> | 是 | 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| name | string | 是 | 指定的目标表名。 | +| values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 | +| callback | AsyncCallback<number> | 是 | 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 | **示例**： ``` @@ -1054,15 +1055,15 @@ insert(name: string, values: ValuesBucket):Promise<number> **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | name | string | 是 | 指定的目标表名。 | - | values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| name | string | 是 | 指定的目标表名。 | +| values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 指定Promise回调函数。如果操作成功，返回行ID；否则返回-1。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<number> | 指定Promise回调函数。如果操作成功，返回行ID；否则返回-1。 | **示例**： ``` @@ -1090,11 +1091,11 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 | - | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示要插入到表中的数据行。 | - | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。返回受影响的行数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 | +| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示要插入到表中的数据行。 | +| callback | AsyncCallback<number> | 是 | 指定的callback回调方法。返回受影响的行数。 | **示例**： ``` @@ -1120,15 +1121,15 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise<number> **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 | - | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示要插入到表中的数据行。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| values | [ValuesBucket](#valuesbucket) | 是 | value指示数据库中要更新的数据行。键值对与数据库表的列名相关联 | +| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示要插入到表中的数据行。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 指定的Promise回调方法。返回受影响的行数。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<number> | 指定的Promise回调方法。返回受影响的行数。 | **示例**： ``` @@ -1159,10 +1160,10 @@ delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 | - | callback | AsyncCallback<number> | 是 | 指定callback回调函数。返回受影响的行数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 | +| callback | AsyncCallback<number> | 是 | 指定callback回调函数。返回受影响的行数。 | **示例**： ``` @@ -1183,14 +1184,14 @@ delete(rdbPredicates: RdbPredicates):Promise<number> **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 指定Promise回调函数。返回受影响的行数。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<number> | 指定Promise回调函数。返回受影响的行数。 | **示例**： ``` @@ -1214,11 +1215,11 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: Asyn **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 | - | columns | Array<string> | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 | - | callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 | +| columns | Array<string> | 是 | 表示要查询的列。如果值为空，则查询应用于所有列。 | +| callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | **示例**： ``` @@ -1240,15 +1241,15 @@ query(rdbPredicates: RdbPredicates, columns?: Array<string>):Promise<Re **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 | - | columns | Array<string> | 否 | 表示要查询的列。如果值为空，则查询应用于所有列。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 | +| columns | Array<string> | 否 | 表示要查询的列。如果值为空，则查询应用于所有列。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<[ResultSet](../apis/js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<[ResultSet](../apis/js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | **示例**： ``` @@ -1273,11 +1274,11 @@ querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback& **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | sql | string | 是 | 指定要执行的SQL语句。 | - | bindArgs | Array<[ValueType](#valuetype)> | 是 | SQL语句中参数的值。 | - | callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| sql | string | 是 | 指定要执行的SQL语句。 | +| bindArgs | Array<[ValueType](#valuetype)> | 是 | SQL语句中参数的值。 | +| callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | **示例**： ``` @@ -1297,15 +1298,15 @@ querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | sql | string | 是 | 指定要执行的SQL语句。 | - | bindArgs | Array<[ValueType](#valuetype)> | 否 | SQL语句中参数的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| sql | string | 是 | 指定要执行的SQL语句。 | +| bindArgs | Array<[ValueType](#valuetype)> | 否 | SQL语句中参数的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<[ResultSet](../apis/js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<[ResultSet](../apis/js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | **示例**： ``` @@ -1328,11 +1329,11 @@ executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallbac **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | sql | string | 是 | 指定要执行的SQL语句。 | - | bindArgs | Array<[ValueType](#valuetype)> | 是 | SQL语句中参数的值。 | - | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| sql | string | 是 | 指定要执行的SQL语句。 | +| bindArgs | Array<[ValueType](#valuetype)> | 是 | SQL语句中参数的值。 | +| callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例**： ``` @@ -1351,15 +1352,15 @@ executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void> **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | sql | string | 是 | 指定要执行的SQL语句。 | - | bindArgs | Array<[ValueType](#valuetype)> | 否 | SQL语句中参数的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| sql | string | 是 | 指定要执行的SQL语句。 | +| bindArgs | Array<[ValueType](#valuetype)> | 否 | SQL语句中参数的值。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 指定Promise回调函数。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 指定Promise回调函数。 | **示例**： ``` @@ -1449,7 +1450,7 @@ rollBack():void; ``` -### setDistributedTables +### setDistributedTables8+ setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void @@ -1458,10 +1459,10 @@ setDistributedTables(tables: Array<string>, callback: AsyncCallback<voi **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | tables | Array<string> | 是 | 要设置的分布式列表表名 | - | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| tables | Array<string> | 是 | 要设置的分布式列表表名 | +| callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例**： ``` @@ -1475,7 +1476,7 @@ setDistributedTables(tables: Array<string>, callback: AsyncCallback<voi ``` -### setDistributedTables +### setDistributedTables8+ setDistributedTables(tables: Array<string>): Promise<void> @@ -1484,14 +1485,14 @@ setDistributedTables(tables: Array<string>, callback: AsyncCallback<voi **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | tables | Array<string> | 是 | 要设置的分布式列表表名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| tables | Array<string> | 是 | 要设置的分布式列表表名。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 指定Promise回调函数。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 指定Promise回调函数。 | **示例**： ``` @@ -1503,7 +1504,7 @@ setDistributedTables(tables: Array<string>, callback: AsyncCallback<voi }) ``` -### obtainDistributedTableName +### obtainDistributedTableName8+ obtainDistributedTableName(device: string, table: string, callback: AsyncCallback<string>): void @@ -1512,11 +1513,11 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | device | string | 是 | 远程设备 。| - | table | string | 是 | 本地表名。 | - | callback | AsyncCallback<string> | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| device | string | 是 | 远程设备 。| +| table | string | 是 | 本地表名。 | +| callback | AsyncCallback<string> | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 | **示例**： ``` @@ -1530,7 +1531,7 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac ``` -### obtainDistributedTableName +### obtainDistributedTableName8+ obtainDistributedTableName(device: string, table: string): Promise<string> @@ -1539,15 +1540,15 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | device | string | 是 | 远程设备。 | - | table | string | 是 | 本地表名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| device | string | 是 | 远程设备。 | +| table | string | 是 | 本地表名。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<string> | 指定Promise回调函数。如果操作成功，返回远程设备的分布式表名。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<string> | 指定Promise回调函数。如果操作成功，返回远程设备的分布式表名。 | **示例**： ``` @@ -1568,11 +1569,11 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | mode | SyncMode | 是 | 指同步模式。该值可以是推、拉。 | - | predicates | RdbPredicates | 是 | 约束同步数据和设备。 | - | callback | AsyncCallback<Array<[string, number]>> | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 | +| predicates | [RdbPredicates](#rdbpredicates) | 是 | 约束同步数据和设备。 | +| callback | AsyncCallback<Array<[string, number]>> | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。| **示例**： ``` @@ -1600,15 +1601,16 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | mode | SyncMode | 是 | 指同步模式。该值可以是推、拉。 | - | predicates | RdbPredicates | 是 | 约束同步数据和设备。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 | +| predicates | [RdbPredicates](#rdbpredicates) | 是 | 约束同步数据和设备。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[string, number]>> | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | + +| 类型 | 说明 | +| -------- | -------- | +| Promise<Array<[string, number]>> | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | **示例**： ``` @@ -1625,7 +1627,7 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array }) ``` -### on +### on('dataChange')8+ on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void @@ -1635,10 +1637,11 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<stri **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | SubscribeType | 是 | 指在{@code SubscribeType}中定义的订阅类型。 | - | observer | Callback<Array<string>> | 是 | 指分布式数据库中数据更改事件的观察者。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| event | string | 是 | 取值为'dataChange'，表示数据更改。 | +| type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 | +| observer | Callback<Array<string>> | 是 | 指分布式数据库中数据更改事件的观察者。 | **示例**： ``` @@ -1654,7 +1657,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<stri } ``` -### off +### off('dataChange')8+ off(event:'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void @@ -1664,12 +1667,14 @@ off(event:'dataChange', type: SubscribeType, observer: Callback<Array<stri **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | SubscribeType | 是 | 指在{@code SubscribeType}中定义的订阅类型。 | - | observer | Callback<Array<string>> | 是 | 指已注册的数据更改观察者。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| event | string | 是 | 取值为'dataChange'，表示数据更改。 | +| type | [SubscribeType](#subscribetype8) | 是 | 指在{@code SubscribeType}中定义的订阅类型。 | +| observer | Callback<Array<string>> | 是 | 指已注册的数据更改观察者。| **示例**： + ``` function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { 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 b6d4e0390b8f54518f4e15efc7ef3b7218259858..37c7ab69629d4e71c9034415023dfbd4472fe1b1 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 @@ -26,7 +26,6 @@ createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager> | config | [KVManagerConfig](#kvmanagerconfig) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | | callback | AsyncCallback<[KVManager](#kvmanager)> | 是 | KVManager实例创建时调用的回调，返回KVManager对象实例。 | - **示例**： let kvManager; @@ -573,7 +572,7 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v | autoSync | boolean | 否 |设置数据库文件是否自动同步，默认不自动同步。 | | kvStoreType | [KVStoreType](#kvstoretype) | 否 |设置要创建的数据库类型，默认为多设备协同数据库。 | | securityLevel | [SecurityLevel](#securitylevel) | 否 |设置数据库安全级别，默认不设置安全级别。 | -| schema | [schema](#Schema8+) | 否 | 设置定义存储在数据库中的值。 | +| schema8+ | [Schema](#schema8) | 否 | 设置定义存储在数据库中的值。 | ## KVStoreType @@ -629,7 +628,7 @@ KVStore常量。 | 名称 | 类型 | 说明 | | --- | ---- | ----------------------- | -| root8+ | [FieldNode](#FieldNode) | 表示json根对象 | +| root8+ | [FieldNode](#fieldnode8) | 表示json根对象 | | indexes8+ | Array | 表示json类型的字符串数组。 | | mode8+ | number | 表示Schema的模式。 | | skip8+ | number | Schema的跳跃大小。 | @@ -651,7 +650,7 @@ constructor() | 名称 | 类型 | 说明 | | --- | ---- | ----------------------- | | nullable8+ | boolean | 表示数据库字段是否可以为空。 | -| default8+ | string | 表示fieldnode的默认值。 | +| default8+ | string | 表示Fieldnode的默认值。 | | type8+ | number | 表示值。 | ### constructor8+ ### @@ -664,9 +663,9 @@ constructor(name: string) **参数**： -| 参数名 | 参数类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------------------- | -| name | string | 是 | FieldNode的值。 +| 参数名 | 参数类型 | 必填 | 说明 | +| ------ | -------- | ---- | --------------- | +| name | string | 是 | FieldNode的值。 | ### appendChild8+ ### @@ -680,7 +679,7 @@ appendChild(child: FieldNode): boolean | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| child | [FieldNode](#FieldNode) | 是 | 要附加的域节点。 | +| child | [FieldNode](#fieldnode8) | 是 | 要附加的域节点。 | **返回值**： @@ -2985,7 +2984,7 @@ get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | numb ### get -get(key: string): Promise<Uint8Array | string | boolean | number> +get(key: string): Promise<Uint8Array | string | boolean | number> 获取指定键的值，并通过Promise方式返回，此方法为异步方法。 @@ -3252,7 +3251,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>) | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | keyPrefix |string | 是 |表示要匹配的键前缀。 | -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)> | 是 |表示要匹配的键前缀。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)> | 是 |回调函数。 | **示例** @@ -5075,7 +5074,7 @@ sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void ### on8+ ### -on(event: 'syncComplete', syncCallback: Callback<Arrary<[string, number]>>): void +on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void 订阅同步完成事件回调通知，该方法为同步方法。 @@ -5086,9 +5085,10 @@ on(event: 'syncComplete', syncCallback: Callback<Arrary<[string, number]&g | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | event |'syncComplete' | 是 |同步完成时触发的事件名。 | -| syncCallback |Callback7+ | number | 是 | 否 | 单个PasteData中所能包含的Record的数量上限。 | +| MAX_RECORD_NUM7+ | number | 是 | 否 | 单个PasteData中所能包含的Record的数量上限。 | | MIMETYPE_TEXT_HTML7+ | string | 是 | 否 | HTML text文本的MIME类型定义。 | | MIMETYPE_TEXT_WANT7+ | string | 是 | 否 | Want的MIME类型定义。 | | MIMETYPE_TEXT_PLAIN7+ | string | 是 | 否 | Plain text文本的MIME类型定义。 | @@ -35,14 +35,14 @@ createPlainTextData(text:string): PasteData **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | text | string | 是 | 纯文本数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| text | string | 是 | 纯文本数据。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | **示例** @@ -60,14 +60,14 @@ createHtmlData(htmlText:string): PasteData **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | htmlText | string | 是 | 待保存的HTML文本内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| htmlText | string | 是 | 待保存的HTML文本内容。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | **示例** @@ -86,14 +86,14 @@ createWantData(want:Want): PasteData **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#want) | 是 | 待保存的Want内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-featureAbility.md#want) | 是 | 待保存的Want内容。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | **示例** @@ -115,14 +115,14 @@ createUriData(uri:string): PasteData **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | uri | string | 是 | 待保存的URI内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| uri | string | 是 | 待保存的URI内容。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteData](#pastedata) | 包含此内容的剪贴板内容对象。 | **示例** @@ -140,14 +140,14 @@ createPlainTextRecord(text:string): PasteDataRecord **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | text | string | 是 | 纯文本内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| text | string | 是 | 纯文本内容。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteDataRecord](#pastedatarecord7) | 一条新建的纯文本内容条目。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteDataRecord](#pastedatarecord7) | 一条新建的纯文本内容条目。 | **示例** @@ -165,14 +165,14 @@ createHtmlTextRecord(htmlText:string): PasteDataRecord **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | htmlText | string | 是 | 文本内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| htmlText | string | 是 | HTML内容。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteDataRecord](#pastedatarecord7) | 一条新建的HTML内容条目。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteDataRecord](#pastedatarecord7) | 一条新建的HTML内容条目。 | **示例** @@ -191,14 +191,14 @@ createWantRecord(want:Want): PasteDataRecord **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#want) | 是 | Want类型数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-featureAbility.md#want) | 是 | Want类型数据。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteDataRecord](#pastedatarecord7) | 一条新建的Want内容条目 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteDataRecord](#pastedatarecord7) | 一条新建的Want内容条目 | **示例** @@ -220,14 +220,14 @@ createUriRecord(uri:string): PasteDataRecord **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | uri | string | 是 | URI内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| uri | string | 是 | URI内容。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteDataRecord](#pastedatarecord7) | 一条新建的URI内容条目。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteDataRecord](#pastedatarecord7) | 一条新建的URI内容条目。 | **示例** @@ -242,13 +242,13 @@ createUriRecord(uri:string): PasteDataRecord **系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。 - | 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| additions | {[key: string]: object} | 是 | 是 | 设置的其他附加属性数据。 | -| mimeTypes | Array<string> | 是 | 否 | 剪贴板内容条目的数据类型, 非重复的类型列表。 | -| tag | string | 是 | 是 | 用户自定义标签。 | -| timestamp | number | 是 | 否 | 剪贴板数据的写入时间戳（毫秒）。 | -| localOnly | boolean | 是 | 是 | 配置剪贴板内容的“仅在本地”标志位。
- 默认情况为true。
- 配置为true时，表示内容仅在本地，不会在设备之间传递。
- 配置为false时，表示内容将在设备间传递。 | +| additions | {[key: string]: object} | 是 | 是 | 设置的其他附加属性数据。 | +| mimeTypes | Array<string> | 是 | 否 | 剪贴板内容条目的数据类型, 非重复的类型列表。 | +| tag | string | 是 | 是 | 用户自定义标签。 | +| timestamp | number | 是 | 否 | 剪贴板数据的写入时间戳（毫秒）。 | +| localOnly | boolean | 是 | 是 | 配置剪贴板内容的“仅在本地”标志位。
- 默认情况为true。
- 配置为true时，表示内容仅在本地，不会在设备之间传递。
- 配置为false时，表示内容将在设备间传递。 | ## PasteDataRecord7+ @@ -278,9 +278,9 @@ convertToText(): Promise<string> **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 异步回调函数，调用成功则返回强制转换的文本内容，调用失败则返回error信息。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 异步回调函数，调用成功则返回强制转换的文本内容，调用失败则返回error信息。 | **示例** @@ -303,9 +303,9 @@ convertToText(callback: AsyncCallback<string>): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<string> | 是 | 回调函数，调用成功则返回强制转换的文本内容，调用失败则返回error信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<string> | 是 | 回调函数，调用成功则返回强制转换的文本内容，调用失败则返回error信息。 | **示例** @@ -340,9 +340,9 @@ getPrimaryText(): string **返回值** - | 类型 | 说明 | - | -------- | -------- | - | string | 纯文本内容。 | +| 类型 | 说明 | +| -------- | -------- | +| string | 纯文本内容。 | **示例** @@ -361,9 +361,9 @@ getPrimaryHtml(): string **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | string | HTML文本数据。 | +| 类型 | 说明 | +| -------- | -------- | +| string | HTML文本数据。 | **示例** @@ -383,9 +383,9 @@ getPrimaryWant(): Want **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [Want](js-apis-featureAbility.md#want) | Want对象内容。 | +| 类型 | 说明 | +| -------- | -------- | +| [Want](js-apis-featureAbility.md#want) | Want对象内容。 | **示例** @@ -408,9 +408,9 @@ getPrimaryUri(): string **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | string | URI文本内容。 | +| 类型 | 说明 | +| -------- | -------- | +| string | URI文本内容。 | **示例** @@ -431,9 +431,9 @@ addTextRecord(text: string): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | text | string | 是 | 纯文本内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| text | string | 是 | 纯文本内容。 | **示例** @@ -454,9 +454,9 @@ addHtmlRecord(htmlText: string): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | htmlText | string | 是 | HTML格式的文本内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| htmlText | string | 是 | HTML格式的文本内容。 | **示例** @@ -478,9 +478,9 @@ addWantRecord(want: Want): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#want) | 是 | Want对象内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-featureAbility.md#want) | 是 | Want对象内容。 | **示例** @@ -505,9 +505,9 @@ addUriRecord(uri: string): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | uri | string | 是 | URI文本内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| uri | string | 是 | URI文本内容。 | **示例** @@ -528,9 +528,9 @@ addRecord(record: PasteDataRecord): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | record | [PasteDataRecord](#pastedatarecord7) | 是 | 待添加的条目。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| record | [PasteDataRecord](#pastedatarecord7) | 是 | 待添加的条目。 | **示例** @@ -553,9 +553,9 @@ getMimeTypes(): Array<string> **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | Array<string> | 非重复的类型列表。 | +| 类型 | 说明 | +| -------- | -------- | +| Array<string> | 非重复的类型列表。 | **示例** @@ -574,9 +574,9 @@ getPrimaryMimeType(): string **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | string | 首个条目的数据类型。 | +| 类型 | 说明 | +| -------- | -------- | +| string | 首个条目的数据类型。 | **示例** @@ -595,9 +595,9 @@ getProperty(): PasteDataProperty **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteDataProperty](#pastedataproperty7) | 属性描述对象。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteDataProperty](#pastedataproperty7) | 属性描述对象。 | **示例** @@ -616,14 +616,14 @@ getRecordAt(index: number): PasteDataRecord **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | index | number | 是 | 指定条目的下标。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| index | number | 是 | 指定条目的下标。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [PasteDataRecord](#pastedatarecord7) | 指定下标的条目。 | +| 类型 | 说明 | +| -------- | -------- | +| [PasteDataRecord](#pastedatarecord7) | 指定下标的条目。 | **示例** @@ -642,9 +642,9 @@ getRecordCount(): number **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | number | 条目的个数。 | +| 类型 | 说明 | +| -------- | -------- | +| number | 条目的个数。 | **示例** @@ -663,9 +663,9 @@ getTag(): string **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | string | 获取用户自定义的标签内容，如果没有设置用户自定义的标签内容将返回空。 | +| 类型 | 说明 | +| -------- | -------- | +| string | 获取用户自定义的标签内容，如果没有设置用户自定义的标签内容将返回空。 | **示例** @@ -684,14 +684,14 @@ hasMimeType(mimeType: string): boolean **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | mimeType | string | 是 | 待查询的数据类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| mimeType | string | 是 | 待查询的数据类型。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | boolean | 有指定的数据类型返回true，否则返回false。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 有指定的数据类型返回true，否则返回false。 | **示例** @@ -710,14 +710,14 @@ removeRecordAt(index: number): boolean **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | index | number | 是 | 指定的下标。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| index | number | 是 | 指定的下标。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | boolean | 成功移除返回true，失败返回false。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 成功移除返回true，失败返回false。 | **示例** @@ -736,15 +736,15 @@ replaceRecordAt(index: number, record: PasteDataRecord): boolean **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | index | number | 是 | 指定的下标。 | - | record | [PasteDataRecord](#pastedatarecord7) | 是 | 替换后的条目。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| index | number | 是 | 指定的下标。 | +| record | [PasteDataRecord](#pastedatarecord7) | 是 | 替换后的条目。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | boolean | 成功替换返回true，失败返回false。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 成功替换返回true，失败返回false。 | **示例** @@ -764,9 +764,9 @@ getSystemPasteboard(): SystemPasteboard **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | [SystemPasteboard](#systempasteboard) | 系统剪切板对象。 | +| 类型 | 说明 | +| -------- | -------- | +| [SystemPasteboard](#systempasteboard) | 系统剪切板对象。 | **示例** @@ -786,17 +786,17 @@ var systemPasteboard = pasteboard.getSystemPasteboard(); ### setPasteData -setPasteData(pasteData:PasteData, callback:AsyncCallback<void>): void +setPasteData(data:PasteData, callback:AsyncCallback<void>): void 将数据写入系统剪切板，并使用callback方式返回结果。 **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | pasteData | [PasteData](#pastedata) | 是 | PasteData对象。 | - | callback | AsyncCallback<void> | 是 | 回调函数，表示是否成功将数据写入系统剪切板。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| data | [PasteData](#pastedata) | 是 | PasteData对象。 | +| callback | AsyncCallback<void> | 是 | 回调函数，表示是否成功将数据写入系统剪切板。 | **示例** @@ -815,21 +815,21 @@ setPasteData(pasteData:PasteData, callback:AsyncCallback<void>): void ### setPasteData -setPasteData(pasteData:PasteData): Promise<void> +setPasteData(data:PasteData): Promise<void> 将数据写入系统剪切板，并使用Promise异步方式返回结果。 **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 说明 | - | -------- | -------- | -------- | - | pasteData | [PasteData](#pastedata) | PasteData对象。 | +| 参数名 | 类型 | 说明 | +| -------- | -------- | -------- | +| data | [PasteData](#pastedata) | PasteData对象。 | **返回值** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 异步回调函数，表示是否成功将数据写入系统剪切板。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 异步回调函数，表示是否成功将数据写入系统剪切板。 | **示例** @@ -853,9 +853,9 @@ getPasteData( callback:AsyncCallback<PasteData>): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[PasteData](#pastedata)> | 是 | 回调函数，返回系统剪切板数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<[PasteData](#pastedata)> | 是 | 回调函数，返回系统剪切板数据。 | **示例** @@ -880,9 +880,9 @@ getPasteData(): Promise<PasteData> **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | Promise<[PasteData](#pastedata)> | 异步回调函数，调返回系统剪切板数据。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<[PasteData](#pastedata)> | 异步回调函数，调返回系统剪切板数据。 | **示例** @@ -905,10 +905,10 @@ on(type: 'update', callback: () =>void ): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 | - | callback | function | 是 | 剪贴板中内容变化时触发的用户程序的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 | +| callback | function | 是 | 剪贴板中内容变化时触发的用户程序的回调。 | **示例** @@ -923,17 +923,17 @@ on(type: 'update', callback: () =>void ): void ### off('update')7+ -off(type: 'update', callback？: () =>void ): void +off(type: 'update', callback?: () =>void ): void 取消订阅系统剪贴板内容变化事件。 **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 | - | callback | function | 否 | 剪贴板中内容变化时触发的用户程序的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 取值为'update'，表示系统剪贴板内容变化事件。 | +| callback | function | 否 | 剪贴板中内容变化时触发的用户程序的回调。 | **示例** @@ -951,9 +951,9 @@ hasPasteData(callback: AsyncCallback<boolean>): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | 返回为true表示系统剪切板中有内容，返回false表示系统剪切板中没有内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<boolean> | 是 | 返回为true表示系统剪切板中有内容，返回false表示系统剪切板中没有内容。 | **示例** @@ -977,9 +977,9 @@ hasPasteData(): Promise<boolean> **系统能力**: SystemCapability.MiscServices.Pasteboard **返回值** - | 类型 | 说明 | - | -------- | -------- | - | Promise<boolean> | 返回为true表示系统剪切板中有内容，返回false表示系统剪切板中没有内容。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<boolean> | 返回为true表示系统剪切板中有内容，返回false表示系统剪切板中没有内容。 | **示例** @@ -1001,9 +1001,9 @@ clear(callback: AsyncCallback<void>): void **系统能力**: SystemCapability.MiscServices.Pasteboard **参数** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 回调函数，表示是否成功清空系统剪切板内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<void> | 是 | 回调函数，表示是否成功清空系统剪切板内容。 | **示例** @@ -1028,9 +1028,9 @@ clear(): Promise<void> **返回值** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 异步回调函数，表示是否成功清空系统剪切板内容。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<void> | 异步回调函数，表示是否成功清空系统剪切板内容。 | **示例** diff --git a/zh-cn/application-dev/reference/apis/js-apis-request.md b/zh-cn/application-dev/reference/apis/js-apis-request.md index faa80affd73302027b4ca787275ae9dca721631a..8d7ed2246a63c497b40605392468340e45282c30 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -445,7 +445,7 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) => vo ``` request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { if (err) { - console.error('Fail to request download. Cause:' + err); + console.error('Failed to request download. Cause:' + err); return; } downloadTask = data; @@ -485,7 +485,7 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) => ``` request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { if (err) { - console.error('Fail to request download. Cause:' + err); + console.error('Failed to request download. Cause:' + err); return; } downloadTask = data; @@ -497,11 +497,11 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) => ``` -### on('complete')7+ +### on('complete'|'pause'|'remove')7+ -on(type: 'complete', callback:() => void): void +on(type: 'complete'|'pause'|'remove', callback:() => void): void -开启下载任务完成监听，异步方法，使用callback形式返回。 +开启下载任务相关的监听，异步方法，使用callback形式返回。 **需要权限**：ohos.permission.INTERNET @@ -510,15 +510,15 @@ on(type: 'complete', callback:() => void): void - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 订阅的事件类型，取值为'complete'（下载任务完成）。 | - | callback | function | 是 | 下载完成的回调函数。 | + | type | string | 是 | 订阅的事件类型。
- 取值为'complete'，表示下载任务完成；
- 取值为'pause'，表示下载任务暂停；
- 取值为'remove'，表示下载任务移除。 | + | callback | function | 是 | 回调函数。 | - 示例： ``` request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { if (err) { - console.error('Fail to request download. Cause:' + err); + console.error('Failed to request download. Cause:' + err); return; } downloadTask= data; @@ -530,11 +530,11 @@ on(type: 'complete', callback:() => void): void ``` -### off('complete')7+ +### off('complete'|'pause'|'remove')7+ -off(type: 'complete', callback?:() => void): void +off(type: 'complete'|'pause'|'remove', callback?:() => void): void -取消下载任务完成监听，异步方法，使用callback形式返回。 +取消下载任务相关的监听，异步方法，使用callback形式返回。 **需要权限**：ohos.permission.INTERNET @@ -543,15 +543,15 @@ off(type: 'complete', callback?:() => void): void - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 取消订阅的事件类型，取值为'complete'（下载任务完成）。 | - | callback | function | 否 | 取消下载完成的回调函数。 | + | type | string | 是 | 取消订阅的事件类型。
- 取值为'complete'，表示下载任务完成；
- 取值为'pause'，表示下载任务暂停；
- 取值为'remove'，表示下载任务移除。 | + | callback | function | 否 | 回调函数。 | - 示例： ``` request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { if (err) { - console.error('Fail to request download. Cause:' + JSON.stringify(err)); + console.error('Failed to request download. Cause:' + JSON.stringify(err)); return; } downloadTask = data; @@ -590,7 +590,7 @@ on(type: 'fail', callback: (err: number) => void): void ``` request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { if (err) { - console.error('Fail to request download. Cause:' + err); + console.error('Failed to request download. Cause:' + err); return; } downloadTask = data; @@ -629,7 +629,7 @@ off(type: 'fail', callback?: (err: number) => void): void ``` request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { if (err) { - console.error('Fail to request download. Cause:' + err); + console.error('Failed to request download. Cause:' + err); return; } downloadTask = data; @@ -641,137 +641,6 @@ off(type: 'fail', callback?: (err: number) => void): void ``` -### on('pause')7+ - -on(type: 'pause', callback:() => void): void - -开启下载任务暂停监听，异步方法，使用callback形式返回结果。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**: SystemCapability.MiscServices.Download - -- 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 订阅的事件类型，取值为'pause'（下载暂停）。 | - | callback | function | 是 | 下载暂停的回调函数。 | - -- 示例： - - ``` - request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { - if (err) { - console.error('Failed to pause the download task. Cause:' + err); - return; - } - downloadTask = data; - downloadTask.on('pause', function callBack() { - console.info('Download task paused.'); - } - ); - }); - ``` - - -### off('pause')7+ - -off(type: 'pause', callback?:() => void): void - -取消下载任务暂停监听，异步方法，使用callback形式返回结果。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**: SystemCapability.MiscServices.Download - -- 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 取消订阅的事件类型，取值为'pause'（下载暂停）。 | - | callback | function | 否 | 取消下载暂停的回调函数。 | - -- 示例： - - ``` - request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { - if (err) { - console.error('Failed to pause the download task. Cause:' + err); - return; - } - downloadTask = data; - downloadTask.off('pause', function callBack() { - console.info('Download task paused.'); - } - ); - }); - ``` - - -### on('remove')7+ - -on(type: 'remove', callback:() => void): void - -开启下载任务移除监听，异步方法，使用callback形式返回结果。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**: SystemCapability.MiscServices.Download - -- 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 订阅的事件类型，取值为'remove'（下载任务移除）。 | - | callback | function | 是 | 下载移除的回调函数。 | - -- 示例: - - ``` - request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { - if (err) { - console.error('Failed to remove the download task. Cause:' + err); - return; - } - downloadTask = data; - downloadTask.on('remove', function callBack() { - console.info('Download task removed.'); - } - ); - }); - ``` - - -### off('remove')7+ - -off(type: 'remove', callback?:() => void): void - -取消下载任务移除监听，异步方法，使用callback形式返回结果。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**: SystemCapability.MiscServices.Download - -- 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 取消订阅的事件类型，取值为'remove'（下载任务移除）。 | - | callback | function | 否 | 取消下载移除的回调函数。 | - -- 示例： - - ``` - request.download({ url: 'https://xxxx/xxxx.hap' }, (err, data)=> { - if (err) { - console.error('Failed to remove the download task. Cause:' + JSON.stringify(err)); - } - downloadTask = data; - downloadTask.off('remove', function callBack() { - console.info('Download task removed.'); - } - ); - }); - ``` - - ### remove remove(): Promise<boolean> @@ -853,7 +722,7 @@ query(): Promise<DownloadInfo> ``` downloadTask.query().then((downloadInfo) => { - console.info('Download task queried. Data:' + JSON.stringfy(downloadInfo)) + console.info('Download task queried. Data:' + JSON.stringify(downloadInfo)) }) .catch((err) => { console.error('Failed to query the download task. Cause:' + err) }); 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 975ce49cb9e17efb19f024ea0afaeed95936ce51..6202965ca408f1598e08c8a5fc10177ab8e44e93 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-window.md +++ b/zh-cn/application-dev/reference/apis/js-apis-window.md @@ -160,12 +160,14 @@ import window from '@ohos.window'; | DEFAULT | 0 | 默认色域模式。 | | WIDE_GAMUT | 1 | 广色域模式。 | -## window.create7 +## window.create7+ create(id: string, type: WindowType, callback: AsyncCallback<Window>): void 创建子窗口，使用callback方式作为异步方法。 +从API version 8开始，此接口废弃，推荐使用[window.create8+](#windowcreate8)接口。 + **系统能力**：SystemCapability.WindowManager.WindowManager.Core - 参数 @@ -191,12 +193,14 @@ create(id: string, type: WindowType, callback: AsyncCallback<Window>): voi }); ``` -## window.create7 +## window.create7+ create(id: string, type: WindowType): Promise<Window> 创建子窗口，使用Promise方式作为异步方法。 +从API version 8开始，此接口废弃，推荐使用[window.create8+](#windowcreate8)接口。 + **系统能力**：SystemCapability.WindowManager.WindowManager.Core - 参数 @@ -523,7 +527,7 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >) ## Window -下列API示例中都需使用[getTopWindow()](#window-gettopwindow)、[create()](#window-create)、[find()](#window-find)等先获取到Window实例，再通过此实例调用对应方法。 +下列API示例中都需使用[getTopWindow()](#window-gettopwindow)、[create()](#windowcreate7)、[find()](#window-find)等先获取到Window实例，再通过此实例调用对应方法。 ### hide7+ diff --git a/zh-cn/application-dev/security/accesstoken-overview.md b/zh-cn/application-dev/security/accesstoken-overview.md index 53e1626d326f644b3d0630c645c69c6efa9d8866..a3f64bb28afda94aa1daf5172b3a1368339c6c67 100644 --- a/zh-cn/application-dev/security/accesstoken-overview.md +++ b/zh-cn/application-dev/security/accesstoken-overview.md @@ -166,7 +166,7 @@ ACL方式的工作流程可以参考[ACL方式使用说明](#ACL方式使用说 如果应用申请的权限中，存在部分权限的权限等级比应用APL等级高，开发者可以选择通过ACL方式来解决这个等级不匹配的问题。 -在上述的[授权流程](# 不同权限类型的授权流程)的基础上，应用需要进行额外的ACL声明步骤。 +在上述的[授权流程](#不同权限类型的授权流程)的基础上，应用需要进行额外的ACL声明步骤。 应用除了需要在config.json文件声明所需申请的权限，还需要在应用的[profile文件中声明](accesstoken-guidelines.md)不满足申请条件的高等级权限，接下来的授权流程不变。 diff --git a/zh-cn/application-dev/security/figures/figure1.png b/zh-cn/application-dev/security/figures/figure1.png index f6c57888cc065ddb5239600ae7f44e6585237804..b09cdea12f110f83e67ab3f497ba15f73108c9bb 100644 Binary files a/zh-cn/application-dev/security/figures/figure1.png and b/zh-cn/application-dev/security/figures/figure1.png differ