docs/en/application-dev/reference/apis-arkdata/js-apis-data-cloudExtension-sys.md-代码预览-docs:基于OpenHarmony生态的开发者文档项目 - AtomGit

Ddd---Signed-off-by: dd--- <humengdi2@huawei.com>

The cloudExtension module provides APIs for third-party vendors to implement the device-cloud sharing service. You can use these APIs to share the device data to the server and implement device-cloud data sharing, including sharing and unsharing data, exiting a share, changing the privilege (operation permissions) on the shared data, querying participants by data identifier or invitation code, and confirming or changing a sharing invitation. Before you get started, it is helpful to understand the following concepts:

sharingResource: an identifier of the string type generated for each data record shared by an application when device-cloud sync is performed. It uniquely identifies the data record being shared.

Participant: all participants involved in a share, including the inviter and invitees.

invitationCode: an invitation code generated by the share server for a share operation. It is generated after a share is initiated and attached to an invitation to be pushed to the devices of target invitees. The target invitees then confirm the invitation via this code.

CloudService: device-cloud sync server, which implements data sync across devices with the same account for the same application.

ShareCenter: device-cloud sharing server, which implements cross-account and cross-device data sharing for the same application.

NOTE

The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs provided by this module are system APIs.

Modules to Import

import { cloudExtension } from '@kit.ArkData';

Result<T>

Represents the data sharing result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
code	number	No	No	Error code.
description	string	No	Yes	Detailed description of the error code. The default value is undefined.
value	T	No	Yes	Value returned. The specific type is specified by the T parameter. The default value is undefined.

CloudAsset

Represents the cloud asset information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
assetId	string	No	No	Asset ID.
hash	string	No	No	Hashed value of the asset modification time and size.

CloudAssets

Represents an array of CloudAsset.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Type	Description
Array<CloudAsset>	Array of CloudAsset.

ServiceInfo

Represents the cloud service information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
enableCloud	boolean	No	No	Whether the cloud service is enabled. The value true means that the cloud service is enabled, and the value false means the opposite.
id	string	No	No	Cloud account ID generated using SHA-256.
totalSpace	number	No	No	Total account space on the server, in KB.
remainingSpace	number	No	No	Available account space on the server, in KB.
user	number	No	No	Current user ID of the device.

Flag

Enumerates the operations that can be performed on a database. Use the enum name rather than the enum value.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Value	Description
INSERT	0	Insert data.
UPDATE	1	Update data.
DELETE	2	Delete data.

ExtensionValue

Represents additional information about a data record.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
id	string	Yes	No	ID generated when data is inserted.
createTime	number	Yes	No	Time when a row of data is created, in ms.
modifyTime	number	Yes	No	Time when a row of data is modified, in ms.
operation	Flag	Yes	No	Operation performed.

CloudType

Enumerates the types of the cloud data field. The specific type is determined by the parameter function.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Type	Description
null	The value is null.
number	The value is a number.
string	The value is a string.
boolean	The value is true or false.
Uint8Array	The value is a Uint8 array.
CloudAsset	The value is of the cloud asset type.
CloudAssets	The value is an array of cloud assets.

CloudInfo

Represents the cloud information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
cloudInfo	ServiceInfo	No	No	Cloud service information.
apps	Record<string, AppBriefInfo>	No	No	Brief application information.

CloudData

Represents the cloud data.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
nextCursor	string	No	No	Cursor for data query.
hasMore	boolean	No	No	Whether there is data to be queried on the server. The value true means there is data to be queried on the server; the value false means the opposite.
values	Array<Record<string, CloudType>>	No	No	Array of data to be queried, which consists of the data value and ExtensionValue.

AppBriefInfo

Represents the brief application information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
appId	string	No	No	Application ID.
bundleName	string	No	No	Bundle name of the application.
cloudSwitch	boolean	No	No	Whether the cloud service is enabled for the application. The value true means the cloud service is enabled; the value false means the opposite.
instanceId	number	No	No	Application twin ID. The value 0 indicates the application itself, and the twin ID increases in ascending order.

FieldType

Enumerates the types of the fields in a database table. Use the enum name rather than the enum value.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Value	Description
NULL	0	Null.
NUMBER	1	Number.
REAL	2	Double-precision floating point.
TEXT	3	Text.
BOOL	4	Boolean.
BLOB	5	BLOB, which can hold a binary file.
ASSET	6	Asset.
ASSETS	7	Assets.

Field

Represents a field in the database.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
alias	string	No	No	Alias of the field in the table.
colName	string	No	No	Name of the column, in which the field is located.
type	FieldType	No	No	Type of the field.
primary	boolean	No	No	Whether the current column is the primary key. The value true means the current column is the primary key; the value false means the opposite.
nullable	boolean	No	No	Whether the current column can be null. The value true means the current column can be null; the value false means the opposite.

Table

Represents the table information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
alias	string	No	No	Alias of the table in the database.
name	string	No	No	Table name.
fields	Array<Field>	No	No	Field information in the table.

Database

Represents the database information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
name	string	No	No	Name of the database.
alias	string	No	No	Alias of the database on the server.
tables	Array<Table>	No	No	Table in the database, including the detailed data information.

AppSchema

Represents the application database schema.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
bundleName	string	No	No	Bundle name of the application.
version	number	No	No	Version of the database schema.
databases	Array<Database>	No	No	Database information of the application.

SubscribeId

Represents the subscription ID information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
databaseAlias	string	No	No	Name of the database on the server.
id	string	No	No	Subscription ID.

SubscribeInfo

Represents the subscription information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
expirationTime	number	No	No	Subscription expiration time, in ms.
subscribe	Record<string, Array<SubscribeId>>	No	No	Subscription information.

LockInfo

Represents the cloud database lock information.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Type	Read-Only	Optional	Description
interval	number	No	No	Lock period of the cloud database, in seconds.
lockId	number	No	No	Lock ID.

ErrorCode

Enumerates the device-cloud sync states. Use the enum name rather than the enum value.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Name	Value	Description
SUCCESS	0	The device-cloud sync is successful.
UNKNOWN_ERROR	1	An unknown error occurs during the device-cloud sync process.
NETWORK_ERROR	2	A network error occurs during the device-cloud sync process.
CLOUD_DISABLED	3	Cloud sync is disabled.
LOCKED_BY_OTHERS	4	The device-cloud sync of another device is being performed. The sync of the local device can be performed only when the device-cloud resources are available.
RECORD_LIMIT_EXCEEDED	5	The number of records or size of the data to be synced exceeds the maximum. The maximum value is configured on the cloud.
NO_SPACE_FOR_ASSET	6	The remaining cloud space is less than the size of the data to be synced.

cloudExtension.createCloudServiceStub

createCloudServiceStub(instance: CloudService): Promise<rpc.RemoteObject>

Creates a RemoteObject instance based on a CloudService instance. The system uses this object to call the APIs of the CloudService instance. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
instance	CloudService	Yes	Instance of the CloudService class.

Return value

Type	Description
Promise<rpc.RemoteObject>	Promise used to return the RemoteObject instance of CloudService.

Example

import { Want, ServiceExtensionAbility } from '@kit.AbilityKit';
import { rpc } from '@kit.IPCKit';

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
  async connectShareCenter(userId: number, bundleName: string): Promise<rpc.RemoteObject> {
    // ...
  }
}

export default class MyServiceExtension extends ServiceExtensionAbility {
  onCreate(want: Want) {
    console.info(`onCreate: ${want}`);
  }
  onRequest(want: Want, startId: number) {
    console.info(`onRequest: ${want} ${startId}`);
  }
  onConnect(want: Want): rpc.RemoteObject | Promise<rpc.RemoteObject> {
    console.info(`onConnect: ${want}`);
    return cloudExtension.createCloudServiceStub(new MyCloudService());
  }
  onDisconnect(want: Want) {
    console.info(`onDisconnect: ${want}`);
  }
  onDestroy() {
    console.info('onDestroy');
  }
}

cloudExtension.createShareServiceStub

createShareServiceStub(instance: ShareCenter): Promise<rpc.RemoteObject>

Creates a RemoteObject instance based on a ShareCenter instance. The system uses this object to call the APIs of the ShareCenter instance. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
instance	ShareCenter	Yes	Instance of the ShareCenter class.

Return value

Type	Description
Promise<rpc.RemoteObject>	Promise used to return the RemoteObject instance of ShareCenter.

Example

import { rpc } from '@kit.IPCKit';

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  // ...
}

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
  async connectShareCenter(userId: number, bundleName: string): Promise<rpc.RemoteObject> {
    console.info(`connect share center, bundle: ${bundleName}`);
    return cloudExtension.createShareServiceStub(new MyShareCenter());
  }
}

cloudExtension.createCloudDBStub

createCloudDBStub(instance: CloudDB): Promise<rpc.RemoteObject>

Creates a RemoteObject instance based on a CloudDB instance. The system uses this object to call the APIs of the CloudDB instance. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
instance	CloudDB	Yes	CloudDB instance.

Return value

Type	Description
Promise<rpc.RemoteObject>	Promise used to return the rpc.RemoteObject instance of CloudDB.

import { rpc } from '@kit.IPCKit';

class MyCloudDB implements cloudExtension.CloudDB {
  // ...
}

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
  // ...
  async connectDB(bundleName: string, database: cloudExtension.Database): Promise<rpc.RemoteObject> {
    console.info(`connect DB, bundleName: ${bundleName}`);
    return cloudExtension.createCloudDBStub(new MyCloudDB());
  }
}

cloudExtension.createAssetLoaderStub

createAssetLoaderStub(instance: AssetLoader): Promise<rpc.RemoteObject>

Creates a RemoteObject instance based on an AssetLoader instance. The system uses this object to call the APIs of the AssetLoader instance. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
instance	AssetLoader	Yes	AssetLoader instance.

Return value

Type	Description
Promise<rpc.RemoteObject>	Promise used to return the rpc.RemoteObject instance of AssetLoader.

Example

import { rpc } from '@kit.IPCKit';

class MyAssetLoader implements cloudExtension.AssetLoader {
  // ...
}

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
  // ...   
  async connectAssetLoader(bundleName: string, database: cloudExtension.Database): Promise<rpc.RemoteObject> {
    console.info(`connect asset loader, bundle: ${bundleName}`);
    return cloudExtension.createAssetLoaderStub(new MyAssetLoader());
  }
}

CloudDB

Provides APIs for performing cloud database operations.

generateId

generateId(count: number): Promise<Result<Array<string>>>

Generates IDs for the data records inserted to the cloud database. The IDs are unique. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
count	number	Yes	Number of IDs to generate.

Return value

Type	Description
Promise<Result<Array<string>>	Promise used to return the generated IDs in Result.

Example

class MyCloudDB implements cloudExtension.CloudDB {
  async generateId(count: number): Promise<cloudExtension.Result<Array<string>>> {
    console.info(`generate id, count: ${count}`);
    let result = new Array<string>();
    // ...
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'generateId succeeded',
      value: result
    };
  }
  // ...
}

update

update(table: string, values: Array<Record<string, CloudType>>, extensions: Array<Record<string, CloudType>> ): Promise<Array<Result<Record<string, CloudType>>>>

Updates data in the cloud. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
table	string	Yes	Table name.
values	Array<Record<string, CloudType>>	Yes	Data to insert.
extensions	Array<Record<string, CloudType>>	Yes	Extended information about the current data.

Return value

Type	Description
Promise<Array<Result<Record<string, CloudType>>>>	Promise used to return the update result and updated data.

Example

class MyCloudDB implements cloudExtension.CloudDB {
  // ...
  async update(table: string, values: Array<Record<string, cloudExtension.CloudType>>, extensions: Array<Record<string, cloudExtension.CloudType>>): Promise<Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>>> {
    console.info(`update, table: ${table}`);
    let updateRes: Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>> = [];
    // ...
    // Return the data update result.
    return updateRes;
  }
  // ...
}

insert

insert(table: string, values: Array<Record<string, CloudType>>, extensions: Array<Record<string, CloudType>>): Promise<Array<Result<Record<string, CloudType>>>>

Inserts data to a cloud database table. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
table	string	Yes	Table name.
values	Array<Record<string, CloudType>>	Yes	Data to insert.
extensions	Array<Record<string, CloudType>>	Yes	Extended information about the current data.

Return value

Type	Description
Promise<Array<Result<Record<string, CloudType>>>>	Promise used to return the inserted data and operation result.

Example

class MyCloudDB implements cloudExtension.CloudDB {
  // ...
  async insert(table: string, values: Array<Record<string, cloudExtension.CloudType>>, extensions: Array<Record<string, cloudExtension.CloudType>>): Promise<Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>>> {
    console.info(`insert, table: ${table}`);
    let insertRes: Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>> = [];
    // ...
    // Return the operation result.
    return insertRes;
  }
  // ...
}

delete

delete(table: string, extensions: Array<Record<string, CloudType>> ): Promise<Array<Result<Record<string, CloudType>>>>

Deletes data from a cloud database table. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
table	string	Yes	Table name.
extensions	Array<Record<string,CloudType>>	Yes	Extended information about the current data.

Return value

Type	Description
Promise<Array<Result<Record<string, CloudType>>>>	Promise used to return the deleted data and operation result.

Example

class MyCloudDB implements cloudExtension.CloudDB {
  // ...
  async delete(table: string, extensions: Array<Record<string, cloudExtension.CloudType>>): Promise<Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>>> {
    console.info(`delete, table: ${table}`);
    let deleteRes: Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>> = [];
    // ...
    // Returns the result of deleting data.
    return deleteRes;
  }
  // ...
}

query

query(table: string, fields: Array<string>, queryCount: number, queryCursor: string): Promise<Result<CloudData>>

Queries data in a cloud database table. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
table	string	Yes	Table name.
fields	Array<string>	Yes	Name of the fields to query.
queryCount	number	Yes	Number of data records to query.
queryCursor	string	Yes	Cursor for the query.

Return value

Type	Description
Promise<Result<CloudData>>	Promise used to return the data and operation result.

Example

class MyCloudDB implements cloudExtension.CloudDB {
  // ...
  async query(table: string, fields: Array<string>, queryCount: number, queryCursor: string): Promise<cloudExtension.Result<cloudExtension.CloudData>> {
    console.info(`query, table: ${table}`);
    // ...
    // Return the result of querying data.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'query succeeded',
      value: {
        nextCursor: "test_nextCursor",
        hasMore: true,
        values: []
      }
    };
  }
  // ...
}

lock

lock(): Promise<Result<LockInfo>>

Locks this cloud database. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Return value

Type	Description
Promise<Result<LockInfo>>	Promise used to return the lock ID and lock period.

Example

let test_time: number = 10;
let test_lockId: number = 1;
class MyCloudDB implements cloudExtension.CloudDB {
  // ...
  async lock(): Promise<cloudExtension.Result<cloudExtension.LockInfo>> {
    console.info(`DB lock`);
    // ...
    // Returns the result of locking data.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'lock succeeded',
      value: {
        interval: test_time,
        lockId: test_lockId
      }
    };
  }
  // ...
}

heartbeat

heartbeat(lockId: number): Promise<Result<LockInfo>>

Extends the lock period of the database. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
lockId	number	Yes	Lock ID.

Return value

Type	Description
Promise<Result<LockInfo>>	Promise used to return the lock ID and lock period.

Example

let test_lockId: number = 1;
let test_time: number = 10;
class MyCloudDB implements cloudExtension.CloudDB {
  // ...
  async heartbeat(lockId: number): Promise<cloudExtension.Result<cloudExtension.LockInfo>> {
    console.info(`heartbeat lock`);
    // ...
    // Return the heartbeat check result.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'heartbeat succeeded',
      value: {
        interval: test_time,
        lockId: test_lockId
      }
    };
  }
  // ...
}

unlock

unlock(lockId: number): Promise<Result<boolean>>

Unlocks a cloud database. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
lockId	number	Yes	Lock ID to release.

Return value

Type	Description
Promise<Result<boolean>>	Promise used to return the result. The value true means the operation is successful; the value false means the opposite.

Example

class MyCloudDB implements cloudExtension.CloudDB {
    // ...
  async unlock(lockId: number): Promise<cloudExtension.Result<boolean>> {
    console.info(`unlock`);
    // ...
    // Returns the result of unlocking data.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'unlock succeeded',
      value: false
    };
  }
  // ...
}

CloudService

Provides APIs for interacting with the cloud sync service. You need to inherit this class and implement APIs of this class. The system calls these APIs to connect to the cloud and use the cloud sync service.

getServiceInfo

getServiceInfo(): Promise<ServiceInfo>

Obtains the server information. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Return value

Type	Description
Promise<ServiceInfo>	Promise used to return the server information obtained.

Example

import { rpc } from '@kit.IPCKit';

let test_space: number = 100;
let test_userId: number = 1;

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
  // ...
  async getServiceInfo(): Promise<cloudExtension.ServiceInfo> {
    console.info(`get service info`);
    // ...
    return {
      enableCloud: true,
      id: "test_id",
      totalSpace: test_space,
      remainingSpace: test_space,
      user: test_userId,
    };
  }
}

getAppBriefInfo

getAppBriefInfo(): Promise<Record<string, AppBriefInfo>>

Obtains brief application information. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Return value

Type	Description
Promise<Record<string, AppBriefInfo>>>	Promise used to return bundleName and AppBriefInfo, in KV pairs.

Example

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
  // ...
  async getAppBriefInfo(): Promise<Record<string, cloudExtension.AppBriefInfo>> {
    console.info(`get app brief info`);
    // ...
    return {
      "test_bundle":
      {
        appId: "test_appID",
        bundleName: "test_bundlename",
        cloudSwitch: true,
        instanceId: 0,
      }
    };
  }
}

getAppSchema

getAppSchema(bundleName: string): Promise<Result<AppSchema>>

Obtains the application database schema information. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.

Return value

Type	Description
Promise<Result<AppSchema>>	Promise used to return the schema information obtained.

Example

class MyCloudService implements cloudExtension.CloudService {
  constructor() {
  }
  // ...
  async getAppSchema(bundleName: string): Promise<cloudExtension.Result<cloudExtension.AppSchema>> {
    console.info(`get app schema, bundleName:${bundleName}`);
    // ...
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: "get app schema success",
      value: {
        bundleName: "test_bundleName",
        version: 1,
        databases: []
      }
    };
  }
}

subscribe(subInfo: Record<string, Array<Database>>, expirationTime: number): Promise<Result<SubscribeInfo>>

Subscribes to data. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
subInfo	Record<string, Array<Database>>	Yes	Data to be subscribed to, in KV pairs of the application bundle name and database information.
expirationTime	number	Yes	Subscription expiration time, in ms.

Return value

Type	Description
Promise<Result<SubscribeInfo>>	Promise used to return the result, including the subscription expiration time and subscription information.

Example

let test_time: number = 10;
class MyCloudService implements cloudExtension.CloudService {
  constructor() {
  }
  // ...
  async subscribe(subInfo: Record<string, Array<cloudExtension.Database>>, expirationTime: number): Promise<cloudExtension.Result<cloudExtension.SubscribeInfo>> {
    console.info
    (`subscribe expirationTime: ${expirationTime}`);
    // ...
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: "subscribe success",
      value: {
        expirationTime: test_time,
        subscribe: {}
      }
    };
  }
}

unsubscribe

unsubscribe(unsubscribeInfo: Record<string, Array<string>>): Promise<number>

Unsubscribes from data changes in the cloud. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
unsubscribeInfo	Record<string, Array<string>>	Yes	Data to be unsubscribed from, in an array of KV pairs consisting of the application bundle name and database information.

Return value

Type	Description
Promise<number>	Promise used to return the result.

class MyCloudService implements cloudExtension.CloudService {
  constructor() {
  }
  // ...
  async unsubscribe(unsubscribeInfo: Record<string, Array<string>>): Promise<number> {
    console.info(`unsubscribe`);
    // ...
    return cloudExtension.ErrorCode.SUCCESS;
  }
}

connectDB

connectDB(bundleName: string, database: Database): Promise<rpc.RemoteObject>

Connects to a cloud database by obtaining a RemoteObject instance of CloudDB, which is created by using createCloudDBStub. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.
database	Database	Yes	Database to connect.

Return value

Type	Description
Promise<rpc.RemoteObject>	Promise used to return the RemoteObject instance of CloudDB.

import { rpc } from '@kit.IPCKit';

class MyCloudDB implements cloudExtension.CloudDB {
  // ...
}

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
    // ...
  async connectDB(bundleName: string, database: cloudExtension.Database): Promise<rpc.RemoteObject> {
    console.info(`connect DB, bundleName: ${bundleName}`);
    return cloudExtension.createCloudDBStub(new MyCloudDB());
  }
}

connectAssetLoader

connectAssetLoader(bundleName: string, database: Database): Promise<rpc.RemoteObject>

Connects to an asset loader by obtaining a RemoteObject instance of AssetLoader, which is created by using createAssetLoaderStub. This API uses a promise to return the result.

You can use this API to connect to the asset loader.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.
database	Database	Yes	Database to connect.

Return value

Type	Description
Promise<rpc.RemoteObject>	Promise used to return the RemoteObject instance of AssetLoader.

import { rpc } from '@kit.IPCKit';

class MyAssetLoader implements cloudExtension.AssetLoader {
  // ...
}

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
  async connectAssetLoader(bundleName: string, database: cloudExtension.Database): Promise<rpc.RemoteObject> {
      // ...
    console.info(`connect asset loader, bundle: ${bundleName}`);
    return cloudExtension.createAssetLoaderStub(new MyAssetLoader());
  }
}

connectShareCenter

connectShareCenter(userId: number, bundleName: string): Promise<rpc.RemoteObject>

Connects to ShareCenter by obtaining a RemoteObject instance of ShareCenter, which is created by using createShareServiceStub. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.

Return value

Type	Description
Promise<rpc.RemoteObject>	Promise used to return the RemoteObject instance of ShareCenter.

Example

import { rpc } from '@kit.IPCKit';

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  // ...
}

class MyCloudService implements cloudExtension.CloudService {
  constructor() {}
  async connectShareCenter(userId: number, bundleName: string): Promise<rpc.RemoteObject> {
    console.info(`connect share center, bundle: ${bundleName}`);
    return cloudExtension.createShareServiceStub(new MyShareCenter());
  }
}

AssetLoader

Provides APIs for uploading and downloading assets.

download

download(table: string, gid: string, prefix: string, assets: Array<CloudAsset>): Promise<Array<Result<CloudAsset>>>

Downloads assets. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
table	string	Yes	Table name.
gid	string	Yes	Unique identifier generated for the data added to the cloud.
prefix	string	Yes	Asset prefix information.
assets	Array<CloudAsset>	Yes	Assets to download.

Return value

Type	Description
Promise<Array<Result<CloudAsset>>>	Promise used to return the asset download result, including the asset IDs and asset hash values.

Example

class MyAssetLoader implements cloudExtension.AssetLoader {
  async download(table: string, gid: string, prefix: string, assets: Array<cloudExtension.CloudAsset>): Promise<Array<cloudExtension.Result<cloudExtension.CloudAsset>>> {
    console.info(`download asset loader, table: ${table}, gid: ${gid}, prefix: ${prefix}`);
    let downloadRes = Array<cloudExtension.Result<cloudExtension.CloudAsset>>();
    // ...
    return downloadRes;
  }
}

upload

upload(table: string, gid: string, assets: Array<CloudAsset>): Promise<Array<Result<CloudAsset>>>

Uploads assets. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
table	string	Yes	Table name.
gid	string	Yes	Unique identifier generated for the data added to the cloud.
assets	Array<CloudAsset>	Yes	Assets to upload.

Return value

Type	Description
Promise<Array<Result<CloudAsset>>>	Promise used to return the asset upload result, including the asset IDs and asset hash values.

Example

class MyAssetLoader implements cloudExtension.AssetLoader {
  async upload(table: string, gid: string, assets: Array<cloudExtension.CloudAsset>): Promise<Array<cloudExtension.Result<cloudExtension.CloudAsset>>> {
    console.info(`upload asset loader, table: ${table}, gid: ${gid}`);
    let uploadRes = Array<cloudExtension.Result<cloudExtension.CloudAsset>>();
    // ...
    return uploadRes;
  }
    // ...
}

ShareCenter

Provides APIs for interacting with the sharedCenter service. You need to inherit this class and implement APIs of this class. The system calls these APIs to initiate, cancel, or exit a device-cloud share.

share(userId: number, bundleName: string, sharingResource: string, participants: Array<cloudData.sharing.Participant>): Promise<Result<Array<Result<cloudData.sharing.Participant>>>>

Shares data. This API uses a promise to return the result. The application that initiates the share, shared resource ID, participants of the share need to be specified.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.
sharingResource	string	Yes	Shared resource ID.
participants	Array<cloudData.sharing.Participant>	Yes	Participants of the share.

Return value

Type	Description
Promise<Result<Array<Result<cloudData.sharing.Participant>>>>	Promise used to return the result.

Example

import { cloudData } from '@kit.ArkData';

type Participant = cloudData.sharing.Participant;

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  async share(userId: number, bundleName: string, sharingResource: string, participants: Array<Participant>):
    Promise<cloudExtension.Result<Array<cloudExtension.Result<Participant>>>> {
    console.info(`share, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value.
    // ...
    // Return the result obtained from ShareCenter.
    let result: Array<cloudExtension.Result<Participant>> = [];
    participants.forEach((item => {
      result.push({
        code: cloudData.sharing.SharingCode.SUCCESS,
        description: 'share succeeded'    
      })
    }))
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'share succeeded',
      value: result
    }
  }
  // ...
}

unshare

unshare(userId: number, bundleName: string, sharingResource: string, participants: Array<cloudData.sharing.Participant>): Promise<Result<Array<Result<cloudData.sharing.Participant>>>>

Unshares data. This API uses a promise to return the result. The application, shared resource ID, and participants for the data to unshare need to be specified.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.
sharingResource	string	Yes	Shared resource ID.
participants	Array<cloudData.sharing.Participant>	Yes	Participants of the share.

Return value

Type	Description
Promise<Result<Array<Result<cloudData.sharing.Participant>>>>	Promise used to return the result.

Example

import { cloudData } from '@kit.ArkData';

type Participant = cloudData.sharing.Participant;

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  async unshare(userId: number, bundleName: string, sharingResource: string, participants: Array<Participant>):
    Promise<cloudExtension.Result<Array<cloudExtension.Result<Participant>>>> {
    console.info(`unshare, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the unshare operation.
    // ...
    // Return the result obtained from ShareCenter.
    let result: Array<cloudExtension.Result<Participant>> = [];
    participants.forEach((item => {
      result.push({
        code: cloudData.sharing.SharingCode.SUCCESS,
        description: 'unshare succeeded'    
      })
    }))
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'unshare succeeded',
      value: result
    }
  }
  // ...
}

exit

exit(userId: number, bundleName: string, sharingResource: string): Promise<Result<void>>

Exits a device-cloud share. This API uses a promise to return the result. The application and shared resource ID need to be specified.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.
sharingResource	string	Yes	Shared resource ID.

Return value

Type	Description
Promise<Result<void>>	Promise used to return the result.

Example

import { cloudData } from '@kit.ArkData';

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  async exit(userId: number, bundleName: string, sharingResource: string):
    Promise<cloudExtension.Result<void>> {
    console.info(`exit share, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the exit operation.
    // ...
    // Return the result obtained from ShareCenter.
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'exit share succeeded'
    }
  }
  // ...
}

changePrivilege

changePrivilege(userId: number, bundleName: string, sharingResource: string, participants: Array<cloudData.sharing.Participant>): Promise<Result<Array<Result<cloudData.sharing.Participant>>>>

Changes the privilege (operation permissions) on the shared data. This API uses a promise to return the result. The application, shared resource ID, and the participants with new privilege need to be specified.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.
sharingResource	string	Yes	Shared resource ID.
participants	Array<cloudData.sharing.Participant>	Yes	Participants of the share.

Return value

Type	Description
Promise<Result<Array<Result<cloudData.sharing.Participant>>>>	Promise used to return the result.

Example

import { cloudData } from '@kit.ArkData';

type Participant = cloudData.sharing.Participant;

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  async changePrivilege(userId: number, bundleName: string, sharingResource: string, participants: Array<Participant>):
    Promise<cloudExtension.Result<Array<cloudExtension.Result<Participant>>>> {
    console.info(`change privilege, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the privilege change operation.
    // ...
    // Return the result obtained from ShareCenter.
    let result: Array<cloudExtension.Result<Participant>> = [];
    participants.forEach((item => {
      result.push({
        code: cloudData.sharing.SharingCode.SUCCESS,
        description: 'change privilege succeeded'    
      })
    }))
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'change privilege succeeded',
      value: result
    }
  }
  // ...
}

queryParticipants

queryParticipants(userId: number, bundleName: string, sharingResource: string): Promise<Result<Array<cloudData.sharing.Participant>>>

Queries the participants of a share. This API uses a promise to return the result. The application and shared resource ID need to be specified.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.
sharingResource	string	Yes	Shared resource ID.

Return value

Type	Description
Promise<Result<Array<cloudData.sharing.Participant>>>	Promise used to return the participants obtained.

Example

import { cloudData } from '@kit.ArkData';

type Participant = cloudData.sharing.Participant;

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  async queryParticipants(userId: number, bundleName: string, sharingResource: string):
    Promise<cloudExtension.Result<Array<Participant>>> {
    console.info(`query participants, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the query operation.
    // ...
    // Return the result obtained from ShareCenter.
    let participants = new Array<cloudData.sharing.Participant>();
    participants.push({
      identity: '000000000',
      role: cloudData.sharing.Role.ROLE_INVITEE,
      state: cloudData.sharing.State.STATE_ACCEPTED,
      privilege: {
        writable: false,
        readable: true,
        creatable: false,
        deletable: false,
        shareable: false
      },
      attachInfo: ''
    })
    participants.push({
      identity: '111111111',
      role: cloudData.sharing.Role.ROLE_INVITEE,
      state: cloudData.sharing.State.STATE_ACCEPTED,
      privilege: {
        writable: false,
        readable: true,
        creatable: false,
        deletable: false,
        shareable: false
      },
      attachInfo: ''
    })
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'query participants succeeded',
      value: participants
    }
  }
  // ...
}

queryParticipantsByInvitation

queryParticipantsByInvitation(userId: number, bundleName: string, invitationCode: string): Promise<Result<Array<cloudData.sharing.Participant>>>

Queries the participants of a share based on the invitation code. This API uses a promise to return the result. The application and the invitation code of the shared data need to be specified.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.
invitationCode	string	Yes	Invitation code for the share.

Return value

Type	Description
Promise<Result<Array<cloudData.sharing.Participant>>>	Promise used to return the participants obtained.

Example

import { cloudData } from '@kit.ArkData';

type Participant = cloudData.sharing.Participant;

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  async queryParticipantsByInvitation(userId: number, bundleName: string, invitationCode: string):
    Promise<cloudExtension.Result<Array<Participant>>> {
    console.info(`query participants by invitation, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the query operation.
    // ...
    // Return the result obtained from ShareCenter.
    let participants = new Array<cloudData.sharing.Participant>();
    participants.push({
      identity: '000000000',
      role: cloudData.sharing.Role.ROLE_INVITEE,
      state: cloudData.sharing.State.STATE_ACCEPTED,
      privilege: {
        writable: false,
        readable: true,
        creatable: false,
        deletable: false,
        shareable: false
      },
      attachInfo: ''
    })
    participants.push({
      identity: '111111111',
      role: cloudData.sharing.Role.ROLE_INVITEE,
      state: cloudData.sharing.State.STATE_ACCEPTED,
      privilege: {
        writable: false,
        readable: true,
        creatable: false,
        deletable: false,
        shareable: false
      },
      attachInfo: ''
    })
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'query participants by invitation succeeded',
      value: participants
    }
  }
  // ...
}

confirmInvitation

confirmInvitation(userId: number, bundleName: string, invitationCode: string, state: cloudData.sharing.State): Promise<Result<string>>

Confirms the invitation for a share. This API uses a promise to return the result. The application, invitation code for the share, and the confirmation state need to be specified.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.
invitationCode	string	Yes	Invitation code for the share.
state	cloudData.sharing.State	Yes	Confirmation state of the invitation.

Return value

Type	Description
Promise<Result<string>>	Promise used to return the shared resource ID.

Example

import { cloudData } from '@kit.ArkData';

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  async confirmInvitation(userId: number, bundleName: string, invitationCode: string, state: cloudData.sharing.State):
    Promise<cloudExtension.Result<string>> {
    console.info(`confirm invitation, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the invitation confirmation operation.
    // ...
    // Return the result obtained from ShareCenter.
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'confirm invitation succeeded',
      value: 'sharing_resource_test'
    }
  }
  // ...
}

changeConfirmation

changeConfirmation(userId: number, bundleName: string, sharingResource: string, state: cloudData.sharing.State): Promise<Result<void>>

Changes the confirmation state of a share invitation. This API uses a promise to return the result. The application, shared resource ID, and the new conformation state need to be specified. This API uses a promise to return the result.

System capability: SystemCapability.DistributedDataManager.CloudSync.Server

Parameters

Name	Type	Mandatory	Description
userId	number	Yes	User ID.
bundleName	string	Yes	Bundle name of the application.
sharingResource	string	Yes	Shared resource ID.
state	cloudData.sharing.State	Yes	New confirmation state.

Return value

Type	Description
Promise<Result<void>>	Promise used to return the result.

Example

import { cloudData } from '@kit.ArkData';

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {}
  async changeConfirmation(userId: number, bundleName: string, sharingResource: string, state: cloudData.sharing.State):
    Promise<cloudExtension.Result<void>> {
    console.info(`change confirm, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the state change operation.
    // ...
    // Return the result obtained from ShareCenter.
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'change confirm succeeded'
    }
  }
  // ...
}

Complete Sample Code

The classes in the preceding examples are implemented using implements, and the sample code cannot be executed independently until all the methods in the parent classes are implemented. The following provides complete sample code for your reference.

import { Want, ServiceExtensionAbility } from '@kit.AbilityKit';
import { rpc } from '@kit.IPCKit';
import { cloudData, cloudExtension } from '@kit.ArkData';

type Participant = cloudData.sharing.Participant;
let test_lockId: number = 1;
let test_time: number = 10;
let test_space: number = 100;
let test_userId: number = 1;

class MyCloudDB implements cloudExtension.CloudDB {
  async generateId(count: number): Promise<cloudExtension.Result<Array<string>>> {
    console.info(`generate id, count: ${count}`);
    let result = new Array<string>();
    // ...
    // Return the ID generated.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'generateId succeeded',
      value: result
    };
  }

  async update(table: string, values: Array<Record<string, cloudExtension.CloudType>>, extensions: Array<Record<string, cloudExtension.CloudType>>): Promise<Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>>> {
    console.info(`update, table: ${table}`);
    let updateRes: Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>> = [];
    // ...
    // Return the data update result.
    return updateRes;
  }

  async insert(table: string, values: Array<Record<string, cloudExtension.CloudType>>, extensions: Array<Record<string, cloudExtension.CloudType>>): Promise<Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>>> {
    console.info(`insert, table: ${table}`);
    let insertRes: Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>> = [];
    // ...
    // Return the operation result.
    return insertRes;
  }

  async delete(table: string, extensions: Array<Record<string, cloudExtension.CloudType>>): Promise<Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>>> {
    console.info(`delete, table: ${table}`);
    let deleteRes: Array<cloudExtension.Result<Record<string, cloudExtension.CloudType>>> = [];
    // ...
    // Returns the result of deleting data.
    return deleteRes;
  }

  async query(table: string, fields: Array<string>, queryCount: number, queryCursor: string): Promise<cloudExtension.Result<cloudExtension.CloudData>> {
    console.info(`query, table: ${table}`);
    // ...
    // Return the result of querying data.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'query succeeded',
      value: {
        nextCursor: "test_nextCursor",
        hasMore: true,
        values: []
      }
    };
  }

  async lock(): Promise<cloudExtension.Result<cloudExtension.LockInfo>> {
    console.info(`DB lock`);
    // ...
    // Returns the result of locking data.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'lock succeeded',
      value: {
        interval: test_time,
        lockId: test_lockId
      }
    };
  }

  async heartbeat(lockId: number): Promise<cloudExtension.Result<cloudExtension.LockInfo>> {
    console.info(`heartbeat lock`);
    // ...
    // Return the heartbeat check result.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'heartbeat succeeded',
      value: {
        interval: test_time,
        lockId: test_lockId
      }
    };
  }

  async unlock(lockId: number): Promise<cloudExtension.Result<boolean>> {
    console.info(`unlock`);
    // ...
    // Returns the result of unlocking data.
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: 'unlock succeeded',
      value: false
    };
  }
}

class MyAssetLoader implements cloudExtension.AssetLoader {
  async download(table: string, gid: string, prefix: string, assets: Array<cloudExtension.CloudAsset>): Promise<Array<cloudExtension.Result<cloudExtension.CloudAsset>>> {
    console.info(`download asset loader, table: ${table}, gid: ${gid}, prefix: ${prefix}`);
    let downloadRes = Array<cloudExtension.Result<cloudExtension.CloudAsset>>();
    // ...
    return downloadRes;
  }

  async upload(table: string, gid: string, assets: Array<cloudExtension.CloudAsset>): Promise<Array<cloudExtension.Result<cloudExtension.CloudAsset>>> {
    console.info(`upload asset loader, table: ${table}, gid: ${gid}`);
    let uploadRes = Array<cloudExtension.Result<cloudExtension.CloudAsset>>();
    // ...
    return uploadRes;
  }
}

class MyShareCenter implements cloudExtension.ShareCenter {
  constructor() {
  }

  async share(userId: number, bundleName: string, sharingResource: string, participants: Array<Participant>):
    Promise<cloudExtension.Result<Array<cloudExtension.Result<Participant>>>> {
    console.info(`share, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value.
    // ...
    // Return the result obtained from ShareCenter.
    let result: Array<cloudExtension.Result<Participant>> = [];
    participants.forEach((item => {
      result.push({
        code: cloudData.sharing.SharingCode.SUCCESS,
        description: 'share succeeded'
      })
    }))
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'share succeeded',
      value: result
    }
  }

  async unshare(userId: number, bundleName: string, sharingResource: string, participants: Array<Participant>):
    Promise<cloudExtension.Result<Array<cloudExtension.Result<Participant>>>> {
    console.info(`unshare, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the unshare operation.
    // ...
    // Return the result obtained from ShareCenter.
    let result: Array<cloudExtension.Result<Participant>> = [];
    participants.forEach((item => {
      result.push({
        code: cloudData.sharing.SharingCode.SUCCESS,
        description: 'unshare succeeded'
      })
    }))
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'unshare succeeded',
      value: result
    }
  }

  async exit(userId: number, bundleName: string, sharingResource: string):
    Promise<cloudExtension.Result<void>> {
    console.info(`exit share, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the exit operation.
    // ...
    // Return the result obtained from ShareCenter.
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'exit share succeeded'
    }
  }

  async changePrivilege(userId: number, bundleName: string, sharingResource: string, participants: Array<Participant>):
    Promise<cloudExtension.Result<Array<cloudExtension.Result<Participant>>>> {
    console.info(`change privilege, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the privilege change operation.
    // ...
    // Return the result obtained from ShareCenter.
    let result: Array<cloudExtension.Result<Participant>> = [];
    participants.forEach((item => {
      result.push({
        code: cloudData.sharing.SharingCode.SUCCESS,
        description: 'change privilege succeeded'
      })
    }))
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'change privilege succeeded',
      value: result
    }
  }

  async queryParticipants(userId: number, bundleName: string, sharingResource: string):
    Promise<cloudExtension.Result<Array<Participant>>> {
    console.info(`query participants, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the query operation.
    // ...
    // Return the result obtained from ShareCenter.
    let participants = new Array<cloudData.sharing.Participant>();
    participants.push({
      identity: '000000000',
      role: cloudData.sharing.Role.ROLE_INVITEE,
      state: cloudData.sharing.State.STATE_ACCEPTED,
      privilege: {
        writable: false,
        readable: true,
        creatable: false,
        deletable: false,
        shareable: false
      },
      attachInfo: ''
    })
    participants.push({
      identity: '111111111',
      role: cloudData.sharing.Role.ROLE_INVITEE,
      state: cloudData.sharing.State.STATE_ACCEPTED,
      privilege: {
        writable: false,
        readable: true,
        creatable: false,
        deletable: false,
        shareable: false
      },
      attachInfo: ''
    })
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'query participants succeeded',
      value: participants
    }
  }

  async queryParticipantsByInvitation(userId: number, bundleName: string, invitationCode: string):
    Promise<cloudExtension.Result<Array<Participant>>> {
    console.info(`query participants by invitation, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the query operation.
    // ...
    // Return the result obtained from ShareCenter.
    let participants = new Array<cloudData.sharing.Participant>();
    participants.push({
      identity: '000000000',
      role: cloudData.sharing.Role.ROLE_INVITEE,
      state: cloudData.sharing.State.STATE_ACCEPTED,
      privilege: {
        writable: false,
        readable: true,
        creatable: false,
        deletable: false,
        shareable: false
      },
      attachInfo: ''
    })
    participants.push({
      identity: '111111111',
      role: cloudData.sharing.Role.ROLE_INVITEE,
      state: cloudData.sharing.State.STATE_ACCEPTED,
      privilege: {
        writable: false,
        readable: true,
        creatable: false,
        deletable: false,
        shareable: false
      },
      attachInfo: ''
    })
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'query participants by invitation succeeded',
      value: participants
    }
  }

  async confirmInvitation(userId: number, bundleName: string, invitationCode: string, state: cloudData.sharing.State):
    Promise<cloudExtension.Result<string>> {
    console.info(`confirm invitation, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the invitation confirmation operation.
    // ...
    // Return the result obtained from ShareCenter.
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'confirm invitation succeeded',
      value: 'sharing_resource_test'
    }
  }

  async changeConfirmation(userId: number, bundleName: string, sharingResource: string, state: cloudData.sharing.State):
    Promise<cloudExtension.Result<void>> {
    console.info(`change confirm, bundle: ${bundleName}`);
    // Connect to ShareCenter and obtain the return value of the state change operation.
    // ...
    // Return the result obtained from ShareCenter.
    return {
      code: cloudData.sharing.SharingCode.SUCCESS,
      description: 'change confirm succeeded'
    }
  }
}

class MyCloudService implements cloudExtension.CloudService {
  constructor() {
  }

  async getServiceInfo(): Promise<cloudExtension.ServiceInfo> {
    console.info(`get service info`);
    // ...
    return {
      enableCloud: true,
      id: "test_id",
      totalSpace: test_space,
      remainingSpace: test_space,
      user: test_userId,
    };
  }

  async getAppBriefInfo(): Promise<Record<string, cloudExtension.AppBriefInfo>> {
    console.info(`get app brief info`);
    // ...
    return {
      "test_bundle":
      {
        appId: "test_appID",
        bundleName: "test_bundlename",
        cloudSwitch: true,
        instanceId: 0,
      }
    };
  }

  async getAppSchema(bundleName: string): Promise<cloudExtension.Result<cloudExtension.AppSchema>> {
    console.info(`get app schema, bundleName:${bundleName}`);
    // ...
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: "get app schema success",
      value: {
        bundleName: "test_bundleName",
        version: 1,
        databases: []
      }
    };
  }

  async subscribe(subInfo: Record<string, Array<cloudExtension.Database>>, expirationTime: number): Promise<cloudExtension.Result<cloudExtension.SubscribeInfo>> {
    console.info(`subscribe expirationTime: ${expirationTime}`);
    // ...
    return {
      code: cloudExtension.ErrorCode.SUCCESS,
      description: "subscribe success",
      value: {
        expirationTime: test_time,
        subscribe: {}
      }
    };
  }

  async unsubscribe(unsubscribeInfo: Record<string, Array<string>>): Promise<number> {
    console.info(`unsubscribe`);
    // ...
    return cloudExtension.ErrorCode.SUCCESS;
  }

  async connectDB(bundleName: string, database: cloudExtension.Database): Promise<rpc.RemoteObject> {
    console.info(`connect DB, bundleName: ${bundleName}`);
    return cloudExtension.createCloudDBStub(new MyCloudDB());
  }

  async connectAssetLoader(bundleName: string, database: cloudExtension.Database): Promise<rpc.RemoteObject> {
    console.info(`connect asset loader, bundle: ${bundleName}`);
    return cloudExtension.createAssetLoaderStub(new MyAssetLoader());
  }

  async connectShareCenter(userId: number, bundleName: string): Promise<rpc.RemoteObject> {
    console.info(`connect share center, bundle: ${bundleName}`);
    // ...
    return cloudExtension.createShareServiceStub(new MyShareCenter());
  }
}

export default class MyServiceExtension extends ServiceExtensionAbility {
  onCreate(want: Want) {
    console.info(`onCreate: ${want}`);
  }

  onRequest(want: Want, startId: number) {
    console.info(`onRequest: ${want} ${startId}`);
  }

  onConnect(want: Want): rpc.RemoteObject | Promise<rpc.RemoteObject> {
    console.info(`onConnect: ${want}`);
    return cloudExtension.createCloudServiceStub(new MyCloudService());
  }

  onDisconnect(want: Want) {
    console.info(`onDisconnect: ${want}`);
  }

  onDestroy() {
    console.info('onDestroy');
  }
}

@ohos.data.cloudExtension (Device-Cloud Sharing Extension) (System API)

Modules to Import

Result<T>

CloudAsset

CloudAssets

ServiceInfo

Flag

ExtensionValue

CloudType

CloudInfo

CloudData

AppBriefInfo

FieldType

Field

Table

Database

AppSchema

SubscribeId

SubscribeInfo

LockInfo

ErrorCode

cloudExtension.createCloudServiceStub

cloudExtension.createShareServiceStub

cloudExtension.createCloudDBStub

cloudExtension.createAssetLoaderStub

CloudDB

generateId

update

insert

delete

query

lock

heartbeat

unlock

CloudService

getServiceInfo

getAppBriefInfo

getAppSchema

subscribe

unsubscribe

connectDB

connectAssetLoader

connectShareCenter

AssetLoader

download

upload

ShareCenter

share

unshare

exit

changePrivilege

queryParticipants

queryParticipantsByInvitation

confirmInvitation

changeConfirmation

Complete Sample Code