# @ohos.data.distributedDataObject (分布式数据对象) 本模块提供管理基本数据对象的相关能力，包括创建、查询、删除、修改、订阅等；同时支持相同应用多设备间的分布式数据对象协同能力。 > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 ```ts import { distributedDataObject } from '@kit.ArkData'; ``` ## distributedDataObject.create9+ create(context: Context, source: object): DataObject 创建一个分布式数据对象。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | context | Context | 是 | 应用的上下文。
FA模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](../apis-ability-kit/js-apis-inner-application-uiAbilityContext.md)。 | | source | object | 是 | 设置分布式数据对象的属性。 | **返回值：** | 类型 | 说明 | | -------- | -------- | | [DataObject](#dataobject) | 创建完成的分布式数据对象。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | **示例：** FA模型示例： ```ts // 导入模块 import { featureAbility } from '@kit.AbilityKit'; import { BusinessError } from '@kit.BasicServicesKit'; // 获取context let context = featureAbility.getContext(); class SourceObject { name: string age: number isVis: boolean constructor(name: string, age: number, isVis: boolean) { this.name = name this.age = age this.isVis = isVis } } let source: SourceObject = new SourceObject("jack", 18, false); let g_object: distributedDataObject.DataObject = distributedDataObject.create(context, source); ``` Stage模型示例： ```ts // 导入模块 import { UIAbility } from '@kit.AbilityKit'; import { BusinessError } from '@kit.BasicServicesKit'; import { window } from '@kit.ArkUI'; let g_object: distributedDataObject.DataObject|null = null; class SourceObject { name: string age: number isVis: boolean constructor(name: string, age: number, isVis: boolean) { this.name = name this.age = age this.isVis = isVis } } class EntryAbility extends UIAbility { onWindowStageCreate(windowStage: window.WindowStage) { let source: SourceObject = new SourceObject("jack", 18, false); g_object = distributedDataObject.create(this.context, source); } } ``` ## distributedDataObject.genSessionId genSessionId(): string 随机创建一个sessionId。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **返回值：** | 类型 | 说明 | | -------- | -------- | | string | 随机创建的sessionId。 | **示例：** ```ts let sessionId: string = distributedDataObject.genSessionId(); ``` ## SaveSuccessResponse9+ [save](#save9)接口回调信息。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | sessionId | string | 是 | 多设备协同的唯一标识。 | | version | number | 是 | 已保存对象的版本。 | | deviceId | string | 是 | 存储数据的设备号，标识需要保存对象的设备。"local"表示本地设备，否则表示其他设备的设备号。 | ## RevokeSaveSuccessResponse9+ [revokeSave](#revokesave9)接口回调信息。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | sessionId | string | 是 | 多设备协同的唯一标识。 | ## BindInfo11+ 数据库的绑定信息。当前版本只支持关系型数据库。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject | 名称 | 类型 | 只读 | 可选 | 说明 | | ---------- | ------------------------------------------------------------------ | ---- | ---- | ------------------------------------ | | storeName | string | 否 | 否 | 待绑定资产在所属的数据库中的库名。 | | tableName | string | 否 | 否 | 待绑定资产在所属的数据库中的表名。 | | primaryKey | [commonType.ValuesBucket](js-apis-data-commonType.md#valuesbucket) | 否 | 否 | 待绑定资产在所属的数据库中的主键。 | | field | string | 否 | 否 | 待绑定资产在所属的数据库中的列名。 | | assetName | string | 否 | 否 | 待绑定资产在所属的数据库中的资产名。 | ## DataObject 表示一个分布式数据对象。在使用以下接口前，需调用[create()](#distributeddataobjectcreate9)获取DataObject对象。 ### setSessionId9+ setSessionId(sessionId: string, callback: AsyncCallback<void>): void 设置sessionId，使用callback方式异步回调。当可信组网中有多个设备处于协同状态时，如果多个设备间的分布式对象设置为同一个sessionId，就能自动同步。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | -------------------------------------------------------------------------------------------------------------- | | sessionId | string | 是 | 分布式数据对象在可信组网中的标识ID，长度不大于128，且只能包含字母数字或下划线_。设置为""时表示退出分布式组网。 | | callback | AsyncCallback<void> | 是 | 加入session的异步回调。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[分布式数据对象错误码](errorcode-distributed-dataObject.md)。 | 错误码ID | 错误信息 | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 201 | Permission verification failed. | | 401 | Parameter error. Possible causes: 1. Incorrect parameter types; 2. The sessionId allows only letters, digits, and underscores(_), and cannot exceed 128 in length. | | 15400001 | Failed to create the in-memory database. | **示例：** ```ts // g_object加入分布式组网 g_object.setSessionId(distributedDataObject.genSessionId(), ()=>{ console.info("join session"); }); // g_object退出分布式组网 g_object.setSessionId("", ()=>{ console.info("leave all session"); }); ``` ### setSessionId9+ setSessionId(callback: AsyncCallback<void>): void 退出所有已加入的session，使用callback方式异步回调。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<void> | 是 | 退出所有已加入session的异步回调。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[分布式数据对象错误码](errorcode-distributed-dataObject.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 201 | Permission verification failed. | | 401 | Parameter error. Incorrect parameter types. | | 15400001 | Failed to create the in-memory database. | **示例：** ```ts // g_object加入分布式组网 g_object.setSessionId(distributedDataObject.genSessionId(), ()=>{ console.info("join session"); }); // 退出分布式组网 g_object.setSessionId(() => { console.info("leave all session."); }); ``` ### setSessionId9+ setSessionId(sessionId?: string): Promise<void> 设置sessionId，使用Promise异步返回。当可信组网中有多个设备处于协同状态时，如果多个设备间的分布式对象设置为同一个sessionId，就能自动同步。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------------------------------------------------------------------------------------------------------------------------- | | sessionId | string | 否 | 分布式数据对象在可信组网中的标识ID，长度不大于128，且只能包含字母数字或下划线_。如果要退出分布式组网，设置为""或不设置均可。 | **返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<void> | Promise对象。| **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[分布式数据对象错误码](errorcode-distributed-dataObject.md)。 | 错误码ID | 错误信息 | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | 201 | Permission verification failed. | | 401 | Parameter error. Possible causes: 1. Incorrect parameter types; 2. The sessionId allows only letters, digits, and underscores(_), and cannot exceed 128 in length. | | 15400001 | Failed to create the in-memory database. | **示例：** ```ts // g_object加入分布式组网 g_object.setSessionId(distributedDataObject.genSessionId()).then (()=>{ console.info("join session."); }).catch((error: BusinessError)=>{ console.info("error:" + error.code + error.message); }); // 退出分布式组网 g_object.setSessionId().then (()=>{ console.info("leave all session."); }).catch((error: BusinessError)=>{ console.info("error:" + error.code + error.message); }); ``` ### on('change')9+ on(type: 'change', callback: (sessionId: string, fields: Array<string>) => void): void 监听分布式数据对象的数据变更。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'change'，表示数据变更。 | | callback | Function | 是 | 变更回调对象实例。
sessionId：标识变更对象的sessionId；
fields：标识对象变更的属性名。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | **示例：** ```ts g_object.on("change", (sessionId: string, fields: Array) => { console.info("change" + sessionId); if (g_object != null && fields != null && fields != undefined) { for (let index: number = 0; index < fields.length; index++) { console.info("changed !" + fields[index] + " " + g_object[fields[index]]); } } }); ``` ### off('change')9+ off(type: 'change', callback?: (sessionId: string, fields: Array<string>) => void): void 当不再进行数据变更监听时，使用此接口删除对象的变更监听。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'change'，表示数据变更。 | | callback | Function | 否 | 需要删除的数据变更回调，若不设置则删除该对象所有的数据变更回调。
sessionId：标识变更对象的sessionId；
fields：标识对象变更的属性名。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | **示例：** ```ts // 删除数据变更回调changeCallback g_object.off("change", (sessionId: string, fields: Array) => { console.info("change" + sessionId); if (g_object != null && fields != null && fields != undefined) { for (let index: number = 0; index < fields.length; index++) { console.info("changed !" + fields[index] + " " + g_object[fields[index]]); } } }); // 删除所有的数据变更回调 g_object.off("change"); ``` ### on('status')9+ on(type: 'status', callback: (sessionId: string, networkId: string, status: 'online' \| 'offline' ) => void): void 监听分布式数据对象的上下线。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'status'，表示对象上下线。 | | callback | Function | 是 | 监听上下线回调实例。
sessionId：标识变更对象的sessionId；
networkId：标识对象设备；
status：标识对象为'online'(上线)或'offline'(下线)的状态。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | **示例：** ```ts g_object.on("status", (sessionId: string, networkId: string, status: 'online' | 'offline') => { console.info("status changed " + sessionId + " " + status + " " + networkId); }); ``` ### off('status')9+ off(type: 'status', callback?:(sessionId: string, networkId: string, status: 'online' \| 'offline') => void): void 当不再进行对象上下线监听时，使用此接口删除对象的上下线监听。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'status'，表示对象上下线。 | | callback | Function | 否 | 需要删除的上下线回调，若不设置则删除该对象所有的上下线回调。
sessionId：标识变更对象的sessionId；
networkId：标识变更对象；
status：标识对象为'online'(上线)或'offline'(下线)的状态。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | **示例：** ```ts // 删除上下线回调changeCallback g_object.off("status", (sessionId: string, networkId: string, status: 'online' | 'offline') => { console.info("status changed " + sessionId + " " + status + " " + networkId); }); // 删除所有的上下线回调 g_object.off("status"); ``` ### save9+ save(deviceId: string, callback: AsyncCallback<SaveSuccessResponse>): void 保存分布式数据对象。使用callback方式异步回调。 对象数据保存成功后，当应用存在时不会释放对象数据，当应用退出后，重新进入应用时，恢复保存在设备上的数据。 有以下几种情况时，保存的数据将会被释放： - 存储时间超过24小时。 - 应用卸载。 - 成功恢复数据之后。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 保存数据的deviceId，当deviceId为"local"，代表存储在本地设备。 | | callback | AsyncCallback<[SaveSuccessResponse](#savesuccessresponse9)> | 是 | 回调函数。返回SaveSuccessResponse，包含sessionId、version、deviceId等信息。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | | 801 | Capability not supported. | **示例：** ```ts g_object.setSessionId("123456"); g_object.save("local", (err: BusinessError, result:distributedDataObject.SaveSuccessResponse) => { if (err) { console.info("save failed, error code = " + err.code); console.info("save failed, error message: " + err.message); return; } console.info("save callback"); console.info("save sessionId: " + result.sessionId); console.info("save version: " + result.version); console.info("save deviceId: " + result.deviceId); }); ``` ### save9+ save(deviceId: string): Promise<SaveSuccessResponse> 保存分布式数据对象。使用Promise方式作为异步回调。 对象数据保存成功后，当应用存在时不会释放对象数据，当应用退出后，重新进入应用时，恢复保存在设备上的数据。 有以下几种情况时，保存的数据将会被释放： - 存储时间超过24小时。 - 应用卸载。 - 成功恢复数据之后。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | deviceId | string | 是 | 保存数据的设备号，当deviceId默认为"local"，标识需要保存对象的设备。 | **返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<[SaveSuccessResponse](#savesuccessresponse9)> | Promise对象。返回SaveSuccessResponse，包含sessionId、version、deviceId等信息。| **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | | 801 | Capability not supported. | **示例：** ```ts g_object.setSessionId("123456"); g_object.save("local").then((result: distributedDataObject.SaveSuccessResponse) => { console.info("save callback"); console.info("save sessionId " + result.sessionId); console.info("save version " + result.version); console.info("save deviceId " + result.deviceId); }).catch((err: BusinessError) => { console.info("save failed, error code = " + err.code); console.info("save failed, error message: " + err.message); }); ``` ### revokeSave9+ revokeSave(callback: AsyncCallback<RevokeSaveSuccessResponse>): void 撤回保存的分布式数据对象。使用callback方式作为异步方法。 如果对象保存在本地设备，那么将删除所有受信任设备上所保存的数据。 如果对象保存在其他设备，那么将删除本地设备上的数据。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[RevokeSaveSuccessResponse](#revokesavesuccessresponse9)> | 是 | 回调函数。返回RevokeSaveSuccessResponse，包含sessionId。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Incorrect parameter types. | | 801 | Capability not supported. | **示例：** ```ts g_object.setSessionId("123456"); // 持久化数据 g_object.save("local", (err: BusinessError, result: distributedDataObject.SaveSuccessResponse) => { if (err) { console.info("save failed, error code = " + err.code); console.info("save failed, error message: " + err.message); return; } console.info("save callback"); console.info("save sessionId: " + result.sessionId); console.info("save version: " + result.version); console.info("save deviceId: " + result.deviceId); }); // 删除持久化保存的数据 g_object.revokeSave((err: BusinessError, result: distributedDataObject.RevokeSaveSuccessResponse) => { if (err) { console.info("revokeSave failed, error code = " + err.code); console.info("revokeSave failed, error message: " + err.message); return; } console.info("revokeSave callback"); console.info("revokeSave sessionId " + result.sessionId); }); ``` ### revokeSave9+ revokeSave(): Promise<RevokeSaveSuccessResponse> 撤回保存的分布式数据对象。使用Promise方式作为异步方法。 如果对象保存在本地设备，那么将删除所有受信任设备上所保存的数据。 如果对象保存在其他设备，那么将删除本地设备上的数据。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **返回值：** | 类型 | 说明 | | -------- | -------- | | Promise<[RevokeSaveSuccessResponse](#revokesavesuccessresponse9)> | Promise对象。返回RevokeSaveSuccessResponse，包含sessionId。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 801 | Capability not supported. | **示例：** ```ts g_object.setSessionId("123456"); // 持久化数据 g_object.save("local").then((result: distributedDataObject.SaveSuccessResponse) => { console.info("save callback"); console.info("save sessionId " + result.sessionId); console.info("save version " + result.version); console.info("save deviceId " + result.deviceId); }).catch((err: BusinessError) => { console.info("save failed, error code = " + err.code); console.info("save failed, error message: " + err.message); }); // 删除持久化保存的数据 g_object.revokeSave().then((result: distributedDataObject.RevokeSaveSuccessResponse) => { console.info("revokeSave callback"); console.info("sessionId" + result.sessionId); }).catch((err: BusinessError)=> { console.info("revokeSave failed, error code = " + err.code); console.info("revokeSave failed, error message = " + err.message); }); ``` ### bindAssetStore11+ bindAssetStore(assetKey: string, bindInfo: BindInfo, callback: AsyncCallback<void>): void 绑定分布式对象中的单个资产与其对应的数据库信息，当前版本只支持分布式对象中的资产与关系型数据库的绑定。使用callback方式异步回调。 当分布式对象中包含的资产和关系型数据库中包含的资产指向同一个实体资产文件，即两个资产的Uri相同时，就会存在冲突，我们把这种资产称为融合资产。如果需要分布式数据管理进行融合资产的冲突解决，需要先进行资产的绑定。当应用退出session后，绑定关系随之消失。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------------------------------------------------------------------------- | | assetKey | string | 是 | 待绑定的融合资产在分布式对象中的键值。 | | bindInfo | [BindInfo](#bindinfo11) | 是 | 待绑定的融合资产在数据库中的信息，包含库名、表名、主键、列名及在数据库中的资产名。 | | callback | AsyncCallback<void> | 是 | 绑定数据库的回调。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | | 801 | Capability not supported. | **示例：** ```ts import { UIAbility } from '@kit.AbilityKit'; import { window } from '@kit.ArkUI'; import { commonType } from '@kit.ArkData'; import { BusinessError } from '@kit.BasicServicesKit'; class Note { title: string | undefined text: string | undefined attachment: commonType.Asset | undefined constructor(title: string | undefined, text: string | undefined, attachment: commonType.Asset | undefined) { this.title = title; this.text = text; this.attachment = attachment; } } class EntryAbility extends UIAbility { onWindowStageCreate(windowStage: window.WindowStage) { let attachment: commonType.Asset = { name: 'test_img.jpg', uri: 'file://com.example.myapplication/data/storage/el2/distributedfiles/dir/test_img.jpg', path: '/dir/test_img.jpg', createTime: '2024-01-02 10:00:00', modifyTime: '2024-01-02 10:00:00', size: '5', status: commonType.AssetStatus.ASSET_NORMAL } let note: Note = new Note('test', 'test', attachment); let g_object: distributedDataObject.DataObject = distributedDataObject.create(this.context, note); g_object.setSessionId('123456'); const bindInfo: distributedDataObject.BindInfo = { storeName: 'notepad', tableName: 'note_t', primaryKey: { 'uuid': '00000000-0000-0000-0000-000000000000' }, field: 'attachment', assetName: attachment.name as string } g_object.bindAssetStore('attachment', bindInfo, (err: BusinessError) => { if (err) { console.error('bindAssetStore failed.'); } console.info('bindAssetStore success.'); }); } } ``` ### bindAssetStore11+ bindAssetStore(assetKey: string, bindInfo: BindInfo): Promise<void> 绑定分布式对象中的单个资产与其对应的数据库信息，当前版本只支持分布式对象中的资产与关系型数据库的绑定。使用Promise方式作为异步回调。 当分布式对象中包含的资产和关系型数据库中包含的资产指向同一个实体资产文件，即两个资产的Uri相同时，就会存在冲突，我们把这种资产称为融合资产。如果需要分布式数据管理进行融合资产的冲突解决，需要先进行资产的绑定。当应用退出session后，绑定关系随之消失。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ---------------------------------------------------------------------------------- | | assetKey | string | 是 | 待绑定的融合资产在分布式对象中的键值。 | | bindInfo | [BindInfo](#bindinfo11) | 是 | 待绑定的融合资产在数据库中的信息，包含库名、表名、主键、列名及在数据库中的资产名。 | **返回值：** | 类型 | 说明 | | ------------------- | ------------- | | Promise<void> | 无返回结果的Promise对象。 | **错误码：** 以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 | 错误码ID | 错误信息 | | -------- | -------- | | 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. | | 801 | Capability not supported. | **示例:** ```ts import { UIAbility } from '@kit.AbilityKit'; import { window } from '@kit.ArkUI'; import { commonType } from '@kit.ArkData'; import { BusinessError } from '@kit.BasicServicesKit'; class Note { title: string | undefined text: string | undefined attachment: commonType.Asset | undefined constructor(title: string | undefined, text: string | undefined, attachment: commonType.Asset | undefined) { this.title = title; this.text = text; this.attachment = attachment; } } class EntryAbility extends UIAbility { onWindowStageCreate(windowStage: window.WindowStage) { let attachment: commonType.Asset = { name: 'test_img.jpg', uri: 'file://com.example.myapplication/data/storage/el2/distributedfiles/dir/test_img.jpg', path: '/dir/test_img.jpg', createTime: '2024-01-02 10:00:00', modifyTime: '2024-01-02 10:00:00', size: '5', status: commonType.AssetStatus.ASSET_NORMAL } let note: Note = new Note('test', 'test', attachment); let g_object: distributedDataObject.DataObject = distributedDataObject.create(this.context, note); g_object.setSessionId('123456'); const bindInfo: distributedDataObject.BindInfo = { storeName: 'notepad', tableName: 'note_t', primaryKey: { 'uuid': '00000000-0000-0000-0000-000000000000' }, field: 'attachment', assetName: attachment.name as string } g_object.bindAssetStore("attachment", bindInfo).then(() => { console.info('bindAssetStore success.'); }).catch((err: BusinessError) => { console.error("bindAssetStore failed, error code = " + err.code); }); } } ``` ## distributedDataObject.createDistributedObject(deprecated) createDistributedObject(source: object): DistributedObject 创建一个分布式数据对象。 > **说明：** > > 从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用[distributedDataObject.create](#distributeddataobjectcreate9)替代。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | source | object | 是 | 设置分布式数据对象的属性。 | **返回值：** | 类型 | 说明 | | -------- | -------- | | [DistributedObject](#distributedobjectdeprecated) | 创建完成的分布式数据对象。 | **示例：** ```ts class SourceObject { name: string age: number isVis: boolean constructor(name: string, age: number, isVis: boolean) { this.name = name this.age = age this.isVis = isVis } } let source: SourceObject = new SourceObject("jack", 18, false); let g_object: distributedDataObject.DistributedObject = distributedDataObject.createDistributedObject(source); ``` ## DistributedObject(deprecated) 表示一个分布式数据对象。在使用以下接口前，需调用[createDistributedObject()](#distributeddataobjectcreatedistributedobjectdeprecated)获取DistributedObject对象。 ### setSessionId(deprecated) setSessionId(sessionId?: string): boolean 设置sessionId。当可信组网中有多个设备处于协同状态时，如果多个设备间的分布式对象设置为同一个sessionId，就能自动同步。 > **说明：** > > 从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用[setSessionId](#setsessionid9)替代。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | sessionId | string | 否 | 分布式数据对象在可信组网中的标识ID。如果要退出分布式组网，设置为""或不设置均可。 | **返回值：** | 类型 | 说明 | | -------- | -------- | | boolean | true：标识设置sessionId成功。
false：标识设置sessionId失败。 | **示例：** ```ts class SourceObject { name: string age: number isVis: boolean constructor(name: string, age: number, isVis: boolean) { this.name = name this.age = age this.isVis = isVis } } let source: SourceObject = new SourceObject("jack", 18, false); let g_object: distributedDataObject.DistributedObject = distributedDataObject.createDistributedObject(source); // g_object加入分布式组网 g_object.setSessionId(distributedDataObject.genSessionId()); // 设置为""退出分布式组网 g_object.setSessionId(""); ``` ### on('change')(deprecated) on(type: 'change', callback: (sessionId: string, fields: Array<string>) => void): void 监听分布式数据对象的变更。 > **说明：** > > 从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用[on('change')](#onchange9)替代。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'change'，表示数据变更。 | | callback | Function | 是 | 变更回调对象实例。
sessionId：标识变更对象的sessionId；
fields：标识对象变更的属性名。 | **示例：** ```ts class SourceObject { name: string age: number isVis: boolean constructor(name: string, age: number, isVis: boolean) { this.name = name this.age = age this.isVis = isVis } } let source: SourceObject = new SourceObject("jack", 18, false); let g_object: distributedDataObject.DistributedObject = distributedDataObject.createDistributedObject(source); g_object.on("change", (sessionId: string, fields: Array) => { console.info("change" + sessionId); if (fields != null && fields != undefined) { for (let index: number = 0; index < fields.length; index++) { console.info("changed !" + fields[index] + " " + g_object[fields[index]]); } } }); ``` ### off('change')(deprecated) off(type: 'change', callback?: (sessionId: string, fields: Array<string>) => void): void 当不再进行数据变更监听时，使用此接口删除对象的变更监听。 > **说明：** > > 从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用[off('change')](#offchange9)替代。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'change'，表示数据变更。 | | callback | Function | 否 | 需要删除的数据变更回调，若不设置则删除该对象所有的数据变更回调。
sessionId：标识变更对象的sessionId；
fields：标识对象变更的属性名。 | **示例：** ```ts class SourceObject { name: string age: number isVis: boolean constructor(name: string, age: number, isVis: boolean) { this.name = name this.age = age this.isVis = isVis } } let source: SourceObject = new SourceObject("jack", 18, false); let g_object: distributedDataObject.DistributedObject = distributedDataObject.createDistributedObject(source); // 删除数据变更回调changeCallback g_object.off("change", (sessionId: string, fields: Array) => { console.info("change" + sessionId); if (fields != null && fields != undefined) { for (let index: number = 0; index < fields.length; index++) { console.info("changed !" + fields[index] + " " + g_object[fields[index]]); } } }); // 删除所有的数据变更回调 g_object.off("change"); ``` ### on('status')(deprecated) on(type: 'status', callback: (sessionId: string, networkId: string, status: 'online' | 'offline' ) => void): void 监听分布式数据对象的上下线。 > **说明：** > > 从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用[on('status')](#onstatus9)替代。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'status'，表示对象上下线。 | | callback | Function | 是 | 监听上下线回调实例。
sessionId：标识变更对象的sessionId；
networkId：标识对象设备；
status：标识对象为'online'(上线)或'offline'(下线)的状态。 | **示例：** ```ts class SourceObject { name: string age: number isVis: boolean constructor(name: string, age: number, isVis: boolean) { this.name = name this.age = age this.isVis = isVis } } let source: SourceObject = new SourceObject("jack", 18, false); let g_object: distributedDataObject.DistributedObject = distributedDataObject.createDistributedObject(source); g_object.on("status", (sessionId: string, networkId: string, status: 'online' | 'offline') => { console.info("status changed " + sessionId + " " + status + " " + networkId); }); ``` ### off('status')(deprecated) off(type: 'status', callback?: (sessionId: string, networkId: string, status: 'online' | 'offline' ) => void): void 当不再进行对象上下线监听时，使用此接口删除对象的上下线监听。 > **说明：** > > 从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用[off('status')](#offstatus9)替代。 **系统能力：** SystemCapability.DistributedDataManager.DataObject.DistributedObject **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 事件类型，固定为'status'，表示对象上下线。 | | callback | Function | 否 | 需要删除的上下线回调，若不设置则删除该对象所有的上下线回调。
sessionId：标识变更对象的sessionId；
networkId：标识变更对象；
status：标识对象为'online'(上线)或'offline'(下线)的状态。 | **示例：** ```ts class SourceObject { name: string age: number isVis: boolean constructor(name: string, age: number, isVis: boolean) { this.name = name this.age = age this.isVis = isVis } } let source: SourceObject = new SourceObject("jack", 18, false); let g_object: distributedDataObject.DistributedObject = distributedDataObject.createDistributedObject(source); // 删除上下线回调changeCallback g_object.off("status", (sessionId: string, networkId: string, status: 'online' | 'offline') => { console.info("status changed " + sessionId + " " + status + " " + networkId); }); // 删除所有的上下线回调 g_object.off("status"); ```