Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
You need to sign in or sign up before continuing.
未验证 提交 729a08cc 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!16847 [翻译完成】#I6R63W (16013+16247+16144+ 16256+ 6260+16383+ 16104+ 16399+16405+ 16496+16119+16512) 

Merge pull request !16847 from Annie_wang/PR16576
上级 0a22abab f2d904b0
展开全部 隐藏空白更改
内联 并排
Showing with 981 addition and 659 deletion
en/application-dev/reference/apis/Readme-EN.md
浏览文件 @ 729a08cc
...@@ -230,8 +230,6 @@ ...@@ -230,8 +230,6 @@
- [@ohos.data.preferences (Preferences)](js-apis-data-preferences.md) - [@ohos.data.preferences (Preferences)](js-apis-data-preferences.md)
- [@ohos.data.relationalStore (RDB Store)](js-apis-data-relationalStore.md) - [@ohos.data.relationalStore (RDB Store)](js-apis-data-relationalStore.md)
- [@ohos.data.ValuesBucket (Value Bucket)](js-apis-data-valuesBucket.md) - [@ohos.data.ValuesBucket (Value Bucket)](js-apis-data-valuesBucket.md)
- data/rdb
- [resultSet (Result Set)](js-apis-data-resultset.md)
- File Management - File Management
- [@ohos.file.environment (Directory Environment Capability)](js-apis-file-environment.md) - [@ohos.file.environment (Directory Environment Capability)](js-apis-file-environment.md)
...@@ -447,3 +445,5 @@ ...@@ -447,3 +445,5 @@
- [PermissionDef](js-apis-bundle-PermissionDef.md) - [PermissionDef](js-apis-bundle-PermissionDef.md)
- [remoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md) - [remoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md)
- [shortcutInfo](js-apis-bundle-ShortcutInfo.md) - [shortcutInfo](js-apis-bundle-ShortcutInfo.md)
- data/rdb
- [resultSet (Result Set)](js-apis-data-resultset.md)
\ No newline at end of file
en/application-dev/reference/apis/js-apis-abilityAccessCtrl.md
浏览文件 @ 729a08cc
...@@ -207,8 +207,8 @@ For details about the error codes, see [Application Access Control Error Codes]( ...@@ -207,8 +207,8 @@ For details about the error codes, see [Application Access Control Error Codes](
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, or the flags value is invalid. | | 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, or the flags value is invalid. |
| 12100002 | TokenId does not exist. | | 12100002 | The specified tokenID does not exist. |
| 12100003 | Permission does not exist. | | 12100003 | The specified permission does not exist. |
| 12100006 | The application specified by the tokenID is not allowed to be granted with the specified permission. Either the application is a sandbox or the tokenID is from a remote device. | | 12100006 | The application specified by the tokenID is not allowed to be granted with the specified permission. Either the application is a sandbox or the tokenID is from a remote device. |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
...@@ -318,8 +318,8 @@ For details about the error codes, see [Application Access Control Error Codes]( ...@@ -318,8 +318,8 @@ For details about the error codes, see [Application Access Control Error Codes](
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, or the flags value is invalid. | | 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, or the flags value is invalid. |
| 12100002 | TokenId does not exist. | | 12100002 | The specified tokenID does not exist. |
| 12100003 | Permission does not exist. | | 12100003 | The specified permission does not exist. |
| 12100006 | The application specified by the tokenID is not allowed to be revoked with the specified permission. Either the application is a sandbox or the tokenID is from a remote device. | | 12100006 | The application specified by the tokenID is not allowed to be revoked with the specified permission. Either the application is a sandbox or the tokenID is from a remote device. |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
...@@ -693,6 +693,44 @@ promise.then(data => { ...@@ -693,6 +693,44 @@ promise.then(data => {
}); });
``` ```
### checkAccessTokenSync<sup>10+</sup>
checkAccessTokenSync(tokenID: number, permissionName: Permissions): GrantStatus;
Checks whether a permission is granted to an application. This API returns the result synchronously.
**System capability**: SystemCapability.Security.AccessToken
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------------------- | ---- | ------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundleManager-applicationInfo.md). |
| permissionName | Permissions | Yes | Permission to check. For details about the permissions, see the [Application Permission List](../../security/permission-list.md).|
**Return value**
| Type | Description |
| :------------ | :---------------------------------- |
| [GrantStatus](#grantstatus) | Permission grant state.|
**Error codes**
For details about the error codes, see [Application Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. |
**Example**
```js
let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // Use bundleManager.getApplicationInfo() to obtain the token ID for a system application, and use bundleManager.getBundleInfoForSelf() to obtain the token ID for a non-system application.
let data = atManager.checkAccessTokenSync(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS");
console.log(`data->${JSON.stringify(data)}`);
```
### GrantStatus ### GrantStatus
Enumerates the permission grant states. Enumerates the permission grant states.
...@@ -719,7 +757,7 @@ Enumerates the operations that trigger permission grant state changes. ...@@ -719,7 +757,7 @@ Enumerates the operations that trigger permission grant state changes.
### PermissionStateChangeInfo<sup>9+</sup> ### PermissionStateChangeInfo<sup>9+</sup>
Defines detailed information about the permission grant state change. Defines information about the permission grant state change.
**System API**: This is a system API. **System API**: This is a system API.
...@@ -730,4 +768,3 @@ Defines detailed information about the permission grant state change. ...@@ -730,4 +768,3 @@ Defines detailed information about the permission grant state change.
| change | [PermissionStateChangeType](#permissionstatechangetype9) | Yes | No | Operation that triggers the permission grant state change. | | change | [PermissionStateChangeType](#permissionstatechangetype9) | Yes | No | Operation that triggers the permission grant state change. |
| tokenID | number | Yes | No | Token ID of the application. | | tokenID | number | Yes | No | Token ID of the application. |
| permissionName | Permissions | Yes | No | Permission whose grant state changes. For details about the permissions, see the [Application Permission List](../../security/permission-list.md). | | permissionName | Permissions | Yes | No | Permission whose grant state changes. For details about the permissions, see the [Application Permission List](../../security/permission-list.md). |
en/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @ 729a08cc
...@@ -148,7 +148,6 @@ Creates an app account with custom data. This API uses a promise to return the r ...@@ -148,7 +148,6 @@ Creates an app account with custom data. This API uses a promise to return the r
| 12300002 | Invalid name or options. | | 12300002 | Invalid name or options. |
| 12300004 | Account already exists. | | 12300004 | Account already exists. |
| 12300007 | The number of accounts reaches the upper limit. | | 12300007 | The number of accounts reaches the upper limit. |
| 12400003 | The number of custom data reaches the upper limit. |
**Example** **Example**
...@@ -248,7 +247,7 @@ Creates an app account implicitly based on the specified account owner and optio ...@@ -248,7 +247,7 @@ Creates an app account implicitly based on the specified account owner and optio
| ID| Error Message| | ID| Error Message|
| ------- | ------- | | ------- | ------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or options. | | 12300002 | Invalid owner or options. |
| 12300007 | The number of accounts reaches the upper limit. | | 12300007 | The number of accounts reaches the upper limit. |
| 12300010 | Account service busy. | | 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. | | 12300113 | Authenticator service not found. |
...@@ -481,7 +480,6 @@ Checks whether an app can access the data of an account. This API uses an asynch ...@@ -481,7 +480,6 @@ Checks whether an app can access the data of an account. This API uses an asynch
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. | | 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12400001 | Application not found. |
**Example** **Example**
...@@ -527,7 +525,6 @@ Checks whether an app can access the data of an account. This API uses a promise ...@@ -527,7 +525,6 @@ Checks whether an app can access the data of an account. This API uses a promise
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. | | 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12400001 | Application not found. |
**Example** **Example**
...@@ -903,7 +900,7 @@ Sets custom data for an app account. This API uses an asynchronous callback to r ...@@ -903,7 +900,7 @@ Sets custom data for an app account. This API uses an asynchronous callback to r
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or key or value. | | 12300002 | Invalid name, key, or value. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12400003 | The number of custom data reaches the upper limit. | | 12400003 | The number of custom data reaches the upper limit. |
...@@ -950,7 +947,7 @@ Sets custom data for an app account. This API uses a promise to return the resul ...@@ -950,7 +947,7 @@ Sets custom data for an app account. This API uses a promise to return the resul
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or key or value. | | 12300002 | Invalid name, key, or value. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12400003 | The number of custom data reaches the upper limit. | | 12400003 | The number of custom data reaches the upper limit. |
...@@ -1267,7 +1264,6 @@ Subscribes to account information changes of apps. ...@@ -1267,7 +1264,6 @@ Subscribes to account information changes of apps.
| ------- | ------- | | ------- | ------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid type or owners. | | 12300002 | Invalid type or owners. |
| 12300011 | Callback has been registered. |
| 12400001 | Application not found. | | 12400001 | Application not found. |
**Example** **Example**
...@@ -1304,7 +1300,6 @@ Unsubscribes from account information changes. ...@@ -1304,7 +1300,6 @@ Unsubscribes from account information changes.
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid type. | | 12300002 | Invalid type. |
| 12300012 | Callback has not been registered. |
**Example** **Example**
...@@ -1347,7 +1342,7 @@ Authenticates an app account. This API uses an asynchronous callback to return t ...@@ -1347,7 +1342,7 @@ Authenticates an app account. This API uses an asynchronous callback to return t
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType. | | 12300002 | Invalid name, owner, or authType. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300010 | Account service busy. | | 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. | | 12300113 | Authenticator service not found. |
...@@ -1410,8 +1405,8 @@ Authenticates an app account with customized options. This API uses an asynchron ...@@ -1410,8 +1405,8 @@ Authenticates an app account with customized options. This API uses an asynchron
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType. | | 12300002 | Invalid name, owner, authType, or options. |
| 12300003 | Account not exist. | | 12300003 | Account not found. |
| 12300010 | Account service busy. | | 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. | | 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. | | 12300114 | Authenticator service exception. |
...@@ -1522,7 +1517,7 @@ Obtains the authorization token of the specified authentication type for an app ...@@ -1522,7 +1517,7 @@ Obtains the authorization token of the specified authentication type for an app
| ID| Error Message| | ID| Error Message|
| ------- | ------- | | ------- | ------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType. | | 12300002 | Invalid name, owner, or authType. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300107 | AuthType not found. | | 12300107 | AuthType not found. |
...@@ -1562,7 +1557,7 @@ Sets an authorization token of the specific authentication type for an app accou ...@@ -1562,7 +1557,7 @@ Sets an authorization token of the specific authentication type for an app accou
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or authType or token. | | 12300002 | Invalid name, authType, or token. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12400004 | The number of token reaches the upper limit. | | 12400004 | The number of token reaches the upper limit. |
...@@ -1609,7 +1604,7 @@ Sets an authorization token of the specific authentication type for an app accou ...@@ -1609,7 +1604,7 @@ Sets an authorization token of the specific authentication type for an app accou
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or authType or token. | | 12300002 | Invalid name, authType, or token. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12400004 | The number of token reaches the upper limit. | | 12400004 | The number of token reaches the upper limit. |
...@@ -1650,7 +1645,7 @@ Deletes the authorization token of the specified authentication type for an app ...@@ -1650,7 +1645,7 @@ Deletes the authorization token of the specified authentication type for an app
| ID| Error Message| | ID| Error Message|
| ------- | ------- | | ------- | ------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType or token. | | 12300002 | Invalid name, owner, authType, or token. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300107 | AuthType not found. | | 12300107 | AuthType not found. |
...@@ -1698,7 +1693,7 @@ Deletes the authorization token of the specified authentication type for an app ...@@ -1698,7 +1693,7 @@ Deletes the authorization token of the specified authentication type for an app
| ID| Error Message| | ID| Error Message|
| ------- | ------- | | ------- | ------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType or token. | | 12300002 | Invalid name, owner, authType, or token. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300107 | AuthType not found. | | 12300107 | AuthType not found. |
...@@ -1739,7 +1734,7 @@ Sets the visibility of an authorization token to an app. This API uses an asynch ...@@ -1739,7 +1734,7 @@ Sets the visibility of an authorization token to an app. This API uses an asynch
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. | | 12300002 | Invalid name, authType, or bundleName. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300107 | AuthType not found. | | 12300107 | AuthType not found. |
| 12400001 | Application not found. | | 12400001 | Application not found. |
...@@ -1789,7 +1784,7 @@ Sets the visibility of an authorization token to an app. This API uses a promise ...@@ -1789,7 +1784,7 @@ Sets the visibility of an authorization token to an app. This API uses a promise
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. | | 12300002 | Invalid name, authType, or bundleName. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300107 | AuthType not found. | | 12300107 | AuthType not found. |
| 12400001 | Application not found. | | 12400001 | Application not found. |
...@@ -1831,10 +1826,9 @@ Checks the visibility of an authorization token of the specified authentication ...@@ -1831,10 +1826,9 @@ Checks the visibility of an authorization token of the specified authentication
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. | | 12300002 | Invalid name, authType, or bundleName. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300107 | AuthType not found. | | 12300107 | AuthType not found. |
| 12400001 | Application not found. |
**Example** **Example**
...@@ -1879,10 +1873,9 @@ Checks the visibility of an authorization token of the specified authentication ...@@ -1879,10 +1873,9 @@ Checks the visibility of an authorization token of the specified authentication
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. | | 12300002 | Invalid name, authType, or bundleName. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300107 | AuthType not found. | | 12300107 | AuthType not found. |
| 12400001 | Application not found. |
**Example** **Example**
...@@ -2281,7 +2274,7 @@ Checks whether an app account has specific labels. This API uses an asynchronous ...@@ -2281,7 +2274,7 @@ Checks whether an app account has specific labels. This API uses an asynchronous
| ID| Error Message| | ID| Error Message|
| ------- | ------- | | ------- | ------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or owner or labels. | | 12300002 | Invalid name, owner, or labels. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300010 | Account service busy. | | 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. | | 12300113 | Authenticator service not found. |
...@@ -2331,7 +2324,7 @@ Checks whether an app account has specific labels. This API uses a promise to re ...@@ -2331,7 +2324,7 @@ Checks whether an app account has specific labels. This API uses a promise to re
| ID| Error Message| | ID| Error Message|
| ------- | ------- | | ------- | ------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or owner or labels. | | 12300002 | Invalid name, owner, or labels. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300010 | Account service busy. | | 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. | | 12300113 | Authenticator service not found. |
...@@ -2594,7 +2587,7 @@ Verifies the user credential. This API uses an asynchronous callback to return t ...@@ -2594,7 +2587,7 @@ Verifies the user credential. This API uses an asynchronous callback to return t
| ID| Error Message| | ID| Error Message|
| ------- | -------| | ------- | -------|
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid name or owner or options. | | 12300002 | Invalid name, owner, or options. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300010 | Account service busy. | | 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. | | 12300113 | Authenticator service not found. |
......
en/application-dev/reference/apis/js-apis-data-distributedobject.md
浏览文件 @ 729a08cc
...@@ -131,7 +131,7 @@ Sets a session ID for synchronization. Automatic synchronization is performed fo ...@@ -131,7 +131,7 @@ Sets a session ID for synchronization. Automatic synchronization is performed fo
**Error codes** **Error codes**
For details about the error codes, see [Distributed Data Object Error Codes](../errorcodes/errorcode-distributed-dataObject.md). For details about the error codes, see [Distributed Data Object Error Codes](../errorcodes/errorcode-distributed-dataObject.md).
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
...@@ -288,7 +288,7 @@ g_object.off("change"); ...@@ -288,7 +288,7 @@ g_object.off("change");
on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, status: 'online' | 'offline' }>): void on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, status: 'online' | 'offline' }>): void
Subscribes to statue changes of this distributed data object. Subscribes to status changes of this distributed data object.
**System capability**: SystemCapability.DistributedDataManager.DataObject.DistributedObject **System capability**: SystemCapability.DistributedDataManager.DataObject.DistributedObject
...@@ -363,7 +363,12 @@ The saved data will be released in the following cases: ...@@ -363,7 +363,12 @@ The saved data will be released in the following cases:
```ts ```ts
g_object.setSessionId("123456"); g_object.setSessionId("123456");
g_object.save("local", (result) => { 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 callback");
console.info("save sessionId: " + result.sessionId); console.info("save sessionId: " + result.sessionId);
console.info("save version: " + result.version); console.info("save version: " + result.version);
...@@ -408,8 +413,9 @@ g_object.save("local").then((result) => { ...@@ -408,8 +413,9 @@ g_object.save("local").then((result) => {
console.info("save sessionId " + result.sessionId); console.info("save sessionId " + result.sessionId);
console.info("save version " + result.version); console.info("save version " + result.version);
console.info("save deviceId " + result.deviceId); console.info("save deviceId " + result.deviceId);
}, () => { }).catch((err) => {
console.error("save failed"); console.info("save failed, error code = " + err.code);
console.info("save failed, error message: " + err.message);
}); });
``` ```
...@@ -435,16 +441,26 @@ If the object is stored on another device, the data on the local device will be ...@@ -435,16 +441,26 @@ If the object is stored on another device, the data on the local device will be
```js ```js
g_object.setSessionId("123456"); g_object.setSessionId("123456");
// Save data for persistence. // Save data for persistence.
g_object.save("local", (result) => { 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 callback");
console.info("save sessionId " + result.sessionId); console.info("save sessionId: " + result.sessionId);
console.info("save version " + result.version); console.info("save version: " + result.version);
console.info("save deviceId " + result.deviceId); console.info("save deviceId: " + result.deviceId);
}); });
// Delete the persistence data. // Delete the persistence data.
g_object.revokeSave((result) => { g_object.revokeSave((err, result) => {
console.info("revokeSave callback"); if (err) {
console.info("revokeSave sessionId " + result.sessionId); 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);
}); });
``` ```
...@@ -475,15 +491,17 @@ g_object.save("local").then((result) => { ...@@ -475,15 +491,17 @@ g_object.save("local").then((result) => {
console.info("save sessionId " + result.sessionId); console.info("save sessionId " + result.sessionId);
console.info("save version " + result.version); console.info("save version " + result.version);
console.info("save deviceId " + result.deviceId); console.info("save deviceId " + result.deviceId);
}, () => { }).catch((err) => {
console.error("save failed"); console.info("save failed, error code = " + err.code);
console.info("save failed, error message: " + err.message);
}); });
// Delete the persistence data. // Delete the persistence data.
g_object.revokeSave().then((result) => { g_object.revokeSave().then((result) => {
console.info("revokeSave callback"); console.info("revokeSave callback");
console.info("sessionId" + result.sessionId); console.info("sessionId" + result.sessionId);
}, () => { }).catch((err)=> {
console.error("revokeSave failed"); console.info("revokeSave failed, error code = " + err.code);
console.info("revokeSave failed, error message = " + err.message);
}); });
``` ```
...@@ -583,7 +601,7 @@ Subscribes to data changes of this distributed data object. ...@@ -583,7 +601,7 @@ Subscribes to data changes of this distributed data object.
**Example** **Example**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
globalThis.changeCallback = (sessionId, changeData) => { globalThis.changeCallback = (sessionId, changeData) => {
console.info("change" + sessionId); console.info("change" + sessionId);
...@@ -612,14 +630,14 @@ Unsubscribes from the data changes of this distributed data object. ...@@ -612,14 +630,14 @@ Unsubscribes from the data changes of this distributed data object.
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type to unsubscribe from. The value is **change**, which indicates data changes. | | type | string | Yes| Event type to unsubscribe from. The value is **change**, which indicates data changes.|
| callback | Callback<{ sessionId: string, fields: Array&lt;string&gt; }> | No| Callback for data changes. If this parameter is not specified, all data change callbacks of this distributed data object will be unregistered.<br>**sessionId** indicates the session ID of the distributed data object.<br>**fields** indicates the changed attributes of the distributed data object.| | callback | Callback<{ sessionId: string, fields: Array&lt;string&gt; }> | No| Callback for data changes. If this parameter is not specified, all data change callbacks of this distributed data object will be unregistered.<br>**sessionId** indicates the session ID of the distributed data object.<br>**fields** indicates the changed attributes of the distributed data object.|
**Example** **Example**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
// Unregister the specified data change callback. // Unregister the specified data change callback.
g_object.off("change", globalThis.changeCallback); g_object.off("change", globalThis.changeCallback);
...@@ -673,14 +691,14 @@ Unsubscribes from the status change of this distributed data object. ...@@ -673,14 +691,14 @@ Unsubscribes from the status change of this distributed data object.
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Event type to unsubscribe from. The value is **status**, which indicates the status change (online or offline) of the distributed data object. | | type | string | Yes| Event type to unsubscribe from. The value is **status**, which indicates the status change (online or offline) of the distributed data object.|
| callback | Callback<{ sessionId: string, deviceId: string, status: 'online' \| 'offline' }> | No| Callback for status changes. If this parameter is not specified, all status change callbacks of this distributed data object will be unregistered.<br>**sessionId** indicates the session ID of the distributed data object.<br>**deviceId** indicates the device ID of the distributed data object.<br>**status** indicates the object status, which can be online or offline.| | callback | Callback<{ sessionId: string, deviceId: string, status: 'online' \| 'offline' }> | No| Callback for status changes. If this parameter is not specified, all status change callbacks of this distributed data object will be unregistered.<br>**sessionId** indicates the session ID of the distributed data object.<br>**deviceId** indicates the device ID of the distributed data object.<br>**status** indicates the object status, which can be online or offline.|
**Example** **Example**
```js ```js
import distributedObject from '@ohos.data.distributedDataObject'; import distributedObject from '@ohos.data.distributedDataObject';
let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}}); let g_object = distributedObject.createDistributedObject({name:"Amy", age:18, isVis:false, parent:{mother:"jack mom",father:"jack Dad"}});
globalThis.statusCallback = (sessionId, networkId, status) => { globalThis.statusCallback = (sessionId, networkId, status) => {
globalThis.response += "status changed " + sessionId + " " + status + " " + networkId; globalThis.response += "status changed " + sessionId + " " + status + " " + networkId;
......
en/application-dev/reference/apis/js-apis-data-rdb.md
浏览文件 @ 729a08cc
...@@ -7,7 +7,7 @@ This module provides the following RDB-related functions: ...@@ -7,7 +7,7 @@ This module provides the following RDB-related functions:
- [RdbPredicates](#rdbpredicates): provides predicates indicating the nature, feature, or relationship of a data entity in an RDB store. It is used to define the operation conditions for an RDB store. - [RdbPredicates](#rdbpredicates): provides predicates indicating the nature, feature, or relationship of a data entity in an RDB store. It is used to define the operation conditions for an RDB store.
- [RdbStore](#rdbstore): provides APIs for managing an RDB store. - [RdbStore](#rdbstore): provides APIs for managing an RDB store.
> **NOTE**<br/> > **NOTE**
> >
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
> >
...@@ -31,7 +31,7 @@ Obtains an RDB store. This API uses an asynchronous callback to return the resul ...@@ -31,7 +31,7 @@ Obtains an RDB store. This API uses an asynchronous callback to return the resul
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
| context | Context | Yes | Application context.<br>For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).<br>For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | context | Context | Yes | Application context.<br>For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).<br>For details about the application context of the stage model, see [Context](js-apis-inner-app-context.md).|
| config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. | | config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. |
| version | number | Yes | RDB store version.<br>Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. | | version | number | Yes | RDB store version.<br>Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. |
| callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | Yes | Callback invoked to return the RDB store obtained. | | callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | Yes | Callback invoked to return the RDB store obtained. |
...@@ -92,7 +92,7 @@ Obtains an RDB store. This API uses a promise to return the result. You can set ...@@ -92,7 +92,7 @@ Obtains an RDB store. This API uses a promise to return the result. You can set
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------- | --------------------------- | ---- | ------------------------------------------------------------ | | ------- | --------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | Yes | Application context.<br>For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).<br>For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | context | Context | Yes | Application context.<br>For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).<br>For details about the application context of the stage model, see [Context](js-apis-inner-app-context.md).|
| config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. | | config | [StoreConfig](#storeconfig) | Yes | Configuration of the RDB store. |
| version | number | Yes | RDB store version.<br>Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. | | version | number | Yes | RDB store version.<br>Currently, automatic RDB upgrades and downgrades performed based on **version** is not supported. |
...@@ -156,7 +156,7 @@ Deletes an RDB store. This API uses an asynchronous callback to return the resul ...@@ -156,7 +156,7 @@ Deletes an RDB store. This API uses an asynchronous callback to return the resul
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| context | Context | Yes | Application context.<br>For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).<br>For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | context | Context | Yes | Application context.<br>For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).<br>For details about the application context of the stage model, see [Context](js-apis-inner-app-context.md).|
| name | string | Yes | Name of the RDB store to delete. | | name | string | Yes | Name of the RDB store to delete. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result. |
...@@ -214,7 +214,7 @@ Deletes an RDB store. This API uses a promise to return the result. ...@@ -214,7 +214,7 @@ Deletes an RDB store. This API uses a promise to return the result.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------- | ------- | ---- | ------------------------------------------------------------ | | ------- | ------- | ---- | ------------------------------------------------------------ |
| context | Context | Yes | Application context.<br>For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).<br>For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | context | Context | Yes | Application context.<br>For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).<br>For details about the application context of the stage model, see [Context](js-apis-inner-app-context.md).|
| name | string | Yes | Name of the RDB store to delete. | | name | string | Yes | Name of the RDB store to delete. |
**Return value** **Return value**
...@@ -349,6 +349,10 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates ...@@ -349,6 +349,10 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates
Sets an **RdbPredicates** to specify the remote devices to connect on the network during distributed database synchronization. Sets an **RdbPredicates** to specify the remote devices to connect on the network during distributed database synchronization.
> **NOTE**
>
> The value of **devices** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
**Parameters** **Parameters**
...@@ -366,8 +370,24 @@ Sets an **RdbPredicates** to specify the remote devices to connect on the networ ...@@ -366,8 +370,24 @@ Sets an **RdbPredicates** to specify the remote devices to connect on the networ
**Example** **Example**
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") import deviceManager from '@ohos.distributedHardware.deviceManager';
predicates.inDevices(['12345678abcde']) let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceIds = [];
for (var i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
})
let predicates = new data_rdb.RdbPredicates("EMPLOYEE");
predicates.inDevices(deviceIds);
``` ```
### inAllDevices<sup>8+</sup> ### inAllDevices<sup>8+</sup>
...@@ -1269,10 +1289,10 @@ const valueBucket3 = { ...@@ -1269,10 +1289,10 @@ const valueBucket3 = {
let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3); let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
rdbStore.batchInsert("EMPLOYEE", valueBuckets, function(status, insertNum) { rdbStore.batchInsert("EMPLOYEE", valueBuckets, function(status, insertNum) {
if (status) { if (status) {
console.log("Failed to batch insert data, status = " + status); console.log("batchInsert is failed, status = " + status);
return; return;
} }
console.log("Batch inserted data successfully. The number of values that were inserted = " + insertNum); console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
}) })
``` ```
...@@ -1322,9 +1342,9 @@ const valueBucket3 = { ...@@ -1322,9 +1342,9 @@ const valueBucket3 = {
let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3); let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
let promise = rdbStore.batchInsert("EMPLOYEE", valueBuckets); let promise = rdbStore.batchInsert("EMPLOYEE", valueBuckets);
promise.then((insertNum) => { promise.then((insertNum) => {
console.log("Batch inserted data successfully. The number of values that were inserted = " + insertNum); console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
}).catch((status) => { }).catch((status) => {
console.log("Failed to batch insert data, status = " + status); console.log("batchInsert is failed, status = " + status);
}) })
``` ```
...@@ -1340,7 +1360,7 @@ Updates data in the RDB store based on the specified **RdbPredicates** object. T ...@@ -1340,7 +1360,7 @@ Updates data in the RDB store based on the specified **RdbPredicates** object. T
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| values | [ValuesBucket](#valuesbucket) | Yes| Data to update in the RDB store. The key-value pair is associated with the column name in the target table.| | values | [ValuesBucket](#valuesbucket) | Yes| Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
| predicates | [RdbPredicates](#rdbpredicates) | Yes| Update conditions specified by the **RdbPredicates** object.| | predicates | [RdbPredicates](#rdbpredicates) | Yes| Update conditions specified by the **RdbPredicates** object.|
| callback | AsyncCallback&lt;number&gt; | Yes| Callback invoked to return the number of rows updated.| | callback | AsyncCallback&lt;number&gt; | Yes| Callback invoked to return the number of rows updated.|
...@@ -1376,7 +1396,7 @@ Updates data based on the specified **RdbPredicates** object. This API uses a pr ...@@ -1376,7 +1396,7 @@ Updates data based on the specified **RdbPredicates** object. This API uses a pr
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| values | [ValuesBucket](#valuesbucket) | Yes| Data to update in the RDB store. The key-value pair is associated with the column name in the target table.| | values | [ValuesBucket](#valuesbucket) | Yes| Rows of data to update in the RDB store. The key-value pair is associated with the column name in the target table.|
| predicates | [RdbPredicates](#rdbpredicates) | Yes| Update conditions specified by the **RdbPredicates** object.| | predicates | [RdbPredicates](#rdbpredicates) | Yes| Update conditions specified by the **RdbPredicates** object.|
**Return value** **Return value**
...@@ -1619,7 +1639,7 @@ rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) { ...@@ -1619,7 +1639,7 @@ rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) {
console.info("Failed to execute SQL, err: " + err) console.info("Failed to execute SQL, err: " + err)
return return
} }
console.info('Created table successfully.') console.info('Create table done.')
}) })
``` ```
...@@ -1650,7 +1670,7 @@ Executes an SQL statement that contains specified arguments but returns no value ...@@ -1650,7 +1670,7 @@ Executes an SQL statement that contains specified arguments but returns no value
const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
let promise = rdbStore.executeSql(SQL_CREATE_TABLE) let promise = rdbStore.executeSql(SQL_CREATE_TABLE)
promise.then(() => { promise.then(() => {
console.info('Created table successfully.') console.info('Create table done.')
}).catch((err) => { }).catch((err) => {
console.info("Failed to execute SQL, err: " + err) console.info("Failed to execute SQL, err: " + err)
}) })
...@@ -1808,7 +1828,11 @@ promise.then(() => { ...@@ -1808,7 +1828,11 @@ promise.then(() => {
obtainDistributedTableName(device: string, table: string, callback: AsyncCallback&lt;string&gt;): void obtainDistributedTableName(device: string, table: string, callback: AsyncCallback&lt;string&gt;): void
Obtains the distributed table name for a remote device based on the local table name. This API uses an asynchronous callback to return the result. The distributed table name is required when the RDB store of a remote device is queried. Obtains the distributed table name for a remote device based on the local table name. The distributed table name is required when the RDB store of a remote device is queried.
> **NOTE**<br/>
>
> The value of **device** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
...@@ -1818,14 +1842,28 @@ Obtains the distributed table name for a remote device based on the local table ...@@ -1818,14 +1842,28 @@ Obtains the distributed table name for a remote device based on the local table
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| device | string | Yes| Remote device.| | device | string | Yes| ID of the remote device.|
| table | string | Yes| Local table name.| | table | string | Yes| Local table name of the remote device.|
| callback | AsyncCallback&lt;string&gt; | Yes| Callback invoked to return the result. If the operation succeeds, the distributed table name of the remote device is returned.| | callback | AsyncCallback&lt;string&gt; | Yes| Callback invoked to return the result. If the operation succeeds, the distributed table name of the remote device is returned.|
**Example** **Example**
```js ```js
rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) { import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceId = devices[0].deviceId;
})
rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE", function (err, tableName) {
if (err) { if (err) {
console.info('Failed to obtain DistributedTableName, err: ' + err) console.info('Failed to obtain DistributedTableName, err: ' + err)
return return
...@@ -1838,7 +1876,11 @@ rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, ...@@ -1838,7 +1876,11 @@ rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err,
obtainDistributedTableName(device: string, table: string): Promise&lt;string&gt; obtainDistributedTableName(device: string, table: string): Promise&lt;string&gt;
Obtains the distributed table name for a remote device based on the local table name. This API uses a promise to return the result. The distributed table name is required when the RDB store of a remote device is queried. Obtains the distributed table name for a remote device based on the local table name. The distributed table name is required when the RDB store of a remote device is queried.
> **NOTE**<br/>
>
> The value of **device** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
...@@ -1848,8 +1890,8 @@ Obtains the distributed table name for a remote device based on the local table ...@@ -1848,8 +1890,8 @@ Obtains the distributed table name for a remote device based on the local table
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| device | string | Yes| Remote device.| | device | string | Yes| ID of the remote device.|
| table | string | Yes| Local table name.| | table | string | Yes| Local table name of the remote device.|
**Return value** **Return value**
...@@ -1860,7 +1902,20 @@ Obtains the distributed table name for a remote device based on the local table ...@@ -1860,7 +1902,20 @@ Obtains the distributed table name for a remote device based on the local table
**Example** **Example**
```js ```js
let promise = rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE") import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceId = devices[0].deviceId;
})
let promise = rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE")
promise.then((tableName) => { promise.then((tableName) => {
console.info('Obtained distributed table name successfully, tableName= ' + tableName) console.info('Obtained distributed table name successfully, tableName= ' + tableName)
}).catch((err) => { }).catch((err) => {
...@@ -1889,8 +1944,24 @@ Synchronizes data between devices. This API uses an asynchronous callback to ret ...@@ -1889,8 +1944,24 @@ Synchronizes data between devices. This API uses an asynchronous callback to ret
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceIds = [];
for (var i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
})
let predicates = new data_rdb.RdbPredicates('EMPLOYEE') let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde']) predicates.inDevices(deviceIds)
rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) { rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) {
if (err) { if (err) {
console.log('Sync failed, err: ' + err) console.log('Sync failed, err: ' + err)
...@@ -1924,13 +1995,29 @@ Synchronizes data between devices. This API uses a promise to return the result. ...@@ -1924,13 +1995,29 @@ Synchronizes data between devices. This API uses a promise to return the result.
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;Array&lt;[string, number]&gt;&gt; | Promise used to return the synchronization result to the caller. <br>**string** indicates the device ID. <br>**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. | | Promise&lt;Array&lt;[string, number]&gt;&gt; | Promise used to return the synchronization result. <br>**string** indicates the device ID. <br>**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. |
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceIds = [];
for (var i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
})
let predicates = new data_rdb.RdbPredicates('EMPLOYEE') let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde']) predicates.inDevices(deviceIds)
let promise = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates) let promise = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates)
promise.then((result) =>{ promise.then((result) =>{
console.log('Sync done.') console.log('Sync done.')
......
en/application-dev/reference/apis/js-apis-data-relationalStore.md
浏览文件 @ 729a08cc
...@@ -115,7 +115,7 @@ Obtains an RDB store. This API uses a promise to return the result. You can set ...@@ -115,7 +115,7 @@ Obtains an RDB store. This API uses a promise to return the result. You can set
| Type | Description | | Type | Description |
| ----------------------------------------- | --------------------------------- | | ----------------------------------------- | --------------------------------- |
| Promise&lt;[RdbStore](#rdbstore)&gt; | Promise used to return the RDB store obtained.| | Promise&lt;[RdbStore](#rdbstore)&gt; | Promise used to return the **RdbStore** object.|
**Error codes** **Error codes**
...@@ -414,9 +414,12 @@ let predicates = new relationalStore.RdbPredicates("EMPLOYEE"); ...@@ -414,9 +414,12 @@ let predicates = new relationalStore.RdbPredicates("EMPLOYEE");
inDevices(devices: Array&lt;string&gt;): RdbPredicates inDevices(devices: Array&lt;string&gt;): RdbPredicates
Sets an **RdbPredicates** to specify the remote devices to connect on the network during distributed database synchronization. Sets an **RdbPredicates** to specify the remote devices to connect on the network during distributed database synchronization.
> **NOTE**<br/>
>
> The value of **devices** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
**Parameters** **Parameters**
...@@ -434,8 +437,24 @@ Sets an **RdbPredicates** to specify the remote devices to connect on the networ ...@@ -434,8 +437,24 @@ Sets an **RdbPredicates** to specify the remote devices to connect on the networ
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceIds = [];
for (var i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
})
let predicates = new relationalStore.RdbPredicates("EMPLOYEE"); let predicates = new relationalStore.RdbPredicates("EMPLOYEE");
predicates.inDevices(['12345678abcde']); predicates.inDevices(deviceIds);
``` ```
### inAllDevices ### inAllDevices
...@@ -2008,24 +2027,41 @@ remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: A ...@@ -2008,24 +2027,41 @@ remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: A
Queries data from the RDB store of a remote device based on specified conditions. This API uses an asynchronous callback to return the result. Queries data from the RDB store of a remote device based on specified conditions. This API uses an asynchronous callback to return the result.
> **NOTE**<br/>
>
> The value of **device** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- | | ---------- | -------------------------------------------- | ---- | --------------------------------------------------------- |
| device | string | Yes | Network ID of the remote device. | | device | string | Yes | ID of the remote device. |
| table | string | Yes | Name of the target table. | | table | string | Yes | Name of the target table. |
| predicates | [RdbPredicates](#rdbpredicates) | Yes | Query conditions specified by the **RdbPredicates** object. | | predicates | [RdbPredicates](#rdbpredicates) | Yes | Query conditions specified by the **RdbPredicates** object. |
| columns | Array&lt;string&gt; | Yes | Columns to query. If this parameter is not specified, the query applies to all columns. | | columns | Array&lt;string&gt; | Yes | Columns to query. If this parameter is not specified, the query applies to all columns. |
| callback | AsyncCallback&lt;[ResultSet](#resultset)&gt; | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSet** object will be returned.| | callback | AsyncCallback&lt;[ResultSet](#resultset)&gt; | Yes | Callback invoked to return the result. If the operation is successful, a **ResultSet** object will be returned.|
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceId = devices[0].deviceId;
})
let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
predicates.greaterThan("id", 0); predicates.greaterThan("id", 0);
store.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], store.remoteQuery(deviceId, "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"],
function(err, resultSet) { function(err, resultSet) {
if (err) { if (err) {
console.error(`Failed to remoteQuery, err: ${err}`); console.error(`Failed to remoteQuery, err: ${err}`);
...@@ -2043,13 +2079,17 @@ remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: A ...@@ -2043,13 +2079,17 @@ remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: A
Queries data from the RDB store of a remote device based on specified conditions. This API uses a promise to return the result. Queries data from the RDB store of a remote device based on specified conditions. This API uses a promise to return the result.
> **NOTE**<br/>
>
> The value of **device** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | ------------------------------------ | ---- | ------------------------------------------------ | | ---------- | ------------------------------------ | ---- | ------------------------------------------------ |
| device | string | Yes | Network ID of the remote device. | | device | string | Yes | ID of the remote device. |
| table | string | Yes | Name of the target table. | | table | string | Yes | Name of the target table. |
| predicates | [RdbPredicates](#rdbpredicates) | Yes | Query conditions specified by the **RdbPredicates** object. | | predicates | [RdbPredicates](#rdbpredicates) | Yes | Query conditions specified by the **RdbPredicates** object. |
| columns | Array&lt;string&gt; | Yes | Columns to query. If this parameter is not specified, the query applies to all columns.| | columns | Array&lt;string&gt; | Yes | Columns to query. If this parameter is not specified, the query applies to all columns.|
...@@ -2063,6 +2103,19 @@ Queries data from the RDB store of a remote device based on specified conditions ...@@ -2063,6 +2103,19 @@ Queries data from the RDB store of a remote device based on specified conditions
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceId = devices[0].deviceId;
})
let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
predicates.greaterThan("id", 0); predicates.greaterThan("id", 0);
let promise = store.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]); let promise = store.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]);
...@@ -2488,7 +2541,11 @@ promise.then(() => { ...@@ -2488,7 +2541,11 @@ promise.then(() => {
obtainDistributedTableName(device: string, table: string, callback: AsyncCallback&lt;string&gt;): void obtainDistributedTableName(device: string, table: string, callback: AsyncCallback&lt;string&gt;): void
Obtains the distributed table name for a remote device based on the local table name. This API uses an asynchronous callback to return the result. The distributed table name is required when the RDB store of a remote device is queried. Obtains the distributed table name for a remote device based on the local table name. The distributed table name is required when the RDB store of a remote device is queried.
> **NOTE**<br/>
>
> The value of **device** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
...@@ -2498,14 +2555,27 @@ Obtains the distributed table name for a remote device based on the local table ...@@ -2498,14 +2555,27 @@ Obtains the distributed table name for a remote device based on the local table
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| device | string | Yes | Remote device. | | device | string | Yes | ID of the remote device. |
| table | string | Yes | Local table name. | | table | string | Yes | Local table name of the remote device. |
| callback | AsyncCallback&lt;string&gt; | Yes | Callback invoked to return the result. If the operation succeeds, the distributed table name of the remote device is returned.| | callback | AsyncCallback&lt;string&gt; | Yes | Callback invoked to return the result. If the operation succeeds, the distributed table name of the remote device is returned.|
**Example** **Example**
```js ```js
store.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) { import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceId = devices[0].deviceId;
})
store.obtainDistributedTableName(deviceId, "EMPLOYEE", function (err, tableName) {
if (err) { if (err) {
console.error(`ObtainDistributedTableName failed, err: ${err}`); console.error(`ObtainDistributedTableName failed, err: ${err}`);
return; return;
...@@ -2518,7 +2588,11 @@ store.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tab ...@@ -2518,7 +2588,11 @@ store.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tab
obtainDistributedTableName(device: string, table: string): Promise&lt;string&gt; obtainDistributedTableName(device: string, table: string): Promise&lt;string&gt;
Obtains the distributed table name for a remote device based on the local table name. This API uses a promise to return the result. The distributed table name is required when the RDB store of a remote device is queried. Obtains the distributed table name for a remote device based on the local table name. The distributed table name is required when the RDB store of a remote device is queried.
> **NOTE**<br/>
>
> The value of **device** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
...@@ -2526,10 +2600,10 @@ Obtains the distributed table name for a remote device based on the local table ...@@ -2526,10 +2600,10 @@ Obtains the distributed table name for a remote device based on the local table
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ---------- | | ------ | ------ | ---- | -------------------- |
| device | string | Yes | Remote device.| | device | string | Yes | ID of the remote device. |
| table | string | Yes | Local table name.| | table | string | Yes | Local table name of the remote device.|
**Return value** **Return value**
...@@ -2540,7 +2614,20 @@ Obtains the distributed table name for a remote device based on the local table ...@@ -2540,7 +2614,20 @@ Obtains the distributed table name for a remote device based on the local table
**Example** **Example**
```js ```js
let promise = store.obtainDistributedTableName("12345678abcde", "EMPLOYEE"); import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceId = devices[0].deviceId;
})
let promise = store.obtainDistributedTableName(deviceId, "EMPLOYEE");
promise.then((tableName) => { promise.then((tableName) => {
console.info(`ObtainDistributedTableName successfully, tableName= ${tableName}`); console.info(`ObtainDistributedTableName successfully, tableName= ${tableName}`);
}).catch((err) => { }).catch((err) => {
...@@ -2569,8 +2656,24 @@ Synchronizes data between devices. This API uses an asynchronous callback to ret ...@@ -2569,8 +2656,24 @@ Synchronizes data between devices. This API uses an asynchronous callback to ret
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceIds = [];
for (var i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
})
let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
predicates.inDevices(['12345678abcde']); predicates.inDevices(deviceIds);
store.sync(relationalStore.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) { store.sync(relationalStore.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) {
if (err) { if (err) {
console.error(`Sync failed, err: ${err}`); console.error(`Sync failed, err: ${err}`);
...@@ -2609,8 +2712,24 @@ Synchronizes data between devices. This API uses a promise to return the result. ...@@ -2609,8 +2712,24 @@ Synchronizes data between devices. This API uses a promise to return the result.
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmInstance = null;
deviceManager.createDeviceManager("com.example.appdatamgrverify", (err, manager) => {
if (err) {
console.log("create device manager failed, err=" + err);
return;
}
dmInstance = manager;
let devices = dmInstance.getTrustedDeviceListSync();
let deviceIds = [];
for (var i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
})
let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
predicates.inDevices(['12345678abcde']); predicates.inDevices(deviceIds);
let promise = store.sync(relationalStore.SyncMode.SYNC_MODE_PUSH, predicates); let promise = store.sync(relationalStore.SyncMode.SYNC_MODE_PUSH, predicates);
promise.then((result) =>{ promise.then((result) =>{
console.info(`Sync done.`); console.info(`Sync done.`);
...@@ -2634,9 +2753,9 @@ Registers an observer for this RDB store. When the data in the RDB store changes ...@@ -2634,9 +2753,9 @@ Registers an observer for this RDB store. When the data in the RDB store changes
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ----------------------------------- | ---- | ------------------------------------------- | | -------- | ----------------------------------- | ---- | ------------------------------------------- |
| event | string | Yes | Event to observe. The value is **dataChange**, which indicates a data change event. | | event | string | Yes | Event to observe. The value is **dataChange**, which indicates a data change event. |
| type | [SubscribeType](#subscribetype) | Yes | Subscription type to register.| | type | [SubscribeType](#subscribetype) | Yes | Subscription type to register.|
| observer | Callback&lt;Array&lt;string&gt;&gt; | Yes | Callback invoked to return the data change event. | | observer | Callback&lt;Array&lt;string&gt;&gt; | Yes | Callback invoked to return the data change event. |
**Example** **Example**
...@@ -2657,7 +2776,7 @@ try { ...@@ -2657,7 +2776,7 @@ try {
off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;string&gt;&gt;): void
Unregisters the observer of the specified type from the RDB store. This API uses an asynchronous callback to return the result. Unregisters the observer of the specified type from the RDB store. This API uses a callback to return the result.
**System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core
......
en/application-dev/reference/apis/js-apis-distributed-account.md
浏览文件 @ 729a08cc
...@@ -232,7 +232,8 @@ Sets the distributed account information. This API uses a promise to return the ...@@ -232,7 +232,8 @@ Sets the distributed account information. This API uses a promise to return the
| ID| Error Message| | ID| Error Message|
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | invalid accountInfo. | | 12300002 | Invalid accountInfo. |
| 12300003 | Account not found. |
**Example** **Example**
```js ```js
...@@ -325,4 +326,4 @@ Defines distributed OS account information. ...@@ -325,4 +326,4 @@ Defines distributed OS account information.
| event | string | Yes| Login state of the distributed account. The state can be login, logout, token invalid, or logoff, which correspond to the following strings respectively:<br>-&nbsp;Ohos.account.event.LOGIN<br>-&nbsp;Ohos.account.event.LOGOUT<br>-&nbsp;Ohos.account.event.TOKEN_INVALID<br>-&nbsp;Ohos.account.event.LOGOFF | | event | string | Yes| Login state of the distributed account. The state can be login, logout, token invalid, or logoff, which correspond to the following strings respectively:<br>-&nbsp;Ohos.account.event.LOGIN<br>-&nbsp;Ohos.account.event.LOGOUT<br>-&nbsp;Ohos.account.event.TOKEN_INVALID<br>-&nbsp;Ohos.account.event.LOGOFF |
| nickname<sup>9+</sup> | string | No| Nickname of the distributed account. It must be a non-null string.| | nickname<sup>9+</sup> | string | No| Nickname of the distributed account. It must be a non-null string.|
| avatar<sup>9+</sup> | string | No| Avatar of the distributed account. It must be a non-null string.| | avatar<sup>9+</sup> | string | No| Avatar of the distributed account. It must be a non-null string.|
| scalableData | object | No| Extended information about the distributed account, passed in key-value (KV) pairs.<br>**NOTE**<br>This parameter is reserved and not used in the setters and getters.| | scalableData<sup>8+</sup> | object | No| Extended information about the distributed account, passed in key-value (KV) pairs.<br>**NOTE**<br>This parameter is reserved and not used in the setters and getters.|
en/application-dev/reference/apis/js-apis-distributed-data.md
浏览文件 @ 729a08cc
...@@ -11,9 +11,9 @@ This module provides the following functions: ...@@ -11,9 +11,9 @@ This module provides the following functions:
- [SingleKVStore](#singlekvstore): provides methods to query and synchronize data in a single KV store. This class inherits from [KVStore](#kvstore), and data is not distinguished by device. - [SingleKVStore](#singlekvstore): provides methods to query and synchronize data in a single KV store. This class inherits from [KVStore](#kvstore), and data is not distinguished by device.
- [DeviceKVStore<sup>8+</sup> ](#devicekvstore8): provides methods to query and synchronize data in a device KV store. This class inherits from [KVStore](#kvstore), and data is distinguished by device. - [DeviceKVStore<sup>8+</sup> ](#devicekvstore8): provides methods to query and synchronize data in a device KV store. This class inherits from [KVStore](#kvstore), and data is distinguished by device.
>**NOTE**<br/> >**NOTE**
> >
>- The APIs provided by this module are no longer maintained since API version 9. You are advised to use `@ohos.data.distributedKVStore`](js-apis-distributedKVStore.md). >- The APIs provided by this module are no longer maintained since API version 9. You are advised to use [@ohos.data.distributedKVStore](js-apis-distributedKVStore.md).
> >
>- The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. >- The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
...@@ -162,7 +162,7 @@ Creates and obtains a KV store. This API uses an asynchronous callback to return ...@@ -162,7 +162,7 @@ Creates and obtains a KV store. This API uses an asynchronous callback to return
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| storeId | string | Yes | Unique identifier of the KV store. The length cannot exceed [MAX_STORE_ID_LENGTH](#constants).| | storeId | string | Yes | Unique identifier of the KV store. The length cannot exceed [MAX_STORE_ID_LENGTH](#constants).|
| options | [Options](#options) | Yes | Configuration of the KV store.| | options | [Options](#options) | Yes | Configuration of the KV store.|
| callback | AsyncCallback&lt;T&gt; | Yes | Callback invoked to return the KV store created.| | callback | AsyncCallback&lt;T&gt; | Yes | Callback invoked to return the KV store instance created.|
**Example** **Example**
...@@ -212,7 +212,7 @@ Creates and obtains a KV store. This API uses a promise to return the result. ...@@ -212,7 +212,7 @@ Creates and obtains a KV store. This API uses a promise to return the result.
| Type | Description | | Type | Description |
| -------------------------------------- | ------------------------ | | -------------------------------------- | ------------------------ |
| Promise&lt;T&gt;, &lt;T extends [KVStore](#kvstore)&gt; | Promise used to return the KV store created.| | Promise&lt;T&gt;, &lt;T extends [KVStore](#kvstore)&gt; | Promise used to return the KV store instance created. |
**Example** **Example**
...@@ -449,7 +449,7 @@ Obtains the IDs of all KV stores that are created by [getKVStore()](#getkvstore) ...@@ -449,7 +449,7 @@ Obtains the IDs of all KV stores that are created by [getKVStore()](#getkvstore)
| Name | Type| Mandatory | Description | | Name | Type| Mandatory | Description |
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| appId | string | Yes | Bundle name of the app that invokes the KV store. | | appId | string | Yes | Bundle name of the app that invokes the KV store. |
| callback | AsyncCallback&lt;string[]&gt; | Yes |Callback invoked to return the KV store IDs obtained.| | callback | AsyncCallback&lt;string[]&gt; | Yes |Callback invoked to return the IDs of all created KV stores.|
**Example** **Example**
...@@ -485,7 +485,7 @@ Obtains the IDs of all KV stores that are created by [getKVStore()](#getkvstore) ...@@ -485,7 +485,7 @@ Obtains the IDs of all KV stores that are created by [getKVStore()](#getkvstore)
| Type | Description | | Type | Description |
| ------------- | -------------- | | ------------- | -------------- |
| Promise&lt;string[]&gt;| Promise used to return the KV store IDs obtained.| | Promise&lt;string[]&gt;| Promise used to return the IDs of all created KV stores. |
**Example** **Example**
...@@ -578,7 +578,7 @@ Provides KV store configuration. ...@@ -578,7 +578,7 @@ Provides KV store configuration.
| createIfMissing | boolean | No| Whether to create a KV store if no database file exists. By default, a KV store is created.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | | createIfMissing | boolean | No| Whether to create a KV store if no database file exists. By default, a KV store is created.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core |
| encrypt | boolean | No|Whether to encrypt database files. By default, database files are not encrypted.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | | encrypt | boolean | No|Whether to encrypt database files. By default, database files are not encrypted.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core |
| backup | boolean | No|Whether to back up database files. By default, database files are backed up. <br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | | backup | boolean | No|Whether to back up database files. By default, database files are backed up. <br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core |
| autoSync | boolean | No|Whether database files are automatically synchronized. By default, database files are not automatically synchronized.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core<br>**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC | | autoSync | boolean | No|Whether to automatically synchronize database files. The value **false** (default) means to manually synchronize database files; the value **true** means to automatically synchronize database files.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core<br>**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC |
| kvStoreType | [KVStoreType](#kvstoretype) | No|Type of the KV store to create. By default, a device KV store is created. The device KV store stores data for multiple devices that collaborate with each other.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core| | kvStoreType | [KVStoreType](#kvstoretype) | No|Type of the KV store to create. By default, a device KV store is created. The device KV store stores data for multiple devices that collaborate with each other.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core|
| securityLevel | [SecurityLevel](#securitylevel) | No|Security level of the KV store. By default, the security level is not set.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | | securityLevel | [SecurityLevel](#securitylevel) | No|Security level of the KV store. By default, the security level is not set.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.Core |
| schema<sup>8+</sup> | [Schema](#schema8) | No| Schema used to define the values stored in a KV store.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.DistributedKVStore| | schema<sup>8+</sup> | [Schema](#schema8) | No| Schema used to define the values stored in a KV store.<br>**System capability**: SystemCapability.DistributedDataManager.KVStore.DistributedKVStore|
...@@ -3074,7 +3074,7 @@ Obtains all KV pairs that match the specified key prefix. This API uses an async ...@@ -3074,7 +3074,7 @@ Obtains all KV pairs that match the specified key prefix. This API uses an async
| Name | Type| Mandatory | Description | | Name | Type| Mandatory | Description |
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| keyPrefix |string | Yes |Key prefix to match. | | keyPrefix |string | Yes |Key prefix to match. |
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | Yes |Callback invoked to return the KV pairs obtained. | | callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | Yes |Callback invoked to return the KV pairs that match the specified prefix. |
**Example** **Example**
...@@ -3125,7 +3125,7 @@ Obtains all KV pairs that match the specified key prefix. This API uses a promis ...@@ -3125,7 +3125,7 @@ Obtains all KV pairs that match the specified key prefix. This API uses a promis
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs obtained.| |Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs that match the specified prefix.|
**Example** **Example**
...@@ -3178,7 +3178,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses an ...@@ -3178,7 +3178,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses an
| Name | Type| Mandatory | Description | | Name | Type| Mandatory | Description |
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | Yes |Key prefix to match. | | query |[Query](#query8) | Yes |Key prefix to match. |
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | Yes |Callback invoked to return the KV pairs obtained. | | callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | Yes |Callback invoked to return the KV pairs that match the specified **Query** object. |
**Example** **Example**
...@@ -3234,7 +3234,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses a ...@@ -3234,7 +3234,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses a
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs obtained.| |Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs that match the specified **Query** object.|
**Example** **Example**
...@@ -3287,7 +3287,7 @@ Obtains the result set with the specified prefix. This API uses an asynchronous ...@@ -3287,7 +3287,7 @@ Obtains the result set with the specified prefix. This API uses an asynchronous
| Name | Type| Mandatory | Description | | Name | Type| Mandatory | Description |
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| keyPrefix |string | Yes |Key prefix to match.| | keyPrefix |string | Yes |Key prefix to match.|
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | Yes |Callback invoked to return the result set obtained.| | callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | Yes |Callback invoked to return the result set with the specified prefix.|
**Example** **Example**
...@@ -3341,7 +3341,7 @@ Obtains the result set with the specified prefix. This API uses a promise to ret ...@@ -3341,7 +3341,7 @@ Obtains the result set with the specified prefix. This API uses a promise to ret
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise used to return the result set obtained.| |Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise used to return the result set with the specified prefix.|
**Example** **Example**
...@@ -3571,7 +3571,7 @@ Obtains the number of results that matches the specified **Query** object. This ...@@ -3571,7 +3571,7 @@ Obtains the number of results that matches the specified **Query** object. This
| Name | Type| Mandatory | Description | | Name | Type| Mandatory | Description |
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | Yes |**Query** object to match. | | query |[Query](#query8) | Yes |**Query** object to match. |
| callback |AsyncCallback&lt;number&gt; | Yes |Callback invoked to return the number of results obtained. | | callback |AsyncCallback&lt;number&gt; | Yes |Callback invoked to return the number of results that match the specified **Query** object. |
**Example** **Example**
...@@ -3755,6 +3755,9 @@ try { ...@@ -3755,6 +3755,9 @@ try {
sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md).
> **NOTE**<br/>
>
> The value of **deviceIds** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
...@@ -3771,8 +3774,41 @@ Synchronizes the KV store manually. For details about the synchronization modes ...@@ -3771,8 +3774,41 @@ Synchronizes the KV store manually. For details about the synchronization modes
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let devManager;
let kvStore; let kvStore;
kvStore.sync(['deviceIds'], distributedData.SyncMode.PULL_ONLY, 1000); const KEY_TEST_SYNC_ELEMENT = 'key_test_sync';
const VALUE_TEST_SYNC_ELEMENT = 'value-string-001';
// create deviceManager
deviceManager.createDeviceManager('bundleName', (err, value) => {
if (!err) {
devManager = value;
let deviceIds = [];
if (devManager != null) {
var devices = devManager.getTrustedDeviceListSync();
for (var i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
}
try {
kvStore.on('syncComplete', function (data) {
console.log('Sync dataChange');
});
kvStore.put(KEY_TEST_SYNC_ELEMENT + 'testSync101', VALUE_TEST_SYNC_ELEMENT, function (err, data) {
if (err != undefined) {
console.log("put err: " + JSON.stringify(err));
return;
}
console.log('Succeeded in putting data');
const mode = distributedData.SyncMode.PULL_ONLY;
kvStore.sync(deviceIds, mode, 1000);
});
} catch (e) {
console.log('Sync e' + e);
}
}
});
``` ```
### on('dataChange')<sup>8+</sup> ### on('dataChange')<sup>8+</sup>
...@@ -3884,7 +3920,7 @@ Unsubscribes from synchronization complete events. ...@@ -3884,7 +3920,7 @@ Unsubscribes from synchronization complete events.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- | | ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| event | string | Yes | Event to unsubscribe from. The value is **syncComplete**, which indicates a synchronization complete event.| | event | string | Yes | Event to unsubscribe from. The value is **syncComplete**, which indicates a synchronization complete event.|
| syncCallback | Callback&lt;Array&lt;[string, number]&gt;&gt; | No | Callback for a synchronization complete event. | | syncCallback | Callback&lt;Array&lt;[string, number]&gt;&gt; | No | Callback for the synchronization complete event. |
**Example** **Example**
...@@ -3987,7 +4023,7 @@ Obtains the security level of this KV store. This API uses an asynchronous callb ...@@ -3987,7 +4023,7 @@ Obtains the security level of this KV store. This API uses an asynchronous callb
| Name | Type| Mandatory | Description | | Name | Type| Mandatory | Description |
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| callback |AsyncCallback&lt;[SecurityLevel](#securitylevel)&gt; | Yes |Callback invoked to return the security level obtained. | | callback |AsyncCallback&lt;[SecurityLevel](#securitylevel)&gt; | Yes |Callback invoked to return the security level of the KV store. |
**Example** **Example**
...@@ -4015,7 +4051,7 @@ Obtains the security level of this KV store. This API uses a promise to return t ...@@ -4015,7 +4051,7 @@ Obtains the security level of this KV store. This API uses a promise to return t
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[SecurityLevel](#securitylevel)&gt; |Promise used to return the security level obtained.| |Promise&lt;[SecurityLevel](#securitylevel)&gt; |Promise used to return the security level of the KV store.|
**Example** **Example**
...@@ -4097,7 +4133,7 @@ Obtains a string value that matches the specified device ID and key. This API us ...@@ -4097,7 +4133,7 @@ Obtains a string value that matches the specified device ID and key. This API us
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;boolean\|string\|number\|Uint8Array&gt; |Promise used to return the string value obtained.| |Promise&lt;boolean\|string\|number\|Uint8Array&gt; |Promise used to return the string value that matches the given condition.|
**Example** **Example**
...@@ -4189,7 +4225,7 @@ Obtains all KV pairs that match the specified device ID and key prefix. This API ...@@ -4189,7 +4225,7 @@ Obtains all KV pairs that match the specified device ID and key prefix. This API
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs obtained.| |Promise&lt;[Entry](#entry)[]&gt; |Promise used to return all the KV pairs that match the given condition.|
**Example** **Example**
...@@ -4299,7 +4335,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses a ...@@ -4299,7 +4335,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses a
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs obtained.| |Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs that match the specified **Query** object.|
**Example** **Example**
...@@ -4353,7 +4389,7 @@ Obtains the KV pairs that match the specified device ID and **Query** object. Th ...@@ -4353,7 +4389,7 @@ Obtains the KV pairs that match the specified device ID and **Query** object. Th
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| deviceId |string | Yes |ID of the target device. | | deviceId |string | Yes |ID of the target device. |
| query |[Query](#query8) | Yes |**Query** object to match. | | query |[Query](#query8) | Yes |**Query** object to match. |
| callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | Yes |Callback invoked to return the KV pairs obtained. | | callback |AsyncCallback&lt;[Entry](#entry)[]&gt; | Yes |Callback invoked to return the KV pairs that match the specified device ID and **Query** object. |
**Example** **Example**
...@@ -4411,7 +4447,7 @@ Obtains the KV pairs that match the specified device ID and **Query** object. Th ...@@ -4411,7 +4447,7 @@ Obtains the KV pairs that match the specified device ID and **Query** object. Th
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs obtained.| |Promise&lt;[Entry](#entry)[]&gt; |Promise used to return the KV pairs that match the specified device ID and **Query** object.|
**Example** **Example**
...@@ -4466,7 +4502,7 @@ Obtains a **KvStoreResultSet** object that matches the specified device ID and k ...@@ -4466,7 +4502,7 @@ Obtains a **KvStoreResultSet** object that matches the specified device ID and k
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| deviceId |string | Yes |ID of the target device. | | deviceId |string | Yes |ID of the target device. |
| keyPrefix |string | Yes |Key prefix to match. | | keyPrefix |string | Yes |Key prefix to match. |
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | Yes |Callback invoked to return the **KvStoreResultSet** object obtained. | | callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | Yes |Callback invoked to return the **KvStoreResultSet** object that matches the specified device ID and key prefix. |
**Example** **Example**
...@@ -4506,7 +4542,7 @@ Obtains a **KvStoreResultSet** object that matches the specified device ID and k ...@@ -4506,7 +4542,7 @@ Obtains a **KvStoreResultSet** object that matches the specified device ID and k
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise used to return the **KvStoreResultSet** object obtained.| |Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise used to return the **KvStoreResultSet** object that matches the specified device ID and key prefix.|
**Example** **Example**
...@@ -4601,7 +4637,7 @@ Obtains a **KvStoreResultSet** object that matches the specified **Query** objec ...@@ -4601,7 +4637,7 @@ Obtains a **KvStoreResultSet** object that matches the specified **Query** objec
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise used to return the **KvStoreResultSet** object obtained.| |Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise used to return the **KvStoreResultSet** object that matches the specified **Query** object.|
**Example** **Example**
...@@ -4661,7 +4697,7 @@ Obtains a **KvStoreResultSet** object that matches the specified device ID and * ...@@ -4661,7 +4697,7 @@ Obtains a **KvStoreResultSet** object that matches the specified device ID and *
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| deviceId |string | Yes |ID of the target device. | | deviceId |string | Yes |ID of the target device. |
| query |[Query](#query8) | Yes |**Query** object to match. | | query |[Query](#query8) | Yes |**Query** object to match. |
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | Yes |Callback invoked to return the **KvStoreResultSet** object obtained. | | callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | Yes |Callback invoked to return the **KvStoreResultSet** object that matches the specified device ID and **Query** object. |
**Example** **Example**
...@@ -4718,7 +4754,7 @@ Obtains a **KvStoreResultSet** object that matches the specified device ID and * ...@@ -4718,7 +4754,7 @@ Obtains a **KvStoreResultSet** object that matches the specified device ID and *
| Type | Description | | Type | Description |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise used to return the **KvStoreResultSet** object obtained.| |Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise used to return the **KvStoreResultSet** object that matches the specified device ID and **Query** object.|
**Example** **Example**
...@@ -5141,6 +5177,10 @@ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void ...@@ -5141,6 +5177,10 @@ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void
Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md).
> **NOTE**<br/>
>
> The value of **deviceIds** is obtained by [deviceManager.getTrustedDeviceListSync](js-apis-device-manager.md#gettrusteddevicelistsync). The APIs of the **deviceManager** module are system interfaces and available only to system applications.
**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC
**System capability**: SystemCapability.DistributedDataManager.KVStore.Core **System capability**: SystemCapability.DistributedDataManager.KVStore.Core
...@@ -5156,22 +5196,41 @@ Synchronizes the KV store manually. For details about the synchronization modes ...@@ -5156,22 +5196,41 @@ Synchronizes the KV store manually. For details about the synchronization modes
**Example** **Example**
```js ```js
import deviceManager from '@ohos.distributedHardware.deviceManager';
let devManager;
let kvStore; let kvStore;
const KEY_TEST_SYNC_ELEMENT = 'key_test_sync'; const KEY_TEST_SYNC_ELEMENT = 'key_test_sync';
const VALUE_TEST_SYNC_ELEMENT = 'value-string-001'; const VALUE_TEST_SYNC_ELEMENT = 'value-string-001';
try { // create deviceManager
kvStore.on('syncComplete', function (data) { deviceManager.createDeviceManager('bundleName', (err, value) => {
if (!err) {
devManager = value;
let deviceIds = [];
if (devManager != null) {
var devices = devManager.getTrustedDeviceListSync();
for (var i = 0; i < devices.length; i++) {
deviceIds[i] = devices[i].deviceId;
}
}
try {
kvStore.on('syncComplete', function (data) {
console.log('Sync dataChange'); console.log('Sync dataChange');
}); });
kvStore.put(KEY_TEST_SYNC_ELEMENT + 'testSync101', VALUE_TEST_SYNC_ELEMENT, function (err,data) { kvStore.put(KEY_TEST_SYNC_ELEMENT + 'testSync101', VALUE_TEST_SYNC_ELEMENT, function (err, data) {
console.log('Sync put success'); if (err != undefined) {
const devices = ['deviceList']; console.log("put err: " + JSON.stringify(err));
return;
}
console.log('Succeeded in putting data');
const mode = distributedData.SyncMode.PULL_ONLY; const mode = distributedData.SyncMode.PULL_ONLY;
kvStore.sync(devices, mode); kvStore.sync(deviceIds, mode, 1000);
}); });
}catch(e) { } catch (e) {
console.log('Sync e' + e); console.log('Sync e' + e);
} }
}
});
``` ```
### on('dataChange')<sup>8+</sup> ### on('dataChange')<sup>8+</sup>
...@@ -5283,7 +5342,7 @@ Unsubscribes from synchronization complete events. ...@@ -5283,7 +5342,7 @@ Unsubscribes from synchronization complete events.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- | | ------------ | --------------------------------------------- | ---- | ---------------------------------------------------------- |
| event | string | Yes | Event to unsubscribe from. The value is **syncComplete**, which indicates a synchronization complete event.| | event | string | Yes | Event to unsubscribe from. The value is **syncComplete**, which indicates a synchronization complete event.|
| syncCallback | Callback&lt;Array&lt;[string, number]&gt;&gt; | No | Callback for a synchronization complete event. | | syncCallback | Callback&lt;Array&lt;[string, number]&gt;&gt; | No | Callback for the synchronization complete event. |
**Example** **Example**
......
en/application-dev/reference/apis/js-apis-file-picker.md
浏览文件 @ 729a08cc
# @ohos.file.picker (File Picker) # @ohos.file.picker (File Picker)
The File Picker encapsulates system applications, such as **PhotoViewPicker**, **DocumentViewPicker**, and **AudioViewPicker**, and provides capabilities of selecting and saving photos, documents, and audio clips. The application can select the picker as required.
> **NOTE** > **NOTE**
> >
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
The File Picker encapsulates system applications, such as **PhotoViewPicker**, **DocumentViewPicker**, and **AudioViewPicker**, and provides capabilities of selecting and saving photos, documents, and audio clips. The application can select the picker as required.
## Modules to Import ## Modules to Import
```js ```js
......
en/application-dev/reference/apis/js-apis-file-statvfs.md
浏览文件 @ 729a08cc
...@@ -22,15 +22,15 @@ Obtains the number of free bytes of the specified file system in asynchronous mo ...@@ -22,15 +22,15 @@ Obtains the number of free bytes of the specified file system in asynchronous mo
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ---------------------------- | | ------ | ------ | ---- | ---------------------------- |
| path | string | Yes | File path of the file system.| | path | string | Yes | File path of the file system.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | -------------- | | --------------------- | -------------- |
| Promise&lt;number&gt; | Promise used to return the number of free bytes obtained.| | Promise&lt;number&gt; | Promise used to return the number of free bytes obtained.|
**Example** **Example**
...@@ -53,10 +53,10 @@ Obtains the number of free bytes of the specified file system in asynchronous mo ...@@ -53,10 +53,10 @@ Obtains the number of free bytes of the specified file system in asynchronous mo
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | --------------------------- | ---- | ---------------------------- | | -------- | --------------------------- | ---- | ---------------------------- |
| path | string | Yes | File path of the file system.| | path | string | Yes | File path of the file system.|
| callback | AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the number of free bytes obtained.| | callback | AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the number of free bytes obtained.|
**Example** **Example**
...@@ -81,15 +81,15 @@ Obtains the total number of bytes of the specified file system in asynchronous m ...@@ -81,15 +81,15 @@ Obtains the total number of bytes of the specified file system in asynchronous m
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ---- | ------ | ---- | ---------------------------- | | ---- | ------ | ---- | ---------------------------- |
| path | string | Yes | File path of the file system.| | path | string | Yes | File path of the file system.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | ------------ | | --------------------- | ------------ |
| Promise&lt;number&gt; | Promise used to return the total number of bytes obtained.| | Promise&lt;number&gt; | Promise used to return the total number of bytes obtained.|
**Example** **Example**
...@@ -112,10 +112,10 @@ Obtains the total number of bytes of the specified file system in asynchronous m ...@@ -112,10 +112,10 @@ Obtains the total number of bytes of the specified file system in asynchronous m
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | --------------------------- | ---- | ---------------------------- | | -------- | --------------------------- | ---- | ---------------------------- |
| path | string | Yes | File path of the file system.| | path | string | Yes | File path of the file system.|
| callback | AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the total number of bytes obtained. | | callback | AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the total number of bytes obtained. |
**Example** **Example**
......
en/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @ 729a08cc
...@@ -326,9 +326,9 @@ Checks whether the specified constraint is enabled for an OS account. This API u ...@@ -326,9 +326,9 @@ Checks whether the specified constraint is enabled for an OS account. This API u
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid localId or constraint. | | 12300002 | Invalid localId or constraint. |
| 12300003 | the account indicated by localId dose not exist. | | 12300003 | Account not found. |
**Example**: Check whether OS account 100 is forbidden to use Wi-Fi. **Example**: Check whether OS account 100 is forbidden to use Wi-Fi.
...@@ -376,9 +376,9 @@ Checks whether the specified constraint is enabled for an OS account. This API u ...@@ -376,9 +376,9 @@ Checks whether the specified constraint is enabled for an OS account. This API u
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid localId or constraint. | | 12300002 | Invalid localId or constraint. |
| 12300003 | the account indicated by localId dose not exist. | | 12300003 | Account not found. |
**Example**: Check whether OS account 100 is forbidden to use Wi-Fi. **Example**: Check whether OS account 100 is forbidden to use Wi-Fi.
...@@ -487,7 +487,7 @@ Checks whether this OS account has been verified. This API uses an asynchronous ...@@ -487,7 +487,7 @@ Checks whether this OS account has been verified. This API uses an asynchronous
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
**Example** **Example**
...@@ -527,9 +527,9 @@ Checks whether an OS account has been verified. This API uses an asynchronous ca ...@@ -527,9 +527,9 @@ Checks whether an OS account has been verified. This API uses an asynchronous ca
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid localId. | | 12300002 | Invalid localId. |
| 12300003 | the account indicated by localId dose not exist. | | 12300003 | Account not found. |
**Example** **Example**
...@@ -575,9 +575,9 @@ Checks whether an OS account has been verified. This API uses a promise to retur ...@@ -575,9 +575,9 @@ Checks whether an OS account has been verified. This API uses a promise to retur
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid localId. | | 12300002 | Invalid localId. |
| 12300003 | the account indicated by localId dose not exist. | | 12300003 | Account not found. |
**Example** **Example**
...@@ -720,7 +720,7 @@ Sets or removes constraints for an OS account. This API uses an asynchronous cal ...@@ -720,7 +720,7 @@ Sets or removes constraints for an OS account. This API uses an asynchronous cal
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid localId. | | 12300002 | Invalid localId or constraints. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300008 | Restricted Account. | | 12300008 | Restricted Account. |
...@@ -774,7 +774,7 @@ Sets or removes constraints for an OS account. This API uses a promise to return ...@@ -774,7 +774,7 @@ Sets or removes constraints for an OS account. This API uses a promise to return
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid localId. | | 12300002 | Invalid localId or constraints. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
| 12300008 | Restricted Account. | | 12300008 | Restricted Account. |
...@@ -987,7 +987,7 @@ Obtains the ID of the OS account to which the current process belongs. This API ...@@ -987,7 +987,7 @@ Obtains the ID of the OS account to which the current process belongs. This API
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
**Example** **Example**
...@@ -1024,7 +1024,7 @@ Obtains the ID of the OS account to which the current process belongs. This API ...@@ -1024,7 +1024,7 @@ Obtains the ID of the OS account to which the current process belongs. This API
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
**Example** **Example**
...@@ -1060,8 +1060,8 @@ Obtains the OS account ID based on the process UID. This API uses an asynchronou ...@@ -1060,8 +1060,8 @@ Obtains the OS account ID based on the process UID. This API uses an asynchronou
| ID| Error Message | | ID| Error Message |
| -------- | --------------- | | -------- | --------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid uid. | | 12300002 | Invalid uid. |
**Example**: Obtain the ID of the OS account whose process UID is **12345678**. **Example**: Obtain the ID of the OS account whose process UID is **12345678**.
...@@ -1104,8 +1104,8 @@ Obtains the OS account ID based on the process UID. This API uses a promise to r ...@@ -1104,8 +1104,8 @@ Obtains the OS account ID based on the process UID. This API uses a promise to r
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid uid. | | 12300002 | Invalid uid. |
**Example**: Obtain the ID of the OS account whose process UID is **12345678**. **Example**: Obtain the ID of the OS account whose process UID is **12345678**.
...@@ -1144,8 +1144,8 @@ Obtains the OS account ID based on the domain account information. This API uses ...@@ -1144,8 +1144,8 @@ Obtains the OS account ID based on the domain account information. This API uses
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid domainInfo. | | 12300002 | Invalid domainInfo. |
**Example** **Example**
...@@ -1191,8 +1191,8 @@ Obtains the OS account ID based on the domain account information. This API uses ...@@ -1191,8 +1191,8 @@ Obtains the OS account ID based on the domain account information. This API uses
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid domainInfo. | | 12300002 | Invalid domainInfo. |
**Example** **Example**
...@@ -1470,7 +1470,7 @@ Obtains information about all activated OS accounts. This API uses an asynchrono ...@@ -1470,7 +1470,7 @@ Obtains information about all activated OS accounts. This API uses an asynchrono
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
**Example** **Example**
...@@ -1507,7 +1507,7 @@ Obtains information about all activated OS accounts. This API uses a promise to ...@@ -1507,7 +1507,7 @@ Obtains information about all activated OS accounts. This API uses a promise to
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
**Example** **Example**
...@@ -1858,7 +1858,7 @@ Obtains information about the OS account of the given ID. This API uses a promis ...@@ -1858,7 +1858,7 @@ Obtains information about the OS account of the given ID. This API uses a promis
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid localId. | | 12300002 | Invalid localId. |
| 12300003 | Account not found. | | 12300003 | Account not found. |
**Example**: Query information about OS account 100. **Example**: Query information about OS account 100.
...@@ -2229,9 +2229,9 @@ Obtains the OS account ID based on the serial number (SN). This API uses an asyn ...@@ -2229,9 +2229,9 @@ Obtains the OS account ID based on the serial number (SN). This API uses an asyn
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid serialNumber. | | 12300002 | Invalid serialNumber. |
| 12300003 | the account indicated by serialNumber dose not exist. | | 12300003 | The account indicated by serialNumber dose not exist. |
**Example**: Obtain the ID of the OS account whose SN is 12345. **Example**: Obtain the ID of the OS account whose SN is 12345.
...@@ -2272,9 +2272,9 @@ Obtains the OS account ID based on the SN. This API uses a promise to return the ...@@ -2272,9 +2272,9 @@ Obtains the OS account ID based on the SN. This API uses a promise to return the
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid serialNumber. | | 12300002 | Invalid serialNumber. |
| 12300003 | the account indicated by serialNumber dose not exist. | | 12300003 | The account indicated by serialNumber dose not exist. |
**Example**: Obtain the ID of the OS account whose SN is 12345. **Example**: Obtain the ID of the OS account whose SN is 12345.
...@@ -2311,9 +2311,9 @@ Obtains the SN of an OS account based on the account ID. This API uses an asynch ...@@ -2311,9 +2311,9 @@ Obtains the SN of an OS account based on the account ID. This API uses an asynch
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid localId. | | 12300002 | Invalid localId. |
| 12300003 | the account indicated by localId dose not exist. | | 12300003 | Account not found. |
**Example**: Obtain the SN of the OS account 100. **Example**: Obtain the SN of the OS account 100.
...@@ -2354,9 +2354,9 @@ Obtains the SN of an OS account based on the account ID. This API uses a promise ...@@ -2354,9 +2354,9 @@ Obtains the SN of an OS account based on the account ID. This API uses a promise
| ID| Error Message | | ID| Error Message |
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid localId. | | 12300002 | Invalid localId. |
| 12300003 | the account indicated by localId dose not exist. | | 12300003 | Account not found. |
**Example**: Obtain the SN of the OS account 100. **Example**: Obtain the SN of the OS account 100.
...@@ -2400,7 +2400,6 @@ Subscribes to the OS account activation states, including the states of the acco ...@@ -2400,7 +2400,6 @@ Subscribes to the OS account activation states, including the states of the acco
| -------- | ------------- | | -------- | ------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid type or name. | | 12300002 | Invalid type or name. |
| 12300011 | Callback has been registered. |
**Example** **Example**
...@@ -2442,7 +2441,6 @@ Unsubscribes from the OS account activation states, including the states of the ...@@ -2442,7 +2441,6 @@ Unsubscribes from the OS account activation states, including the states of the
| -------- | ------------- | | -------- | ------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid type or name. | | 12300002 | Invalid type or name. |
| 12300012 | Callback has not been registered. |
**Example** **Example**
...@@ -2479,8 +2477,8 @@ Obtains the bundle ID based on the UID. This API uses an asynchronous callback t ...@@ -2479,8 +2477,8 @@ Obtains the bundle ID based on the UID. This API uses an asynchronous callback t
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid uid. | | 12300002 | Invalid uid. |
**Example** **Example**
...@@ -2522,8 +2520,8 @@ Obtains the bundle ID based on the UID. This API uses a promise to return the re ...@@ -2522,8 +2520,8 @@ Obtains the bundle ID based on the UID. This API uses a promise to return the re
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid uid. | | 12300002 | Invalid uid. |
**Example** **Example**
...@@ -2640,9 +2638,9 @@ Obtains the constraint source information of an OS account. This API uses an asy ...@@ -2640,9 +2638,9 @@ Obtains the constraint source information of an OS account. This API uses an asy
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid name or constraint. | | 12300002 | Invalid name or constraint. |
| 12300003 | the account indicated by localId dose not exist. | | 12300003 | Account not found. |
**Example** **Example**
...@@ -2687,9 +2685,9 @@ Obtains the constraint source information of an OS account. This API uses a prom ...@@ -2687,9 +2685,9 @@ Obtains the constraint source information of an OS account. This API uses a prom
| ID| Error Message | | ID| Error Message |
| -------- | ------------- | | -------- | ------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid name or constraint. | | 12300002 | Invalid name or constraint. |
| 12300003 | the account indicated by localId dose not exist. | | 12300003 | Account not found. |
**Example** **Example**
...@@ -4113,9 +4111,9 @@ Performs authentication of the current user. This API uses an asynchronous callb ...@@ -4113,9 +4111,9 @@ Performs authentication of the current user. This API uses an asynchronous callb
| 12300101 | Credential is incorrect. | | 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. | | 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. | | 12300106 | Unsupported authType. |
| 12300110 | Authentication locked. | | 12300110 | Authentication is locked. |
| 12300111 | Authentication timeout. | | 12300111 | Authentication timeout. |
| 12300112 | Authentication service busy. | | 12300112 | Authentication service is busy. |
**Example** **Example**
```js ```js
...@@ -4172,9 +4170,9 @@ Performs authentication of the specified user. This API uses an asynchronous cal ...@@ -4172,9 +4170,9 @@ Performs authentication of the specified user. This API uses an asynchronous cal
| 12300101 | Credential is incorrect. | | 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. | | 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. | | 12300106 | Unsupported authType. |
| 12300110 | Authentication locked. | | 12300110 | Authentication is locked. |
| 12300111 | Authentication timeout. | | 12300111 | Authentication timeout. |
| 12300112 | Authentication service busy. | | 12300112 | Authentication service is busy. |
**Example** **Example**
```js ```js
...@@ -4282,7 +4280,7 @@ Register a PIN inputer. ...@@ -4282,7 +4280,7 @@ Register a PIN inputer.
| ID| Error Message | | ID| Error Message |
| -------- | --------------------------- | | -------- | --------------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300102 | Invalid inputer. | | 12300002 | Invalid inputer. |
| 12300103 | Inputer already registered. | | 12300103 | Inputer already registered. |
**Example** **Example**
...@@ -4347,7 +4345,7 @@ Register a credential inputer. ...@@ -4347,7 +4345,7 @@ Register a credential inputer.
| ID| Error Message | | ID| Error Message |
| -------- | --------------------------- | | -------- | --------------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300102 | Invalid authType or inputer. | | 12300002 | Invalid authType or inputer. |
| 12300103 | The credential inputer has been registered. | | 12300103 | The credential inputer has been registered. |
| 12300106 | Unsupported authType. | | 12300106 | Unsupported authType. |
...@@ -4716,7 +4714,7 @@ Registers a domain plug-in. ...@@ -4716,7 +4714,7 @@ Registers a domain plug-in.
| ID| Error Message | | ID| Error Message |
| -------- | --------------------------- | | -------- | --------------------------- |
| 12300201 | the domain plugin has been registered. | | 12300201 | The domain plugin has been registered. |
**Example** **Example**
```js ```js
...@@ -4783,17 +4781,17 @@ Authenticates a domain account. ...@@ -4783,17 +4781,17 @@ Authenticates a domain account.
| ID| Error Message | | ID| Error Message |
| -------- | --------------------------- | | -------- | --------------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid domainAccountInfo or credential. | | 12300002 | Invalid domainAccountInfo or credential. |
| 12300003 | domain account does not exist. | | 12300003 | Domain account does not exist. |
| 12300013 | network exception. | | 12300013 | Network exception. |
| 12300101 | authentication failed. | | 12300101 | Authentication failed. |
| 12300109 | authentication is canceled. | | 12300109 | Authentication is canceled. |
| 12300110 | authentication is locked. | | 12300110 | Authentication is locked. |
| 12300111 | authentication timeout. | | 12300111 | Authentication timeout. |
| 12300112 | authentication service is busy. | | 12300112 | Authentication service is busy. |
| 12300113 | authentication service does not exist. | | 12300113 | Authentication service does not exist. |
| 12300114 | authentication service exception. | | 12300114 | Authentication service exception. |
**Example** **Example**
```js ```js
...@@ -4836,16 +4834,16 @@ Authenticates this domain account in a pop-up window. ...@@ -4836,16 +4834,16 @@ Authenticates this domain account in a pop-up window.
| ID| Error Message | | ID| Error Message |
| -------- | --------------------------- | | -------- | --------------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300003 | no domain account is bound. | | 12300003 | No domain account is bound. |
| 12300013 | network exception. | | 12300013 | Network exception. |
| 12300101 | authentication failed. | | 12300101 | Authentication failed. |
| 12300109 | authentication is canceled. | | 12300109 | Authentication is canceled. |
| 12300110 | authentication is locked. | | 12300110 | Authentication is locked. |
| 12300111 | authentication timeout. | | 12300111 | Authentication timeout. |
| 12300112 | authentication service is busy. | | 12300112 | Authentication service is busy. |
| 12300113 | authentication service does not exist. | | 12300113 | Authentication service does not exist. |
| 12300114 | authentication service exception. | | 12300114 | Authentication service exception. |
**Example** **Example**
```js ```js
...@@ -4884,17 +4882,17 @@ Authenticates a domain account in a pop-up window. ...@@ -4884,17 +4882,17 @@ Authenticates a domain account in a pop-up window.
| ID| Error Message | | ID| Error Message |
| -------- | --------------------------- | | -------- | --------------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid localId. | | 12300002 | Invalid localId. |
| 12300003 | no domain account is bound. | | 12300003 | No domain account is bound. |
| 12300013 | network exception. | | 12300013 | Network exception. |
| 12300101 | authentication failed. | | 12300101 | Authentication failed. |
| 12300109 | authentication is canceled. | | 12300109 | Authentication is canceled. |
| 12300110 | authentication is locked. | | 12300110 | Authentication is locked. |
| 12300111 | authentication timeout. | | 12300111 | Authentication timeout. |
| 12300112 | authentication service is busy. | | 12300112 | Authentication service is busy. |
| 12300113 | authentication service does not exist. | | 12300113 | Authentication service does not exist. |
| 12300114 | authentication service exception. | | 12300114 | Authentication service exception. |
**Example** **Example**
```js ```js
...@@ -4933,9 +4931,9 @@ Checks whether a domain account exists. ...@@ -4933,9 +4931,9 @@ Checks whether a domain account exists.
| ID| Error Message | | ID| Error Message |
| -------- | --------------------------- | | -------- | --------------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid domainAccountInfo. | | 12300002 | Invalid domainAccountInfo. |
| 12300013 | network exception. | | 12300013 | Network exception. |
**Example** **Example**
```js ```js
...@@ -4984,9 +4982,9 @@ Checks whether a domain account exists. ...@@ -4984,9 +4982,9 @@ Checks whether a domain account exists.
| ID| Error Message | | ID| Error Message |
| -------- | --------------------------- | | -------- | --------------------------- |
| 12300001 | system service exception. | | 12300001 | System service exception. |
| 12300002 | invalid domainAccountInfo. | | 12300002 | Invalid domainAccountInfo. |
| 12300013 | network exception. | | 12300013 | Network exception. |
**Example** **Example**
```js ```js
...@@ -5389,7 +5387,6 @@ Obtains authentication information. This API uses an asynchronous callback to re ...@@ -5389,7 +5387,6 @@ Obtains authentication information. This API uses an asynchronous callback to re
| ID| Error Message | | ID| Error Message |
| -------- | --------------------- | | -------- | --------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300102 | Credential not found. |
**Example** **Example**
```js ```js
...@@ -5429,7 +5426,6 @@ Obtains authentication information of the specified type. This API uses an async ...@@ -5429,7 +5426,6 @@ Obtains authentication information of the specified type. This API uses an async
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid authType. | | 12300002 | Invalid authType. |
| 12300102 | Credential not found. |
**Example** **Example**
```js ```js
...@@ -5474,7 +5470,6 @@ Obtains authentication information of the specified type. This API uses a promis ...@@ -5474,7 +5470,6 @@ Obtains authentication information of the specified type. This API uses a promis
| -------- | ------------------- | | -------- | ------------------- |
| 12300001 | System service exception. | | 12300001 | System service exception. |
| 12300002 | Invalid authType. | | 12300002 | Invalid authType. |
| 12300102 | Credential not found. |
**Example** **Example**
```js ```js
...@@ -5513,6 +5508,12 @@ Called to set data in a PIN operation. ...@@ -5513,6 +5508,12 @@ Called to set data in a PIN operation.
| authSubType | [AuthSubType](#authsubtype8) | Yes | Credential subtype. | | authSubType | [AuthSubType](#authsubtype8) | Yes | Credential subtype. |
| data | Uint8Array | Yes | Data (credential) to set. The data is used for authentication and operations for adding and modifying credentials.| | data | Uint8Array | Yes | Data (credential) to set. The data is used for authentication and operations for adding and modifying credentials.|
**Error codes**
| ID| Error Message |
| -------- | ------------------- |
| 12300002 | Invalid pinSubType. |
**Example** **Example**
```js ```js
let password = new Uint8Array([0, 0, 0, 0, 0, 0]); let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
...@@ -5975,7 +5976,7 @@ Defines the domain account information. ...@@ -5975,7 +5976,7 @@ Defines the domain account information.
| ----------- | ------ | ---- | ---------- | | ----------- | ------ | ---- | ---------- |
| domain | string | Yes | Domain name. | | domain | string | Yes | Domain name. |
| accountName | string | Yes | Domain account name.| | accountName | string | Yes | Domain account name.|
| accountId<sup>10+</sup> | string | No | Domain account ID.| | accountId<sup>10+</sup> | string | No | Domain account ID.<br>**System API**: This is a system API.|
## Constraints ## Constraints
......
en/application-dev/reference/apis/js-apis-privacyManager.md
浏览文件 @ 729a08cc
...@@ -47,8 +47,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -47,8 +47,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, or the count value is invalid. | | 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, or the count value is invalid. |
| 12100002 | The specified tokenID does not exist or it does not refer to an application process. | | 12100002 | The specified tokenID does not exist or refer to an application process. |
| 12100003 | The specified permission does not exist or it is not an user_grant permission. | | 12100003 | The specified permission does not exist or is not an user_grant permission. |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
...@@ -97,8 +97,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -97,8 +97,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, or the count value is invalid. | | 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256, or the count value is invalid. |
| 12100002 | The specified tokenID does not exist or it does not refer to an application process. | | 12100002 | The specified tokenID does not exist or refer to an application process. |
| 12100003 | The specified permission does not exist or it is not an user_grant permission. | | 12100003 | The specified permission does not exist or is not an user_grant permission. |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
...@@ -150,8 +150,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -150,8 +150,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. the value of flag in request is invalid. | | 12100001 | The parameter is invalid. the value of flag in request is invalid. |
| 12100002 | The specified tokenID does not exist or it does not refer to an application process. | | 12100002 | The specified tokenID does not exist or refer to an application process. |
| 12100003 | The specified permission does not exist or it is not an user_grant permission. | | 12100003 | The specified permission does not exist or is not an user_grant permission. |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
...@@ -205,8 +205,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -205,8 +205,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. the value of flag in request is invalid. | | 12100001 | The parameter is invalid. the value of flag in request is invalid. |
| 12100002 | The specified tokenID does not exist or it does not refer to an application process. | | 12100002 | The specified tokenID does not exist or refer to an application process. |
| 12100003 | The specified permission does not exist or it is not an user_grant permission. | | 12100003 | The specified permission does not exist or is not an user_grant permission. |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
...@@ -268,8 +268,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -268,8 +268,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. | | 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. |
| 12100002 | The specified tokenID does not exist or it does not refer to an application process. | | 12100002 | The specified tokenID does not exist or refer to an application process. |
| 12100003 | The specified permission does not exist or it is not an user_grant permission. | | 12100003 | The specified permission does not exist or is not an user_grant permission. |
| 12100004 | The interface is called repeatedly with the same input. It means the application specified by the tokenID has been using the specified permission. | | 12100004 | The interface is called repeatedly with the same input. It means the application specified by the tokenID has been using the specified permission. |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
...@@ -316,8 +316,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -316,8 +316,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. | | 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. |
| 12100002 | The specified tokenID does not exist or it does not refer to an application process. | | 12100002 | The specified tokenID does not exist or refer to an application process. |
| 12100003 | The specified permission does not exist or it is not an user_grant permission. | | 12100003 | The specified permission does not exist or is not an user_grant permission. |
| 12100004 | The interface is called repeatedly with the same input. It means the application specified by the tokenID has been using the specified permission. | | 12100004 | The interface is called repeatedly with the same input. It means the application specified by the tokenID has been using the specified permission. |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
...@@ -371,8 +371,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -371,8 +371,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. | | 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. |
| 12100002 | The specified tokenID does not exist or it does not refer to an application process. | | 12100002 | The specified tokenID does not exist or refer to an application process. |
| 12100003 | The specified permission does not exist or it is not an user_grant permission. | | 12100003 | The specified permission does not exist or is not an user_grant permission. |
| 12100004 | The interface is not used with | | 12100004 | The interface is not used with |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
...@@ -419,8 +419,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -419,8 +419,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. | | 12100001 | The parameter is invalid. The tokenID is 0, or the string size of permissionName is larger than 256. |
| 12100002 | The specified tokenID does not exist or it does not refer to an application process. | | 12100002 | The specified tokenID does not exist or refer to an application process. |
| 12100003 | The specified permission does not exist or it is not an user_grant permission. | | 12100003 | The specified permission does not exist or is not an user_grant permission. |
| 12100004 | The interface is not used with | | 12100004 | The interface is not used with |
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
...@@ -513,8 +513,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e ...@@ -513,8 +513,8 @@ For details about the error codes, see [Ability Access Control Error Codes](../e
| ID| Error Message| | ID| Error Message|
| -------- | -------- | | -------- | -------- |
| 12100001 | The parameter is invalid. The permissionName in list is all invalid or the list size is larger than 1024. | | 12100001 | The permissionNames in the list are all invalid, or the list size exceeds 1024 bytes. |
| 12100004 | The API is not used together with "on()". | | 12100004 | The interface is not used together with "on()".|
| 12100007 | Service is abnormal. | | 12100007 | Service is abnormal. |
| 12100008 | Out of memory. | | 12100008 | Out of memory. |
......
en/application-dev/reference/apis/js-apis-useriam-userauth.md
浏览文件 @ 729a08cc
...@@ -2,7 +2,8 @@ ...@@ -2,7 +2,8 @@
The **userIAM.userAuth** module provides user authentication capabilities in identity authentication scenarios, such as device unlocking, payment, and app login. The **userIAM.userAuth** module provides user authentication capabilities in identity authentication scenarios, such as device unlocking, payment, and app login.
> **NOTE**<br> > **NOTE**
>
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
...@@ -399,44 +400,6 @@ try { ...@@ -399,44 +400,6 @@ try {
} }
``` ```
## userIAM_userAuth.getVersion<sup>9+</sup>
getVersion(): number
Obtains the version of this authenticator.
**Required permissions**: ohos.permission.ACCESS_BIOMETRIC
**System capability**: SystemCapability.UserIAM.UserAuth.Core
**Return value**
| Type | Description |
| ------ | ---------------------- |
| number | Authenticator version obtained.|
For details about the error codes, see [User Authentication Error Codes](../errorcodes/errorcode-useriam.md).
**Error codes**
| ID| Error Message|
| -------- | ------- |
| 201 | Permission verification failed. |
| 12500002 | General operation error. |
**Example**
```js
import userIAM_userAuth from '@ohos.userIAM.userAuth';
try {
let version = userIAM_userAuth.getVersion();
console.info("auth version = " + version);
} catch (error) {
console.info("get version failed, error = " + error);
}
```
## userIAM_userAuth.getAvailableStatus<sup>9+</sup> ## userIAM_userAuth.getAvailableStatus<sup>9+</sup>
getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void getAvailableStatus(authType : UserAuthType, authTrustLevel : AuthTrustLevel): void
...@@ -535,7 +498,7 @@ getVersion() : number ...@@ -535,7 +498,7 @@ getVersion() : number
Obtains the version of this authenticator. Obtains the version of this authenticator.
> **NOTE**<br> > **NOTE**<br>
> This API is supported since API version 8 and deprecated since API version 9. You are advised to use [getVersion](#useriam_userauthgetversion9). > This API is supported since API version 8 and deprecated since API version 9.
**Required permissions**: ohos.permission.ACCESS_BIOMETRIC **Required permissions**: ohos.permission.ACCESS_BIOMETRIC
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或