提交 e710276e 编写于 作者: IT_newip's avatar IT_newip

Merge branch 'master' of https://gitee.com/openharmony/docs

...@@ -14,17 +14,18 @@ ...@@ -14,17 +14,18 @@
## 接口说明 ## 接口说明
进行坐标和地理编码信息的相互转化,所使用的接口说明如下,详细信息参见:[位置服务](../reference/apis/js-apis-geoLocationManager.md) 进行坐标和地理编码信息的相互转化,所使用的接口说明如下,详细信息参见:[位置服务](../reference/apis/js-apis-geolocation.md)
**表1** 地理编码转化能力和逆地理编码转化能力的API功能介绍 **表1** 地理编码转化能力和逆地理编码转化能力的API功能介绍
| 接口名 | 功能描述 | | 接口名 | 功能描述 |
| -------- | -------- | | -------- | -------- |
| isGeocoderAvailable(): boolean; | 判断(逆)地理编码服务状态。 | | isGeoServiceAvailable(callback: AsyncCallback<boolean>) : void | 判断(逆)地理编码服务状态,使用callback回调异步返回结果。 |
| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void | 调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。 | | isGeoServiceAvailable() : Promise<boolean> | 判断(逆)地理编码服务状态,使用Promise方式异步返回结果。 |
| getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>> | 调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。 | | getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | 调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void | 调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。 | | getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array<GeoAddress>> | 调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> | 调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。 | | getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | 调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array<GeoAddress>> | 调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。 |
## 开发步骤 ## 开发步骤
...@@ -32,22 +33,23 @@ ...@@ -32,22 +33,23 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> GeoConvert需要访问后端服务,请确保设备联网,以进行信息获取。 > GeoConvert需要访问后端服务,请确保设备联网,以进行信息获取。
1. 导入geoLocationManager模块,所有与(逆)地理编码转化能力相关的功能API,都是通过该模块提供的。 1. 导入geolocation模块,所有与(逆)地理编码转化能力相关的功能API,都是通过该模块提供的。
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geolocation from '@ohos.geolocation';
``` ```
2. 查询geoCoder服务是否可用。 2. 查询geoCoder服务是否可用。
- 调用isGeoServiceAvailable查询geoCoder服务是否可用,如果服务可用再继续进行步骤3。 - 调用isGeoServiceAvailable查询geoCoder服务是否可用,如果服务可用再继续进行步骤3。
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; geolocation.isGeoServiceAvailable((err, data) => {
try { if (err) {
var isAvailable = geoLocationManager.isGeocoderAvailable(); console.log('isGeoServiceAvailable err: ' + JSON.stringify(err));
} catch (err) { } else {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.log('isGeoServiceAvailable data: ' + JSON.stringify(data));
} }
});
``` ```
3. 获取转化结果。 3. 获取转化结果。
...@@ -55,7 +57,7 @@ ...@@ -55,7 +57,7 @@
```ts ```ts
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('getAddressesFromLocation err: ' + JSON.stringify(err)); console.log('getAddressesFromLocation err: ' + JSON.stringify(err));
} else { } else {
...@@ -64,12 +66,12 @@ ...@@ -64,12 +66,12 @@
}); });
``` ```
参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md),应用可以获得与此坐标匹配的GeoAddress列表,应用可以根据实际使用需求,读取相应的参数数据。 参考接口API说明[位置服务](../reference/apis/js-apis-geolocation.md),应用可以获得与此坐标匹配的GeoAddress列表,应用可以根据实际使用需求,读取相应的参数数据。
- 调用getAddressesFromLocationName位置描述转化坐标。 - 调用getAddressesFromLocationName位置描述转化坐标。
```ts ```ts
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('getAddressesFromLocationName err: ' + JSON.stringify(err)); console.log('getAddressesFromLocationName err: ' + JSON.stringify(err));
} else { } else {
...@@ -78,6 +80,6 @@ ...@@ -78,6 +80,6 @@
}); });
``` ```
参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md),应用可以获得与位置描述相匹配的GeoAddress列表,其中包含对应的坐标数据,请参考API使用。 参考接口API说明[位置服务](../reference/apis/js-apis-geolocation.md),应用可以获得与位置描述相匹配的GeoAddress列表,其中包含对应的坐标数据,请参考API使用。
如果需要查询的位置描述可能出现多地重名的请求,可以设置GeoCodeRequest,通过设置一个经纬度范围,以高效地获取期望的准确结果。 如果需要查询的位置描述可能出现多地重名的请求,可以设置GeoCodeRequest,通过设置一个经纬度范围,以高效地获取期望的准确结果。
...@@ -10,12 +10,12 @@ ...@@ -10,12 +10,12 @@
## 接口说明 ## 接口说明
获取设备的位置信息,所使用的接口说明参见:[位置服务](../reference/apis/js-apis-geoLocationManager.md) 获取设备的位置信息,所使用的接口说明参见:[位置服务](../reference/apis/js-apis-geolocation.md)
## 开发步骤 ## 开发步骤
如需要获取设备位置相关接口信息,请参考[位置服务](../reference/apis/js-apis-geoLocationManager.md) 如需要获取设备位置相关接口信息,请参考[位置服务](../reference/apis/js-apis-geolocation.md)
1. 应用在使用系统能力前,需要检查是否已经获取用户授权访问设备位置信息。如未获得授权,可以向用户申请需要的位置权限,申请方式请参考下文。 1. 应用在使用系统能力前,需要检查是否已经获取用户授权访问设备位置信息。如未获得授权,可以向用户申请需要的位置权限,申请方式请参考下文。
系统提供的定位权限有: 系统提供的定位权限有:
...@@ -42,10 +42,10 @@ ...@@ -42,10 +42,10 @@
开发者可以在应用配置文件中声明所需要的权限,具体可参考[授权申请指导](../security/accesstoken-guidelines.md) 开发者可以在应用配置文件中声明所需要的权限,具体可参考[授权申请指导](../security/accesstoken-guidelines.md)
2. 导入geoLocationManager模块,所有与基础定位能力相关的功能API,都是通过该模块提供的。 2. 导入geolocation模块,所有与基础定位能力相关的功能API,都是通过该模块提供的。
```ts ```
import geoLocationManager from '@ohos.geoLocationManager'; import geolocation from '@ohos.geolocation';
``` ```
3. 实例化LocationRequest对象,用于告知系统该向应用提供何种类型的位置服务,以及位置结果上报的频率。<br/> 3. 实例化LocationRequest对象,用于告知系统该向应用提供何种类型的位置服务,以及位置结果上报的频率。<br/>
...@@ -78,8 +78,8 @@ ...@@ -78,8 +78,8 @@
以导航场景为例,实例化方式如下: 以导航场景为例,实例化方式如下:
```ts ```
var requestInfo = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; var requestInfo = {'scenario': geolocation.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
``` ```
**方式二:** **方式二:**
...@@ -108,7 +108,7 @@ ...@@ -108,7 +108,7 @@
以定位精度优先策略为例,实例化方式如下: 以定位精度优先策略为例,实例化方式如下:
```ts ```ts
var requestInfo = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; var requestInfo = {'priority': geolocation.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
``` ```
4. 实例化Callback对象,用于向系统提供位置上报的途径。 4. 实例化Callback对象,用于向系统提供位置上报的途径。
...@@ -123,24 +123,25 @@ ...@@ -123,24 +123,25 @@
5. 启动定位。 5. 启动定位。
```ts ```ts
geoLocationManager.on('locationChange', requestInfo, locationChange); geolocation.on('locationChange', requestInfo, locationChange);
``` ```
6. (可选)结束定位。 6. (可选)结束定位。
```ts ```ts
geoLocationManager.off('locationChange', locationChange); geolocation.off('locationChange', locationChange);
``` ```
如果应用使用场景不需要实时的设备位置,可以获取系统缓存的最近一次历史定位结果。 如果应用使用场景不需要实时的设备位置,可以获取系统缓存的最近一次历史定位结果。
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; geolocation.getLastLocation((err, data) => {
try { if (err) {
var location = geoLocationManager.getLastLocation(); console.log('getLastLocation: err: ' + JSON.stringify(err));
} catch (err) { } else {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.log('getLastLocation: data: ' + JSON.stringify(data));
} }
});
``` ```
此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。 此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。
\ No newline at end of file
# 接口 # 接口
- [开发说明](development-intro.md) - [开发说明](development-intro.md)
......
...@@ -27,6 +27,7 @@ create(options: AnimatorOptions): AnimatorResult ...@@ -27,6 +27,7 @@ create(options: AnimatorOptions): AnimatorResult
| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。 | | options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------- | ------------- | | --------------------------------- | ------------- |
| [AnimatorResult](#animatorresult) | Animator结果接口。 | | [AnimatorResult](#animatorresult) | Animator结果接口。 |
...@@ -51,8 +52,6 @@ create(options: AnimatorOptions): AnimatorResult ...@@ -51,8 +52,6 @@ create(options: AnimatorOptions): AnimatorResult
定义Animator结果接口。 定义Animator结果接口。
<span id = "#resetsup9sup"></span>
### reset<sup>9+</sup> ### reset<sup>9+</sup>
reset(options: AnimatorOptions): void reset(options: AnimatorOptions): void
...@@ -71,7 +70,7 @@ reset(options: AnimatorOptions): void ...@@ -71,7 +70,7 @@ reset(options: AnimatorOptions): void
以下错误码的详细介绍请参见[ohos.animator(动画)](../errorcodes/errorcode-animator.md)错误码。 以下错误码的详细介绍请参见[ohos.animator(动画)](../errorcodes/errorcode-animator.md)错误码。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| --------- | ------- | | --------- | ------- |
| 100001 | Internal error. | | 100001 | Internal error. |
...@@ -181,6 +180,7 @@ onframe: (progress: number) => void ...@@ -181,6 +180,7 @@ onframe: (progress: number) => void
| progress | number | 是 | 动画的当前进度。 | | progress | number | 是 | 动画的当前进度。 |
**示例:** **示例:**
```js ```js
let animatorResult = animator.create(options) let animatorResult = animator.create(options)
animatorResult.onframe = function(value) { animatorResult.onframe = function(value) {
...@@ -208,7 +208,7 @@ animatorResult.onfinish = function() { ...@@ -208,7 +208,7 @@ animatorResult.onfinish = function() {
### oncancel ### oncancel
oncancel: () => void oncancel: () => void
不再维护
动画被取消时回调。 动画被取消时回调。
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
...@@ -247,7 +247,7 @@ animatorResult.onrepeat = function() { ...@@ -247,7 +247,7 @@ animatorResult.onrepeat = function() {
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ---------------------------------------- | | ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| duration | number | 是 | 动画播放的时长,单位毫秒,默认为0。 | | duration | number | 是 | 动画播放的时长,单位毫秒,默认为0。 |
| easing | string | 是 | 动画插值曲线,默认为'ease'。 | | easing | string | 是 | 动画插值曲线,默认为'ease'。 |
......
...@@ -127,7 +127,7 @@ update?(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueB ...@@ -127,7 +127,7 @@ update?(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueB
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| valueBucket | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 | | valueBucket | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回更新的数据记录数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回更新的数据记录数。 |
...@@ -170,7 +170,7 @@ delete?(uri: string, predicates: dataSharePredicates.DataSharePredicates, callba ...@@ -170,7 +170,7 @@ delete?(uri: string, predicates: dataSharePredicates.DataSharePredicates, callba
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ---------------------------------- | | ---------- | ------------------------------------------------------------ | ---- | ---------------------------------- |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回已删除的数据记录数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回已删除的数据记录数。 |
**示例:** **示例:**
...@@ -212,7 +212,7 @@ query?(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns ...@@ -212,7 +212,7 @@ query?(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 | | columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| callback | AsyncCallback&lt;Object&gt; | 是 | 回调函数。返回查询到的结果集。 | | callback | AsyncCallback&lt;Object&gt; | 是 | 回调函数。返回查询到的结果集。 |
......
...@@ -53,7 +53,7 @@ dataShareHelper.query(uri, da, columns).then((data) => { ...@@ -53,7 +53,7 @@ dataShareHelper.query(uri, da, columns).then((data) => {
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core **系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------- | ------------- | ---- | ------------------------ | | ----------- | ------------- | ---- | ------------------------ |
| columnNames | Array&lt;string&gt; | 是 | 结果集中所有列的名称。 | | columnNames | Array&lt;string&gt; | 是 | 结果集中所有列的名称。 |
| columnCount | number | 是 | 结果集中的列数。 | | columnCount | number | 是 | 结果集中的列数。 |
......
...@@ -125,7 +125,7 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -125,7 +125,7 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback&lt;void&gt;): void
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 订阅的事件/回调类型,支持的事件为'dataChange',当数据更改时,触发该事件。 | | type | string | 是 | 订阅的事件/回调类型,支持的事件为'dataChange',当数据更改时,触发该事件。 |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 表示指定的数据路径。 |
...@@ -152,7 +152,7 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback&lt;void&gt;): void ...@@ -152,7 +152,7 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback&lt;void&gt;): void
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 取消订阅的事件/回调类型,支持的事件为'dataChange'。 | | type | string | 是 | 取消订阅的事件/回调类型,支持的事件为'dataChange'。 |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 表示指定的数据路径。 |
...@@ -179,7 +179,7 @@ insert(uri: string, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): ...@@ -179,7 +179,7 @@ insert(uri: string, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;):
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。如果此参数为空,将插入一个空行。 | | value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。如果此参数为空,将插入一个空行。 |
...@@ -218,7 +218,7 @@ insert(uri: string, value: ValuesBucket): Promise&lt;number&gt; ...@@ -218,7 +218,7 @@ insert(uri: string, value: ValuesBucket): Promise&lt;number&gt;
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | --------------------------------------------------------- | ---- | -------------------------------------------------- | | ----- | --------------------------------------------------------- | ---- | -------------------------------------------------- |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。如果此参数为空,将插入一个空行。 | | value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。如果此参数为空,将插入一个空行。 |
...@@ -260,7 +260,7 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callbac ...@@ -260,7 +260,7 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callbac
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 | | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 |
...@@ -298,7 +298,7 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promis ...@@ -298,7 +298,7 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promis
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 | | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 |
...@@ -339,7 +339,7 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: ...@@ -339,7 +339,7 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns:
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey。 | | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey。 |
...@@ -379,7 +379,7 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: ...@@ -379,7 +379,7 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns:
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey。 | | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey。 |
...@@ -422,7 +422,7 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ...@@ -422,7 +422,7 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value:
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 | | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 |
...@@ -467,7 +467,7 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ...@@ -467,7 +467,7 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value:
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 | | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 |
...@@ -515,7 +515,7 @@ batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallb ...@@ -515,7 +515,7 @@ batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallb
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据。 | | values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据。 |
...@@ -552,7 +552,7 @@ batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&g ...@@ -552,7 +552,7 @@ batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&g
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------------------------------ | ---- | ------------------------ | | ------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据。 | | values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据。 |
...@@ -592,7 +592,7 @@ normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -592,7 +592,7 @@ normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | -------------------------------------------------------- | | -------- | ---------------------- | ---- | -------------------------------------------------------- |
| uri | string | 是 | 指示要规范化的[URI](js-apis-uri.md#uri)。 | | uri | string | 是 | 指示要规范化的[URI](js-apis-uri.md#uri)。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当将给定的DataShare URI转换为规范化URI成功,err为undefined,data为获取到的规范化URI(如果支持URI规范化,则返回规范化URI,否则返回空);否则为错误对象。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当将给定的DataShare URI转换为规范化URI成功,err为undefined,data为获取到的规范化URI(如果支持URI规范化,则返回规范化URI,否则返回空);否则为错误对象。 |
...@@ -621,7 +621,7 @@ normalizeUri(uri: string): Promise&lt;string&gt; ...@@ -621,7 +621,7 @@ normalizeUri(uri: string): Promise&lt;string&gt;
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------------------------------- | | ---- | ------ | ---- | ----------------------------------------- |
| uri | string | 是 | 指示要规范化的[URI](js-apis-uri.md#uri)。 | | uri | string | 是 | 指示要规范化的[URI](js-apis-uri.md#uri)。 |
...@@ -653,7 +653,7 @@ denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -653,7 +653,7 @@ denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | --------------------------------------------------- | | -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要反规范化的[URI](js-apis-uri.md#uri)。 | | uri | string | 是 | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当将指定的URI转换为非规范化URI,err为undefined,data为获取到的反规范化URI(如果反规范化成功,则返回反规范化的URI;如果无需进行反规范化,则返回原始URI;若不支持则返回空);否则为错误对象。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当将指定的URI转换为非规范化URI,err为undefined,data为获取到的反规范化URI(如果反规范化成功,则返回反规范化的URI;如果无需进行反规范化,则返回原始URI;若不支持则返回空);否则为错误对象。 |
...@@ -682,7 +682,7 @@ denormalizeUri(uri: string): Promise&lt;string&gt; ...@@ -682,7 +682,7 @@ denormalizeUri(uri: string): Promise&lt;string&gt;
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------------------------------- | | ---- | ------ | ---- | ------------------------------------------- |
| uri | string | 是 | 指示要反规范化的[URI](js-apis-uri.md#uri)。 | | uri | string | 是 | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
...@@ -714,7 +714,7 @@ notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -714,7 +714,7 @@ notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 表示指定的数据路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当通知已注册的观察者指定URI对应的数据资源已发生变更成功,err为undefined;否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当通知已注册的观察者指定URI对应的数据资源已发生变更成功,err为undefined;否则为错误对象。 |
...@@ -739,7 +739,7 @@ notifyChange(uri: string): Promise&lt;void&gt; ...@@ -739,7 +739,7 @@ notifyChange(uri: string): Promise&lt;void&gt;
**参数:** **参数:**
| 名称 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------------- | | ---- | ------ | ---- | -------------------- |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 表示指定的数据路径。 |
......
...@@ -2656,7 +2656,7 @@ try { ...@@ -2656,7 +2656,7 @@ try {
**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core **系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------- | ---- | --------------------------------------------------------- | | ------------- | ------------- | ---- | --------------------------------------------------------- |
| name | string | 是 | 数据库文件名。 | | name | string | 是 | 数据库文件名。 |
| securityLevel | SecurityLevel | 是 | 设置数据库安全级别 | | securityLevel | SecurityLevel | 是 | 设置数据库安全级别 |
...@@ -4649,7 +4649,7 @@ try { ...@@ -4649,7 +4649,7 @@ try {
**系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core **系统能力:**SystemCapability.DistributedDataManager.RelationalStore.Core
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| name | string | 是 | 数据库文件名。 | | name | string | 是 | 数据库文件名。 |
...@@ -162,7 +162,7 @@ getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options, callback: ...@@ -162,7 +162,7 @@ getKVStore&lt;T extends KVStore&gt;(storeId: string, options: Options, callback:
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| storeId | string | 是 | 数据库唯一标识符,长度不大于[MAX_STORE_ID_LENGTH](#constants)。 | | storeId | string | 是 | 数据库唯一标识符,长度不大于[MAX_STORE_ID_LENGTH](#constants)。 |
| options | [Options](#options) | 是 | 创建KVStore实例的配置信息。 | | options | [Options](#options) | 是 | 创建KVStore实例的配置信息。 |
| callback | AsyncCallback&lt;T&gt;&lt;T extends [KVStore](#kvstore)&gt; | 是 | 回调函数。返回创建的KVStore数据库实例。 | | callback | AsyncCallback&lt;T&gt; | 是 | 回调函数。返回创建的KVStore数据库实例。 |
**示例:** **示例:**
...@@ -2328,7 +2328,7 @@ putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void ...@@ -2328,7 +2328,7 @@ putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| entries |[Entry](#entry)[] | 是 |表示要批量插入的键值对。 | | entries |[Entry](#entry)[] | 是 |表示要批量插入的键值对。 |
| callback |Asyncallback&lt;void&gt; |是 |回调函数。 | | callback |AsyncCallback&lt;void&gt; |是 |回调函数。 |
**示例:** **示例:**
...@@ -4369,7 +4369,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KvS ...@@ -4369,7 +4369,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KvS
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |标识要查询其数据的设备。 | | deviceId |string | 是 |标识要查询其数据的设备。 |
| keyPrefix |string | 是 |表示要匹配的键前缀。 | | keyPrefix |string | 是 |表示要匹配的键前缀。 |
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; | 是 |回调函数。返回与指定设备ID和key前缀匹配的KvStoreResultSet对象。 | | callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | 是 |回调函数。返回与指定设备ID和key前缀匹配的KvStoreResultSet对象。 |
**示例:** **示例:**
...@@ -4409,7 +4409,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KvStoreResultSet&g ...@@ -4409,7 +4409,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KvStoreResultSet&g
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; |Promise对象。返回与指定设备ID和key前缀匹配的KvStoreResultSet对象。| |Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise对象。返回与指定设备ID和key前缀匹配的KvStoreResultSet对象。|
**示例:** **示例:**
...@@ -4447,7 +4447,7 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): voi ...@@ -4447,7 +4447,7 @@ getResultSet(query: Query, callback: AsyncCallback&lt;KvStoreResultSet&gt;): voi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| query |[Query](#query8) | 是 |表示查询对象。 | | query |[Query](#query8) | 是 |表示查询对象。 |
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; | 是 |回调函数,返回与指定Query对象匹配的KvStoreResultSet对象。 | | callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | 是 |回调函数,返回与指定Query对象匹配的KvStoreResultSet对象。 |
**示例:** **示例:**
...@@ -4504,7 +4504,7 @@ getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt; ...@@ -4504,7 +4504,7 @@ getResultSet(query: Query): Promise&lt;KvStoreResultSet&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; |Promise对象。返回与指定Query对象匹配的KvStoreResultSet对象。| |Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise对象。返回与指定Query对象匹配的KvStoreResultSet对象。|
**示例:** **示例:**
...@@ -4564,7 +4564,7 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KvStoreR ...@@ -4564,7 +4564,7 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KvStoreR
| ----- | ------ | ---- | ----------------------- | | ----- | ------ | ---- | ----------------------- |
| deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | | deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 |
| query |[Query](#query8) | 是 |表示查询对象。 | | query |[Query](#query8) | 是 |表示查询对象。 |
| callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; | 是 |回调函数。返回与指定设备ID和Query对象匹配的KvStoreResultSet对象。 | | callback |AsyncCallback&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; | 是 |回调函数。返回与指定设备ID和Query对象匹配的KvStoreResultSet对象。 |
**示例:** **示例:**
...@@ -4621,7 +4621,7 @@ getResultSet(deviceId: string, query: Query): Promise&lt;KvStoreResultSet&gt; ...@@ -4621,7 +4621,7 @@ getResultSet(deviceId: string, query: Query): Promise&lt;KvStoreResultSet&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------- | | ------ | ------- |
|Promise&lt;[KvStoreResultSet](#kvstoreresultset8)[]&gt; |Promise对象。返回与指定设备ID和Query对象匹配的KvStoreResultSet对象。| |Promise&lt;[KvStoreResultSet](#kvstoreresultset8)&gt; |Promise对象。返回与指定设备ID和Query对象匹配的KvStoreResultSet对象。|
**示例:** **示例:**
......
...@@ -2269,7 +2269,7 @@ putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void ...@@ -2269,7 +2269,7 @@ putBatch(entries: Entry[], callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------ | | -------- | ------------------------ | ---- | ------------------------ |
| entries | [Entry](#entry)[] | 是 | 表示要批量插入的键值对。 | | entries | [Entry](#entry)[] | 是 | 表示要批量插入的键值对。 |
| callback | Asyncallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码:** **错误码:**
...@@ -2396,7 +2396,7 @@ putBatch(value: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;void&gt;): ...@@ -2396,7 +2396,7 @@ putBatch(value: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;void&gt;):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------ |
| value | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 表示要插入的数据。 | | value | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 表示要插入的数据。 |
| callback | Asyncallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码:** **错误码:**
...@@ -2605,7 +2605,7 @@ delete(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallb ...@@ -2605,7 +2605,7 @@ delete(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallb
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- | | ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码:** **错误码:**
...@@ -2651,7 +2651,7 @@ delete(predicates: dataSharePredicates.DataSharePredicates): Promise&lt;void&gt; ...@@ -2651,7 +2651,7 @@ delete(predicates: dataSharePredicates.DataSharePredicates): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- | | ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 |
**返回值:** **返回值:**
...@@ -3566,7 +3566,7 @@ getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: Asyn ...@@ -3566,7 +3566,7 @@ getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: Asyn
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 |
| callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数,获取与指定Predicates对象匹配的KVStoreResultSet对象。 | | callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数,获取与指定Predicates对象匹配的KVStoreResultSet对象。 |
**错误码:** **错误码:**
...@@ -3622,7 +3622,7 @@ getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise&lt;KV ...@@ -3622,7 +3622,7 @@ getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise&lt;KV
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- | | ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 |
**返回值:** **返回值:**
...@@ -5311,7 +5311,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KVS ...@@ -5311,7 +5311,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback&lt;KVS
| --------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | --------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 标识要查询其数据的设备。 | | deviceId | string | 是 | 标识要查询其数据的设备。 |
| keyPrefix | string | 是 | 表示要匹配的键前缀。 | | keyPrefix | string | 是 | 表示要匹配的键前缀。 |
| callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)[]&gt; | 是 | 回调函数。返回与指定设备ID和key前缀匹配的KVStoreResultSet对象。 | | callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数。返回与指定设备ID和key前缀匹配的KVStoreResultSet对象。 |
**错误码:** **错误码:**
...@@ -5367,7 +5367,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KVStoreResultSet&g ...@@ -5367,7 +5367,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise&lt;KVStoreResultSet&g
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------ | ------------------------------------------------------------ |
| Promise&lt;[KVStoreResultSet](#kvstoreresultset)[]&gt; | Promise对象。返回与指定设备ID和key前缀匹配的KVStoreResultSet对象。 | | Promise&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | Promise对象。返回与指定设备ID和key前缀匹配的KVStoreResultSet对象。 |
**错误码:** **错误码:**
...@@ -5414,7 +5414,7 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KVStoreR ...@@ -5414,7 +5414,7 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback&lt;KVStoreR
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | KVStoreResultSet对象所属的设备ID。 | | deviceId | string | 是 | KVStoreResultSet对象所属的设备ID。 |
| query | [Query](query) | 是 | 表示查询对象。 | | query | [Query](query) | 是 | 表示查询对象。 |
| callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)[]&gt; | 是 | 回调函数。返回与指定设备ID和Query对象匹配的KVStoreResultSet对象。 | | callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数。返回与指定设备ID和Query对象匹配的KVStoreResultSet对象。 |
**错误码:** **错误码:**
...@@ -5491,7 +5491,7 @@ getResultSet(deviceId: string, query: Query): Promise&lt;KVStoreResultSet&gt; ...@@ -5491,7 +5491,7 @@ getResultSet(deviceId: string, query: Query): Promise&lt;KVStoreResultSet&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------ | ------------------------------------------------------------ |
| Promise&lt;[KVStoreResultSet](#kvstoreresultset)[]&gt; | Promise对象。返回与指定设备ID和Query对象匹配的KVStoreResultSet对象。 | | Promise&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | Promise对象。返回与指定设备ID和Query对象匹配的KVStoreResultSet对象。 |
**错误码:** **错误码:**
...@@ -5561,7 +5561,7 @@ getResultSet(deviceId: string, predicates: dataSharePredicates.DataSharePredicat ...@@ -5561,7 +5561,7 @@ getResultSet(deviceId: string, predicates: dataSharePredicates.DataSharePredicat
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| deviceId | string | 是 | 标识要查询其数据的设备。 | | deviceId | string | 是 | 标识要查询其数据的设备。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 |
| callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数,获取与指定Predicates对象匹配的KVStoreResultSet对象。 | | callback | AsyncCallback&lt;[KVStoreResultSet](#kvstoreresultset)&gt; | 是 | 回调函数,获取与指定Predicates对象匹配的KVStoreResultSet对象。 |
**错误码:** **错误码:**
...@@ -5618,7 +5618,7 @@ getResultSet(deviceId: string, predicates: dataSharePredicates.DataSharePredicat ...@@ -5618,7 +5618,7 @@ getResultSet(deviceId: string, predicates: dataSharePredicates.DataSharePredicat
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- | | ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| deviceId | string | 是 | 标识要查询其数据的设备。 | | deviceId | string | 是 | 标识要查询其数据的设备。 |
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件,当此参数为null时,应定义处理逻辑。 |
**返回值:** **返回值:**
......
# 企业设备信息管理
本模块提供企业设备信息管理能力,包括获取设备序列号等。仅企业设备管理员应用才能调用。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import deviceInfo from '@ohos.enterprise.deviceInfo';
```
## deviceInfo.getDeviceSerial
getDeviceSerial(admin: Want, callback: AsyncCallback<string>): void
获取设备序列号,使用callback形式返回设备序列号。
**需要权限:** ohos.permission.ENTERPRISE_GET_DEVICE_INFO
**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
**系统API**: 此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| callback | AsyncCallback&lt;string&gt; | 是 | callback方式返回设备序列号 |
**错误码**
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
| 类型 | 说明 |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | The application is not a administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
**示例:**
```js
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
deviceInfo.getDeviceSerial(wantTemp, (error, result) => {
if (error != null) {
console.log("error code:" + error.code + " error message:" + error.message);
return;
}
console.log(result);
});
```
## deviceInfo.getDeviceSerial
getDeviceSerial(admin: Want, callback: AsyncCallback<string>): void
获取设备序列号,使用callback形式返回设备序列号。
**需要权限:** ohos.permission.ENTERPRISE_GET_DEVICE_INFO
**系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
**系统API**: 此接口为系统接口。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | Promise方式返回设备序列号 |
**错误码**
以下的错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md)
| 类型 | 说明 |
| ------- | ---------------------------------------------------------------------------- |
| 9200001 | The application is not a administrator of the device. |
| 9200002 | the administrator application does not have permission to manage the device. |
**示例:**
```js
let wantTemp = {
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
};
deviceInfo.getDeviceSerial(wantTemp).then((result) => {
console.log(result);
}).catch(error => {
console.log("error code:" + error.code + " error message:" + error.message);
});
```
\ No newline at end of file
...@@ -12,9 +12,9 @@ import faultLogger from '@ohos.faultLogger' ...@@ -12,9 +12,9 @@ import faultLogger from '@ohos.faultLogger'
故障类型枚举。 故障类型枚举。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.Hiview.FaultLogger。 **系统能力:** SystemCapability.HiviewDFX.Hiview.FaultLogger
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| NO_SPECIFIC | 0 | 不区分故障类型 | | NO_SPECIFIC | 0 | 不区分故障类型 |
| CPP_CRASH | 2 | C++程序故障类型 | | CPP_CRASH | 2 | C++程序故障类型 |
...@@ -25,9 +25,9 @@ import faultLogger from '@ohos.faultLogger' ...@@ -25,9 +25,9 @@ import faultLogger from '@ohos.faultLogger'
故障信息数据结构,获取到的故障信息的数据结构。 故障信息数据结构,获取到的故障信息的数据结构。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.Hiview.FaultLogger。 **系统能力:** SystemCapability.HiviewDFX.Hiview.FaultLogger
| 名称 | 参数类型 | 说明 | | 名称 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| pid | number | 故障进程的进程id | | pid | number | 故障进程的进程id |
| uid | number | 故障进程的用户id | | uid | number | 故障进程的用户id |
...@@ -53,7 +53,7 @@ querySelfFaultLog(faultType: FaultType, callback: AsyncCallback&lt;Array&lt;Faul ...@@ -53,7 +53,7 @@ querySelfFaultLog(faultType: FaultType, callback: AsyncCallback&lt;Array&lt;Faul
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| faultType | [FaultType](#faulttype) | 是 | 输入要查询的故障类型。 | | faultType | [FaultType](#faulttype) | 是 | 输入要查询的故障类型。 |
| callback | AsyncCallbackArray&lt;Array&lt;[FaultLogInfo](#faultloginfo)&gt;&gt; | 是 | 回调函数,在回调函数中获取故障信息数组。<br/>-&nbsp;value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串 | callback | AsyncCallback&lt;Array&lt;[FaultLogInfo](#faultloginfo)&gt;&gt; | 是 | 回调函数,在回调函数中获取故障信息数组。<br/>-&nbsp;value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串
**示例:** **示例:**
...@@ -138,13 +138,13 @@ query(faultType: FaultType, callback: AsyncCallback&lt;Array&lt;FaultLogInfo&gt; ...@@ -138,13 +138,13 @@ query(faultType: FaultType, callback: AsyncCallback&lt;Array&lt;FaultLogInfo&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| faultType | [FaultType](#faulttype) | 是 | 输入要查询的故障类型。 | | faultType | [FaultType](#faulttype) | 是 | 输入要查询的故障类型。 |
| callback | AsyncCallbackArray&lt;Array&lt;[FaultLogInfo](#faultloginfo)&gt;&gt; | 是 | 回调函数,在回调函数中获取故障信息数组。<br/>-&nbsp;value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串 | callback | AsyncCallback&lt;Array&lt;[FaultLogInfo](#faultloginfo)&gt;&gt; | 是 | 回调函数,在回调函数中获取故障信息数组。<br/>-&nbsp;value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串
**错误码:** **错误码:**
以下错误码的详细介绍参见[ohos.faultLogger错误码](../errorcodes/errorcode-faultlogger.md) 以下错误码的详细介绍参见[ohos.faultLogger错误码](../errorcodes/errorcode-faultlogger.md)
| 错误码ID | 错误信息(此处仅提供错误抛出的关键信息) | | 错误码ID | 错误信息 |
| --- | --- | | --- | --- |
| 10600001 | The service is not running or broken | | 10600001 | The service is not running or broken |
...@@ -201,7 +201,7 @@ query(faultType: FaultType) : Promise&lt;Array&lt;FaultLogInfo&gt;&gt; ...@@ -201,7 +201,7 @@ query(faultType: FaultType) : Promise&lt;Array&lt;FaultLogInfo&gt;&gt;
以下错误码的详细介绍参见[ohos.faultLogger错误码](../errorcodes/errorcode-faultlogger.md) 以下错误码的详细介绍参见[ohos.faultLogger错误码](../errorcodes/errorcode-faultlogger.md)
| 错误码ID | 错误信息(此处仅提供错误抛出的关键信息) | | 错误码ID | 错误信息 |
| --- | --- | | --- | --- |
| 10600001 | The service is not running or broken | | 10600001 | The service is not running or broken |
......
...@@ -234,7 +234,7 @@ hidebug.dumpHeapData("heap-20220216"); ...@@ -234,7 +234,7 @@ hidebug.dumpHeapData("heap-20220216");
## hidebug.getServiceDump<sup>9+<sup> ## hidebug.getServiceDump<sup>9+<sup>
getServiceDump(serviceid : number, fd : number, args : Array<string>) : void getServiceDump(serviceid : number, fd : number, args : Array\<string>) : void
获取系统服务信息。 获取系统服务信息。
...@@ -248,7 +248,7 @@ getServiceDump(serviceid : number, fd : number, args : Array<string>) : void ...@@ -248,7 +248,7 @@ getServiceDump(serviceid : number, fd : number, args : Array<string>) : void
| -------- | ------ | ---- | ------------------------------------------------------------ | | -------- | ------ | ---- | ------------------------------------------------------------ |
| serviceid | number | 是 | 基于该用户输入的service id获取系统服务信息。| | serviceid | number | 是 | 基于该用户输入的service id获取系统服务信息。|
| fd | number | 是 | 文件描述符,该接口会往该fd中写入数据。| | fd | number | 是 | 文件描述符,该接口会往该fd中写入数据。|
| args | Array<string> | 是 | 系统服务的Dump接口所对应的参数列表。| | args | Array\<string> | 是 | 系统服务的Dump接口所对应的参数列表。|
**示例:** **示例:**
......
...@@ -45,7 +45,7 @@ hilog.isLoggable(0x0001, "testTag", hilog.LogLevel.INFO); ...@@ -45,7 +45,7 @@ hilog.isLoggable(0x0001, "testTag", hilog.LogLevel.INFO);
**系统能力:** SystemCapability.HiviewDFX.HiLog **系统能力:** SystemCapability.HiviewDFX.HiLog
| 名称 | 默认值 | 说明 | | 名称 | | 说明 |
| ----- | ------ | ------------------------------------------------------------ | | ----- | ------ | ------------------------------------------------------------ |
| DEBUG | 3 | 详细的流程记录,通过该级别的日志可以更详细地分析业务流程和定位分析问题。 | | DEBUG | 3 | 详细的流程记录,通过该级别的日志可以更详细地分析业务流程和定位分析问题。 |
| INFO | 4 | 用于记录业务关键流程节点,可以还原业务的主要运行过程;<br/>用于记录可预料的非正常情况信息,如无网络信号、登录失败等。<br/>这些日志都应该由该业务内处于支配地位的模块来记录,避免在多个被调用的模块或低级函数中重复记录。 | | INFO | 4 | 用于记录业务关键流程节点,可以还原业务的主要运行过程;<br/>用于记录可预料的非正常情况信息,如无网络信号、登录失败等。<br/>这些日志都应该由该业务内处于支配地位的模块来记录,避免在多个被调用的模块或低级函数中重复记录。 |
......
...@@ -19,7 +19,7 @@ import hiSysEvent from '@ohos.hiSysEvent'; ...@@ -19,7 +19,7 @@ import hiSysEvent from '@ohos.hiSysEvent';
**系统能力:** SystemCapability.HiviewDFX.HiSysEvent **系统能力:** SystemCapability.HiviewDFX.HiSysEvent
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| FAULT | 1 | 错误事件类型。 | | FAULT | 1 | 错误事件类型。 |
| STATISTIC | 2 | 统计事件类型。 | | STATISTIC | 2 | 统计事件类型。 |
...@@ -32,7 +32,7 @@ import hiSysEvent from '@ohos.hiSysEvent'; ...@@ -32,7 +32,7 @@ import hiSysEvent from '@ohos.hiSysEvent';
**系统能力:** SystemCapability.HiviewDFX.HiSysEvent **系统能力:** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| domain | string | 是 | 事件领域。 | | domain | string | 是 | 事件领域。 |
| name | string | 是 | 事件名称。 | | name | string | 是 | 事件名称。 |
...@@ -168,7 +168,7 @@ try { ...@@ -168,7 +168,7 @@ try {
**系统能力:** SystemCapability.HiviewDFX.HiSysEvent **系统能力:** SystemCapability.HiviewDFX.HiSysEvent
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| WHOLE_WORD | 1 | 全词匹配类型。 | | WHOLE_WORD | 1 | 全词匹配类型。 |
| PREFIX | 2 | 前缀匹配类型。 | | PREFIX | 2 | 前缀匹配类型。 |
...@@ -180,7 +180,7 @@ try { ...@@ -180,7 +180,7 @@ try {
**系统能力:** SystemCapability.HiviewDFX.HiSysEvent **系统能力:** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| domain | string | 是 | 事件领域。 | | domain | string | 是 | 事件领域。 |
| name | string | 是 | 事件名称。 | | name | string | 是 | 事件名称。 |
...@@ -193,7 +193,7 @@ try { ...@@ -193,7 +193,7 @@ try {
**系统能力:** SystemCapability.HiviewDFX.HiSysEvent **系统能力:** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rules | [WatchRule](#watchrule)[] | 是 | 订阅对象数组,每个订阅者对象包含多个订阅规则。 | | rules | [WatchRule](#watchrule)[] | 是 | 订阅对象数组,每个订阅者对象包含多个订阅规则。 |
| onEvent | function | 是 | 订阅事件的回调方法(info: [SysEventInfo](#syseventinfo)) => void。 | | onEvent | function | 是 | 订阅事件的回调方法(info: [SysEventInfo](#syseventinfo)) => void。 |
...@@ -307,7 +307,7 @@ try { ...@@ -307,7 +307,7 @@ try {
**系统能力:** SystemCapability.HiviewDFX.HiSysEvent **系统能力:** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| beginTime | number | 是 | 查询的系统事件起始时间(13位时间戳)。 | | beginTime | number | 是 | 查询的系统事件起始时间(13位时间戳)。 |
| endTime | number | 是 | 查询的系统事件结束时间(13位时间戳)。 | | endTime | number | 是 | 查询的系统事件结束时间(13位时间戳)。 |
...@@ -319,7 +319,7 @@ try { ...@@ -319,7 +319,7 @@ try {
**系统能力:** SystemCapability.HiviewDFX.HiSysEvent **系统能力:** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| domain | string | 是 | 查询包含的事件领域。 | | domain | string | 是 | 查询包含的事件领域。 |
| names | string[] | 是 | 查询所包含的多个事件名称,每个查询规则对象包含多个系统事件名称。 | | names | string[] | 是 | 查询所包含的多个事件名称,每个查询规则对象包含多个系统事件名称。 |
...@@ -330,7 +330,7 @@ try { ...@@ -330,7 +330,7 @@ try {
**系统能力:** SystemCapability.HiviewDFX.HiSysEvent **系统能力:** SystemCapability.HiviewDFX.HiSysEvent
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| onQuery | function | 是 | 返回查询到的系统事件的回调方法(infos: [SysEventInfo](#syseventinfo)[]) => void。 | | onQuery | function | 是 | 返回查询到的系统事件的回调方法(infos: [SysEventInfo](#syseventinfo)[]) => void。 |
| onComplete | function | 是 | 查询结果统计的回调方法(reason: number, total: number) => void。 | | onComplete | function | 是 | 查询结果统计的回调方法(reason: number, total: number) => void。 |
......
...@@ -18,7 +18,7 @@ import hiTraceChain from '@ohos.hiTraceChain'; ...@@ -18,7 +18,7 @@ import hiTraceChain from '@ohos.hiTraceChain';
**系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| DEFAULT | 0 | 缺省标志。 | | DEFAULT | 0 | 缺省标志。 |
| INCLUDE_ASYNC | 1 | 异步调用标志。启动跟踪时,缺省只跟踪同步调用。设置该标志,同时跟踪同步、异步调用。 | | INCLUDE_ASYNC | 1 | 异步调用标志。启动跟踪时,缺省只跟踪同步调用。设置该标志,同时跟踪同步、异步调用。 |
...@@ -35,7 +35,7 @@ import hiTraceChain from '@ohos.hiTraceChain'; ...@@ -35,7 +35,7 @@ import hiTraceChain from '@ohos.hiTraceChain';
**系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| CS | 0 | 客户端发送类型,标识client侧的发送埋点。 | | CS | 0 | 客户端发送类型,标识client侧的发送埋点。 |
| CR | 1 | 客户端接收类型,标识client侧的接收埋点。 | | CR | 1 | 客户端接收类型,标识client侧的接收埋点。 |
...@@ -49,7 +49,7 @@ import hiTraceChain from '@ohos.hiTraceChain'; ...@@ -49,7 +49,7 @@ import hiTraceChain from '@ohos.hiTraceChain';
**系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| DEFAULT | 0 | 缺省通信类型 | | DEFAULT | 0 | 缺省通信类型 |
| THREAD | 1 | 线程间通信类型 | | THREAD | 1 | 线程间通信类型 |
...@@ -62,7 +62,7 @@ import hiTraceChain from '@ohos.hiTraceChain'; ...@@ -62,7 +62,7 @@ import hiTraceChain from '@ohos.hiTraceChain';
**系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| chainId | bigint | 是 | 跟踪链标识。 | | chainId | bigint | 是 | 跟踪链标识。 |
| spanId | number | 否 | 分支标识。 | | spanId | number | 否 | 分支标识。 |
......
...@@ -613,7 +613,7 @@ try { ...@@ -613,7 +613,7 @@ try {
showSoftKeyboard(callback: AsyncCallback&lt;void&gt;): void showSoftKeyboard(callback: AsyncCallback&lt;void&gt;): void
显示软键盘。使用callback异步回调。 显示软键盘。需要与输入框绑定使用。当点击输入框后,才可通过该接口的调用显示出当前输入法的软键盘。使用callback异步回调。
**需要权限:** ohos.permission.CONNECT_IME_ABILITY **需要权限:** ohos.permission.CONNECT_IME_ABILITY
...@@ -648,9 +648,7 @@ inputMethodController.showSoftKeyboard((err) => { ...@@ -648,9 +648,7 @@ inputMethodController.showSoftKeyboard((err) => {
### showSoftKeyboard<sup>9+</sup> ### showSoftKeyboard<sup>9+</sup>
showSoftKeyboard(): Promise&lt;void&gt; 显示软键盘。需要与输入框绑定使用。当点击输入框后,才可通过该接口的调用显示出当前输入法的软键盘。使用Promise异步回调。
显示软键盘,使用Promise异步回调。
**需要权限:** ohos.permission.CONNECT_IME_ABILITY **需要权限:** ohos.permission.CONNECT_IME_ABILITY
...@@ -836,7 +834,7 @@ on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, input ...@@ -836,7 +834,7 @@ on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, input
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。<br/>-type为‘imeChange’时表示订阅输入法及子类型变化监听事件。 | | type | string | 是 | 设置监听类型。<br/>-type为‘imeChange’时表示订阅输入法及子类型变化监听事件。 |
| callback | [InputMethodProperty](#inputmethodproperty8), [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype) | 是 | 回调函数,返回输入法属性对象及输入法子类型对象。 | | callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)) => void | 是 | 回调函数,返回输入法属性对象及输入法子类型对象。 |
**示例:** **示例:**
...@@ -859,7 +857,7 @@ off(type: 'imeChange', callback?: (inputMethodProperty: InputMethodProperty, inp ...@@ -859,7 +857,7 @@ off(type: 'imeChange', callback?: (inputMethodProperty: InputMethodProperty, inp
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。<br/>-type为‘imeChange’时表示取消订阅输入法及子类型变化监听事件。 | | type | string | 是 | 设置监听类型。<br/>-type为‘imeChange’时表示取消订阅输入法及子类型变化监听事件。 |
| callback | [InputMethodProperty](#inputmethodproperty8), [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype) | 否 | 回调函数,返回取消订阅的输入法属性对象及输入法子类型对象。 | | callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)) => void | 否 | 回调函数,返回取消订阅的输入法属性对象及输入法子类型对象。 |
**示例:** **示例:**
......
...@@ -1309,7 +1309,7 @@ getThumbnail(size: image.Size, callback: AsyncCallback&lt;image.PixelMap&gt;): v ...@@ -1309,7 +1309,7 @@ getThumbnail(size: image.Size, callback: AsyncCallback&lt;image.PixelMap&gt;): v
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ---------------- | | -------- | ----------------------------------- | ---- | ---------------- |
| size | Size | 是 | 缩略图尺寸 | | size | [image.Size](js-apis-image.md#size) | 是 | 缩略图尺寸 |
| callback | AsyncCallback&lt;[image.PixelMap](js-apis-image.md#pixelmap7)&gt; | 是 | 回调返回缩略图的PixelMap | | callback | AsyncCallback&lt;[image.PixelMap](js-apis-image.md#pixelmap7)&gt; | 是 | 回调返回缩略图的PixelMap |
**示例:** **示例:**
...@@ -1352,7 +1352,7 @@ getThumbnail(size?: image.Size): Promise&lt;image.PixelMap&gt; ...@@ -1352,7 +1352,7 @@ getThumbnail(size?: image.Size): Promise&lt;image.PixelMap&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------- | ---- | ----- | | ---- | -------------- | ---- | ----- |
| size | Size | 否 | 缩略图尺寸 | | size | [image.Size](js-apis-image.md#size) | 否 | 缩略图尺寸 |
**返回值:** **返回值:**
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
| ---------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | ---------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 准备开发环境 | 了解声明式UI的工程结构。<br>了解资源分类与访问。 | [OpenHarmony工程介绍](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-project-overview-0000001218440650)<br>[资源分类与访问](../quick-start/resource-categories-and-access.md) | | 准备开发环境 | 了解声明式UI的工程结构。<br>了解资源分类与访问。 | [OpenHarmony工程介绍](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-project-overview-0000001218440650)<br>[资源分类与访问](../quick-start/resource-categories-and-access.md) |
| 学习ArkTS语言 | ArkTS是HarmonyOS优选的主力应用开发语言,当前,ArkTS在TS基础上主要扩展了声明式UI能力。 | [学习ArkTS语言](../quick-start/arkts-get-started.md) | | 学习ArkTS语言 | ArkTS是HarmonyOS优选的主力应用开发语言,当前,ArkTS在TS基础上主要扩展了声明式UI能力。 | [学习ArkTS语言](../quick-start/arkts-get-started.md) |
| 开发页面 | 根据页面的使用场景,选择合适的布局。<br>根据页面需要实现的内容,添加系统内置组件,并修改组件样式。<br>更新页面内容,丰富页面展现形式。 | [创建页面](#创建页面)<br> [常见布局开发指导](ui-ts-layout-linear.md)<br> [常见组件说明](ui-ts-components-intro.md)<br>[修改组件样式](#修改组件样式)<br>[更新页面内容](#更新页面内容) | | 开发页面 | 根据页面的使用场景,选择合适的布局。<br>根据页面需要实现的内容,添加系统内置组件,并修改组件样式。<br>更新页面内容,丰富页面展现形式。 | [创建页面](#创建页面)<br> &nbsp;&nbsp;[常见布局开发指导](ui-ts-layout-linear.md)<br> &nbsp;&nbsp;[常见组件说明](ui-ts-components-intro.md)<br>[修改组件样式](#修改组件样式)<br>[更新页面内容](#更新页面内容) |
| (可选)页面多样化 | 绘图和动画。 | [绘图组件](../reference/arkui-ts/ts-drawing-components-circle.md)<br>[画布组件](../reference/arkui-ts/ts-components-canvas-canvas.md)<br>[动画](../reference/arkui-ts/ts-animatorproperty.md) | | (可选)页面多样化 | 绘图和动画。 | [绘图组件](../reference/arkui-ts/ts-drawing-components-circle.md)<br>[画布组件](../reference/arkui-ts/ts-components-canvas-canvas.md)<br>[动画](../reference/arkui-ts/ts-animatorproperty.md) |
| (可选)页面之间的跳转 | 使用页面路由实现多个页面之前的跳转。 | [页面路由](../reference/apis/js-apis-router.md) | | (可选)页面之间的跳转 | 使用页面路由实现多个页面之前的跳转。 | [页面路由](../reference/apis/js-apis-router.md) |
| (可选)性能提升 | 避免低性能代码对应用的性能造成负面影响。 | [性能提升的推荐方法](ui-ts-performance-improvement-recommendation.md) | | (可选)性能提升 | 避免低性能代码对应用的性能造成负面影响。 | [性能提升的推荐方法](ui-ts-performance-improvement-recommendation.md) |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册