分布式数据对象


分布式数据对象

说明: 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import distributedObject from '@ohos.data.distributedDataObject';
1

distributedDataObject.createDistributedObject

createDistributedObject(source: object): DistributedObject

创建一个分布式对象。

系统能力: SystemCapability.DistributedDataManager.DataObject.DistributedObject。

参数:

参数名 类型 必填 说明
source object 设置distributedObject的属性。

返回值:

类型 说明
DistributedObject 创建完成的分布式对象。

示例:

import distributedObject from '@ohos.data.distributedDataObject'
// 创建对象,对象包含4个属性类型,string,number,boolean和Object
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, 
               parent:{mother:"jack mom",father:"jack Dad"}});
1
2
3
4

distributedObject.genSessionId()

genSessionId(): string

随机创建一个sessionId。

系统能力: SystemCapability.DistributedDataManager.DataObject.DistributedObject。

返回值:

类型 说明
string 随机创建的sessionId。

示例:

import distributedObject from '@ohos.data.distributedDataObject'
var sessionId = distributedObject.genSessionId();
1
2

DistributedObject

表示一个分布式对象。

setSessionId

setSessionId(sessionId?: string): boolean

设置同步的sessionId,当可信组网中有多个设备时,多个设备间的对象如果设置为同一个sessionId,就能自动同步。

系统能力: SystemCapability.DistributedDataManager.DataObject.DistributedObject。

参数:

参数名 类型 必填 说明
sessionId string 分布式对象在可信组网中的标识ID。如果要退出分布式组网,设置为""或不设置均可。

返回值:

类型 说明
boolean true:标识设置sessionId成功;
false:标识设置sessionId失败。

示例:

import distributedObject from '@ohos.data.distributedDataObject'
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, 
               parent:{mother:"jack mom",father:"jack Dad"}});
//g_object加入分布式组网
g_object.setSessionId(distributedObject.genSessionId());
//设置为""退出分布式组网
g_object.setSessionId("");
1
2
3
4
5
6
7

on('change')

on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<string> }>): void

监听分布式对象的变更。

系统能力: SystemCapability.DistributedDataManager.DataObject.DistributedObject。

参数:

参数名 类型 必填 说明
type string 事件类型,固定为'change',表示数据变更。
callback Callback<{ sessionId: string, fields: Array<string> }> 变更回调对象实例。
sessionId:标识变更对象的sessionId;
fields:标识对象变更的属性名。

示例:

import distributedObject from '@ohos.data.distributedDataObject'
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, 
               parent:{mother:"jack mom",father:"jack Dad"}});
g_object.on("change", function (sessionId, changeData) {
    console.info("change" + sessionId);  
    if (changeData != null && changeData != undefined) {
        changeData.forEach(element => {
            console.info("changed !" + element + " " + g_object[element]);
        });
    }
});
1
2
3
4
5
6
7
8
9
10
11

off('change')

off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<string> }>): void

当不再进行数据变更监听时,使用此接口删除对象的变更监听。

系统能力: SystemCapability.DistributedDataManager.DataObject.DistributedObject。

参数:

参数名 类型 必填 说明
type string 事件类型,固定为'change',表示数据变更。
callback Callback<{ sessionId: string, fields: Array<string> }> 需要删除的变更回调,若不设置则删除该对象所有的变更回调。
sessionId:标识变更对象的sessionId;
fields:标识对象变更的属性名。

示例:

import distributedObject from '@ohos.data.distributedDataObject'
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, 
               parent:{mother:"jack mom",father:"jack Dad"}});
g_object.on("change", function (sessionId, changeData) {
    console.info("change" + sessionId);
});
//删除变更回调changeCallback
g_object.off("change", function (sessionId, changeData) {
    console.info("change" + sessionId);
});
//删除所有的变更回调
g_object.off("change");
1
2
3
4
5
6
7
8
9
10
11
12

on('status')

on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, status: 'online' | 'offline' }>): void

监听分布式对象的上下线。

系统能力: SystemCapability.DistributedDataManager.DataObject.DistributedObject。

参数:

参数名 类型 必填 说明
type string 事件类型,固定为'status',表示对象上下线。
callback Callback<{ sessionId: string, networkId: string, status: 'online' | 'offline' }> 监听上下线回调实例。
sessionId:标识变更对象的sessionId;
networkId:标识对象设备的networkId;
status:标识对象为'online'(上线)或'offline'(下线)的状态。

示例:

import distributedObject from '@ohos.data.distributedDataObject'
var g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, 
               parent:{mother:"jack mom",father:"jack Dad"}});
g_object.on("status", function (sessionId, networkid, status) {
    this.response += "status changed " + sessionId + " " + status + " " + networkId;
});
1
2
3
4
5
6

off('status')

off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, status: 'online' | 'offline' }>): void

当不再进行对象上下线监听时,使用此接口删除对象的上下线监听。

系统能力: SystemCapability.DistributedDataManager.DataObject.DistributedObject。

参数:

参数名 类型 必填 说明
type string 事件类型,固定为'status',表示对象上下线。
callback Callback<{ sessionId: string, deviceId: string, status: 'online' | 'offline' }> 需要删除的上下线回调,若不设置则删除该对象所有的上下线回调。
sessionId:标识变更对象的sessionId;
deviceId:标识变更对象的deviceId;
status:标识对象为'online'(上线)或'offline'(下线)的状态。

示例:

import distributedObject from '@ohos.data.distributedDataObject'  
g_object.on("status", function (sessionId, networkId, status) {
    this.response += "status changed " + sessionId + " " + status + " " + networkId;
});
//删除上下线回调changeCallback
g_object.off("status", function (sessionId, networkId, status) {
    this.response += "status changed " + sessionId + " " + status + " " + networkId;
});
//删除所有的上下线回调
g_object.off("status");
1
2
3
4
5
6
7
8
9
10