From f464596dbb7457f6e122a430a7da5cf83df9b44a Mon Sep 17 00:00:00 2001 From: HelloCrease Date: Thu, 16 Jun 2022 17:00:47 +0800 Subject: [PATCH] update docs Signed-off-by: HelloCrease --- .../apis/js-apis-deviceUsageStatistics.md | 422 +++++++++--------- .../reference/apis/js-apis-inputdevice.md | 28 +- .../reference/apis/js-apis-mediaquery.md | 76 ++-- .../reference/apis/js-apis-sensor.md | 220 ++++----- .../reference/apis/js-apis-system-prompt.md | 16 +- .../reference/apis/js-apis-system-router.md | 40 +- .../arkui-ts/ts-interpolation-calculation.md | 4 +- 7 files changed, 385 insertions(+), 421 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md b/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md index 8515aec21d..fa9879bfa5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md @@ -20,10 +20,10 @@ isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | bundleName | string | 是 | 应用的bundleName。| - | callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ---------------------------- | ---- | ---------------------------------------- | +| bundleName | string | 是 | 应用的bundleName。 | +| callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。 | **示例**： @@ -47,15 +47,15 @@ isIdleState(bundleName: string): Promise<boolean> **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | bundleName | string | 是 | 应用的bundleName。| +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | -------------- | +| bundleName | string | 是 | 应用的bundleName。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<boolean> | 指定的Promise回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。 | +| 类型 | 说明 | +| ---------------------- | ---------------------------------------- | +| Promise<boolean> | 指定的Promise回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。 | **示例**： @@ -77,8 +77,8 @@ queryAppUsagePriorityGroup(): Promise **返回值**： -| 类型 | 说明 | -| --------------- | ----------------------------------------------- | +| 类型 | 说明 | +| --------------- | --------------------------- | | Promise | 指定的Promise回调方法。返回查询的应用分组结果。 | **示例**： @@ -101,9 +101,9 @@ queryAppUsagePriorityGroup(callback: AsyncCallback): void **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ---- | -------------------------------------------- | -| callback | AsyncCallback | 是 | 指定的CallBack回调方法。返回查询的应用分组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | -------------------------- | +| callback | AsyncCallback | 是 | 指定的CallBack回调方法。返回查询的应用分组。 | **示例**： @@ -140,11 +140,11 @@ queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<Bun **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<[BundleActiveInfoResponse](#bundleactiveinforesponse)> | 是 | 指定的callback回调方法。返回指定起始和结束时间内应用使用时长统计信息。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------------------------------------- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | +| callback | AsyncCallback<[BundleActiveInfoResponse](#bundleactiveinforesponse)> | 是 | 指定的callback回调方法。返回指定起始和结束时间内应用使用时长统计信息。 | **示例**： @@ -178,16 +178,16 @@ queryBundleStateInfos(begin: number, end: number): Promise<BundleActiveInfoRe **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<[BundleActiveInfoResponse](#bundleactiveinforesponse)> | 指定的Promise回调方法。返回指定起始和结束时间内应用使用时长统计信息。| +| 类型 | 说明 | +| ---------------------------------------- | -------------------------------------- | +| Promise<[BundleActiveInfoResponse](#bundleactiveinforesponse)> | 指定的Promise回调方法。返回指定起始和结束时间内应用使用时长统计信息。 | **示例**： @@ -219,12 +219,12 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。| - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<Array<[BundleStateInfo](#bundlestateinfo)>> | 是 | 指定的callback回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。| +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ---------------------------------------- | ---- | ---------------------------------------- | +| byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。 | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | +| callback | AsyncCallback<Array<[BundleStateInfo](#bundlestateinfo)>> | 是 | 指定的callback回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。 | **示例**： @@ -256,17 +256,17 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。| - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ----------------------------- | ---- | ----- | +| byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。 | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleStateInfo](#bundlestateinfo)>> | 指定的Promise回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。| +| 类型 | 说明 | +| ---------------------------------------- | ---------------------------------------- | +| Promise<Array<[BundleStateInfo](#bundlestateinfo)>> | 指定的Promise回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。 | **示例**： @@ -296,11 +296,11 @@ queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback<A **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<Array<[BundleActiveState](#bundleactivestate)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询所有应用的事件集合。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------------------------------------- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | +| callback | AsyncCallback<Array<[BundleActiveState](#bundleactivestate)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询所有应用的事件集合。 | **示例**： @@ -332,16 +332,16 @@ queryBundleActiveStates(begin: number, end: number): Promise<Array<BundleA **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleActiveState](#bundleactivestate)>> | 指定的Promise回调方法。返回指定起始和结束时间查询所有应用的事件集合。| +| 类型 | 说明 | +| ---------------------------------------- | -------------------------------------- | +| Promise<Array<[BundleActiveState](#bundleactivestate)>> | 指定的Promise回调方法。返回指定起始和结束时间查询所有应用的事件集合。 | **示例**： @@ -367,11 +367,11 @@ queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallba **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<Array<[BundleActiveState](#bundleactivestate)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询当前应用的事件集合。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------------------------------------- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | +| callback | AsyncCallback<Array<[BundleActiveState](#bundleactivestate)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询当前应用的事件集合。 | **示例**： @@ -399,16 +399,16 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise<Array< **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleActiveState](#bundleactivestate)>> | 指定的Promise回调方法。返回指定起始和结束时间查询当前应用的事件集合。| +| 类型 | 说明 | +| ---------------------------------------- | -------------------------------------- | +| Promise<Array<[BundleActiveState](#bundleactivestate)>> | 指定的Promise回调方法。返回指定起始和结束时间查询当前应用的事件集合。 | **示例**： @@ -438,20 +438,20 @@ getRecentlyUsedModules(maxNum?: number): Promise<Array<BundleActiveModuleI **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | maxNum | number | 否 | 返回条目的最大数量，最多支持1000条。若不填写，则默认为1000。| +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------------------------------- | +| maxNum | number | 否 | 返回条目的最大数量，最多支持1000条。若不填写，则默认为1000。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleActiveModuleInfo](#bundleactivemoduleinfo9)>> | 指定的Promise回调方法。返回不超过maxNum条FA使用记录。| +| 类型 | 说明 | +| ---------------------------------------- | ---------------------------------- | +| Promise<Array<[BundleActiveModuleInfo](#bundleactivemoduleinfo9)>> | 指定的Promise回调方法。返回不超过maxNum条FA使用记录。 | **示例**： ```js - bundleState.getRecentlyUsedModules(this.maxNum).then( res => { + bundleState.getRecentlyUsedModules(1000).then( res => { console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise succeeded'); for (let i = 0; i < res.length; i++) { console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise number : ' + (i + 1)); @@ -487,15 +487,15 @@ getRecentlyUsedModules(maxNum?: number, callback: AsyncCallback<Array<Bund **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | maxNum | number | 否 | 返回条目的最大数量，最多支持1000条。若不填写，则默认为1000。| - | callback | AsyncCallback<Array<[BundleActiveModuleInfo](#bundleactivemoduleinfo9)>> | 是 | 指定的CallBack回调方法。返回不超过maxNum条FA使用记录。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ----------------------------------- | +| maxNum | number | 否 | 返回条目的最大数量，最多支持1000条。若不填写，则默认为1000。 | +| callback | AsyncCallback<Array<[BundleActiveModuleInfo](#bundleactivemoduleinfo9)>> | 是 | 指定的CallBack回调方法。返回不超过maxNum条FA使用记录。 | **示例**： ```js - bundleState.getRecentlyUsedModules(this.maxNum,(err, res) => { + bundleState.getRecentlyUsedModules(1000,(err, res) => { if(err) { console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback failed, because: ' + err.code); } else { @@ -508,7 +508,7 @@ getRecentlyUsedModules(maxNum?: number, callback: AsyncCallback<Array<Bund }); // 无maNum参数调用方式 - stats.getRecentlyUsedModules((err, res) => { + bundleState.getRecentlyUsedModules((err, res) => { if(err) { console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback failed, because: ' + err.code); } else { @@ -535,14 +535,14 @@ queryAppUsagePriorityGroup(bundleName? : string): Promise **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------ | ---- | ------------------------------------------------------------ | -| bundleName | string | 否 | 可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | ---------------------------------------- | +| bundleName | string | 否 | 可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。 | **返回值**： -| 类型 | 说明 | -| --------------- | ----------------------------------------------- | +| 类型 | 说明 | +| --------------- | --------------------------- | | Promise | 指定的Promise回调方法。返回查询的应用分组结果。 | **示例**： @@ -576,10 +576,10 @@ queryAppUsagePriorityGroup(bundleName? : string, callback: AsyncCallback **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | --------------------- | ---- | ------------------------------------------------------------ | -| bundleName | string | 否 | 可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。 | -| callback | AsyncCallback | 是 | 指定的CallBack回调方法。返回查询的应用分组。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------------------- | ---- | ---------------------------------------- | +| bundleName | string | 否 | 可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。 | +| callback | AsyncCallback | 是 | 指定的CallBack回调方法。返回查询的应用分组。 | **示例**： @@ -616,15 +616,15 @@ setBundleGroup(bundleName: string, newGroup: GroupType): Promise **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | --------- | ---- | -------- | -| bundleName | string | 是 | 应用名称 | -| newGroup | GroupType | 是 | 应用分组 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | --------- | ---- | ---- | +| bundleName | string | 是 | 应用名称 | +| newGroup | GroupType | 是 | 应用分组 | **返回值**： -| 类型 | 说明 | -| ------------- | ------------------------------------------- | +| 类型 | 说明 | +| ------------- | ------------------------- | | Promise | 指定的Promise回调方法。返回本次设置是否成功 | **示例**： @@ -654,11 +654,11 @@ setBundleGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback< **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------- | ---- | ------------------------------------------ | -| bundleName | string | 是 | 应用名称 | -| newGroup | GroupType | 是 | 应用分组 | -| callback | AsyncCallback | 是 | 指定的CallBack回调方法。返回设置是否成功。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------- | ---- | ------------------------- | +| bundleName | string | 是 | 应用名称 | +| newGroup | GroupType | 是 | 应用分组 | +| callback | AsyncCallback | 是 | 指定的CallBack回调方法。返回设置是否成功。 | **示例**： @@ -689,14 +689,14 @@ registerGroupCallBack(callback: Callback): Promis **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ---------------------- | -| callback | Callback | 是 | 应用分组变化的回调函数 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ----------- | +| callback | Callback | 是 | 应用分组变化的回调函数 | **返回值**： -| 类型 | 说明 | -| ------------- | --------------------------------------- | +| 类型 | 说明 | +| ------------- | ----------------------- | | Promise | 指定的Promise回调方法。返回注册是否成功 | **示例**： @@ -731,10 +731,10 @@ registerGroupCallBack(callback: Callback, callbac **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | -------------------------- | -| callback | Callback | 是 | 应用分组变化的回调函数 | -| callback | AsyncCallback | 是 | 注册是否成功的异步回调函数 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ------------- | +| callback | Callback | 是 | 应用分组变化的回调函数 | +| callback | AsyncCallback | 是 | 注册是否成功的异步回调函数 | **示例**： @@ -772,8 +772,8 @@ unRegisterGroupCallBack(): Promise **返回值**： -| 类型 | 说明 | -| ------------- | ----------------------------------------- | +| 类型 | 说明 | +| ------------- | ------------------------ | | Promise | 指定的Promise回调方法。返回解注册是否成功 | **示例**： @@ -800,9 +800,9 @@ unRegisterGroupCallBack(callback: AsyncCallback): void; **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------- | ---- | ---------------------------- | -| callback | AsyncCallback | 是 | 解注册是否成功的异步回调函数 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------- | ---- | -------------- | +| callback | AsyncCallback | 是 | 解注册是否成功的异步回调函数 | **示例**： @@ -830,16 +830,16 @@ queryBundleActiveEventStates(begin: number, end: number): Promise<Array<Bu **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleActiveEventState](#bundleactiveeventstate9)>> | 指定的Promise回调方法。返回指定起始和结束时间查询系统事件（休眠、唤醒、解锁、锁屏）统计信息。| +| 类型 | 说明 | +| ---------------------------------------- | ---------------------------------------- | +| Promise<Array<[BundleActiveEventState](#bundleactiveeventstate9)>> | 指定的Promise回调方法。返回指定起始和结束时间查询系统事件（休眠、唤醒、解锁、锁屏）统计信息。 | **示例**： @@ -866,11 +866,11 @@ queryBundleActiveEventStates(begin: number, end: number, callback: AsyncCallback **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<Array<[BundleActiveEventState](#bundleactiveeventstate9)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询系统事件（休眠、唤醒、解锁、锁屏）统计信息。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | +| callback | AsyncCallback<Array<[BundleActiveEventState](#bundleactiveeventstate9)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询系统事件（休眠、唤醒、解锁、锁屏）统计信息。 | **示例**： @@ -899,16 +899,16 @@ queryAppNotificationNumber(begin: number, end: number): Promise<Array<Bund **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleActiveEventState](#bundleactiveeventstate9)>> | 指定的Promise回调方法。返回指定起始和结束时间查询所有应用的通知次数信息。| +| 类型 | 说明 | +| ---------------------------------------- | ---------------------------------------- | +| Promise<Array<[BundleActiveEventState](#bundleactiveeventstate9)>> | 指定的Promise回调方法。返回指定起始和结束时间查询所有应用的通知次数信息。 | **示例**： @@ -935,11 +935,11 @@ queryAppNotificationNumber(begin: number, end: number, callback: AsyncCallback&l **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<Array<[BundleActiveEventState](#bundleactiveeventstate9)>> | 是 | 指定的callback回调方法。返回通过指定起始和结束时间查询所有应用的通知次数信息。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| begin | number | 是 | 起始时间。 | +| end | number | 是 | 结束时间。 | +| callback | AsyncCallback<Array<[BundleActiveEventState](#bundleactiveeventstate9)>> | 是 | 指定的callback回调方法。返回通过指定起始和结束时间查询所有应用的通知次数信息。 | **示例**： @@ -959,34 +959,34 @@ FA的使用信息的属性集合。 **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| deviceId | string | 否 | FA所属deviceId。| -| bundleName | string | 是 | FA所属应用包名。| -| moduleName | string | 是 | FA所属module名。| -| abilityName | string | 否 | FA的MainAbility名。| -| appLabelId | number | 否 | FA的应用labelId。| -| labelId | number | 否 | FA所属module的labelId。| -| descriptionId | number | 否 | FA所属的应用descriptionId。| -| abilityLableId | number | 否 | FA的MainAbility labelId。| -| abilityDescriptionId | number | 否 | FA的MainAbility descriptionId。| -| abilityIconId | number | 否 | FA的MainAbility iconId。| -| launchedCount | number | 是 | FA的启动次数。| -| lastModuleUsedTime | number | 是 | FA的上一次使用时间。| -| formRecords | Array<[BundleActiveFormInfo](#bundleactiveforminfo9)> | 是 | FA中卡片的使用记录。| +| 参数名 | 类型 | 必填 | 说明 | +| -------------------- | ---------------------------------------- | ---- | ----------------------------- | +| deviceId | string | 否 | FA所属deviceId。 | +| bundleName | string | 是 | FA所属应用包名。 | +| moduleName | string | 是 | FA所属module名。 | +| abilityName | string | 否 | FA的MainAbility名。 | +| appLabelId | number | 否 | FA的应用labelId。 | +| labelId | number | 否 | FA所属module的labelId。 | +| descriptionId | number | 否 | FA所属的应用descriptionId。 | +| abilityLableId | number | 否 | FA的MainAbility labelId。 | +| abilityDescriptionId | number | 否 | FA的MainAbility descriptionId。 | +| abilityIconId | number | 否 | FA的MainAbility iconId。 | +| launchedCount | number | 是 | FA的启动次数。 | +| lastModuleUsedTime | number | 是 | FA的上一次使用时间。 | +| formRecords | Array<[BundleActiveFormInfo](#bundleactiveforminfo9)> | 是 | FA中卡片的使用记录。 | ## BundleActiveFormInfo9+ FA卡片的使用信息的属性集合。 **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| formName | number | 是 | 卡片名称。| -| formDimension | number | 是 | 卡片尺寸。| -| formId | number | 是 | 卡片Id。| -| formLastUsedTime | number | 是 | 卡片的上一次点击时间。| -| count | number | 是 | 卡片的点击次数。| +| 参数名 | 类型 | 必填 | 说明 | +| ---------------- | ------ | ---- | ----------- | +| formName | number | 是 | 卡片名称。 | +| formDimension | number | 是 | 卡片尺寸。 | +| formId | number | 是 | 卡片Id。 | +| formLastUsedTime | number | 是 | 卡片的上一次点击时间。 | +| count | number | 是 | 卡片的点击次数。 | ## BundleActiveGroupCallbackInfo9+ @@ -994,13 +994,13 @@ FA卡片的使用信息的属性集合。 **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App -| 参数名 | 类型 | 必填 | 说明 | -| ---------------- | ------ | ---- | ---------------- | -| appUsageOldGroup | number | 是 | 修改前的应用分组 | -| appUsageNewGroup | number | 是 | 修改后的应用分组 | -| useId | number | 是 | 用户id | -| changeReason | number | 是 | 分组变化原因 | -| bundleName | string | 是 | 应用名称 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------------- | ------ | ---- | -------- | +| appUsageOldGroup | number | 是 | 修改前的应用分组 | +| appUsageNewGroup | number | 是 | 修改后的应用分组 | +| useId | number | 是 | 用户id | +| changeReason | number | 是 | 分组变化原因 | +| bundleName | string | 是 | 应用名称 | ## BundleStateInfo @@ -1010,18 +1010,18 @@ FA卡片的使用信息的属性集合。 **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.AppGroup -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 应用包名。| -| abilityPrevAccessTime | number | 是 | 应用最后一次使用的时间。| -| abilityInFgTotalTime | number | 是 | 应用在前台使用的总时间。| -| id | number | 否 | 用户id。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| abilityPrevSeenTime | number | 否 | 应用最后一次在前台可见的时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| abilitySeenTotalTime | number | 否 | 应用在前台可见的总时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| fgAbilityAccessTotalTime | number | 否 | 应用访问前台的总时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| fgAbilityPrevAccessTime | number | 否 | 应用最后一次访问前台的时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| infosBeginTime | number | 否 | BundleActiveInfo对象中第一条应用使用统计的记录时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| infosEndTime | number | 否 | BundleActiveInfo对象中最后一条应用使用统计的记录时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| +| 参数名 | 类型 | 必填 | 说明 | +| ------------------------ | ------ | ---- | ---------------------------------------- | +| bundleName | string | 是 | 应用包名。 | +| abilityPrevAccessTime | number | 是 | 应用最后一次使用的时间。 | +| abilityInFgTotalTime | number | 是 | 应用在前台使用的总时间。 | +| id | number | 否 | 用户id。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| abilityPrevSeenTime | number | 否 | 应用最后一次在前台可见的时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| abilitySeenTotalTime | number | 否 | 应用在前台可见的总时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| fgAbilityAccessTotalTime | number | 否 | 应用访问前台的总时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| fgAbilityPrevAccessTime | number | 否 | 应用最后一次访问前台的时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| infosBeginTime | number | 否 | BundleActiveInfo对象中第一条应用使用统计的记录时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| infosEndTime | number | 否 | BundleActiveInfo对象中最后一条应用使用统计的记录时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | ### merge @@ -1035,9 +1035,9 @@ merge(toMerge: BundleStateInfo): void **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | toMerge | [BundleStateInfo](#bundlestateinfo) | 是 | 相同包名的应用使用统计信息。| +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------------------------------- | ---- | -------------- | +| toMerge | [BundleStateInfo](#bundlestateinfo) | 是 | 相同包名的应用使用统计信息。 | ## BundleActiveState @@ -1045,14 +1045,14 @@ merge(toMerge: BundleStateInfo): void **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| bundleName | string | 是 | 应用包名。| -| stateType | number | 是 | 应用事件类型。| -| stateOccurredTime | number | 是 | 应用事件发生的时间戳。| -| appUsagePriorityGroup | number | 否 | 应用程序的使用优先级组。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| indexOfLink | string | 否 | 快捷方式id。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| nameOfClass | string | 否 | 类名。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| +| 参数名 | 类型 | 必填 | 说明 | +| --------------------- | ------ | ---- | ---------------------------------------- | +| bundleName | string | 是 | 应用包名。 | +| stateType | number | 是 | 应用事件类型。 | +| stateOccurredTime | number | 是 | 应用事件发生的时间戳。 | +| appUsagePriorityGroup | number | 否 | 应用程序的使用优先级组。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| indexOfLink | string | 否 | 快捷方式id。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| nameOfClass | string | 否 | 类名。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | ## BundleActiveInfoResponse @@ -1060,9 +1060,9 @@ merge(toMerge: BundleStateInfo): void **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| [key: string]: BundleStateInfo | [key: string]: [BundleStateInfo](#bundlestateinfo) | 是 | 不同应用的使用时长统计信息。| +| 参数名 | 类型 | 必填 | 说明 | +| ------------------------------ | ---------------------------------------- | ---- | -------------- | +| [key: string]: BundleStateInfo | [key: string]: [BundleStateInfo](#bundlestateinfo) | 是 | 不同应用的使用时长统计信息。 | ## BundleActiveEventState9+ @@ -1072,11 +1072,11 @@ merge(toMerge: BundleStateInfo): void **系统API**：此接口为系统接口，三方应用不支持调用。 -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| name | string | 是 | 通知应用包名或者系统事件名。| -| eventId | number | 是 | 通知、系统事件类型。| -| count | number | 是 | 应用通知次数或者系统事件触发次数。| +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ----------------- | +| name | string | 是 | 通知应用包名或者系统事件名。 | +| eventId | number | 是 | 通知、系统事件类型。 | +| count | number | 是 | 应用通知次数或者系统事件触发次数。 | ## IntervalType @@ -1084,13 +1084,13 @@ merge(toMerge: BundleStateInfo): void **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App -|名称 |默认值 |说明| -| -------- | -------- | -------- | -| BY_OPTIMIZED | 0 | 表示系统自行判断最合适的查询类型（天、周、月、年）去查询指定时间段间隔的应用使用时长信息。| -| BY_DAILY | 1 | 表示系统按照天去查询指定时间段间隔的应用使用时长信息。| -| BY_WEEKLY | 2 | 表示系统按照周去查询指定时间段间隔的应用使用时长信息。| -| BY_MONTHLY | 3 | 表示系统按照月去查询指定时间段间隔的应用使用时长信息。| -| BY_ANNUALLY | 4 | 表示系统按照年去查询指定时间段间隔的应用使用时长信息。| +| 名称 | 默认值 | 说明 | +| ------------ | ---- | ---------------------------------------- | +| BY_OPTIMIZED | 0 | 表示系统自行判断最合适的查询类型（天、周、月、年）去查询指定时间段间隔的应用使用时长信息。 | +| BY_DAILY | 1 | 表示系统按照天去查询指定时间段间隔的应用使用时长信息。 | +| BY_WEEKLY | 2 | 表示系统按照周去查询指定时间段间隔的应用使用时长信息。 | +| BY_MONTHLY | 3 | 表示系统按照月去查询指定时间段间隔的应用使用时长信息。 | +| BY_ANNUALLY | 4 | 表示系统按照年去查询指定时间段间隔的应用使用时长信息。 | ## GroupType @@ -1098,11 +1098,11 @@ merge(toMerge: BundleStateInfo): void **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.AppGroup -| 名称 | 默认值 | 说明 | -| ------------------ | ------ | ---------------------------------- | -| ACTIVE_GROUP_ALIVE | 10 | 活跃分组 | -| ACTIVE_GROUP_DAILY | 20 | 经常使用，但当前并未在活跃态 | -| ACTIVE_GROUP_FIXED | 30 | 常用分组，定期使用，但不是每天使用 | -| ACTIVE_GROUP_RARE | 40 | 极少使用分组，不经常使用 | -| ACTIVE_GROUP_LIMIT | 50 | 受限使用分组 | -| ACTIVE_GROUP_NEVER | 60 | 从未使用分组，安装但是从未运行过 | \ No newline at end of file +| 名称 | 默认值 | 说明 | +| ------------------ | ---- | ----------------- | +| ACTIVE_GROUP_ALIVE | 10 | 活跃分组 | +| ACTIVE_GROUP_DAILY | 20 | 经常使用，但当前并未在活跃态 | +| ACTIVE_GROUP_FIXED | 30 | 常用分组，定期使用，但不是每天使用 | +| ACTIVE_GROUP_RARE | 40 | 极少使用分组，不经常使用 | +| ACTIVE_GROUP_LIMIT | 50 | 受限使用分组 | +| ACTIVE_GROUP_NEVER | 60 | 从未使用分组，安装但是从未运行过 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md index d1b12cce4c..95beee6a14 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md @@ -36,7 +36,7 @@ on(type: “change”, listener: Callback<DeviceListener>): void let isPhysicalKeyboardExist = true; inputDevice.on("change", (data) => { console.log("type: " + data.type + ", deviceId: " + data.deviceId); - inputDevice.getKeyboardType(data.deviceId, (ret) => { + inputDevice.getKeyboardType(data.deviceId, (err, ret) => { console.log("The keyboard type of the device is: " + ret); if (ret == inputDevice.KeyboardType.ALPHABETIC_KEYBOARD && data.type == 'add') { // 监听物理键盘已连接。 @@ -68,12 +68,12 @@ off(type: “change”, listener?: Callback<DeviceListener>): void **示例**： ```js -listener: function(data) { +function listener(data) { console.log("type: " + data.type + ", deviceId: " + data.deviceId); } // 单独取消listener的监听。 -inputDevice.off("change", this.listener); +inputDevice.off("change", listener); // 取消所有监听。 inputDevice.off("change"); @@ -90,7 +90,7 @@ getDeviceIds(callback: AsyncCallback<Array<number>>): void **参数**： -| 参数 | 类型 | 必填 | 说明 | +| 参数 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----- | | callback | AsyncCallback<Array<number>> | 是 | 回调函数。 | @@ -134,9 +134,9 @@ getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): voi **参数**： -| 参数 | 类型 | 必填 | 说明 | +| 参数 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------------------------- | -| deviceId | number | 是 | 需要获取信息的设备id。 | +| deviceId | number | 是 | 需要获取信息的设备id。 | | callback | AsyncCallback<[InputDeviceData](#inputdevicedata)> | 是 | 回调函数，异步返回InputDeviceData对象。 | **示例**： @@ -333,15 +333,15 @@ inputDevice.getKeyboardType(1).then((ret)=>{ **系统能力**： 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice -| 名称 | 参数类型 | 说明 | -| ----------------------- | ------------------------- | ---------------- | +| 名称 | 参数类型 | 说明 | +| ----------------------- | ------------------------- | -------- | | source | [SourceType](#sourcetype) | 轴的输入源类型。 | -| axis | [AxisType](#axistype) | 轴的类型。 | -| max | number | 轴的最大值。 | -| min | number | 轴的最小值。 | -| fuzz9+ | number | 轴的模糊值。 | -| flat9+ | number | 轴的基准值。 | -| resolution9+ | number | 轴的分辨率。 | +| axis | [AxisType](#axistype) | 轴的类型。 | +| max | number | 轴的最大值。 | +| min | number | 轴的最小值。 | +| fuzz9+ | number | 轴的模糊值。 | +| flat9+ | number | 轴的基准值。 | +| resolution9+ | number | 轴的分辨率。 | ## SourceType diff --git a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md index d58e37ee2f..8e721b186d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md @@ -1,12 +1,12 @@ # 媒体查询 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 导入模块 -``` +```js import mediaquery from '@ohos.mediaquery' ``` @@ -22,19 +22,19 @@ matchMediaSync(condition: string): MediaQueryListener 设置媒体查询的查询条件，并返回对应的监听句柄。 -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | condition | string | 是 | 媒体事件的匹配条件。 | +**参数：** +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ---------- | +| condition | string | 是 | 媒体事件的匹配条件。 | -- 返回值 - | 类型 | 说明 | - | -------- | -------- | - | MediaQueryListener | 媒体事件监听句柄，用于注册和去注册监听回调。 | +**返回值：** +| 类型 | 说明 | +| ------------------ | ---------------------- | +| MediaQueryListener | 媒体事件监听句柄，用于注册和去注册监听回调。 | -- 示例 - ``` - listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件 +**示例：** + ```js +let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件 ``` @@ -45,10 +45,10 @@ matchMediaSync(condition: string): MediaQueryListener ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| matches | boolean | 是 | 否 | 是否符合匹配条件。 | -| media | string | 是 | 否 | 媒体事件的匹配条件。 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ------- | ------- | ---- | ---- | ---------- | +| matches | boolean | 是 | 否 | 是否符合匹配条件。 | +| media | string | 是 | 否 | 媒体事件的匹配条件。 | ### on @@ -57,13 +57,13 @@ on(type: 'change', callback: Callback<MediaQueryResult>): void 通过句柄向对应的查询条件注册回调，当媒体属性发生变更时会触发该回调。 -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 必须填写字符串'change'。 | - | callback | Callback<MediaQueryResult> | 是 | 向媒体查询注册的回调 | +**参数：** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ---------------- | +| type | string | 是 | 必须填写字符串'change'。 | +| callback | Callback<MediaQueryResult> | 是 | 向媒体查询注册的回调 | -- 示例 +**示例：** 详见[off示例](#off)。 @@ -72,14 +72,14 @@ on(type: 'change', callback: Callback<MediaQueryResult>): void off(type: 'change', callback?: Callback<MediaQueryResult>): void 通过句柄向对应的查询条件去注册回调，当媒体属性发生变更时不在触发指定的回调。 -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | boolean | 是 | 必须填写字符串'change'。 | - | callback | Callback<MediaQueryResult> | 否 | 需要去注册的回调，如果参数缺省则去注册该句柄下所有的回调。 | - -- 示例 - ``` +**参数：** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ----------------------------- | +| type | boolean | 是 | 必须填写字符串'change'。 | +| callback | Callback<MediaQueryResult> | 否 | 需要去注册的回调，如果参数缺省则去注册该句柄下所有的回调。 | + +**示例：** + ```js import mediaquery from '@ohos.mediaquery' let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件 @@ -90,8 +90,8 @@ off(type: 'change', callback?: Callback<MediaQueryResult>): void // do something here } } - this.listener.on('change', this.onPortrait) // 注册回调 - this.listener.off('change', this.onPortrait) // 去注册回调 + listener.on('change', onPortrait) // 注册回调 + listener.off('change', onPortrait) // 去注册回调 ``` @@ -100,15 +100,15 @@ off(type: 'change', callback?: Callback<MediaQueryResult>): void ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| matches | boolean | 是 | 否 | 是否符合匹配条件。 | -| media | string | 是 | 否 | 媒体事件的匹配条件。 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ------- | ------- | ---- | ---- | ---------- | +| matches | boolean | 是 | 否 | 是否符合匹配条件。 | +| media | string | 是 | 否 | 媒体事件的匹配条件。 | ### 示例 -``` +```js import mediaquery from '@ohos.mediaquery' let portraitFunc = null diff --git a/zh-cn/application-dev/reference/apis/js-apis-sensor.md b/zh-cn/application-dev/reference/apis/js-apis-sensor.md index 81cc96bbf6..ad3a72baee 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-sensor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-sensor.md @@ -10,8 +10,9 @@ import sensor from '@ohos.sensor'; ``` +## sensor.on -## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER) +### ACCELEROMETER on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>,options?: Options): void @@ -40,8 +41,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Acceler ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION) +### LINEAR_ACCELERATION on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>, options?: Options): void @@ -69,8 +69,7 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Line ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED) +### ACCELEROMETER_UNCALIBRATED on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>, options?: Options): void @@ -101,8 +100,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_GRAVITY) +### GRAVITY on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>,options?: Options): void @@ -128,8 +126,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespons ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE) +### GYROSCOPE on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>, options?: Options): void @@ -157,8 +154,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeRes ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED) +### GYROSCOPE_UNCALIBRATED on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<GyroscopeUncalibratedResponse>, options?: Options): void @@ -189,8 +185,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<G ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION) +### SIGNIFICANT_MOTION on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<SignificantMotionResponse>, options?: Options): void @@ -214,8 +209,7 @@ on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<Sig ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION) +### PEDOMETER_DETECTION on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<PedometerDetectionResponse>, options?: Options): void @@ -241,8 +235,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<Pe ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER) +### PEDOMETER on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>, options?: Options): void @@ -268,8 +261,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerRes ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) +### AMBIENT_TEMPERATURE on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<AmbientTemperatureResponse>, options?: Options): void @@ -293,8 +285,7 @@ on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<Ambie ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD) +### MAGNETIC_FIELD on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>,options?: Options): void @@ -320,8 +311,7 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magneti ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED) +### MAGNETIC_FIELD_UNCALIBRATED on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>, options?: Options): void @@ -350,8 +340,7 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callbac ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_PROXIMITY) +### PROXIMITY on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>,options?: Options): void @@ -375,8 +364,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityRes ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_HUMIDITY) +### HUMIDITY on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>,options?: Options): void @@ -400,8 +388,7 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRespo ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_BAROMETER) +### BAROMETER on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>,options?: Options): void @@ -425,8 +412,7 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerRes ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_HALL) +### HALL on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, options?: Options): void @@ -450,8 +436,7 @@ on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT) +### AMBIENT_LIGHT on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>, options?: Options): void @@ -475,8 +460,7 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightRes ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_ORIENTATION) +### ORIENTATION on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>, options?: Options): void @@ -502,7 +486,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientatio ); ``` -## sensor.on(SensorType.SENSOR_TYPE_ID_HEART_RATE) +### HEART_RATE on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>, options?: Options): void @@ -529,7 +513,7 @@ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){ ); ``` -## sensor.on(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR) +### ROTATION_VECTOR on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<RotationVectorResponse>,options?: Options): void @@ -556,8 +540,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<Rotatio ); ``` - -## sensor.on(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION) +### WEAR_DETECTION on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>,options?: Options): void @@ -581,8 +564,9 @@ on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDet ); ``` +## sensor.once -## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER) +### ACCELEROMETER once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>): void @@ -608,8 +592,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Accele ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION) +### LINEAR_ACCELERATION once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>): void @@ -635,8 +618,7 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Li ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED) +### ACCELEROMETER_UNCALIBRATED once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>): void @@ -665,8 +647,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callba ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_GRAVITY) +### GRAVITY once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>): void @@ -690,8 +671,7 @@ once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespo ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE) +### GYROSCOPE once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>): void @@ -717,8 +697,7 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeR ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED) +### GYROSCOPE_UNCALIBRATED once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback<GyroscopeUncalibratedResponse>): void @@ -747,8 +726,7 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&l ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION) +### SIGNIFICANT_MOTION once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<SignificantMotionResponse>): void @@ -770,8 +748,7 @@ once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<Si ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION) +### PEDOMETER_DETECTION once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<PedometerDetectionResponse>): void @@ -795,8 +772,7 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<P ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER) +### PEDOMETER once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>): void @@ -820,8 +796,7 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerR ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) +### AMBIENT_TEMPERATURE once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<AmbientTemperatureResponse>): void @@ -843,8 +818,7 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<A ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD) +### MAGNETIC_FIELD once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>): void @@ -868,8 +842,7 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magne ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED) +### MAGNETIC_FIELD_UNCALIBRATED once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>): void @@ -896,8 +869,7 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callb ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_PROXIMITY) +### PROXIMITY once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>): void @@ -923,8 +895,7 @@ once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityR ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_HUMIDITY) +### HUMIDITY once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>): void @@ -946,8 +917,7 @@ once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRes ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_BAROMETER) +### BAROMETER once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>): void @@ -969,8 +939,7 @@ once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerR ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_HALL) +### HALL once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>): void @@ -992,8 +961,7 @@ once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse> ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT) +### AMBIENT_LIGHT once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>): void @@ -1015,8 +983,7 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightR ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_ORIENTATION) +### ORIENTATION once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>): void @@ -1040,8 +1007,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientat ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR) +### ROTATION_VECTOR once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<RotationVectorResponse>): void @@ -1066,8 +1032,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<Rota ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_HEART_RATE) +### HEART_RATE once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>): void @@ -1091,8 +1056,7 @@ once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRate ); ``` - -## sensor.once(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION) +### WEAR_DETECTION once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>): void @@ -1114,7 +1078,9 @@ once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearD ); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_ACCELEROMETER) +## sensor.off + +### ACCELEROMETER off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback<AccelerometerResponse>): void @@ -1142,7 +1108,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED) +### ACCELEROMETER_UNCALIBRATED off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callback<AccelerometerUncalibratedResponse>): void @@ -1173,7 +1139,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT) +### AMBIENT_LIGHT off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback<LightResponse>): void @@ -1197,7 +1163,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) +### AMBIENT_TEMPERATURE off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback<AmbientTemperatureResponse>): void @@ -1221,7 +1187,7 @@ function callback(data) { sensor.off( sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) +### AMBIENT_TEMPERATURE off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback<BarometerResponse>): void @@ -1245,7 +1211,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_GRAVITY) +### GRAVITY off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback<GravityResponse>): void @@ -1271,7 +1237,7 @@ function callback(data) { sensor.off( sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE) +### GYROSCOPE off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback<GyroscopeResponse>): void @@ -1299,7 +1265,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED) +### GYROSCOPE_UNCALIBRATED off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback<GyroscopeUncalibratedResponse>): void @@ -1327,7 +1293,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_HALL) +### HALL off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback<HallResponse>): void @@ -1351,7 +1317,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HALL, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_HEART_RATE) +### HEART_RATE off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback<HeartRateResponse>): void @@ -1377,7 +1343,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_HUMIDITY) +### HUMIDITY off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityResponse>): void @@ -1403,7 +1369,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION) +### LINEAR_ACCELERATION off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback<LinearAccelerometerResponse>): void @@ -1431,7 +1397,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD) +### MAGNETIC_FIELD off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback?: Callback<MagneticFieldResponse>): void @@ -1459,7 +1425,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED) +### MAGNETIC_FIELD_UNCALIBRATED off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback<MagneticFieldUncalibratedResponse>): void @@ -1488,7 +1454,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_ORIENTATION) +### ORIENTATION off(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback?: Callback<OrientationResponse>): void @@ -1514,7 +1480,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_PEDOMETER) +### PEDOMETER off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerResponse>): void @@ -1529,7 +1495,7 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerR | type | [SensorType](#sensortype) | 是 | 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 | | callback | Callback<[PedometerResponse](#pedometerresponse)> | 是 | 取消注册计步传感器的回调函数，上报的数据类型为PedometerResponse。 | -**返回值：** ; +**示例：** ```js function callback(data) { @@ -1538,7 +1504,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION) +### PEDOMETER_DETECTION off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback<PedometerDetectionResponse>): void @@ -1564,7 +1530,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_PROXIMITY) +### PROXIMITY off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback<ProximityResponse>): void @@ -1588,7 +1554,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR) +### ROTATION_VECTOR off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback<RotationVectorResponse>): void @@ -1615,7 +1581,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION) +### SIGNIFICANT_MOTION off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback<SignificantMotionResponse>): void @@ -1639,7 +1605,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback); ``` -## sensor.off(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION) +### WEAR_DETECTION off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback<WearDetectionResponse>): void @@ -1774,7 +1740,7 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promi | ---------------------------------------- | ------- | | Promise<[GeomagneticResponse](#geomagneticresponse)> | 返回磁场信息。 | -**返回值：** +**示例：** ```js const promise = sensor.getGeomagneticField({latitude:80, longitude:0, altitude:0}, 1580486400000); promise.then((data) => { @@ -1802,7 +1768,7 @@ getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallbac | currentPressure | number | 是 | 表示设备所在高度的气压值，单位为hPa。 | | callback | AsyncCallback<number> | 是 | 返回设备所在的海拔高度，单位为米。 | -**返回值：** +**示例：** ```js sensor.getAltitude(0, 200, function(err, data) { @@ -1836,7 +1802,7 @@ getAltitude(seaPressure: number, currentPressure: number): Promise<number> | --------------------- | ------------------ | | Promise<number> | 返回设备所在的海拔高度（单位：米）。 | -**返回值：** +**示例：** ```js const promise = sensor.getAltitude(0, 200); @@ -1863,7 +1829,7 @@ getGeomagneticDip(inclinationMatrix: Array<number>, callback: AsyncCallbac | inclinationMatrix | Array<number> | 是 | 表示倾斜矩阵。 | | callback | AsyncCallback<number> | 是 | 返回地磁倾斜角，单位为弧度。 | -**返回值：** +**示例：** ```js sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) { @@ -1896,7 +1862,7 @@ getGeomagneticDip(inclinationMatrix: Array<number>): Promise<number> | --------------------- | -------------- | | Promise<number> | 返回地磁倾斜角，单位为弧度。 | -**返回值：** +**示例：** ```js const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]); @@ -1923,7 +1889,7 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar | preRotationMatrix | Array<number> | 是 | 表示旋转矩阵。 | | callback | AsyncCallback<Array<number>> | 是 | 返回z、x、y轴方向的旋转角度变化。 | -**返回值：** +**示例：** ```js sensor. getAngleModify([1,0,0,0,1,0,0,0,1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87], function(err, data) { @@ -1934,7 +1900,7 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar } console.info("SensorJsAPI--->Successed to get getAngleModifiy interface get data: " + data.x); for (var i=0; i < data.length; i++) { - console.info(LABEL + "data[" + i + "]: " + data[i]); + console.info("data[" + i + "]: " + data[i]); } }) ``` @@ -1961,17 +1927,17 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar | ---------------------------------- | ------------------ | | Promise<Array<number>> | 返回z、x、y轴方向的旋转角度变化。 | -**返回值：** +**示例：** ```js const promise = sensor.getAngleModify([1,0,0,0,1,0,0,0,1], [1,0,0,0,0.87,-0.50,0,0.50,0.87]); promise.then((data) => { console.info('getAngleModifiy_promise success'); for (var i=0; i < data.length; i++) { - console.info(LABEL + "data[" + i + "]: " + data[i]); + console.info("data[" + i + "]: " + data[i]); } }).catch((reason) => { - console.info(LABEL + "promise::catch", reason); + console.info("promise::catch", reason); }) ``` @@ -1991,7 +1957,7 @@ createRotationMatrix(rotationVector: Array<number>, callback: AsyncCallbac | rotationVector | Array<number> | 是 | 表示旋转矢量。 | | callback | AsyncCallback<Array<number>> | 是 | 返回旋转矩阵。 | -**返回值：** +**示例：** ```js sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) { @@ -2002,7 +1968,7 @@ createRotationMatrix(rotationVector: Array<number>, callback: AsyncCallbac } console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x); for (var i=0; i < data.length; i++) { - console.info(LABEL + "data[" + i + "]: " + data[i]); + console.info("data[" + i + "]: " + data[i]); } }) ``` @@ -2028,17 +1994,17 @@ createRotationMatrix(rotationVector: Array<number>): Promise<Array<n | ---------------------------------- | ------- | | Promise<Array<number>> | 返回旋转矩阵。 | -**返回值：** +**示例：** ```js const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]); promise.then((data) => { console.info('createRotationMatrix_promise success'); for (var i=0; i < data.length; i++) { - console.info(LABEL + "data[" + i + "]: " + data[i]); + console.info("data[" + i + "]: " + data[i]); } }).catch((reason) => { - console.info(LABEL + "promise::catch", reason); + console.info("promise::catch", reason); }) ``` @@ -2058,7 +2024,7 @@ createQuaternion(rotationVector: Array<number>, callback: AsyncCallback< | rotationVector | Array<number> | 是 | 表示旋转矢量。 | | callback | AsyncCallback<Array<number>> | 是 | 返回四元数。 | -**返回值：** +**示例：** ```js sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) { @@ -2069,7 +2035,7 @@ createQuaternion(rotationVector: Array<number>, callback: AsyncCallback< } console.info("SensorJsAPI--->Successed to get createQuaternion interface get data: " + data.x); for (var i=0; i < data.length; i++) { - console.info(LABEL + "data[" + i + "]: " + data[i]); + console.info("data[" + i + "]: " + data[i]); } }) ``` @@ -2095,7 +2061,7 @@ createQuaternion(rotationVector: Array<number>): Promise<Array<numbe | ---------------------------------- | ------ | | Promise<Array<number>> | 返回四元数。 | -**返回值：** +**示例：** ```js const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]); @@ -2125,7 +2091,7 @@ getDirection(rotationMatrix: Array<number>, callback: AsyncCallback<Arr | rotationMatrix | Array<number> | 是 | 表示旋转矩阵。 | | callback | AsyncCallback<Array<number>> | 是 | 返回围绕z、x、y轴方向的旋转角度。 | -**返回值：** +**示例：** ```js sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) { @@ -2134,7 +2100,7 @@ getDirection(rotationMatrix: Array<number>, callback: AsyncCallback<Arr err.message); return; } - console.info("SensorJsAPI--->Successed to get getDirection interface get data: " + data.x); + console.info("SensorJsAPI--->Successed to get getDirection interface get data: " + data); for (var i = 1; i < data.length; i++) { console.info("sensor_getDirection_callback" + data[i]); } @@ -2162,12 +2128,12 @@ getDirection(rotationMatrix: Array<number>): Promise<Array<number> | ---------------------------------- | ------------------ | | Promise<Array<number>> | 返回围绕z、x、y轴方向的旋转角度。 | -**返回值：** +**示例：** ```js const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]); promise.then((data) => { - console.info('sensor_getAltitude_Promise success', data.x); + console.info('sensor_getAltitude_Promise success', data); for (var i = 1; i < data.length; i++) { console.info("sensor_getDirection_promise" + data[i]); } @@ -2193,7 +2159,7 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& | geomagnetic | Array<number> | 是 | 表示地磁矢量。 | | callback | AsyncCallback<[RotationMatrixResponse](#rotationmatrixresponse)> | 是 | 返回旋转矩阵。 | -**返回值：** +**示例：** ```js sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data) { @@ -2231,14 +2197,14 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& | ---------------------------------------- | ------- | | Promise<[RotationMatrixResponse](#rotationmatrixresponse)> | 返回旋转矩阵。 | -**返回值：** +**示例：** ```js const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]); promise.then((data) => { console.info('createRotationMatrix_promise successed'); for (var i=0; i < data.length; i++) { - console.info(LABEL + "data[" + i + "]: " + data[i]); + console.info("data[" + i + "]: " + data[i]); } }).catch((err) => { console.info('promise failed'); diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md b/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md index c400fc3387..4eb1421626 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md @@ -11,7 +11,7 @@ ## 导入模块 -``` +```js import prompt from '@system.prompt'; ``` @@ -31,7 +31,7 @@ showToast(options: ShowToastOptions): void **示例：** -``` +```js export default { showToast() { prompt.showToast({ @@ -60,7 +60,7 @@ showDialog(options: ShowDialogOptions): void **示例：** -``` +```js export default { showDialog() { prompt.showDialog({ @@ -100,7 +100,7 @@ showActionMenu(options: ShowActionMenuOptions): void **示例：** -``` +```js export default { showActionMenu() { prompt.showActionMenu({ @@ -115,11 +115,11 @@ export default { color: '#000000', }, ], - success: function(data) { - console.log('dialog success callback，click button : ' + data.tapIndex); + success: function(tapIndex) { + console.log('dialog success callback，click button : ' + tapIndex); }, - fail: function(data) { - console.log('dialog fail callback' + data.errMsg); + fail: function(errMsg) { + console.log('dialog fail callback' + errMsg); }, }); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-router.md b/zh-cn/application-dev/reference/apis/js-apis-system-router.md index 273b0f04ca..fb61c8c711 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-router.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-router.md @@ -1,6 +1,6 @@ # 页面路由 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> **说明：** > > - 从API Version 8 开始，该接口不再维护，推荐使用新接口[`@ohos.router`](js-apis-router.md)。 > @@ -11,7 +11,7 @@ ## 导入模块 -``` +```js import router from '@system.router'; ``` @@ -31,7 +31,7 @@ push(options: RouterOptions): void **示例：** -``` +```js // 在当前页面中 export default { pushPage() { @@ -49,7 +49,7 @@ export default { ``` -``` +```js // 在routerpage2页面中 export default { data: { @@ -85,7 +85,7 @@ replace(options: RouterOptions): void **示例：** -``` +```js // 在当前页面中 export default { replacePage() { @@ -100,7 +100,7 @@ export default { ``` -``` +```js // 在detail页面中 export default { data: { @@ -128,7 +128,7 @@ back(options?: BackRouterOptions): void **示例：** -``` +```js // index页面 export default { indexPushPage() { @@ -140,7 +140,7 @@ export default { ``` -``` +```js // detail页面 export default { detailPushPage() { @@ -152,7 +152,7 @@ export default { ``` -``` +```js // mall页面通过back，将返回detail页面 export default { mallBackPage() { @@ -162,7 +162,7 @@ export default { ``` -``` +```js // detail页面通过back，将返回index页面 export default { defaultBack() { @@ -172,7 +172,7 @@ export default { ``` -``` +```js // 通过back，返回到detail页面 export default { backToDetail() { @@ -208,7 +208,7 @@ clear(): void **示例：** -``` +```js export default { clearPage() { router.clear(); @@ -232,7 +232,7 @@ getLength(): string **示例：** -``` +```js export default { getLength() { var size = router.getLength(); @@ -257,7 +257,7 @@ getState(): RouterState **示例：** -``` +```js export default { getState() { var page = router.getState(); @@ -284,7 +284,7 @@ enableAlertBeforeBackPage(options: EnableAlertBeforeBackPageOptions): void **示例：** -``` +```js export default { enableAlertBeforeBackPage() { router.enableAlertBeforeBackPage({ @@ -292,8 +292,8 @@ export default { success: function() { console.log('success'); }, - fail: function() { - console.log('fail'); + cancel: function() { + console.log('cancel'); }, }); } @@ -316,15 +316,15 @@ disableAlertBeforeBackPage(options?: DisableAlertBeforeBackPageOptions): void **示例：** -``` +```js export default { disableAlertBeforeBackPage() { router.disableAlertBeforeBackPage({ success: function() { console.log('success'); }, - fail: function() { - console.log('fail'); + cancel: function() { + console.log('cancel'); }, }); } diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md b/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md index 896525c1d3..1c45a5048c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md @@ -6,7 +6,7 @@ ## 导入模块 -``` +```js import curves from '@ohos.curves' ``` @@ -135,8 +135,6 @@ struct ImageComponent { .backgroundColor(Color.Red) .onClick(()=> { let curve = Curves.cubicBezier(0.25, 0.1, 0.25, 1.0); - this.widthSize = curve.interpolate(0.5) * this.widthSize; - this.heightSize = curve.interpolate(0.5) * this.heightSize; }) .animation({duration: 2000 , curve: Curves.spring(0.25, 0.1, 0.25, 1.0)}) }.width("100%").height("100%") -- GitLab