diff --git a/zh-cn/application-dev/database/database-datashare-overview.md b/zh-cn/application-dev/database/database-datashare-overview.md index 85cbaf4e73ca3eaff3cead87a983e2d07e634ac1..f3979961e386912bc2c79d842ba8c720f5c607a4 100644 --- a/zh-cn/application-dev/database/database-datashare-overview.md +++ b/zh-cn/application-dev/database/database-datashare-overview.md @@ -14,23 +14,23 @@ DataShare即数据共享模块，用于应用管理其自身数据，也提供 在进行应用的开发前，开发者应了解以下基本概念： -- 数据提供方 +- **数据提供方** 提供数据及实现相关业务的应用程序，也称为生产者或服务端。 -- 数据访问方 +- **数据访问方** 访问数据提供方所提供的数据或业务的应用程序，也称为消费者或客户端。 -- 数据集 +- **数据集** 用户要插入的数据集合，可以是一条或多条数据。数据集以键值对的形式存在，键为字符串类型，值支持数字、字符串、布尔值、无符号整型数组等多种数据类型。 -- 结果集 +- **结果集** 用户查询之后的结果集合，其提供了灵活的数据访问方式，以便用户获取各项数据。 -- 谓词 +- **谓词** 用户访问数据库中的数据所使用的筛选条件，经常被应用在更新数据、删除数据和查询数据中等场景。 diff --git a/zh-cn/application-dev/database/database-distributedobject-guidelines.md b/zh-cn/application-dev/database/database-distributedobject-guidelines.md index cb99e123fd35cdf38b3a95a1d32fe9b136200a2d..c4cf02f6b476a1f09b19d088540f9f574278f1c2 100644 --- a/zh-cn/application-dev/database/database-distributedobject-guidelines.md +++ b/zh-cn/application-dev/database/database-distributedobject-guidelines.md @@ -16,6 +16,7 @@ **表1** 分布式数据对象实例创建接口 + | 包名 | 接口名 | 描述 | | -------- | -------- | -------- | | ohos.data.distributedDataObject| createDistributedObject(source: object): DistributedObject | 创建一个分布式数据对象实例，用于数据操作。
- source：设置distributedObject的属性。
- DistributedObject：返回值是创建好的分布式对象。 | @@ -25,6 +26,7 @@ 创建一个随机的sessionId，可将其设置为一个分布式数据对象的sessionId。 **表2** 分布式数据对象sessionId创建接口 + | 包名 | 接口名 | 描述 | | -------- | -------- | -------- | | ohos.data.distributedDataObject| genSessionId(): string | 创建一个sessionId，可作为分布式数据对象的sessionId。 | @@ -34,6 +36,7 @@ 设置分布式数据对象的sessionId，sessionId是一次（多设备）协同的唯一标识，同步的多个数据对象需要关联同一个sessionId。 **表3** 分布式数据对象sessionId设置接口 + | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | | DistributedDataObject | setSessionId(sessionId?: string): boolean | 为分布式数据对象设置sessionId。
 sessionId：分布式对象在可信组网中的标识ID。如果要退出分布式组网，设置为""或不设置均可。 | @@ -54,6 +57,7 @@ 订阅数据对象上下线需要指定Callback作为回调方法，订阅的数据对象上线/下线后，对端的数据对象会收到Callback回调。 **表5** 分布式数据对象数据上下线订阅接口 + | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | | DistributedDataObject| on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }>): void | 订阅数据对象上下线。 | @@ -72,6 +76,7 @@ - 成功恢复数据之后。 **表6** 分布式数据对象保存和撤回保存接口 + | 类名 | 接口名 | 描述 | | -------- | -------- | -------- | | DistributedDataObject | save(deviceId: string): Promise<SaveSuccessResponse> | 保存数据对象。 | @@ -267,6 +272,7 @@ ```js local_object.setSessionId(""); ``` + ## 相关实例 针对分布式数据对象，有以下相关实例可供参考： diff --git a/zh-cn/application-dev/database/database-mdds-overview.md b/zh-cn/application-dev/database/database-mdds-overview.md index 680ae41c53ff661ee05970d52e5acd0cbd152842..b7369437c2336574c45e5f9ef7fb7c7c9d8467b9 100644 --- a/zh-cn/application-dev/database/database-mdds-overview.md +++ b/zh-cn/application-dev/database/database-mdds-overview.md @@ -9,48 +9,52 @@ ## 基本概念 -- **KV数据模型** - “KV数据模型”是“Key-Value数据模型”的简称，“Key-Value”即“键-值”；其数据以键值对的形式进行组织、索引和存储。 +### KV数据模型 - KV数据模型适合不涉及过多数据关系和业务关系的业务数据存储，比SQL数据库存储拥有更好的读写性能，同时因其在分布式场景中降低了解决数据库版本兼容问题的复杂度，和数据同步过程中冲突解决的复杂度而被广泛使用。分布式数据库也是基于KV数据模型，对外提供KV类型的访问接口。 +“KV数据模型”是“Key-Value数据模型”的简称，“Key-Value”即“键-值”；其数据以键值对的形式进行组织、索引和存储。 -- **分布式数据库事务性** - 分布式数据库事务支持本地事务（和传统数据库的事务概念一致）和同步事务。同步事务是指在设备之间同步数据时，以本地事务为单位进行同步，一次本地事务的修改要么都同步成功，要么都同步失败。 +KV数据模型适合不涉及过多数据关系和业务关系的业务数据存储，比SQL数据库存储拥有更好的读写性能，同时因其在分布式场景中降低了解决数据库版本兼容问题的复杂度，和数据同步过程中冲突解决的复杂度而被广泛使用。分布式数据库也是基于KV数据模型，对外提供KV类型的访问接口。 -- **分布式数据库一致性** - 在分布式场景中一般会涉及多个设备，组网内设备之间看到的数据是否一致称为分布式数据库的一致性。分布式数据库一致性可以分为**强一致性**、**弱一致性**和**最终一致性**。 +### 分布式数据库事务性 - - **强一致性**：是指某一设备成功增、删、改数据后，组网内设备对该数据的读取操作都将得到更新后的值。 - - **弱一致性**：是指某一设备成功增、删、改数据后，组网内设备可能读取到本次更新数据，也可能读取不到，不能保证在多长时间后每个设备的数据一定是一致的。 - - **最终一致性**：是指某一设备成功增、删、改数据后，组网内设备可能读取不到本次更新数据，但在某个时间窗口之后组网内设备的数据能够达到一致状态。 +分布式数据库事务支持本地事务（和传统数据库的事务概念一致）和同步事务。同步事务是指在设备之间同步数据时，以本地事务为单位进行同步，一次本地事务的修改要么都同步成功，要么都同步失败。 - 强一致性对分布式数据的管理要求非常高，在服务器的分布式场景可能会遇到。因为移动终端设备的不常在线、以及无中心的特性，分布式数据服务不支持强一致性，只支持最终一致性。 +### 分布式数据库一致性 -- **分布式数据库同步** - 底层通信组件完成设备发现和认证，会通知上层应用程序（包括分布式数据服务）设备上线。收到设备上线的消息后分布式数据服务可以在两个设备之间建立加密的数据传输通道，利用该通道在两个设备之间进行数据同步。 +在分布式场景中一般会涉及多个设备，组网内设备之间看到的数据是否一致称为分布式数据库的一致性。分布式数据库一致性可以分为**强一致性**、**弱一致性**和**最终一致性**。 - 分布式数据服务提供了两种同步方式：**手动同步**和**自动同步**。 +- **强一致性**：是指某一设备成功增、删、改数据后，组网内设备对该数据的读取操作都将得到更新后的值。 +- **弱一致性**：是指某一设备成功增、删、改数据后，组网内设备可能读取到本次更新数据，也可能读取不到，不能保证在多长时间后每个设备的数据一定是一致的。 +- **最终一致性**：是指某一设备成功增、删、改数据后，组网内设备可能读取不到本次更新数据，但在某个时间窗口之后组网内设备的数据能够达到一致状态。 - - **手动同步**：由应用程序调用sync接口来触发，需要指定同步的设备列表和同步模式。同步模式分为PULL_ONLY（将远端数据拉到本端）、PUSH_ONLY（将本端数据推送到远端）和PUSH_PULL（将本端数据推送到远端同时也将远端数据拉取到本端）。内部接口支持按条件过滤同步，将符合条件的数据同步到远端。 - - **自动同步**：包括全量同步和按条件订阅同步。全量同步由分布式数据库自动将本端数据推送到远端，同时也将远端数据拉取到本端来完成数据同步，同步时机包括设备上线、应用程序更新数据等，应用不需要主动调用sync接口；内部接口支持按条件订阅同步，将远端符合订阅条件的数据自动同步到本端。 +强一致性对分布式数据的管理要求非常高，在服务器的分布式场景可能会遇到。因为移动终端设备的不常在线、以及无中心的特性，分布式数据服务不支持强一致性，只支持最终一致性。 -- **单版本分布式数据库** +### 分布式数据库同步 - 单版本分布式数据库是指数据在本地保存是以单个KV条目为单位的方式保存，对每个Key最多只保存一个条目项，当数据在本地被用户修改时，不管它是否已经被同步出去，均直接在这个条目上进行修改。同步也以此为基础，按照它在本地被写入或更改的顺序将当前最新一次修改逐条同步至远端设备。 +底层通信组件完成设备发现和认证，会通知上层应用程序（包括分布式数据服务）设备上线。收到设备上线的消息后分布式数据服务可以在两个设备之间建立加密的数据传输通道，利用该通道在两个设备之间进行数据同步。 -- **设备协同分布式数据库** +分布式数据服务提供了两种同步方式：**手动同步**和**自动同步**。 - 设备协同分布式数据库建立在单版本分布式数据库之上，对应用程序存入的KV数据中的Key前面拼接了本设备的DeviceID标识符，这样能保证每个设备产生的数据严格隔离，底层按照设备的维度管理这些数据，设备协同分布式数据库支持以设备的维度查询分布式数据，但是不支持修改远端设备同步过来的数据。 +- **手动同步**：由应用程序调用sync接口来触发，需要指定同步的设备列表和同步模式。同步模式分为PULL_ONLY（将远端数据拉到本端）、PUSH_ONLY（将本端数据推送到远端）和PUSH_PULL（将本端数据推送到远端同时也将远端数据拉取到本端）。内部接口支持按条件过滤同步，将符合条件的数据同步到远端。 +- **自动同步**：包括全量同步和按条件订阅同步。全量同步由分布式数据库自动将本端数据推送到远端，同时也将远端数据拉取到本端来完成数据同步，同步时机包括设备上线、应用程序更新数据等，应用不需要主动调用sync接口；内部接口支持按条件订阅同步，将远端符合订阅条件的数据自动同步到本端。 -- **分布式数据库冲突解决策略** +### 单版本分布式数据库 - 分布式数据库多设备提交冲突场景，在给提交冲突做合并的过程中，如果多个设备同时修改了同一数据，则称这种场景为数据冲突。数据冲突采用默认冲突解决策略（Last-write-wins），基于提交时间戳，取时间戳较大的提交数据，当前不支持定制冲突解决策略。 +单版本分布式数据库是指数据在本地保存是以单个KV条目为单位的方式保存，对每个Key最多只保存一个条目项，当数据在本地被用户修改时，不管它是否已经被同步出去，均直接在这个条目上进行修改。同步也以此为基础，按照它在本地被写入或更改的顺序将当前最新一次修改逐条同步至远端设备。 -- **数据库Schema化管理与谓词查询** +### 设备协同分布式数据库 - 单版本数据库支持在创建和打开数据库时指定Schema，数据库根据Schema定义感知KV记录的Value格式，以实现对Value值结构的检查，并基于Value中的字段实现索引建立和谓词查询。 +设备协同分布式数据库建立在单版本分布式数据库之上，对应用程序存入的KV数据中的Key前面拼接了本设备的DeviceID标识符，这样能保证每个设备产生的数据严格隔离，底层按照设备的维度管理这些数据，设备协同分布式数据库支持以设备的维度查询分布式数据，但是不支持修改远端设备同步过来的数据。 -- **分布式数据库备份能力** +### 分布式数据库冲突解决策略 + +分布式数据库多设备提交冲突场景，在给提交冲突做合并的过程中，如果多个设备同时修改了同一数据，则称这种场景为数据冲突。数据冲突采用默认冲突解决策略（Last-write-wins），基于提交时间戳，取时间戳较大的提交数据，当前不支持定制冲突解决策略。 + +### 数据库Schema化管理与谓词查询 + +单版本数据库支持在创建和打开数据库时指定Schema，数据库根据Schema定义感知KV记录的Value格式，以实现对Value值结构的检查，并基于Value中的字段实现索引建立和谓词查询。 + +### 分布式数据库备份能力 提供分布式数据库备份能力，业务通过设置backup属性为true，可以触发分布式数据服务每日备份。当分布式数据库发生损坏，分布式数据服务会删除损坏数据库，并且从备份数据库中恢复上次备份的数据。如果不存在备份数据库，则创建一个新的数据库。同时支持加密数据库的备份能力。 @@ -59,20 +63,15 @@ 分布式数据服务支撑OpenHarmony系统上应用程序数据库数据分布式管理，支持数据在相同帐号的多端设备之间相互同步，为用户在多端设备上提供一致的用户体验，分布式数据服务包含五部分： -- **服务接口** - 分布式数据服务提供专门的数据库创建、数据访问、数据订阅等接口给应用程序调用，接口支持KV数据模型，支持常用的数据类型，同时确保接口的兼容性、易用性和可发布性。 +- **服务接口：** 分布式数据服务提供专门的数据库创建、数据访问、数据订阅等接口给应用程序调用，接口支持KV数据模型，支持常用的数据类型，同时确保接口的兼容性、易用性和可发布性。 -- **服务组件** - 服务组件负责服务内元数据管理、权限管理、加密管理、备份和恢复管理以及多用户管理等、同时负责初始化底层分布式DB的存储组件、同步组件和通信适配层。 +- **服务组件：** 服务组件负责服务内元数据管理、权限管理、加密管理、备份和恢复管理以及多用户管理等、同时负责初始化底层分布式DB的存储组件、同步组件和通信适配层。 -- **存储组件** - 存储组件负责数据的访问、数据的缩减、事务、快照、数据库加密，以及数据合并和冲突解决等特性。 +- **存储组件：** 存储组件负责数据的访问、数据的缩减、事务、快照、数据库加密，以及数据合并和冲突解决等特性。 -- **同步组件** - 同步组件连结了存储组件与通信组件，其目标是保持在线设备间的数据库数据一致性，包括将本地产生的未同步数据同步给其他设备，接收来自其他设备发送过来的数据，并合并到本地设备中。 +- **同步组件：** 同步组件连结了存储组件与通信组件，其目标是保持在线设备间的数据库数据一致性，包括将本地产生的未同步数据同步给其他设备，接收来自其他设备发送过来的数据，并合并到本地设备中。 -- **通信适配层** - 通信适配层负责调用底层公共通信层的接口完成通信管道的创建、连接，接收设备上下线消息，维护已连接和断开设备列表的元数据，同时将设备上下线信息发送给上层同步组件，同步组件维护连接的设备列表，同步数据时根据该列表，调用通信适配层的接口将数据封装并发送给连接的设备。 +- **通信适配层：** 通信适配层负责调用底层公共通信层的接口完成通信管道的创建、连接，接收设备上下线消息，维护已连接和断开设备列表的元数据，同时将设备上下线信息发送给上层同步组件，同步组件维护连接的设备列表，同步数据时根据该列表，调用通信适配层的接口将数据封装并发送给连接的设备。 应用程序通过调用分布式数据服务接口实现分布式数据库创建、访问、订阅功能，服务接口通过操作服务组件提供的能力，将数据存储至存储组件，存储组件调用同步组件实现将数据同步，同步组件使用通信适配层将数据同步至远端设备，远端设备通过同步组件接收数据，并更新至本端存储组件，通过服务接口提供给应用程序使用。 @@ -88,6 +87,7 @@ - 分布式数据服务的数据模型仅支持KV数据模型，不支持外键、触发器等关系型数据库中的功能。 - 分布式数据服务支持的KV数据模型规格： + - 设备协同数据库，针对每条记录，Key的长度≤896 Byte，Value的长度<4 MB。 - 单版本数据库，针对每条记录，Key的长度≤1 KB，Value的度<4 MB。 - 每个应用程序最多支持同时打开16个分布式数据库。 diff --git a/zh-cn/application-dev/database/database-preference-guidelines.md b/zh-cn/application-dev/database/database-preference-guidelines.md index 247076af7599e7343a82bb70380bb2850b519860..9b23a2b9712f4ff200018ec7f27948a16365d95a 100644 --- a/zh-cn/application-dev/database/database-preference-guidelines.md +++ b/zh-cn/application-dev/database/database-preference-guidelines.md @@ -171,7 +171,9 @@ console.info("Failed to delete. Cause: " + err); }) ``` + ## 相关实例 + 针对首选项开发，有以下相关实例可供参考： - [`Preferences`：首选项（eTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/data/Preferences) \ No newline at end of file diff --git a/zh-cn/application-dev/database/database-relational-guidelines.md b/zh-cn/application-dev/database/database-relational-guidelines.md index e0fe6e11d44020248081d63954be433bd2338489..7ad8f8cc654456ed69a8ee90aa6551db1f7ced72 100644 --- a/zh-cn/application-dev/database/database-relational-guidelines.md +++ b/zh-cn/application-dev/database/database-relational-guidelines.md @@ -30,6 +30,7 @@ **表2** 数据库插入API + | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | RdbStore | insert(table: string, values: ValuesBucket): Promise<number> | 向目标表中插入一行数据，使用Promise异步回调。
如果操作成功，返回行ID；否则返回-1。
-table：指定的目标表名。
-values：表示要插入到表中的数据行。 | @@ -40,6 +41,7 @@ **表3** 数据库更新API + | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | RdbStore | update(values: ValuesBucket, predicates: RdbPredicates): Promise<number> | 根据RdbPredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。
返回受影响的行数。
-values：以ValuesBucket存储的要更新的数据。
-predicates：表示RdbPredicates的实例对象指定的更新条件。 | @@ -50,6 +52,7 @@ **表4** 数据库删除API + | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | RdbStore | delete(predicates: RdbPredicates): Promise<number> | 根据RdbPredicates的指定实例对象从数据库中删除数据，使用Promise异步回调。
返回受影响的行数。
-predicates：RdbPredicates的实例对象指定的删除条件。 | @@ -63,6 +66,7 @@ **表5** 数据库查询API + | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | RdbStore | query(predicates: RdbPredicates, columns?: Array<string>): Promise<ResultSet> | 根据指定条件查询数据库中的数据，使用Promise异步回调。
-predicates：表示RdbPredicates的实例对象指定的查询条件。
-columns：表示要查询的列。如果值为空，则查询应用于所有列。 | diff --git a/zh-cn/application-dev/device/usb-guidelines.md b/zh-cn/application-dev/device/usb-guidelines.md index 084f88660a604397890684a12a29f5b0006105ed..92559d71cffbe3310e7736925a1dc5c88176bf07 100644 --- a/zh-cn/application-dev/device/usb-guidelines.md +++ b/zh-cn/application-dev/device/usb-guidelines.md @@ -38,6 +38,7 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例 1. 获取设备列表。 + ```js // 导入usb接口api包。 import usb from '@ohos.usb'; @@ -97,6 +98,7 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例 ``` 2. 获取设备操作权限。 + ```js var deviceName = deviceList[0].name; // 申请操作指定的device的操作权限。 @@ -108,6 +110,7 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例 ``` 3. 打开Device设备。 + ```js // 打开设备，获取数据传输通道。 var pipe = usb.connectDevice(deviceList[0]); @@ -119,6 +122,7 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例 ``` 4. 数据传输。 + ```js /* 读取数据，在device信息中选取对应数据接收的endpoint来做数据传输 @@ -149,11 +153,14 @@ USB设备可作为Host设备连接Device设备进行数据传输。开发示例 ``` 5. 释放接口，关闭设备。 + ```js usb.releaseInterface(pipe, interface1); usb.closePipe(pipe); ``` + ## 相关实例 + 针对USB管理开发，有以下相关实例可供参考： - [`USBManager`：USB管理（eTS）（API8）](https://gitee.com/openharmony/applications_app_samples/tree/master/device/USBManager) \ No newline at end of file diff --git a/zh-cn/application-dev/quick-start/start-with-ets-fa.md b/zh-cn/application-dev/quick-start/start-with-ets-fa.md index 5e38a772575a4630be0cfd70309421550ba94ee5..cedecd088917475c8f1ecffb3dcc242be303c446 100644 --- a/zh-cn/application-dev/quick-start/start-with-ets-fa.md +++ b/zh-cn/application-dev/quick-start/start-with-ets-fa.md @@ -50,7 +50,6 @@ 1. 使用文本组件。 工程同步完成后，在“**Project**”窗口，点击“**entry > src > main > ets > MainAbility > pages**”，打开“**index.ets**”文件，可以看到页面由Text组件组成。“**index.ets**”文件的示例如下： - ```ts // index.ets @@ -76,7 +75,6 @@ 2. 添加按钮。 在默认页面基础上，我们添加一个Button组件，作为按钮响应用户点击，从而实现跳转到另一个页面。“**index.ets**”文件的示例如下： - ```ts // index.ets @@ -147,7 +145,6 @@ 2. 添加文本及按钮。 参照第一个页面，在第二个页面添加Text组件、Button组件等，并设置其样式。“**second.ets**”文件的示例如下： - ```ts // second.ets @@ -190,7 +187,6 @@ 1. 第一个页面跳转到第二个页面。 在第一个页面中，跳转按钮绑定onClick事件，点击按钮时跳转到第二页。“**index.ets**”文件的示例如下： - ```ts // index.ets @@ -235,7 +231,6 @@ 2. 第二个页面返回到第一个页面。 在第二个页面中，返回按钮绑定onClick事件，点击按钮时返回到第一页。“**second.ets**”文件的示例如下： - ```ts // second.ets diff --git a/zh-cn/application-dev/quick-start/start-with-ets-stage.md b/zh-cn/application-dev/quick-start/start-with-ets-stage.md index 5a9bee7d21c9a36f1aca53ad7796fd01e133d863..5fd89f64851006558fd94c46d983ce88365fd951 100644 --- a/zh-cn/application-dev/quick-start/start-with-ets-stage.md +++ b/zh-cn/application-dev/quick-start/start-with-ets-stage.md @@ -55,7 +55,6 @@ 1. 使用文本组件。 工程同步完成后，在“**Project**”窗口，点击“**entry > src > main > ets > MainAbility > pages**”，打开“**index.ets**”文件，可以看到页面由Text组件组成。“**index.ets**”文件的示例如下： - ```ts // index.ets @@ -81,7 +80,6 @@ 2. 添加按钮。 在默认页面基础上，我们添加一个Button组件，作为按钮响应用户点击，从而实现跳转到另一个页面。“**index.ets**”文件的示例如下： - ```ts // index.ets @@ -146,7 +144,6 @@ 2. 添加文本及按钮。 参照第一个页面，在第二个页面添加Text组件、Button组件等，并设置其样式。“**second.ets**”文件的示例如下： - ```ts // second.ets @@ -189,7 +186,6 @@ 1. 第一个页面跳转到第二个页面。 在第一个页面中，跳转按钮绑定onClick事件，点击按钮时跳转到第二页。“**index.ets**”文件的示例如下： - ```ts // index.ets @@ -234,7 +230,6 @@ 2. 第二个页面返回到第一个页面。 在第二个页面中，返回按钮绑定onClick事件，点击按钮时返回到第一页。“**second.ets**”文件的示例如下： - ```ts // second.ets diff --git a/zh-cn/application-dev/quick-start/start-with-js-fa.md b/zh-cn/application-dev/quick-start/start-with-js-fa.md index 6b80c28372ddf440bf09b84a231adb73fbd788d9..6a34e376e912fbc0aaab8b403b99d786124196b8 100644 --- a/zh-cn/application-dev/quick-start/start-with-js-fa.md +++ b/zh-cn/application-dev/quick-start/start-with-js-fa.md @@ -49,7 +49,6 @@ 1. 使用文本组件。 工程同步完成后，在“**Project**”窗口，点击“**entry > src > main > js > MainAbility > pages> index**”，打开“**index.hml**”文件，设置Text组件内容。“**index.hml**”文件的示例如下： - ```html @@ -63,7 +62,6 @@ 2. 添加按钮，并绑定onclick方法。 在默认页面基础上，我们添加一个button类型的input组件，作为按钮响应用户点击，从而实现跳转到另一个页面。“**index.hml**”文件的示例代码如下： - ```html @@ -80,7 +78,6 @@ 3. 设置页面样式。 在“**Project**”窗口，点击“**entry > src > main > js > MainAbility > pages> index**”，打开“**index.css**”文件，可以对页面中文本、按钮设置宽高、字体大小、间距等样式。“**index.css**”文件的示例如下： - ```css /* index.css */ @@ -129,7 +126,6 @@ 2. 添加文本及按钮。 参照第一个页面，在第二个页面添加文本、按钮及点击按钮绑定页面返回等。“**second.hml**”文件的示例如下： - ```html @@ -184,7 +180,6 @@ 1. 第一个页面跳转到第二个页面。 在第一个页面中，跳转按钮绑定onclick方法，点击按钮时跳转到第二页。“**index.js**”示例如下： - ```js // index.js @@ -202,7 +197,6 @@ 2. 第二个页面返回到第一个页面。 在第二个页面中，返回按钮绑定back方法，点击按钮时返回到第一页。“**second.js**”示例如下： - ```js // second.js diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md index 614ef05b0230e6548718ebbed8a9f123363e2fa1..932871b6a378a441a803bac7c7cbb8ac22a54f71 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md @@ -31,6 +31,8 @@ onConnect(want: Want): void **系统能力：** SystemCapability.WindowManager.WindowManager.Core +**参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-Want.md) | 是 | 当前ability的Want类型信息，包括ability名称、bundle名称等。 | @@ -55,6 +57,8 @@ onDisconnect(want: Want): void **系统能力：** SystemCapability.WindowManager.WindowManager.Core +**参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-Want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | @@ -72,7 +76,6 @@ export default class MyWindowExtensionAbility extends WindowExtensionAbility { } ``` - ## WindowExtensionAbility.onWindowReady onWindowReady(window: Window): void @@ -81,6 +84,8 @@ onWindowReady(window: Window): void **系统能力：** SystemCapability.WindowManager.WindowManager.Core +**参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | window | [Window](js-apis-window.md) | 是 | 当前窗口实例。 | 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 c862b091db7c1b8c1061d9f3eea9a212bc30cf02..b988ea442a2488315c2d427e4b495d070304da9f 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 @@ -13,13 +13,10 @@ DataAbility 谓词用于构造关系型数据库的谓词，提供用于实现 import dataAbility from '@ohos.data.dataAbility'; ``` - ## dataAbility.createRdbPredicates - createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates - 从DataAbilityPredicates对象创建RdbPredicates对象。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 @@ -32,93 +29,93 @@ createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): | dataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | 是 | DataAbility谓词。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | rdb.[RdbPredicates](js-apis-data-rdb.md#rdbpredicates) | 返回RdbPredicates对象。 | **示例：** + ```js let dataAbilityPredicates = new dataAbility.DataAbilityPredicates() dataAbilityPredicates.equalTo("NAME", "Rose") let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates) ``` - ## DataAbilityPredicates 提供用于实现不同查询方法的谓词。 - ### equalTo - equalTo(field: string, value: ValueType): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType且值等于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.equalTo("NAME", "lisi") ``` - ### notEqualTo - notEqualTo(field: string, value: ValueType): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.notEqualTo("NAME", "lisi") ``` - ### beginWrap - beginWrap(): DataAbilityPredicates - 向谓词添加左括号。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有左括号的DataAbility谓词。 | **示例：** + ```js dataAbilityPredicates.equalTo("NAME", "lisi") .beginWrap() @@ -128,23 +125,22 @@ beginWrap(): DataAbilityPredicates .endWrap() ``` - ### endWrap - endWrap(): DataAbilityPredicates - 向谓词添加右括号。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有右括号的DataAbility谓词。 | **示例：** + ```js dataAbilityPredicates.equalTo("NAME", "lisi") .beginWrap() @@ -154,251 +150,247 @@ endWrap(): DataAbilityPredicates .endWrap() ``` - ### or - or(): DataAbilityPredicates - 将或条件添加到谓词中。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有或条件的DataAbility谓词。 | **示例：** + ```js dataAbilityPredicates.equalTo("NAME", "Lisa") .or() .equalTo("NAME", "Rose") ``` - ### and - and(): DataAbilityPredicates - 将和条件添加到谓词中。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回带有和条件的DataAbility谓词。 | **示例：** + ```js dataAbilityPredicates.equalTo("NAME", "Lisa") .and() .equalTo("SALARY", 200.5) ``` - ### contains - contains(field: string, value: string): DataAbilityPredicates - 配置谓词以匹配数据类型为string且value包含指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.contains("NAME", "os") ``` - ### beginsWith - beginsWith(field: string, value: string): DataAbilityPredicates - 配置谓词以匹配数据类型为string且值以指定字符串开头的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.beginsWith("NAME", "os") ``` - ### endsWith - endsWith(field: string, value: string): DataAbilityPredicates - 配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ``` dataAbilityPredicates.endsWith("NAME", "se") ``` - ### isNull - isNull(field: string): DataAbilityPredicates - 配置谓词以匹配值为null的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.isNull("NAME") ``` - ### isNotNull - isNotNull(field: string): DataAbilityPredicates - 配置谓词以匹配值不为null的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.isNotNull("NAME") ``` - ### like - like(field: string, value: string): DataAbilityPredicates - 配置谓词以匹配数据类型为string且值类似于指定字符串的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.like("NAME", "%os%") ``` - ### glob - glob(field: string, value: string): DataAbilityPredicates - 配置谓词以匹配数据类型为string的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.glob("NAME", "?h*g") ``` - ### between - between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType且value在指定范围内的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | @@ -406,27 +398,27 @@ between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates | high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.between("AGE", 10, 50) ``` - ### notBetween - notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | @@ -434,244 +426,245 @@ notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicate | high | [ValueType](#valuetype) | 是 | 指示与谓词匹配的最大值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.notBetween("AGE", 10, 50) ``` - ### greaterThan - greaterThan(field: string, value: ValueType): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType且值大于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.greaterThan("AGE", 18) ``` - ### lessThan - lessThan(field: string, value: ValueType): DataAbilityPredicates - 配置谓词以匹配数据类型为valueType且value小于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.lessThan("AGE", 20) ``` - ### greaterThanOrEqualTo - greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.greaterThanOrEqualTo("AGE", 18) ``` - ### lessThanOrEqualTo - lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.lessThanOrEqualTo("AGE", 20) ``` - ### orderByAsc - orderByAsc(field: string): DataAbilityPredicates - 配置谓词以匹配其值按升序排序的列。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.orderByAsc("NAME") ``` - ### orderByDesc - orderByDesc(field: string): DataAbilityPredicates - 配置谓词以匹配其值按降序排序的列。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.orderByDesc("AGE") ``` - ### distinct - distinct(): DataAbilityPredicates - 配置谓词以过滤重复记录并仅保留其中一个。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于过滤重复记录的谓词。 | **示例：** + ```js dataAbilityPredicates.equalTo("NAME", "Rose").distinct() ``` - ### limitAs - limitAs(value: number): DataAbilityPredicates - 设置最大数据记录数的谓词。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | value | number | 是 | 最大数据记录数。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回可用于设置最大数据记录数的谓词。 | **示例：** + ```js dataAbilityPredicates.equalTo("NAME", "Rose").limitAs(3) ``` - ### offsetAs - offsetAs(rowOffset: number): DataAbilityPredicates - 配置谓词以指定返回结果的起始位置。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定返回结果起始位置的谓词。 | **示例：** + ```js dataAbilityPredicates.equalTo("NAME", "Rose").offsetAs(3) ``` @@ -679,66 +672,66 @@ offsetAs(rowOffset: number): DataAbilityPredicates ### groupBy - groupBy(fields: Array<string>): DataAbilityPredicates - 配置谓词按指定列分组查询结果。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | fields | Array<string> | 是 | 指定分组依赖的列名。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回分组查询列的谓词。 | **示例：** + ```js dataAbilityPredicates.groupBy(["AGE", "NAME"]) ``` ### indexedBy - indexedBy(field: string): DataAbilityPredicates - 配置谓词以指定索引列。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | indexName | string | 是 | 索引列的名称。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定索引列的谓词。 | **示例：** + ```js dataAbilityPredicates.indexedBy("SALARY_INDEX") ``` - ### in - in(field: string, value: Array<ValueType>): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | @@ -746,39 +739,40 @@ in(field: string, value: Array<ValueType>): DataAbilityPredicates **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.in("AGE", [18, 20]) ``` - ### notIn - notIn(field: string, value: Array<ValueType>): DataAbilityPredicates - 配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.DataShare.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType类型数组形式指定的要匹配的值。 | - **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js dataAbilityPredicates.notIn("NAME", ["Lisa", "Rose"]) ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md b/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md index c58b2ad12209b1fabfd32d7c7e83fa38eec097a3..760ac92ace5f443668ea9678a068b4fc74c89edc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md @@ -23,16 +23,19 @@ createDistributedObject(source: object): DistributedObject **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | source | object | 是 | 设置distributedObject的属性。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | [DistributedObject](#distributedobject) | 创建完成的分布式对象。 | **示例：** + ```js import distributedObject from '@ohos.data.distributedDataObject'; // 创建对象，对象包含4个属性类型，string,number,boolean和Object @@ -49,11 +52,13 @@ genSessionId(): string **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **返回值：** + | 类型 | 说明 | | -------- | -------- | | string | 随机创建的sessionId。 | **示例：** + ```js import distributedObject from '@ohos.data.distributedDataObject'; var sessionId = distributedObject.genSessionId(); @@ -118,7 +123,6 @@ g_object.setSessionId(distributedObject.genSessionId()); g_object.setSessionId(""); ``` - ### on('change') on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<string> }>): void @@ -128,12 +132,14 @@ on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<stri **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'change'，表示数据变更。 | | callback | Callback<{ sessionId: string, fields: Array<string> }> | 是 | 变更回调对象实例。
sessionId：标识变更对象的sessionId；
fields：标识对象变更的属性名。 | **示例：** + ```js import distributedObject from '@ohos.data.distributedDataObject'; var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); @@ -157,6 +163,7 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<st **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'change'，表示数据变更。 | @@ -164,6 +171,7 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<st **示例：** + ```js import distributedObject from '@ohos.data.distributedDataObject'; var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); @@ -182,12 +190,14 @@ on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, st **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'status'，表示对象上下线。 | | callback | Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }> | 是 | 监听上下线回调实例。
sessionId：标识变更对象的sessionId；
networkId：标识对象设备，即deviceId；
status：标识对象为'online'(上线)或'offline'(下线)的状态。 | **示例：** + ```js import distributedObject from '@ohos.data.distributedDataObject'; globalThis.statusCallback = (sessionId, networkId, status) => { @@ -201,12 +211,12 @@ g_object.on("status", globalThis.statusCallback); off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, status: 'online' | 'offline' }>): void - 当不再进行对象上下线监听时，使用此接口删除对象的上下线监听。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'status'，表示对象上下线。 | @@ -214,6 +224,7 @@ off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, s **示例：** + ```js import distributedObject from '@ohos.data.distributedDataObject'; var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); @@ -243,12 +254,14 @@ save(deviceId: string, callback: AsyncCallback<SaveSuccessResponse>): void **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 保存数据的deviceId，当deviceId为"local"，代表存储在本地设备。 | | callback | AsyncCallback<[SaveSuccessResponse](#savesuccessresponse9)> | 是 | 回调函数。返回SaveSuccessResponse，包含sessionId、version、deviceId等信息。 | **示例：** + ```js import distributedObject from '@ohos.data.distributedDataObject'; var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false}); @@ -279,6 +292,7 @@ save(deviceId: string): Promise<SaveSuccessResponse> **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 保存数据的设备号，当deviceId默认为"local"，标识需要保存对象的设备。 | @@ -317,6 +331,7 @@ revokeSave(callback: AsyncCallback<RevokeSaveSuccessResponse>): void **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[RevokeSaveSuccessResponse](#revokesavesuccessresponse9)> | 否 | 回调函数。返回RevokeSaveSuccessResponse，包含sessionId。 | 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 8917830a7dae102e715eea0dca5d5069c060df07..7f8fdfcd7d2a5f880713a6696016d65935d5d581 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 @@ -148,6 +148,7 @@ deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void&g **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | context | Context | 是 | 应用的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。| @@ -204,12 +205,14 @@ deleteRdbStore(context: Context, name: string): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | context | Context | 是 | 应用的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。| | name | string | 是 | 数据库名称。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 指定Promise回调函数。 | @@ -268,11 +271,13 @@ constructor(name: string) **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | name | string | 是 | 数据库表名。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") ``` @@ -287,16 +292,19 @@ inDevices(devices: Array<string>): RdbPredicates **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | devices | Array<string> | 是 | 指定的组网内的远程设备ID。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.inDevices(['12345678abcde']) @@ -312,11 +320,13 @@ inAllDevices(): RdbPredicates **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.inAllDevices() @@ -332,17 +342,20 @@ equalTo(field: string, value: ValueType): RdbPredicates **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") @@ -359,17 +372,20 @@ notEqualTo(field: string, value: ValueType): RdbPredicates **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notEqualTo("NAME", "lisi") @@ -386,11 +402,13 @@ beginWrap(): RdbPredicates **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回带有左括号的Rdb谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") @@ -401,22 +419,22 @@ predicates.equalTo("NAME", "lisi") .endWrap() ``` - ### endWrap endWrap(): RdbPredicates - 向谓词添加右括号。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回带有右括号的Rdb谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") @@ -427,22 +445,22 @@ predicates.equalTo("NAME", "lisi") .endWrap() ``` - ### or or(): RdbPredicates - 将或条件添加到谓词中。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回带有或条件的Rdb谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") @@ -450,22 +468,22 @@ predicates.equalTo("NAME", "Lisa") .equalTo("NAME", "Rose") ``` - ### and and(): RdbPredicates - 向谓词添加和条件。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回带有和条件的Rdb谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") @@ -473,7 +491,6 @@ predicates.equalTo("NAME", "Lisa") .equalTo("SALARY", 200.5) ``` - ### contains contains(field: string, value: string): RdbPredicates @@ -483,193 +500,200 @@ contains(field: string, value: string): RdbPredicates **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.contains("NAME", "os") ``` - ### beginsWith beginsWith(field: string, value: string): RdbPredicates - 配置谓词以匹配数据字段为string且值以指定字符串开头的字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.beginsWith("NAME", "os") ``` - ### endsWith endsWith(field: string, value: string): RdbPredicates - 配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.endsWith("NAME", "se") ``` - ### isNull isNull(field: string): RdbPredicates - 配置谓词以匹配值为null的字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | -- 示例 +**示例**： ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNull("NAME") ``` - ### isNotNull isNotNull(field: string): RdbPredicates - 配置谓词以匹配值不为null的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNotNull("NAME") ``` - ### like like(field: string, value: string): RdbPredicates - 配置谓词以匹配数据字段为string且值类似于指定字符串的字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.like("NAME", "%os%") ``` - ### glob glob(field: string, value: string): RdbPredicates - 配置RdbPredicates匹配数据字段为string的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | string | 是 | 指示要与谓词匹配的值。
支持通配符，*表示0个、1个或多个数字或字符，?表示1个数字或字符。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.glob("NAME", "?h*g") ``` - ### between between(field: string, low: ValueType, high: ValueType): RdbPredicates - 将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | @@ -677,27 +701,28 @@ between(field: string, low: ValueType, high: ValueType): RdbPredicates | high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.between("AGE", 10, 50) ``` - ### notBetween notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates - 配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | @@ -705,17 +730,18 @@ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates | high | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的最大值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notBetween("AGE", 10, 50) ``` - ### greaterThan greaterThan(field: string, value: ValueType): RdbPredicates @@ -725,259 +751,265 @@ greaterThan(field: string, value: ValueType): RdbPredicates **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThan("AGE", 18) ``` - ### lessThan lessThan(field: string, value: ValueType): RdbPredicates - 配置谓词以匹配数据字段为valueType且value小于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThan("AGE", 20) ``` - ### greaterThanOrEqualTo - greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates - 配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThanOrEqualTo("AGE", 18) ``` - ### lessThanOrEqualTo - lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates - 配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | [ValueType](#valuetype) | 是 | 指示要与谓词匹配的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThanOrEqualTo("AGE", 20) ``` - ### orderByAsc - orderByAsc(field: string): RdbPredicates - 配置谓词以匹配其值按升序排序的列。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByAsc("NAME") ``` - ### orderByDesc - orderByDesc(field: string): RdbPredicates - 配置谓词以匹配其值按降序排序的列。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByDesc("AGE") ``` - ### distinct distinct(): RdbPredicates - 配置谓词以过滤重复记录并仅保留其中一个。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回可用于过滤重复记录的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").distinct() ``` - ### limitAs limitAs(value: number): RdbPredicates - 设置最大数据记录数的谓词。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | value | number | 是 | 最大数据记录数。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回可用于设置最大数据记录数的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").limitAs(3) ``` - ### offsetAs offsetAs(rowOffset: number): RdbPredicates - 配置RdbPredicates以指定返回结果的起始位置。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | rowOffset | number | 是 | 返回结果的起始位置，取值为正整数。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回具有指定返回结果起始位置的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").offsetAs(3) ``` - ### groupBy groupBy(fields: Array<string>): RdbPredicates - 配置RdbPredicates按指定列分组查询结果。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | fields | Array<string> | 是 | 指定分组依赖的列名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回分组查询列的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.groupBy(["AGE", "NAME"]) ``` - ### indexedBy indexedBy(field: string): RdbPredicates @@ -987,86 +1019,87 @@ indexedBy(field: string): RdbPredicates **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 索引列的名称。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回具有指定索引列的RdbPredicates。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.indexedBy("SALARY_INDEX") ``` - ### in in(field: string, value: Array<ValueType>): RdbPredicates - 配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 | - **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.in("AGE", [18, 20]) ``` - ### notIn notIn(field: string, value: Array<ValueType>): RdbPredicates - 将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 数据库表中的列名。 | | value | Array<[ValueType](#valuetype)> | 是 | 以ValueType数组形式指定的要匹配的值。 | - **返回值**： + | 类型 | 说明 | | -------- | -------- | | [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notIn("NAME", ["Lisa", "Rose"]) ``` - ## RdbStore 提供管理关系数据库(RDB)方法的接口。 在使用以下相关接口前，请使用[executeSql](#executesql)接口初始化数据库表结构和相关数据，具体可见[关系型数据库开发指导](../../database/database-relational-guidelines.md)。 - ### insert insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void @@ -1076,6 +1109,7 @@ insert(table: string, values: ValuesBucket, callback: AsyncCallback<number> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | @@ -1083,6 +1117,7 @@ insert(table: string, values: ValuesBucket, callback: AsyncCallback<number> | callback | AsyncCallback<number> | 是 | 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。 | **示例：** + ```js const valueBucket = { "NAME": "Lisa", @@ -1099,7 +1134,6 @@ rdbStore.insert("EMPLOYEE", valueBucket, function (status, rowId) { }) ``` - ### insert insert(table: string, values: ValuesBucket):Promise<number> @@ -1109,17 +1143,20 @@ insert(table: string, values: ValuesBucket):Promise<number> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | | values | [ValuesBucket](#valuesbucket) | 是 | 表示要插入到表中的数据行。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<number> | 指定Promise回调函数。如果操作成功，返回行ID；否则返回-1。 | **示例：** + ```js const valueBucket = { "NAME": "Lisa", @@ -1144,6 +1181,7 @@ batchInsert(table: string, values: Array<ValuesBucket>, callback: AsyncCal **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | @@ -1151,6 +1189,7 @@ batchInsert(table: string, values: Array<ValuesBucket>, callback: AsyncCal | callback | AsyncCallback<number> | 是 | 指定callback回调函数。如果操作成功，返回插入的数据个数，否则返回-1。 | **示例：** + ```js const valueBucket1 = { "NAME": "Lisa", @@ -1190,17 +1229,20 @@ batchInsert(table: string, values: Array<ValuesBucket>):Promise<number& **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | | values | Array<[ValuesBucket](#valuesbucket)> | 是 | 表示要插入到表中的一组数据。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<number> | 指定Promise回调函数。如果操作成功，返回插入的数据个数，否则返回-1。 | **示例：** + ```js const valueBucket1 = { "NAME": "Lisa", @@ -1239,6 +1281,7 @@ update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback& **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 | @@ -1246,6 +1289,7 @@ update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback& | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。返回受影响的行数。 | **示例：** + ```js const valueBucket = { "NAME": "Rose", @@ -1264,7 +1308,6 @@ rdbStore.update(valueBucket, predicates, function (err, ret) { }) ``` - ### update update(values: ValuesBucket, predicates: RdbPredicates):Promise<number> @@ -1274,17 +1317,20 @@ update(values: ValuesBucket, predicates: RdbPredicates):Promise<number> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | values | [ValuesBucket](#valuesbucket) | 是 | values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。 | | predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的更新条件。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<number> | 指定的Promise回调方法。返回受影响的行数。 | **示例：** + ```js const valueBucket = { "NAME": "Rose", @@ -1312,6 +1358,7 @@ update(table: string, values: ValuesBucket, predicates: dataSharePredicates.Data **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | @@ -1320,6 +1367,7 @@ update(table: string, values: ValuesBucket, predicates: dataSharePredicates.Data | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。返回受影响的行数。 | **示例：** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' const valueBucket = { @@ -1338,6 +1386,7 @@ rdbStore.update("EMPLOYEE", valueBucket, predicates, function (err, ret) { console.log("Updated row count: " + ret) }) ``` + ### update9+ update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates):Promise<number> @@ -1349,6 +1398,7 @@ update(table: string, values: ValuesBucket, predicates: dataSharePredicates.Data **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | @@ -1356,11 +1406,13 @@ update(table: string, values: ValuesBucket, predicates: dataSharePredicates.Data | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的更新条件。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<number> | 指定的Promise回调方法。返回受影响的行数。 | **示例：** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' const valueBucket = { @@ -1383,18 +1435,19 @@ promise.then(async (ret) => { delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void - 根据RdbPredicates的指定实例对象从数据库中删除数据，使用callback异步回调。 **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 | | callback | AsyncCallback<number> | 是 | 指定callback回调函数。返回受影响的行数。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") @@ -1407,7 +1460,6 @@ rdbStore.delete(predicates, function (err, rows) { }) ``` - ### delete delete(predicates: RdbPredicates):Promise<number> @@ -1417,16 +1469,19 @@ delete(predicates: RdbPredicates):Promise<number> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的删除条件。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<number> | 指定Promise回调函数。返回受影响的行数。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") @@ -1442,7 +1497,6 @@ promise.then((rows) => { delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void - 根据DataSharePredicates的指定实例对象从数据库中删除数据，使用callback异步回调。 **系统接口：** 此接口为系统接口。 @@ -1450,6 +1504,7 @@ delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callb **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | @@ -1457,6 +1512,7 @@ delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callb | callback | AsyncCallback<number> | 是 | 指定callback回调函数。返回受影响的行数。 | **示例：** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' let predicates = new dataSharePredicates.DataSharePredicates() @@ -1469,6 +1525,7 @@ rdbStore.delete("EMPLOYEE", predicates, function (err, rows) { console.log("Delete rows: " + rows) }) ``` + ### delete9+ delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promise<number> @@ -1480,17 +1537,20 @@ delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promi **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | DataSharePredicates的实例对象指定的删除条件。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<number> | 指定Promise回调函数。返回受影响的行数。 | **示例：** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' let predicates = new dataSharePredicates.DataSharePredicates() @@ -1512,6 +1572,7 @@ query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCa **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的查询条件。 | @@ -1519,6 +1580,7 @@ query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCa | callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") @@ -1532,7 +1594,6 @@ rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (e }) ``` - ### query query(predicates: RdbPredicates, columns?: Array<string>):Promise<ResultSet> @@ -1542,17 +1603,20 @@ query(predicates: RdbPredicates, columns?: Array<string>):Promise<Resul **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | predicates | [RdbPredicates](#rdbpredicates) | 是 | RdbPredicates的实例对象指定的查询条件。 | | columns | Array<string> | 否 | 表示要查询的列。如果值为空，则查询应用于所有列。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<[ResultSet](js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") @@ -1576,6 +1640,7 @@ query(table: string, predicates: dataSharePredicates.DataSharePredicates, column **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | @@ -1610,6 +1675,7 @@ query(table: string, predicates: dataSharePredicates.DataSharePredicates, column **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | table | string | 是 | 指定的目标表名。 | @@ -1623,6 +1689,7 @@ query(table: string, predicates: dataSharePredicates.DataSharePredicates, column | Promise<[ResultSet](js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | **示例：** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' let predicates = new dataSharePredicates.DataSharePredicates() @@ -1715,6 +1782,7 @@ querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback& **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | sql | string | 是 | 指定要执行的SQL语句。 | @@ -1722,6 +1790,7 @@ querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback& | callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | 是 | 指定callback回调函数。如果操作成功，则返回ResultSet对象。 | **示例：** + ```js rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) { if (err) { @@ -1733,7 +1802,6 @@ rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", }) ``` - ### querySql8+ querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> @@ -1743,17 +1811,20 @@ querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | sql | string | 是 | 指定要执行的SQL语句。 | | bindArgs | Array<[ValueType](#valuetype)> | 否 | SQL语句中参数的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<[ResultSet](js-apis-data-resultset.md)> | 指定Promise回调函数。如果操作成功，则返回ResultSet对象。 | **示例：** + ```js let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo']) promise.then((resultSet) => { @@ -1764,7 +1835,6 @@ promise.then((resultSet) => { }) ``` - ### executeSql executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<void>):void @@ -1774,6 +1844,7 @@ executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallbac **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | sql | string | 是 | 指定要执行的SQL语句。 | @@ -1781,6 +1852,7 @@ executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallbac | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例：** + ```js const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) { @@ -1792,7 +1864,6 @@ rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) { }) ``` - ### executeSql executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void> @@ -1802,17 +1873,20 @@ executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | sql | string | 是 | 指定要执行的SQL语句。 | | bindArgs | Array<[ValueType](#valuetype)> | 否 | SQL语句中参数的值。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 指定Promise回调函数。 | **示例：** + ```js const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" let promise = rdbStore.executeSql(SQL_CREATE_TABLE) @@ -1832,6 +1906,7 @@ beginTransaction():void **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **示例：** + ```js rdbStore.beginTransaction() const valueBucket = { @@ -1844,7 +1919,6 @@ await rdbStore.insert("test", valueBucket) rdbStore.commit() ``` - ### commit8+ commit():void @@ -1854,6 +1928,7 @@ commit():void **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **示例：** + ```js rdbStore.beginTransaction() const valueBucket = { @@ -1867,7 +1942,6 @@ await rdbStore.insert("test", valueBucket) rdbStore.commit() ``` - ### rollBack8+ rollBack():void @@ -1877,6 +1951,7 @@ rollBack():void **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **示例：** + ```js try { rdbStore.beginTransaction() @@ -1903,12 +1978,14 @@ backup(destName:string, callback: AsyncCallback<void>):void **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | destName | string | 是 | 指定数据库的备份文件名。 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例：** + ```js rdbStore.backup("dbBackup.db", function(err) { if (err) { @@ -1928,16 +2005,19 @@ backup(destName:string): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | destName | string | 是 | 指定数据库的备份文件名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 指定Promise回调函数。 | **示例：** + ```js let promiseBackup = rdbStore.backup("dbBackup.db") promiseBackup.then(()=>{ @@ -1956,12 +2036,14 @@ restore(srcName:string, callback: AsyncCallback<void>):void **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | srcName | string | 是 | 指定数据库的备份文件名。 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例：** + ```js rdbStore.restore("dbBackup.db", function(err) { if (err) { @@ -1981,16 +2063,19 @@ restore(srcName:string): Promise<void> **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | srcName | string | 是 | 指定数据库的备份文件名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 指定Promise回调函数。 | **示例：** + ```js let promiseRestore = rdbStore.restore("dbBackup.db") promiseRestore.then(()=>{ @@ -2011,12 +2096,14 @@ setDistributedTables(tables: Array<string>, callback: AsyncCallback<voi **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | tables | Array<string> | 是 | 要设置的分布式列表表名 | | callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例：** + ```js rdbStore.setDistributedTables(["EMPLOYEE"], function (err) { if (err) { @@ -2027,7 +2114,6 @@ rdbStore.setDistributedTables(["EMPLOYEE"], function (err) { }) ``` - ### setDistributedTables8+ setDistributedTables(tables: Array<string>): Promise<void> @@ -2039,16 +2125,19 @@ rdbStore.setDistributedTables(["EMPLOYEE"], function (err) { **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | tables | Array<string> | 是 | 要设置的分布式列表表名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 指定Promise回调函数。 | **示例：** + ```js let promise = rdbStore.setDistributedTables(["EMPLOYEE"]) promise.then(() => { @@ -2069,6 +2158,7 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | device | string | 是 | 远程设备 。| @@ -2076,6 +2166,7 @@ obtainDistributedTableName(device: string, table: string, callback: AsyncCallbac | callback | AsyncCallback<string> | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 | **示例：** + ```js rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) { if (err) { @@ -2086,7 +2177,6 @@ rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, }) ``` - ### obtainDistributedTableName8+ obtainDistributedTableName(device: string, table: string): Promise<string> @@ -2098,17 +2188,20 @@ rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | device | string | 是 | 远程设备。 | | table | string | 是 | 本地表名。 | **返回值**： + | 类型 | 说明 | | -------- | -------- | | Promise<string> | 指定Promise回调函数。如果操作成功，返回远程设备的分布式表名。 | **示例：** + ```js let promise = rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE") promise.then((tableName) => { @@ -2129,6 +2222,7 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 | @@ -2136,6 +2230,7 @@ sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array | callback | AsyncCallback<Array<[string, number]>> | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。| **示例：** + ```js let predicates = new data_rdb.RdbPredicates('EMPLOYEE') predicates.inDevices(['12345678abcde']) @@ -2151,7 +2246,6 @@ rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, resul }) ``` - ### sync8+ sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>> @@ -2163,6 +2257,7 @@ rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, resul **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | mode | [SyncMode](#syncmode8) | 是 | 指同步模式。该值可以是推、拉。 | @@ -2175,6 +2270,7 @@ rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, resul | Promise<Array<[string, number]>> | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 | **示例：** + ```js let predicates = new data_rdb.RdbPredicates('EMPLOYEE') predicates.inDevices(['12345678abcde']) @@ -2208,6 +2304,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<stri | observer | Callback<Array<string>> | 是 | 指分布式数据库中数据更改事件的观察者。 | **示例：** + ```js function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { @@ -2240,6 +2337,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback<Array<stri | observer | Callback<Array<string>> | 是 | 指已注册的数据更改观察者。| **示例：** + ```js function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { 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 010dd4b5dbc1569b776a1ad9f446d7ab532eceb5..e7dcfb41da6e6260fa52aa9bf0bb79210efa609e 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 @@ -6,7 +6,6 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - ## 使用说明 需要通过[RdbStore.query()](js-apis-data-rdb.md#query)获取resultSet对象。 @@ -25,7 +24,6 @@ promise.then((resultSet) => { 提供通过查询数据库生成的数据库结果集的访问方法。 - ### 属性 **系统能力：** 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。 @@ -42,7 +40,6 @@ promise.then((resultSet) => { | isStarted | boolean | 是 | 检查指针是否移动过。 | | isClosed | boolean | 是 | 检查当前结果集是否关闭。 | - ### getColumnIndex getColumnIndex(columnName: string): number @@ -52,16 +49,19 @@ getColumnIndex(columnName: string): number **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | columnName | string | 是 | 表示结果集中指定列的名称。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | number | 返回指定列的索引。 | **示例：** + ```js resultSet.goToFirstRow() const id = resultSet.getLong(resultSet.getColumnIndex("ID")) @@ -70,7 +70,6 @@ getColumnIndex(columnName: string): number const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY")) ``` - ### getColumnName getColumnName(columnIndex: number): string @@ -80,23 +79,25 @@ getColumnName(columnIndex: number): string **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | columnIndex | number | 是 | 表示结果集中指定列的索引。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | string | 返回指定列的名称。 | **示例：** + ```js const id = resultSet.getColumnName(0) const name = resultSet.getColumnName(1) const age = resultSet.getColumnName(2) ``` - ### goTo goTo(offset:number): boolean @@ -106,16 +107,19 @@ 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"]) @@ -127,7 +131,6 @@ goTo(offset:number): boolean }) ``` - ### goToRow goToRow(position: number): boolean @@ -137,16 +140,19 @@ 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"]) @@ -158,7 +164,6 @@ goToRow(position: number): boolean }) ``` - ### goToFirstRow goToFirstRow(): boolean @@ -169,11 +174,13 @@ 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"]) @@ -185,7 +192,6 @@ goToFirstRow(): boolean }) ``` - ### goToLastRow goToLastRow(): boolean @@ -195,11 +201,13 @@ 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"]) @@ -211,7 +219,6 @@ goToLastRow(): boolean }) ``` - ### goToNextRow goToNextRow(): boolean @@ -221,11 +228,13 @@ 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"]) @@ -237,7 +246,6 @@ goToNextRow(): boolean }) ``` - ### goToPreviousRow goToPreviousRow(): boolean @@ -247,11 +255,13 @@ 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"]) @@ -263,7 +273,6 @@ goToPreviousRow(): boolean }) ``` - ### getBlob getBlob(columnIndex: number): Uint8Array @@ -273,21 +282,23 @@ getBlob(columnIndex: number): Uint8Array **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | columnIndex | number | 是 | 指定的列索引，从0开始。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | Uint8Array | 以字节数组的形式返回指定列的值。 | **示例：** + ```js const codes = resultSet.getBlob(resultSet.getColumnIndex("CODES")) ``` - ### getString getString(columnIndex: number): string @@ -297,21 +308,23 @@ getString(columnIndex: number): string **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | columnIndex | number | 是 | 指定的列索引，从0开始。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | string | 以字符串形式返回指定列的值。 | **示例：** + ```js const name = resultSet.getString(resultSet.getColumnIndex("NAME")) ``` - ### getLong getLong(columnIndex: number): number @@ -321,21 +334,23 @@ getLong(columnIndex: number): number **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | columnIndex | number | 是 | 指定的列索引，从0开始。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | number | 以Long形式返回指定列的值。 | **示例：** + ```js const age = resultSet.getLong(resultSet.getColumnIndex("AGE")) ``` - ### getDouble getDouble(columnIndex: number): number @@ -345,21 +360,23 @@ getDouble(columnIndex: number): number **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | columnIndex | number | 是 | 指定的列索引，从0开始。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | number | 以double形式返回指定列的值。 | **示例：** + ```js const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY")) ``` - ### isColumnNull isColumnNull(columnIndex: number): boolean @@ -369,21 +386,23 @@ isColumnNull(columnIndex: number): boolean **系统能力：** SystemCapability.DistributedDataManager.RelationalStore.Core。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | columnIndex | number | 是 | 指定的列索引，从0开始。 | **返回值：** + | 类型 | 说明 | | -------- | -------- | | boolean | 如果当前行中指定列的值为null，则返回true，否则返回false。 | **示例：** + ```js const isColumnNull = resultSet.isColumnNull(resultSet.getColumnIndex("CODES")) ``` - ### close close(): void @@ -393,6 +412,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-screen.md b/zh-cn/application-dev/reference/apis/js-apis-screen.md index 9472f9f6d445586231e7bbb44ec1c87b1cc1dc52..42475c74b7761fd32f73468efa545a209f15d63d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-screen.md +++ b/zh-cn/application-dev/reference/apis/js-apis-screen.md @@ -1,4 +1,5 @@ # 屏幕 + 本模块提供管理屏幕的一些基础能力，包括获取屏幕对象，监听屏幕变化，创建和销毁虚拟屏幕等。 > **说明：** @@ -6,6 +7,7 @@ > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > > 本模块接口为系统接口。 + ## 导入模块 ```js @@ -39,6 +41,7 @@ screen.getAllScreens((err, data) => { screenClass = data[0]; }); ``` + ## screen.getAllScreens getAllScreens(): Promise<Array<Screen>> @@ -48,11 +51,13 @@ getAllScreens(): Promise<Array<Screen>> **系统能力：** SystemCapability.WindowManager.WindowManager.Core **返回值：** + | 类型 | 说明 | | --------------------------------------------- | ----------------------------------------- | | Promise<Array<[Screen](#screen)>> | Promise对象。返回当前获取的屏幕对象集合。 | **示例：** + ```js var screenClass = null; let promise = screen.getAllScreens(); @@ -63,7 +68,9 @@ promise.then((data) => { console.log('Failed to get all screens . Cause: ' + JSON.stringify(err)); }); ``` + ## screen.on('connect' | 'disconnect' | 'change') + on(eventType: 'connect' | 'disconnect' | 'change', callback: Callback<number>): void 开启屏幕状态变化的监听。 @@ -71,19 +78,23 @@ on(eventType: 'connect' | 'disconnect' | 'change', callback: Callback<number& **系统能力：** SystemCapability.WindowManager.WindowManager.Core **参数：** + | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------- | ---- | ------------------------------------------------------------ | | eventType | string | 是 | 监听事件。
-eventType为"connect"表示屏幕连接事件。
-eventType为"disconnect"表示断开屏幕连接事件。
-eventType为"change"表示屏幕状态改变事件。 | | callback | Callback<number> | 是 | 回调函数。返回屏幕的id。 | **示例：** + ```js var callback = (data) => { console.info('Register the callback for screen changes. Data: ' + JSON.stringify(data)) }; screen.on("connect", callback); ``` + ## screen.off('connect' | 'disconnect' | 'change') + off(eventType: 'connect' | 'disconnect' | 'change', callback?: Callback<number>): void 关闭屏幕状态变化的监听。 @@ -91,12 +102,14 @@ off(eventType: 'connect' | 'disconnect' | 'change', callback?: Callback<numbe **系统能力：** SystemCapability.WindowManager.WindowManager.Core **参数：** + | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------- | ---- | ------------------------------------------------------------ | | eventType | string | 是 | 监听事件。
-eventType为"connect"表示屏幕连接事件。
-eventType为"disconnect"表示断开屏幕连接事件。
-eventType为"change"表示屏幕状态改变事件。 | | callback | Callback<number> | 否 | 回调函数。返回屏幕的id。 | **示例：** + ```js var callback = (data) => { console.info('Unegister the callback for screen changes. Data: ' + JSON.stringify(data)) @@ -105,6 +118,7 @@ screen.off("connect", callback); ``` ## screen.makeExpand + makeExpand(options:Array<ExpandOption>, callback: AsyncCallback<number>): void 将屏幕设置为扩展模式，使用callback异步回调。 @@ -112,6 +126,7 @@ makeExpand(options:Array<ExpandOption>, callback: AsyncCallback<number& **系统能力：** SystemCapability.WindowManager.WindowManager.Core **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------ | ---- | -------------------------------- | | options | Array<[ExpandOption](#expandoption)> | 是 | 设置扩展屏幕的参数集合。 | @@ -132,6 +147,7 @@ screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 10 ``` ## screen.makeExpand + makeExpand(options:Array<ExpandOption>): Promise<number> 将屏幕设置为扩展模式，使用Promise异步回调。 @@ -145,11 +161,13 @@ makeExpand(options:Array<ExpandOption>): Promise<number> | options | Array<[ExpandOption](#expandoption)> | 是 | 设置扩展屏幕的参数集合。 | **返回值：** + | 类型 | 说明 | | --------------------- | ----------------------------------- | | Promise<number> | Promise对象。返回扩展屏幕的群组id。 | **示例：** + ```js screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 1080, startY: 0}]).then((data) => { console.info('Succeeded in making screens as expand-screen.Data:' + JSON.stringify(data)); @@ -159,6 +177,7 @@ screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 10 ``` ## screen.makeMirror + makeMirror(mainScreen:number, mirrorScreen:Array<number>, callback: AsyncCallback<number>): void 将屏幕设置为镜像模式，使用callback异步回调。 @@ -174,6 +193,7 @@ makeMirror(mainScreen:number, mirrorScreen:Array<number>, callback: AsyncC | callback | AsyncCallback<number> | 是 | 回调函数。返回镜像屏幕的群组id。 | **示例：** + ```js var mainScreenId = 0; var mirrorScreenIds = [1, 2, 3]; @@ -187,6 +207,7 @@ screen.makeMirror(mainScreenId, mirrorScreenIds, (err, data) => { ``` ## screen.makeMirror + makeMirror(mainScreen:number, mirrorScreen:Array<number>): Promise<number> 将屏幕设置为镜像模式，使用Promise异步回调。 @@ -201,11 +222,13 @@ makeMirror(mainScreen:number, mirrorScreen:Array<number>): Promise<numb | mirrorScreen | Array<number> | 是 | 镜像屏幕id集合。 | **返回值：** + | 类型 | 说明 | | --------------------- | ----------------------------------- | | Promise<number> | Promise对象。返回镜像屏幕的群组id。 | **示例：** + ```js var mainScreenId = 0; var mirrorScreenIds = [1, 2, 3]; @@ -217,6 +240,7 @@ screen.makeMirror(mainScreenId, mirrorScreenIds).then((data) => { ``` ## screen.createVirtualScreen + createVirtualScreen(options:VirtualScreenOption, callback: AsyncCallback<Screen>): void 创建虚拟屏幕，使用callback异步回调。 @@ -233,6 +257,7 @@ createVirtualScreen(options:VirtualScreenOption, callback: AsyncCallback<Scre | callback | AsyncCallback<[Screen](#screen)> | 是 | 回调函数，返回创建的虚拟屏幕对象。 | **示例：** + ```js var screenClass = null; screen.createVirtualScreen({ @@ -252,6 +277,7 @@ screen.createVirtualScreen({ ``` ## screen.createVirtualScreen + createVirtualScreen(options:VirtualScreenOption): Promise<Screen> 创建虚拟屏幕，使用Promise异步回调。 @@ -261,6 +287,7 @@ createVirtualScreen(options:VirtualScreenOption): Promise<Screen> **需要权限**：ohos.permission.CAPTURE_SCREEN，如果VirtualScreenOption.surfaceId有效，此权限是必需的。仅系统应用可用。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------- | ---- | ------------------------ | | options | [VirtualScreenOption](#virtualscreenoption) | 是 | 用于创建虚拟屏幕的参数。 | @@ -272,6 +299,7 @@ createVirtualScreen(options:VirtualScreenOption): Promise<Screen> | Promise<[Screen](#screen)> | Promise对象。返回创建的虚拟屏幕对象。 | **示例：** + ```js var screenClass = null; screen.createVirtualScreen({ @@ -289,6 +317,7 @@ screen.createVirtualScreen({ ``` ## screen.destroyVirtualScreen + destroyVirtualScreen(screenId:number, callback: AsyncCallback<void>): void 销毁虚拟屏幕，使用callback异步回调。 @@ -296,12 +325,14 @@ destroyVirtualScreen(screenId:number, callback: AsyncCallback<void>): void **系统能力：** SystemCapability.WindowManager.WindowManager.Core **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------------------------------------------ | | screenId | number | 是 | 屏幕的id。 | | callback | AsyncCallback<void> | 是 | 回调函数。当销毁虚拟屏幕成功，err为undefined，否则为错误对象。 | **示例：** + ```js var screenId = 1; screen.destroyVirtualScreen(screenId, (err,data) => { @@ -314,6 +345,7 @@ screen.destroyVirtualScreen(screenId, (err,data) => { ``` ## screen.destroyVirtualScreen + destroyVirtualScreen(screenId:number): Promise<void> 销毁虚拟屏幕，使用Promise异步回调。 @@ -321,16 +353,19 @@ destroyVirtualScreen(screenId:number): Promise<void> **系统能力：** SystemCapability.WindowManager.WindowManager.Core **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ---------- | | screenId | number | 是 | 屏幕的id。 | **返回值：** + | 类型 | 说明 | | ------------------- | ------------------------- | | Promise<void> | 无返回结果的Promise对象。 | **示例：** + ```js var screenId = 1; screen.destroyVirtualScreen(screenId).then((data) => { @@ -341,6 +376,7 @@ screen.destroyVirtualScreen(screenId).then((data) => { ``` ## screen.setVirtualScreenSurface + setVirtualScreenSurface(screenId:number, surfaceId: string, callback: AsyncCallback<void>): void 设置虚拟屏幕的surface，使用callback异步回调。 @@ -372,6 +408,7 @@ screen.setVirtualScreenSurface(screenId, surfaceId, (err,data) => { ``` ## screen.setVirtualScreenSurface + setVirtualScreenSurface(screenId:number, surfaceId: string): Promise<void> 设置虚拟屏幕的surface，使用Promise异步回调。 @@ -381,17 +418,20 @@ setVirtualScreenSurface(screenId:number, surfaceId: string): Promise<void> **需要权限**：ohos.permission.CAPTURE_SCREEN，仅系统应用可用。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ------------- | | screenId | number | 是 | 屏幕的id。 | | surfaceId | string | 是 | surface的id。 | **返回值：** + | 类型 | 说明 | | ------------------- | ------------------------- | | Promise<void> | 无返回结果的Promise对象。 | **示例：** + ```js var screenId = 1; var surfaceId = '2048'; @@ -403,6 +443,7 @@ screen.setVirtualScreenSurface(screenId, surfaceId).then((data) => { ``` ## screen.isScreenRotationLocked + isScreenRotationLocked(): Promise<boolean> 查询当前自动转屏是否锁定，使用Promise异步回调。 @@ -410,11 +451,13 @@ isScreenRotationLocked(): Promise<boolean> **系统能力：** SystemCapability.WindowManager.WindowManager.Core **返回值：** + | 类型 | 说明 | | ---------------------- | ------------------------------------- | | Promise<boolean> | Promise对象。返回true表示当前自动转屏处于锁定状态；返回false表示当前自动转屏不处于锁定状态。 | **示例：** + ```js screen.isScreenRotationLocked().then((isLocked) => { console.info('Succeeded in getting screen rotation lock status. isLocked:'+ JSON.stringify(isLocked)); @@ -424,6 +467,7 @@ screen.isScreenRotationLocked().then((isLocked) => { ``` ## screen.isScreenRotationLocked + isScreenRotationLocked(callback: AsyncCallback<boolean>): void 查询当前自动转屏是否锁定，使用callback异步回调。 @@ -449,6 +493,7 @@ screen.isScreenRotationLocked((err, isLocked) => { ``` ## screen.setScreenRotationLocked + setScreenRotationLocked(isLocked: boolean): Promise<void> 设置自动转屏开关是否锁定，使用Promise异步回调。 @@ -456,16 +501,19 @@ setScreenRotationLocked(isLocked: boolean): Promise<void> **系统能力：** SystemCapability.WindowManager.WindowManager.Core **参数：** + | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ------------- | | isLocked | boolean | 是 | 自动转屏开关是否锁定。true为锁定，false为未锁定. | **返回值：** + | 类型 | 说明 | | ------------------- | ------------------------- | | Promise<void> | 无返回结果的Promise对象。 | **示例：** + ```js var isLocked = false; screen.setScreenRotationLocked(isLocked).then((data) => { @@ -476,6 +524,7 @@ screen.setScreenRotationLocked(isLocked).then((data) => { ``` ## screen.setScreenRotationLocked + setScreenRotationLocked(isLocked: boolean, callback: AsyncCallback<void>): void 设置自动转屏开关是否锁定，使用callback异步回调。 @@ -503,6 +552,7 @@ screen.setScreenRotationLocked(isLocked, (err, data) => { ``` ## ExpandOption + 扩展屏幕的参数。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core @@ -514,6 +564,7 @@ screen.setScreenRotationLocked(isLocked, (err, data) => { | startY | number | 是 | 是 | 屏幕的起始Y轴坐标。 | ## VirtualScreenOption + 创建虚拟屏幕的参数。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core @@ -527,6 +578,7 @@ screen.setScreenRotationLocked(isLocked, (err, data) => { | surfaceId | string | 是 | 是 | 指定虚拟屏幕的surfaceId。 | ## Screen + 屏幕实例。 下列API示例中都需先使用[getAllScreens()](#screengetallscreens)、[createVirtualScreen()](#screencreatevirtualscreen)中的任一方法获取到Screen实例，再通过此实例调用对应方法。 @@ -542,6 +594,7 @@ screen.setScreenRotationLocked(isLocked, (err, data) => { | orientation | [Orientation](#orientation) | 是 | 否 | 屏幕方向。 | ### setOrientation + setOrientation(orientation: Orientation, callback: AsyncCallback<void>): void 设置屏幕方向，使用callback异步回调。 @@ -554,6 +607,7 @@ setOrientation(orientation: Orientation, callback: AsyncCallback<void>): v | callback | AsyncCallback<void> | 是 | 回调函数。当设置屏幕方向成功，err为undefined，否则为错误对象。 | **示例：** + ```js screenClass.setOrientation(screen.Orientation.VERTICAL, (err, data) => { if (err.code) { @@ -563,7 +617,9 @@ screenClass.setOrientation(screen.Orientation.VERTICAL, (err, data) => { console.info('Succeeded in setting Orientation VERTICAL. data: ' + JSON.stringify(data)); }) ``` + ### setOrientation + setOrientation(orientation: Orientation): Promise<void> 设置屏幕方向，使用Promise异步回调。 @@ -575,11 +631,13 @@ setOrientation(orientation: Orientation): Promise<void> | orientation | [Orientation](#orientation) | 是 | 屏幕方向。 | **返回值：** + | 类型 | 说明 | | ------------------- | ------------------------- | | Promise<void> | 无返回结果的Promise对象。 | **示例：** + ```js let promise = screenClass.setOrientation(screen.Orientation.VERTICAL); promise.then((data) => { @@ -588,7 +646,9 @@ promise.then((data) => { console.error('Failed to set Orientation VERTICAL. Cause: ' + JSON.stringify(err)); }) ``` + ### setScreenActiveMode + setScreenActiveMode(modeIndex: number, callback: AsyncCallback<void>): void 设置屏幕当前显示模式，使用callback异步回调。 @@ -612,7 +672,9 @@ screenClass.setScreenActiveMode(modeIndex, (err, data) => { console.info('Succeeded in setting ScreenActiveMode 0. data: ' + JSON.stringify(data)); }) ``` + ### setScreenActiveMode + setScreenActiveMode(modeIndex: number): Promise<void> 设置屏幕当前显示模式，使用Promise异步回调。 @@ -630,6 +692,7 @@ setScreenActiveMode(modeIndex: number): Promise<void> | Promise<void> | 无返回结果的Promise对象。 | **示例：** + ```js var modeIndex = 0; let promise = screenClass.setScreenActiveMode(modeIndex); @@ -641,6 +704,7 @@ promise.then((data) => { ``` ### setDensityDpi + setDensityDpi(densityDpi: number, callback: AsyncCallback<void>): void; 设置屏幕的像素密度，使用callback异步回调。 @@ -653,6 +717,7 @@ setDensityDpi(densityDpi: number, callback: AsyncCallback<void>): void; | callback | AsyncCallback<void> | 是 | 回调函数。当设置屏幕的像素密度成功，err为undefined，否则为错误对象。 | **示例：** + ```js var densityDpi = 320; screenClass.setDensityDpi(densityDpi, (err, data) => { @@ -665,6 +730,7 @@ screenClass.setDensityDpi(densityDpi, (err, data) => { ``` ### setDensityDpi + setDensityDpi(densityDpi: number): Promise<void> 设置屏幕的像素密度，使用Promise异步回调。 @@ -682,6 +748,7 @@ setDensityDpi(densityDpi: number): Promise<void> | Promise<void> | 无返回结果的Promise对象。 | **示例：** + ```js var densityDpi = 320; var promise = screenClass.setDensityDpi(densityDpi); @@ -693,6 +760,7 @@ promise.then((data) => { ``` ## Orientation + 屏幕方向枚举。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core @@ -706,6 +774,7 @@ promise.then((data) => { | REVERSE_HORIZONTAL | 4 | 表示指定屏幕为反向水平方向。 | ## ScreenModeInfo + 屏幕显示模式信息。 **系统能力：** SystemCapability.WindowManager.WindowManager.Core diff --git a/zh-cn/application-dev/windowmanager/application-window-fa.md b/zh-cn/application-dev/windowmanager/application-window-fa.md index 56c532b95bfcf7eb501ccf587b6ecf141878a4b7..485b43fcb6ebbd6448d46245e23666830fdd5815 100644 --- a/zh-cn/application-dev/windowmanager/application-window-fa.md +++ b/zh-cn/application-dev/windowmanager/application-window-fa.md @@ -88,7 +88,6 @@ 2. 设置子窗口属性。 子窗口创建成功后，可以改变其大小、位置等，还可以根据应用需要设置窗口背景色、亮度等属性。 - ```js // 2.移动子窗口位置。 @@ -112,7 +111,6 @@ 3. 加载显示子窗口的具体内容。 使用`loadContent`和`show`接口加载显示子窗口的具体内容。 - ```js // 3.为子窗口加载对应的目标页面。 @@ -136,7 +134,6 @@ 4. 销毁子窗口。 当不再需要某些子窗口时，可根据场景的具体实现逻辑，使用`destroy`接口销毁子窗口。 - ```js // 4.销毁子窗口。当不再需要某些子窗口时，可根据场景的具体实现逻辑，使用destroy接口销毁子窗口，此处以监听窗口区域外的点击事件实现子窗口的销毁。 @@ -167,7 +164,6 @@ > 沉浸式能力需要在成功获取应用主窗口对象的前提下进行。 > > 确保应用内最后显示的窗口为主窗口，然后再使用`window.getTopWindow`接口来获取得到主窗口。 - ```js import window from '@ohos.window'; @@ -241,7 +237,6 @@ 3. 加载显示沉浸式窗口的具体内容。 使用`loadContent`和`show`接口加载显示沉浸式窗口的具体内容。 - ```js // 3.为沉浸式窗口加载对应的目标页面。 diff --git a/zh-cn/application-dev/windowmanager/application-window-stage.md b/zh-cn/application-dev/windowmanager/application-window-stage.md index 7b543cabbe6e4c28369b962e8d94436df03e1a3d..658f09d856f16779e255a303e92c4b9573a6b3a7 100644 --- a/zh-cn/application-dev/windowmanager/application-window-stage.md +++ b/zh-cn/application-dev/windowmanager/application-window-stage.md @@ -66,7 +66,6 @@ 3. 为主窗口加载对应的目标页面。 通过`loadContent`接口加载主窗口的目标页面。 - ```ts import Ability from '@ohos.application.Ability' @@ -124,7 +123,6 @@ class MainAbility extends Ability { 4. 销毁子窗口。 当不再需要某些子窗口时，可根据具体实现逻辑，使用`destroy`接口销毁子窗口。 - ```ts import Ability from '@ohos.application.Ability' @@ -214,7 +212,6 @@ class MainAbility extends Ability { 3. 加载显示沉浸式窗口的具体内容。 通过`loadContent`和`show`接口加载显示沉浸式窗口的具体内容。 - ```ts import Ability from '@ohos.application.Ability' @@ -309,7 +306,6 @@ class MainAbility extends Ability { > **说明：** > 虽然悬浮窗具备始终在前台显示的能力，但如果创建悬浮窗的应用任务被系统回收，仍然会导致悬浮窗从界面移除。如果想要保持悬浮窗口始终在前台显示，请申请[长时任务](../task-management/background-task-overview.md)。 - ```json {