未验证 提交 b56c0c42 编写于 作者: O openharmony_ci 提交者: Gitee

!5747 修改js-apis-data-distributedobject.md中格式、超链接

Merge pull request !5747 from huyuanyuan/master
...@@ -33,12 +33,11 @@ createDistributedObject(source: object): DistributedObject ...@@ -33,12 +33,11 @@ createDistributedObject(source: object): DistributedObject
| [DistributedObject](#distributedobject) | 创建完成的分布式对象。 | | [DistributedObject](#distributedobject) | 创建完成的分布式对象。 |
**示例:** **示例:**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
// 创建对象,对象包含4个属性类型,string,number,boolean和Object // 创建对象,对象包含4个属性类型,string,number,boolean和Object
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
parent:{mother:"jack mom",father:"jack Dad"}}); ```
```
## distributedObject.genSessionId ## distributedObject.genSessionId
...@@ -55,10 +54,10 @@ genSessionId(): string ...@@ -55,10 +54,10 @@ genSessionId(): string
| string | 随机创建的sessionId。 | | string | 随机创建的sessionId。 |
**示例:** **示例:**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
var sessionId = distributedObject.genSessionId(); var sessionId = distributedObject.genSessionId();
``` ```
## SaveSuccessResponse<sup>9+</sup> ## SaveSuccessResponse<sup>9+</sup>
...@@ -110,15 +109,14 @@ setSessionId(sessionId?: string): boolean ...@@ -110,15 +109,14 @@ setSessionId(sessionId?: string): boolean
**示例:** **示例:**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});;
parent:{mother:"jack mom",father:"jack Dad"}}); //g_object加入分布式组网
//g_object加入分布式组网 g_object.setSessionId(distributedObject.genSessionId());
g_object.setSessionId(distributedObject.genSessionId()); //设置为""退出分布式组网
//设置为""退出分布式组网 g_object.setSessionId("");
g_object.setSessionId(""); ```
```
### on('change') ### on('change')
...@@ -138,7 +136,7 @@ on(type: 'change', callback: Callback<{ sessionId: string, fields: Array&lt;stri ...@@ -138,7 +136,7 @@ on(type: 'change', callback: Callback<{ sessionId: string, fields: Array&lt;stri
**示例:** **示例:**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false,parent:{mother:"jack mom",father:"jack Dad"}}); var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
globalThis.changeCallback = (sessionId, changeData) => { globalThis.changeCallback = (sessionId, changeData) => {
console.info("change" + sessionId); console.info("change" + sessionId);
if (changeData != null && changeData != undefined) { if (changeData != null && changeData != undefined) {
...@@ -168,7 +166,7 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array&lt;st ...@@ -168,7 +166,7 @@ off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array&lt;st
**示例:** **示例:**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false,parent:{mother:"jack mom",father:"jack Dad"}}); var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
//删除数据变更回调changeCallback //删除数据变更回调changeCallback
g_object.off("change", globalThis.changeCallback); g_object.off("change", globalThis.changeCallback);
//删除所有的数据变更回调 //删除所有的数据变更回调
...@@ -195,7 +193,7 @@ import distributedObject from '@ohos.data.distributedDataObject'; ...@@ -195,7 +193,7 @@ import distributedObject from '@ohos.data.distributedDataObject';
globalThis.statusCallback = (sessionId, networkId, status) => { globalThis.statusCallback = (sessionId, networkId, status) => {
globalThis.response += "status changed " + sessionId + " " + status + " " + networkId; globalThis.response += "status changed " + sessionId + " " + status + " " + networkId;
} }
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false,parent:{mother:"jack mom",father:"jack Dad"}}); var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
g_object.on("status", globalThis.statusCallback); g_object.on("status", globalThis.statusCallback);
``` ```
...@@ -218,7 +216,7 @@ off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, s ...@@ -218,7 +216,7 @@ off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, s
**示例:** **示例:**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false,parent:{mother:"jack mom",father:"jack Dad"}}); var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
globalThis.statusCallback = (sessionId, networkId, status) => { globalThis.statusCallback = (sessionId, networkId, status) => {
globalThis.response += "status changed " + sessionId + " " + status + " " + networkId; globalThis.response += "status changed " + sessionId + " " + status + " " + networkId;
} }
...@@ -248,21 +246,20 @@ save(deviceId: string, callback: AsyncCallback&lt;SaveSuccessResponse&gt;): void ...@@ -248,21 +246,20 @@ save(deviceId: string, callback: AsyncCallback&lt;SaveSuccessResponse&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 保存数据的deviceId,当deviceId为"local",代表存储在本地设备。 | | deviceId | string | 是 | 保存数据的deviceId,当deviceId为"local",代表存储在本地设备。 |
| callback | AsyncCallback&lt;[SaveSuccessResponse](#savesuccessresponse)&gt; | 是 | 回调函数。返回SaveSuccessResponse,包含sessionId、version、deviceId等信息。 | | callback | AsyncCallback&lt;[SaveSuccessResponse](#savesuccessresponse9)&gt; | 是 | 回调函数。返回SaveSuccessResponse,包含sessionId、version、deviceId等信息。 |
**示例:** **示例:**
```js
```ts import distributedObject from '@ohos.data.distributedDataObject';
import distributedObject from '@ohos.data.distributedDataObject'; var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false});
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false}); g_object.setSessionId("123456");
g_object.setSessionId("123456"); g_object.save("local", (result)=>{
g_object.save("local", (result)=>{
console.log("save callback"); console.log("save callback");
console.info("save sessionId " + result.sessionId); console.info("save sessionId " + result.sessionId);
console.info("save version " + result.version); console.info("save version " + result.version);
console.info("save deviceId " + result.deviceId); console.info("save deviceId " + result.deviceId);
}); });
``` ```
### save<sup>9+</sup> ### save<sup>9+</sup>
...@@ -285,27 +282,27 @@ save(deviceId: string): Promise&lt;SaveSuccessResponse&gt; ...@@ -285,27 +282,27 @@ save(deviceId: string): Promise&lt;SaveSuccessResponse&gt;
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 保存数据的设备号,当deviceId默认为"local",标识需要保存对象的设备。 | | deviceId | string | 是 | 保存数据的设备号,当deviceId默认为"local",标识需要保存对象的设备。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[SaveSuccessResponse](#savesuccessresponse)&gt; | Promise对象。返回SaveSuccessResponse,包含sessionId、version、deviceId等信息。| | Promise&lt;[SaveSuccessResponse](#savesuccessresponse9)&gt; | Promise对象。返回SaveSuccessResponse,包含sessionId、version、deviceId等信息。|
**示例:** **示例:**
```ts ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false}); var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false});
g_object.setSessionId("123456"); g_object.setSessionId("123456");
g_object.save("local").then((result)=>{ g_object.save("local").then((result)=>{
console.log("save callback"); console.log("save callback");
console.info("save sessionId " + result.sessionId); console.info("save sessionId " + result.sessionId);
console.info("save version " + result.version); console.info("save version " + result.version);
console.info("save deviceId " + result.deviceId); console.info("save deviceId " + result.deviceId);
}, ()=>{ }, ()=>{
console.error("save failed"); console.error("save failed");
}); });
``` ```
### revokeSave<sup>9+</sup> ### revokeSave<sup>9+</sup>
...@@ -321,18 +318,18 @@ revokeSave(callback: AsyncCallback&lt;SaveSuccessResponse&gt;): void ...@@ -321,18 +318,18 @@ revokeSave(callback: AsyncCallback&lt;SaveSuccessResponse&gt;): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[RevokeSaveSuccessResponse](#revokesavesuccessresponse)&gt; | 否 | 回调函数。返回RevokeSaveSuccessResponse,包含sessionId。 | | callback | AsyncCallback&lt;[RevokeSaveSuccessResponse](#revokesavesuccessresponse9)&gt; | 否 | 回调函数。返回RevokeSaveSuccessResponse,包含sessionId。 |
**示例:** **示例:**
```ts ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false}); var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false});
g_object.setSessionId("123456"); g_object.setSessionId("123456");
g_object.revokeSave((result, data) =>{ g_object.revokeSave((result, data) =>{
console.log("revokeSave callback"); console.log("revokeSave callback");
}); });
``` ```
### revokeSave<sup>9+</sup> ### revokeSave<sup>9+</sup>
...@@ -345,22 +342,22 @@ revokeSave(): Promise&lt;SaveSuccessResponse&gt; ...@@ -345,22 +342,22 @@ revokeSave(): Promise&lt;SaveSuccessResponse&gt;
**系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。 **系统能力:** SystemCapability.DistributedDataManager.DataObject.DistributedObject。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[RevokeSaveSuccessResponse](#revokesavesuccessresponse)&gt; | Promise对象。返回RevokeSaveSuccessResponse,包含sessionId。 | | Promise&lt;[RevokeSaveSuccessResponse](#revokesavesuccessresponse9)&gt; | Promise对象。返回RevokeSaveSuccessResponse,包含sessionId。 |
**示例:** **示例:**
```ts ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false}); var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false});
g_object.setSessionId("123456"); g_object.setSessionId("123456");
g_object.revokeSave("local").then((result)=>{ g_object.revokeSave("local").then((result)=>{
console.log("revokeSave callback"); console.log("revokeSave callback");
console.log("sessionId" + result.sessionId); console.log("sessionId" + result.sessionId);
}, ()=>{ }, ()=>{
console.error("revokeSave failed"); console.error("revokeSave failed");
}); });
``` ```
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册