From a42ee8bf3ca8b9ababceb9f4f5cef9dd497b1e52 Mon Sep 17 00:00:00 2001 From: wuyongning Date: Mon, 21 Mar 2022 19:19:16 +0800 Subject: [PATCH 1/3] update files Signed-off-by: wuyongning --- .../apis/js-apis-data-distributedobject.md | 60 +++++++++++-------- 1 file changed, 36 insertions(+), 24 deletions(-) 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 ca56d462842..05a34c3f567 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 @@ -17,16 +17,21 @@ import distributedObject from '@ohos.data.distributedDataObject' createDistributedObject(source: object): DistributedObject -创建一个分布式对象distributedObject,用户可以通过source指定分布式对象中的属性,属性支持基本类型以及复杂类型,返回值是创建好的分布式对象。 +创建一个分布式对象。 **系统能力**:SystemCapability.DistributedDataManager.DataObject.DistributedObject。 -- 参数: +**参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | object | source | 是 | 设置distributedObject的属性。 | -- 示例: +**返回值:** + | 类型 | 说明 | + | -------- | -------- | + | DistributedObject | 创建好的分布式对象。 | + +**示例:** ```js import distributedObject from '@ohos.data.distributedDataObject' // 创建对象,对象包含4个属性类型,string,number,boolean和Object @@ -39,16 +44,16 @@ createDistributedObject(source: object): DistributedObject genSessionId(): string -随机创建一个sessionId,返回值是随机创建的sessionId。 +随机创建一个sessionId。 **系统能力**:SystemCapability.DistributedDataManager.DataObject.DistributedObject。 -- 返回值: +**返回值:** | 类型 | 说明 | | -------- | -------- | | string | 随机创建的sessionId。 | -- 示例: +**示例:** ```js import distributedObject from '@ohos.data.distributedDataObject' var sessionId = distributedObject.genSessionId(); @@ -62,16 +67,21 @@ genSessionId(): string setSessionId(sessionId?: string): boolean -设置同步的sessionId,当可信组网中有多个设备时,多个设备间的对象如果设置为同一个sessionId,就能自动同步。sessionId是指定的sessionId,如果要退出分布式组网,设置为""或不设置均可。结果以boolean形式返回,true标识设置sessionId成功 +设置同步的sessionId,当可信组网中有多个设备时,多个设备间的对象如果设置为同一个sessionId,就能自动同步。 **系统能力**:SystemCapability.DistributedDataManager.DataObject.DistributedObject。 -- 参数: +**参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | sessionId | string | 否 | 分布式对象在可信组网中的标识ID。 | + | sessionId | string | 否 | 分布式对象在可信组网中的标识ID。如果要退出分布式组网,设置为""或不设置均可。 | + + **返回值:** + | 类型 | 说明 | + | -------- | -------- | + | boolean |
true:标识设置sessionId成功
false:标识设置sessionId失败 | -- 示例: +**示例:** ```js import distributedObject from '@ohos.data.distributedDataObject' var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, @@ -87,17 +97,17 @@ setSessionId(sessionId?: string): boolean on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<string> }>): void -监听分布式对象的变更,type需固定为'change',callback是变更时触发的回调,回调参数sessionId标识变更对象的sessionId,fields标识对象变更的属性名 +监听分布式对象的变更。 **系统能力**:SystemCapability.DistributedDataManager.DataObject.DistributedObject。 -- 参数: +**参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'change',表示数据变更。 | - | callback | Callback<{ sessionId: string, fields: Array<string> }> | 是 | 变更回调对象实例。 | + | 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, @@ -116,18 +126,18 @@ on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<stri off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<string> }>): void -当不再进行数据变更监听时,使用此接口删除对象的变更监听,type固定为'change',callback为可选参数,若不设置则表示删除该对象所有的变更监听 +当不再进行数据变更监听时,使用此接口删除对象的变更监听。 **系统能力**:SystemCapability.DistributedDataManager.DataObject.DistributedObject。 -- 参数: +**参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'change',表示数据变更。 | | callback | Callback<{ sessionId: string, fields: Array<string> }> | 否 | 需要删除的变更回调,若不设置则删除该对象所有的变更回调。 | -- 示例: +**示例:** ```js import distributedObject from '@ohos.data.distributedDataObject' var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, @@ -147,17 +157,19 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<st on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, status: 'online' | 'offline' }>): void -监听分布式对象的上下线,type需固定为'status',callback是分布式对象上下线时触发的回调,回调参数sessionId标识变更对象的sessionId,networkId标识对象设备的networkId,status标识对象为'online'(上线)或'offline'(下线)的状态 +监听分布式对象的上下线。 **系统能力**:SystemCapability.DistributedDataManager.DataObject.DistributedObject。 -- 参数: +**参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'status',表示对象上下线。 | - | callback | Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }> | 是 | 监听上下线回调实例。 | + | callback | Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }> | 是 | 监听上下线回调实例。
sessionId:标识变更对象的sessionId
networkId:标识对象设备的networkId
status:标识对象为'online'(上线)或'offline'(下线)的状态 | + + -- 示例: +**示例:** ```js import distributedObject from '@ohos.data.distributedDataObject' var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, @@ -172,18 +184,18 @@ on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, st off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, status: 'online' | 'offline' }>): void -当不再进行对象上下线监听时,使用此接口删除对象的上下线监听,type固定为'status',callback为可选参数,若不设置则表示删除该对象所有的上下线监听 +当不再进行对象上下线监听时,使用此接口删除对象的上下线监听。 **系统能力**:SystemCapability.DistributedDataManager.DataObject.DistributedObject。 -- 参数: +**参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'status',表示对象上下线。 | | callback | Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }> | 否 | 需要删除的上下线回调,若不设置则删除该对象所有的上下线回调。 | -- 示例: +**示例:** ```js import distributedObject from '@ohos.data.distributedDataObject' g_object.on("status", function (sessionId, networkId, status) { -- Gitee From 4f84dad53af2f6fed98d61db69699250b393d474 Mon Sep 17 00:00:00 2001 From: wuyongning Date: Tue, 22 Mar 2022 11:21:09 +0800 Subject: [PATCH 2/3] =?UTF-8?q?=E5=86=85=E6=BA=90=E9=97=AE=E9=A2=98?= =?UTF-8?q?=E5=A4=84=E7=90=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: wuyongning --- .../database/database-relational-guidelines.md | 13 ------------- .../apis/js-apis-data-distributedobject.md | 10 +++++----- 2 files changed, 5 insertions(+), 18 deletions(-) diff --git a/zh-cn/application-dev/database/database-relational-guidelines.md b/zh-cn/application-dev/database/database-relational-guidelines.md index a30a5d0d158..614e0c20716 100644 --- a/zh-cn/application-dev/database/database-relational-guidelines.md +++ b/zh-cn/application-dev/database/database-relational-guidelines.md @@ -133,20 +133,7 @@ | ResultSet | isColumnNull(columnIndex: number): boolean | 检查当前行中指定列的值是否为null。 | | ResultSet | close(): void | 关闭结果集。 | -**数据库更改秘钥** -用户可以对当前数据库进行加密。 - -数据库的加密仅限于初始使用一个数据库时就进行加密,使用过程中进行秘钥的变更,但不支持取消秘钥。 - -数据库初始时为加密库,则一直为加密库;初始时为未加密库,则一直为未加密库。 - -**表8** 数据库更改秘钥 - -| 类名 | 接口名 | 描述 | -| -------- | -------- | -------- | -| RdbStore | changeEncryptKey(newEncryptKey:Uint8Array, callback: AsyncCallback<number>):void; | 数据库更改秘钥接口,通过callback 可以异步处理返回结果。返回结果0成功,非0失败。 | -| RdbStore | changeEncryptKey(newEncryptKey:Uint8Array): Promise<number>; | 数据库更改秘钥接口,通过await 可以同步处理返回结果。返回结果0成功,非0失败。 | **设置分布式列表。** 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 05a34c3f567..9f5f5f773b5 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 @@ -29,7 +29,7 @@ createDistributedObject(source: object): DistributedObject **返回值:** | 类型 | 说明 | | -------- | -------- | - | DistributedObject | 创建好的分布式对象。 | + | [DistributedObject](#distributedobject) | 创建好的分布式对象。 | **示例:** ```js @@ -67,7 +67,7 @@ genSessionId(): string setSessionId(sessionId?: string): boolean -设置同步的sessionId,当可信组网中有多个设备时,多个设备间的对象如果设置为同一个sessionId,就能自动同步。 +设置同步的sessionId,当可信组网中有多个设备时,多个设备间的对象如果设置为同一个sessionId,就能自动同步。 **系统能力**:SystemCapability.DistributedDataManager.DataObject.DistributedObject。 @@ -76,10 +76,10 @@ setSessionId(sessionId?: string): boolean | -------- | -------- | -------- | -------- | | sessionId | string | 否 | 分布式对象在可信组网中的标识ID。如果要退出分布式组网,设置为""或不设置均可。 | - **返回值:** +**返回值:** | 类型 | 说明 | | -------- | -------- | - | boolean |
true:标识设置sessionId成功
false:标识设置sessionId失败 | + | boolean | true:标识设置sessionId成功;
false:标识设置sessionId失败。 | **示例:** ```js @@ -192,7 +192,7 @@ off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, s | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'status',表示对象上下线。 | - | callback | Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }> | 否 | 需要删除的上下线回调,若不设置则删除该对象所有的上下线回调。 | + | callback | Callback<{ sessionId: string, deviceId: string, status: 'online' \| 'offline' }> | 否 | 需要删除的上下线回调,若不设置则删除该对象所有的上下线回调。
sessionId:标识变更对象的sessionId
deviceId:标识变更对象的deviceId
status:标识对象为'online'(上线)或'offline'(下线)的状态 | **示例:** -- Gitee From 0602408b53ad43451555ebdd9809af25b60bd8c1 Mon Sep 17 00:00:00 2001 From: wuyongning Date: Tue, 22 Mar 2022 15:05:24 +0800 Subject: [PATCH 3/3] update format Signed-off-by: wuyongning --- .../reference/apis/js-apis-data-distributedobject.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) 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 9f5f5f773b5..da4dd52df2b 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 @@ -24,7 +24,7 @@ createDistributedObject(source: object): DistributedObject **参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | object | source | 是 | 设置distributedObject的属性。 | + | source | object | 是 | 设置distributedObject的属性。 | **返回值:** | 类型 | 说明 | @@ -105,7 +105,7 @@ on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<stri | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'change',表示数据变更。 | - | callback | Callback<{ sessionId: string, fields: Array<string> }> | 是 | 变更回调对象实例。
sessionId:标识变更对象的sessionId
fields:标识对象变更的属性名 | + | callback | Callback<{ sessionId: string, fields: Array<string> }> | 是 | 变更回调对象实例。
sessionId:标识变更对象的sessionId;
fields:标识对象变更的属性名。 | **示例:** ```js @@ -134,7 +134,7 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<st | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'change',表示数据变更。 | - | callback | Callback<{ sessionId: string, fields: Array<string> }> | 否 | 需要删除的变更回调,若不设置则删除该对象所有的变更回调。 | + | callback | Callback<{ sessionId: string, fields: Array<string> }> | 否 | 需要删除的变更回调,若不设置则删除该对象所有的变更回调。
sessionId:标识变更对象的sessionId;
fields:标识对象变更的属性名。 | **示例:** @@ -165,7 +165,7 @@ on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, st | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'status',表示对象上下线。 | - | callback | Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }> | 是 | 监听上下线回调实例。
sessionId:标识变更对象的sessionId
networkId:标识对象设备的networkId
status:标识对象为'online'(上线)或'offline'(下线)的状态 | + | callback | Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }> | 是 | 监听上下线回调实例。
sessionId:标识变更对象的sessionId;
networkId:标识对象设备的networkId;
status:标识对象为'online'(上线)或'offline'(下线)的状态。 | @@ -192,7 +192,7 @@ off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, s | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型,固定为'status',表示对象上下线。 | - | callback | Callback<{ sessionId: string, deviceId: string, status: 'online' \| 'offline' }> | 否 | 需要删除的上下线回调,若不设置则删除该对象所有的上下线回调。
sessionId:标识变更对象的sessionId
deviceId:标识变更对象的deviceId
status:标识对象为'online'(上线)或'offline'(下线)的状态 | + | callback | Callback<{ sessionId: string, deviceId: string, status: 'online' \| 'offline' }> | 否 | 需要删除的上下线回调,若不设置则删除该对象所有的上下线回调。
sessionId:标识变更对象的sessionId;
deviceId:标识变更对象的deviceId;
status:标识对象为'online'(上线)或'offline'(下线)的状态。 | **示例:** -- Gitee