mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-23 07:10:52 +00:00
fix:fix code description
Signed-off-by: wangtong <wangtong94@huawei.com>
This commit is contained in:
wangtong
parent
0db359cbe5
commit
3f756f7a1a
77
api/@ohos.data.cloudData.d.ts
vendored
77
api/@ohos.data.cloudData.d.ts
vendored
@ -89,7 +89,7 @@ declare namespace cloudData {
|
||||
|
||||
/**
|
||||
* Extra data, which contains the following fields.
|
||||
* {
|
||||
* '{
|
||||
* "data": "{
|
||||
* "accountId": "aaa",
|
||||
* "bundleName": "com.bbb.xxx",
|
||||
@ -97,7 +97,7 @@ declare namespace cloudData {
|
||||
* "databaseScopes": ["private", "shared"],
|
||||
* "recordTypes": ["xxx", "yyy", "zzz"]
|
||||
* }"
|
||||
* }
|
||||
* }'
|
||||
* All fields are mandatory.
|
||||
*
|
||||
* @type { string }
|
||||
@ -373,8 +373,7 @@ declare namespace cloudData {
|
||||
* @returns { Promise<void> } Promise used to return the result.
|
||||
* @throws { BusinessError } 201 - Permission verification failed, which
|
||||
* is usually returned by <b>VerifyAccessToken</b>.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -394,8 +393,7 @@ declare namespace cloudData {
|
||||
* to return the data changes.
|
||||
* @throws { BusinessError } 201 - Permission verification failed, which
|
||||
* is usually returned by <b>VerifyAccessToken</b>.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -416,8 +414,7 @@ declare namespace cloudData {
|
||||
* to return the data changes.
|
||||
* @throws { BusinessError } 201 - Permission verification failed, which
|
||||
* is usually returned by <b>VerifyAccessToken</b>.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -472,7 +469,7 @@ declare namespace cloudData {
|
||||
* @param { string } [storeId] - Indicates the store ID.
|
||||
* @returns { Promise<Record<string, Array<StatisticInfo>>> } Promise used to return the result.
|
||||
* @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken.
|
||||
* @throws { BusinessError } 202 - Permission denied. The application is not a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -495,8 +492,9 @@ declare namespace cloudData {
|
||||
* @param { string } [storeId] - Indicates the store ID.
|
||||
* @returns { Promise<Record<string, SyncInfo>> } Promise used to return the result.
|
||||
* @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken.
|
||||
* @throws { BusinessError } 202 - Permission denied. The application is not a system application.
|
||||
* @throws { BusinessError } 401 - Parameter error.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
* @syscap SystemCapability.DistributedDataManager.CloudSync.Config
|
||||
* @systemapi
|
||||
@ -1064,8 +1062,7 @@ declare namespace cloudData {
|
||||
* @param { Array<Participant> } participants - Participants to share.
|
||||
* @param { Array<string> } [columns] - Columns to be shared.
|
||||
* @returns { Promise<relationalStore.ResultSet> } - Promise used to return {@link relationalStore.ResultSet}.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1089,8 +1086,7 @@ declare namespace cloudData {
|
||||
* @param { Array<Participant> } participants - Participants to share.
|
||||
* @param { AsyncCallback<relationalStore.ResultSet> } callback - Indicates the
|
||||
* callback invoked to return the {@link relationalStore.ResultSet}.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1115,8 +1111,7 @@ declare namespace cloudData {
|
||||
* @param { Array<string> } columns - Columns to be shared.
|
||||
* @param { AsyncCallback<relationalStore.ResultSet> } callback - Indicates the
|
||||
* callback invoked to return the {@link relationalStore.ResultSet}.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1140,8 +1135,7 @@ declare namespace cloudData {
|
||||
* involved in the data sharing.
|
||||
* @param { AsyncCallback<Result<Array<Result<Participant>>>> } callback - Indicates the
|
||||
* callback invoked to return the result.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1162,8 +1156,7 @@ declare namespace cloudData {
|
||||
* @param { Array<Participant> } participants - Indicates the participants
|
||||
* involved in the data sharing.
|
||||
* @returns { Promise<Result<Array<Result<Participant>>>> } - Promise used to return the result.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1184,8 +1177,7 @@ declare namespace cloudData {
|
||||
* involved.
|
||||
* @param { AsyncCallback<Result<Array<Result<Participant>>>> } callback - Indicates the callback invoked
|
||||
* to return the result.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1206,8 +1198,7 @@ declare namespace cloudData {
|
||||
* @param { Array<Participant> } participants - Indicates the participants
|
||||
* involved.
|
||||
* @returns { Promise<Result<Array<Result<Participant>>>> } - Promise used to return the result.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1225,8 +1216,7 @@ declare namespace cloudData {
|
||||
*
|
||||
* @param { string } sharingResource - Indicates the sharing resource.
|
||||
* @param { AsyncCallback<Result<void>> } callback - The callback of exit.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1241,8 +1231,7 @@ declare namespace cloudData {
|
||||
*
|
||||
* @param { string } sharingResource - Indicates the sharing resource.
|
||||
* @returns { Promise<Result<void>> } - The promise returned by the function.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1260,8 +1249,7 @@ declare namespace cloudData {
|
||||
* whose permissions are to be changed.
|
||||
* @param { AsyncCallback<Result<Array<Result<Participant>>>> } callback - Indicates the
|
||||
* callback invoked to return the result.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1282,8 +1270,7 @@ declare namespace cloudData {
|
||||
* @param { Array<Participant> } participants - Indicates the participants
|
||||
* whose permissions are to be changed.
|
||||
* @returns { Promise<Result<Array<Result<Participant>>>> } - Promise used to return the result.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1302,8 +1289,7 @@ declare namespace cloudData {
|
||||
* @param { string } sharingResource - Indicates the sharing resource.
|
||||
* @param { AsyncCallback<Result<Array<Participant>>> } callback - Indicates the
|
||||
* callback invoked to return the participants obtained.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1318,8 +1304,7 @@ declare namespace cloudData {
|
||||
*
|
||||
* @param { string } sharingResource - Indicates the sharing resource.
|
||||
* @returns { Promise<Result<Array<Participant>>> } - Promise used to return the result.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1335,8 +1320,7 @@ declare namespace cloudData {
|
||||
* @param { string } invitationCode - Indicates the invitation code.
|
||||
* @param { AsyncCallback<Result<Array<Participant>>> } callback - Indicates the
|
||||
* callback invoked to return the participants obtained.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1354,8 +1338,7 @@ declare namespace cloudData {
|
||||
*
|
||||
* @param { string } invitationCode - Indicates the invitation code.
|
||||
* @returns { Promise<Result<Array<Participant>>> } - Promise used to return the result.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1372,8 +1355,7 @@ declare namespace cloudData {
|
||||
* @param { State } state - Indicates the state of invitation.
|
||||
* @param { AsyncCallback<Result<string>> } callback - Indicates the callback
|
||||
* invoked to return the sharing resource.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1389,8 +1371,7 @@ declare namespace cloudData {
|
||||
* @param { string } invitationCode - Indicates the invitation code.
|
||||
* @param { State } state - Indicates the state of invitation.
|
||||
* @returns { Promise<Result<string>> } - Promise used to return the sharing resource.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1406,8 +1387,7 @@ declare namespace cloudData {
|
||||
* @param { string } sharingResource - Indicates the sharing resource.
|
||||
* @param { State } state - Indicates the state of invitation.
|
||||
* @param { AsyncCallback<Result<void>> } callback - Indicates the callback.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
@ -1423,8 +1403,7 @@ declare namespace cloudData {
|
||||
* @param { string } sharingResource - Indicates the sharing resource.
|
||||
* @param { State } state - Indicates the state of invitation.
|
||||
* @returns { Promise<Result<void>> } - The promise returned by the function.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, which is
|
||||
* returned when the system API is not called by a system application.
|
||||
* @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types;
|
||||
* 3. Parameter verification failed.
|
||||
* @throws { BusinessError } 801 - Capability not supported.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user