Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
a42ee8bf
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
a42ee8bf
编写于
3月 21, 2022
作者:
W
wuyongning
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update files
Signed-off-by:
N
wuyongning
<
wuyongning@huawei.com
>
上级
7fe79ddb
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
36 addition
and
24 deletion
+36
-24
zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md
...tion-dev/reference/apis/js-apis-data-distributedobject.md
+36
-24
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-data-distributedobject.md
浏览文件 @
a42ee8bf
...
...
@@ -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 |
<br>
true:标识设置sessionId成功
<br>
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
&
lt
;
string
&
gt
;
}
>
): void
监听分布式对象的变更
,type需固定为'change',callback是变更时触发的回调,回调参数sessionId标识变更对象的sessionId,fields标识对象变更的属性名
监听分布式对象的变更
。
**系统能力**
:SystemCapability.DistributedDataManager.DataObject.DistributedObject。
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 事件类型,固定为'change',表示数据变更。 |
| callback | Callback
<
{
sessionId:
string
,
fields:
Array
&
lt
;
string
&
gt
;
}
>
| 是 | 变更回调对象实例。 |
| callback | Callback
<
{
sessionId:
string
,
fields:
Array
&
lt
;
string
&
gt
;
}
>
| 是 | 变更回调对象实例。
<br>
sessionId:标识变更对象的sessionId
<br>
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
&
lt
;
string
&
gt
;
}
>
): void
当不再进行数据变更监听时,使用此接口删除对象的变更监听
,type固定为'change',callback为可选参数,若不设置则表示删除该对象所有的变更监听
当不再进行数据变更监听时,使用此接口删除对象的变更监听
。
**系统能力**
:SystemCapability.DistributedDataManager.DataObject.DistributedObject。
-
参数:
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 事件类型,固定为'change',表示数据变更。 |
| callback | Callback
<
{
sessionId:
string
,
fields:
Array
&
lt
;
string
&
gt
;
}
>
| 否 | 需要删除的变更回调,若不设置则删除该对象所有的变更回调。 |
-
示例:
**示例:**
```
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
'
}
>
| 是 | 监听上下线回调实例。
<br>
sessionId:标识变更对象的sessionId
<br>
networkId:标识对象设备的networkId
<br>
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
)
{
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录