基本數(shù)據(jù)對象的相關(guān)能力

導(dǎo)入模塊

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

distributedObject.create9+

create(context: Context, source: object): DataObject

創(chuàng)建一個分布式數(shù)據(jù)對象。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

返回值：

示例：

FA模型示例：

// 導(dǎo)入模塊
import distributedObject from '@ohos.data.distributedDataObject';
import featureAbility from '@ohos.ability.featureAbility';
// 獲取context
let context = featureAbility.getContext();
// 創(chuàng)建對象，該對象包含4個屬性類型：string、number、boolean和Object
let g_object = distributedObject.create(context, {name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});

Stage模型示例：

// 導(dǎo)入模塊
import distributedObject from '@ohos.data.distributedDataObject';
import UIAbility from '@ohos.app.ability.UIAbility';

let g_object = null;

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage){
        // 創(chuàng)建對象，該對象包含4個屬性類型：string、number、boolean和Object
        g_object = distributedObject.create(this.context, {name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
    }
}

distributedObject.genSessionId

genSessionId(): string

隨機創(chuàng)建一個sessionId。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

返回值：

示例：

import distributedObject from '@ohos.data.distributedDataObject';
let sessionId = distributedObject.genSessionId();

SaveSuccessResponse9+

save接口回調(diào)信息。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

RevokeSaveSuccessResponse9+

revokeSave接口回調(diào)信息。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

DataObject

表示一個分布式數(shù)據(jù)對象。在使用以下接口前，需調(diào)用create()獲取DataObject對象。

setSessionId9+

setSessionId(sessionId: string, callback: AsyncCallback<void>): void

設(shè)置sessionId，使用callback異步回調(diào)。當(dāng)可信組網(wǎng)中有多個設(shè)備時，多個設(shè)備間的對象如果設(shè)置為同一個sessionId，就能自動同步。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹參見分布式數(shù)據(jù)對象錯誤碼。

示例：

// g_object加入分布式組網(wǎng)
g_object.setSessionId(distributedObject.genSessionId(), ()=>{
    console.info("join session");
});
// 退出分布式組網(wǎng)
g_object.setSessionId(() => {
    console.info("leave all session."); 
});

setSessionId9+

setSessionId(callback: AsyncCallback<void>): void

退出所有已加入的session，使用callback方式異步回調(diào)。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹參見分布式數(shù)據(jù)對象錯誤碼。

示例：

// g_object加入分布式組網(wǎng)
g_object.setSessionId(distributedObject.genSessionId(), ()=>{
    console.info("join session");
});
// 退出分布式組網(wǎng)
g_object.setSessionId(() => {
    console.info("leave all lession.");
});

setSessionId9+

setSessionId(sessionId?: string): Promise<void>

設(shè)置sessionId，使用Promise異步回調(diào)。當(dāng)可信組網(wǎng)中有多個設(shè)備時，多個設(shè)備間的對象如果設(shè)置為同一個sessionId，就能自動同步。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹參見分布式數(shù)據(jù)對象錯誤碼。

示例：

// g_object加入分布式組網(wǎng)
g_object.setSessionId(distributedObject.genSessionId()).then (()=>{
    console.info("join session.");
    }).catch((error)=>{
        console.info("error:" + error.code + error.message);
});
// 退出分布式組網(wǎng)
g_object.setSessionId().then (()=>{
    console.info("leave all lession.");
    }).catch((error)=>{
        console.info("error:" + error.code + error.message);
});

on('change')9+

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

監(jiān)聽分布式數(shù)據(jù)對象的數(shù)據(jù)變更。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

globalThis.changeCallback = (sessionId, changeData) => {
    console.info("change" + sessionId);
    if (changeData != null && changeData != undefined) {
        changeData.forEach(element => {
        console.info("changed !" + element + " " + g_object[element]);
        });
    }
}
g_object.on("change", globalThis.changeCallback);

off('change')9+

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

當(dāng)不再進行數(shù)據(jù)變更監(jiān)聽時，使用此接口刪除對象的變更監(jiān)聽。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

// 刪除數(shù)據(jù)變更回調(diào)changeCallback
g_object.off("change", globalThis.changeCallback);
// 刪除所有的數(shù)據(jù)變更回調(diào)
g_object.off("change");

on('status')9+

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

監(jiān)聽分布式數(shù)據(jù)對象的上下線。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

globalThis.statusCallback = (sessionId, networkId, status) => {
    globalThis.response += "status changed " + sessionId + " " + status + " " + networkId;
}
g_object.on("status", globalThis.statusCallback);

off('status')9+

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

當(dāng)不再進行對象上下線監(jiān)聽時，使用此接口刪除對象的上下線監(jiān)聽。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

globalThis.statusCallback = (sessionId, networkId, status) => {
    globalThis.response += "status changed " + sessionId + " " + status + " " + networkId;
}
// 刪除上下線回調(diào)changeCallback
g_object.off("status",globalThis.statusCallback);
// 刪除所有的上下線回調(diào)
g_object.off("status");

save9+

save(deviceId: string, callback: AsyncCallback<SaveSuccessResponse>): void

保存分布式數(shù)據(jù)對象。使用callback方式異步回調(diào)。

對象數(shù)據(jù)保存成功后，當(dāng)應(yīng)用存在時不會釋放對象數(shù)據(jù)，當(dāng)應(yīng)用退出后，重新進入應(yīng)用時，恢復(fù)保存在設(shè)備上的數(shù)據(jù)。

有以下幾種情況時，保存的數(shù)據(jù)將會被釋放：

• 存儲時間超過24小時。
• 應(yīng)用卸載。
• 成功恢復(fù)數(shù)據(jù)之后。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

g_object.setSessionId("123456");
g_object.save("local", (err, result) => {
  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>

保存分布式數(shù)據(jù)對象。使用Promise方式作為異步回調(diào)。

對象數(shù)據(jù)保存成功后，當(dāng)應(yīng)用存在時不會釋放對象數(shù)據(jù)，當(dāng)應(yīng)用退出后，重新進入應(yīng)用時，恢復(fù)保存在設(shè)備上的數(shù)據(jù)。

有以下幾種情況時，保存的數(shù)據(jù)將會被釋放：

• 存儲時間超過24小時。
• 應(yīng)用卸載。
• 成功恢復(fù)數(shù)據(jù)之后。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

返回值：

示例：

g_object.setSessionId("123456");
g_object.save("local").then((result) => {
    console.info("save callback");
    console.info("save sessionId " + result.sessionId);
    console.info("save version " + result.version);
    console.info("save deviceId " + result.deviceId);
}).catch((err) => {
    console.info("save failed, error code = " + err.code);
    console.info("save failed, error message: " + err.message);
});

revokeSave9+

revokeSave(callback: AsyncCallback<RevokeSaveSuccessResponse>): void

撤回保存的分布式數(shù)據(jù)對象。使用callback方式作為異步方法。

如果對象保存在本地設(shè)備，那么將刪除所有受信任設(shè)備上所保存的數(shù)據(jù)。

如果對象保存在其他設(shè)備，那么將刪除本地設(shè)備上的數(shù)據(jù)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

g_object.setSessionId("123456");
// 持久化數(shù)據(jù)
g_object.save("local", (err, result) => {
    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);
});
// 刪除持久化保存的數(shù)據(jù)
g_object.revokeSave((err, result) => {
    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>

撤回保存的分布式數(shù)據(jù)對象。使用Promise方式作為異步方法。

如果對象保存在本地設(shè)備，那么將刪除所有受信任設(shè)備上所保存的數(shù)據(jù)。

如果對象保存在其他設(shè)備，那么將刪除本地設(shè)備上的數(shù)據(jù)。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

返回值：

示例：

g_object.setSessionId("123456");
// 持久化數(shù)據(jù)
g_object.save("local").then((result) => {
    console.info("save callback");
    console.info("save sessionId " + result.sessionId);
    console.info("save version " + result.version);
    console.info("save deviceId " + result.deviceId);
}).catch((err) => {
    console.info("save failed, error code = " + err.code);
    console.info("save failed, error message: " + err.message);
});
// 刪除持久化保存的數(shù)據(jù)
g_object.revokeSave().then((result) => {
    console.info("revokeSave callback");
    console.info("sessionId" + result.sessionId);
}).catch((err)=> {
    console.info("revokeSave failed, error code = " + err.code);
    console.info("revokeSave failed, error message = " + err.message);
});

distributedObject.createDistributedObject(deprecated)

createDistributedObject(source: object): DistributedObject

創(chuàng)建一個分布式數(shù)據(jù)對象。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

返回值：

示例：

import distributedObject from '@ohos.data.distributedDataObject';
// 創(chuàng)建對象，對象包含4個屬性類型，string,number,boolean和Object
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});

DistributedObject(deprecated)

表示一個分布式數(shù)據(jù)對象。在使用以下接口前，需調(diào)用createDistributedObject()獲取DistributedObject對象。

setSessionId(deprecated)

setSessionId(sessionId?: string): boolean

設(shè)置sessionId，當(dāng)可信組網(wǎng)中有多個設(shè)備時，多個設(shè)備間的對象如果設(shè)置為同一個sessionId，就能自動同步。

需要權(quán)限： ohos.permission.DISTRIBUTED_DATASYNC。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

返回值：

示例：

import distributedObject from '@ohos.data.distributedDataObject';
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});;
// g_object加入分布式組網(wǎng)
g_object.setSessionId(distributedObject.genSessionId());
// 設(shè)置為""退出分布式組網(wǎng)
g_object.setSessionId("");

on('change')(deprecated)

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

監(jiān)聽分布式數(shù)據(jù)對象的變更。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

import distributedObject from '@ohos.data.distributedDataObject';  
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
globalThis.changeCallback = (sessionId, changeData) => {
    console.info("change" + sessionId);
    if (changeData != null && changeData != undefined) {
        changeData.forEach(element => {
        console.info("changed !" + element + " " + g_object[element]);
        });
    }
}
g_object.on("change", globalThis.changeCallback);

off('change')(deprecated)

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

當(dāng)不再進行數(shù)據(jù)變更監(jiān)聽時，使用此接口刪除對象的變更監(jiān)聽。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

import distributedObject from '@ohos.data.distributedDataObject';  
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
// 刪除數(shù)據(jù)變更回調(diào)changeCallback
g_object.off("change", globalThis.changeCallback);
// 刪除所有的數(shù)據(jù)變更回調(diào)
g_object.off("change");

on('status')(deprecated)

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

監(jiān)聽分布式數(shù)據(jù)對象的上下線。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

import distributedObject from '@ohos.data.distributedDataObject';
globalThis.statusCallback = (sessionId, networkId, status) => {
    globalThis.response += "status changed " + sessionId + " " + status + " " + networkId;
}
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
g_object.on("status", globalThis.statusCallback);

off('status')(deprecated)

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

當(dāng)不再進行對象上下線監(jiān)聽時，使用此接口刪除對象的上下線監(jiān)聽。

系統(tǒng)能力： SystemCapability.DistributedDataManager.DataObject.DistributedObject

參數(shù)：

示例：

import distributedObject from '@ohos.data.distributedDataObject'; 
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
globalThis.statusCallback = (sessionId, networkId, status) => {
    globalThis.response += "status changed " + sessionId + " " + status + " " + networkId;
}
// 刪除上下線回調(diào)changeCallback
g_object.off("status",globalThis.statusCallback);
// 刪除所有的上下線回調(diào)
g_object.off("status");