Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
07c46324
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
07c46324
编写于
11月 28, 2022
作者:
Z
zengyawen
浏览文件
操作
浏览文件
下载
差异文件
Merge branch 'master' of
https://gitee.com/zengyawen/docs
上级
599b3e15
423f67e0
变更
44
展开全部
隐藏空白更改
内联
并排
Showing
44 changed file
with
1885 addition
and
995 deletion
+1885
-995
zh-cn/application-dev/application-test/arkxtest-guidelines.md
...n/application-dev/application-test/arkxtest-guidelines.md
+102
-0
zh-cn/application-dev/quick-start/syscap.md
zh-cn/application-dev/quick-start/syscap.md
+30
-50
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
...lication-dev/reference/apis/js-apis-abilityrunninginfo.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
...ication-dev/reference/apis/js-apis-application-ability.md
+9
-7
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md
...ev/reference/apis/js-apis-application-abilityDelegator.md
+43
-47
zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md
...ence/apis/js-apis-application-abilityLifecycleCallback.md
+39
-37
zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md
.../reference/apis/js-apis-application-applicationContext.md
+53
-53
zh-cn/application-dev/reference/apis/js-apis-application-context.md
...ication-dev/reference/apis/js-apis-application-context.md
+8
-35
zh-cn/application-dev/reference/apis/js-apis-application-quickFixManager.md
...dev/reference/apis/js-apis-application-quickFixManager.md
+5
-5
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+8
-8
zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md
...ation-dev/reference/apis/js-apis-backgroundTaskManager.md
+118
-20
zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md
...n/application-dev/reference/apis/js-apis-cardEmulation.md
+4
-5
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
+108
-107
zh-cn/application-dev/reference/apis/js-apis-cryptoFramework.md
...application-dev/reference/apis/js-apis-cryptoFramework.md
+66
-54
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
...plication-dev/reference/apis/js-apis-dataAbilityHelper.md
+33
-34
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
...pplication-dev/reference/apis/js-apis-distributed-data.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-distributedKVStore.md
...lication-dev/reference/apis/js-apis-distributedKVStore.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md
...ation-dev/reference/apis/js-apis-enterprise-deviceInfo.md
+0
-104
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
+0
-1
zh-cn/application-dev/reference/apis/js-apis-faultLogger.md
zh-cn/application-dev/reference/apis/js-apis-faultLogger.md
+8
-8
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
.../application-dev/reference/apis/js-apis-featureAbility.md
+34
-34
zh-cn/application-dev/reference/apis/js-apis-hidebug.md
zh-cn/application-dev/reference/apis/js-apis-hidebug.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-hilog.md
zh-cn/application-dev/reference/apis/js-apis-hilog.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+2
-4
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
+22
-22
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
.../application-dev/reference/apis/js-apis-missionManager.md
+6
-3
zh-cn/application-dev/reference/apis/js-apis-nfcController.md
...n/application-dev/reference/apis/js-apis-nfcController.md
+35
-41
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
+60
-26
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
+146
-21
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
...application-dev/reference/apis/js-apis-particleAbility.md
+7
-11
zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md
...ce/apis/js-apis-resourceschedule-backgroundTaskManager.md
+21
-21
zh-cn/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md
.../reference/apis/js-apis-resourceschedule-workScheduler.md
+32
-32
zh-cn/application-dev/reference/apis/js-apis-stationary.md
zh-cn/application-dev/reference/apis/js-apis-stationary.md
+129
-0
zh-cn/application-dev/reference/apis/js-apis-system-time.md
zh-cn/application-dev/reference/apis/js-apis-system-time.md
+43
-5
zh-cn/application-dev/reference/apis/js-apis-system-timer.md
zh-cn/application-dev/reference/apis/js-apis-system-timer.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
+34
-17
zh-cn/application-dev/reference/apis/js-apis-userFileManager.md
...application-dev/reference/apis/js-apis-userFileManager.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
+34
-44
zh-cn/application-dev/reference/apis/js-apis-webview.md
zh-cn/application-dev/reference/apis/js-apis-webview.md
+171
-36
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
...n/application-dev/reference/apis/js-apis-workScheduler.md
+362
-0
zh-cn/application-dev/security/cryptoFramework-guidelines.md
zh-cn/application-dev/security/cryptoFramework-guidelines.md
+2
-2
zh-cn/device-dev/kernel/figures/zh-cn_image-20220915140627223.png
...vice-dev/kernel/figures/zh-cn_image-20220915140627223.png
+0
-0
zh-cn/device-dev/kernel/kernel-standard-newip.md
zh-cn/device-dev/kernel/kernel-standard-newip.md
+99
-91
未找到文件。
zh-cn/application-dev/application-test/arkxtest-guidelines.md
浏览文件 @
07c46324
...
...
@@ -169,3 +169,105 @@ export default function abilityTest() {
测试执行完毕后可直接在DevEco Studio中查看测试结果,如下图示例所示:
![](
figures/TestResult.PNG
)
## 常见问题
### 单元测试用例常见问题
**1、用例中增加的打印日志在用例结果之后才打印**
**问题描述**
用例中增加的日志打印信息,没有在用例执行过程中出现,而是在用例执行结束之后才出现。
**可能原因**
此类情况只会存在于用例中有调用异步接口的情况,原则上用例中所有的日志信息均在用例执行结束之前打印。
**解决方法**
当被调用的异步接口多于一个时,建议将接口调用封装成Promise方式调用。
**2、执行用例时报error:fail to start ability**
**问题描述**
执行测试用例时候,用例执行失败,控制台返回错误:fail to start ability。
**可能原因**
测试包打包过程中出现问题,未将测试框架依赖文件打包在测试包中。
**解决方法**
检查测试包中是否包含OpenHarmonyTestRunner.abc文件,如没有则重新编译打包后再次执行测试。
**3、执行用例时报用例超时错误**
**问题描述**
用例执行结束,控制台提示execute time XXms错误,即用例执行超时
**可能原因**
1.
用例执行异步接口,但执行过程中没有执行到done函数,导致用例执行一直没有结束,直到超时结束。
2.
用例调用函数耗时过长,超过用例执行设置的超时时间。
**解决方法**
1.
检查用例代码逻辑,确保即使断言失败场景认可走到done函数,保证用例执行结束。
2.
可在IDE中Run/Debug Configurations中修改用例执行超时配置参数,避免用例执行超时。
### UI测试用例常见问题
**1、失败日志有“Get windows failed/GetRootByWindow failed”错误信息**
**问题描述**
UI测试用例执行失败,查看hilog日志发现日志中有“Get windows failed/GetRootByWindow failed”错误信息。
**可能原因**
系统ArkUI开关未开启,导致被测试界面控件树信息未生成。
**解决方法**
执行如下命令,并重启设备再次执行用例。
```
shell
hdc shell param
set
persist.ace.testmode.enabled 1
```
**2、失败日志有“uitest-api dose not allow calling concurrently”错误信息**
**问题描述**
UI测试用例执行失败,查看hilog日志发现日志中有“uitest-api dose not allow calling concurrently”错误信息。
**可能原因**
1.
用例中UI测试框架提供异步接口没有增加await语法糖调用。
2.
多进程执行UI测试用例,导致拉起多个UITest进程,框架不支持多进程调用。
**解决方法**
1.
检查用例实现,异步接口增加await语法糖调用。
2.
避免多进程执行UI测试用例。
**3、失败日志有“dose not exist on current UI! Check if the UI has changed after you got the widget object”错误信息**
**问题描述**
UI测试用例执行失败,查看hilog日志发现日志中有“dose not exist on current UI! Check if the UI has changed after you got the widget object”错误信息。
**可能原因**
在用例中代码查找到目标控件后,设备界面发生了变化,导致查找到的控件丢失,无法进行下一步的模拟操作。
**解决方法**
重新执行UI测试用例。
zh-cn/application-dev/quick-start/syscap.md
浏览文件 @
07c46324
#
SysCap
使用指南
#
系统能力SystemCapability
使用指南
## 概述
### 系统能力与 API
SysCap,全称SystemCapability,即系统能力,指操作系统中每一个相对独立的特性,如蓝牙,WIFI,NFC,摄像头等,都是系统能力之一。每个系统能力对应多个
API,这些 API 绑定在一起,随着目标设备是否支持该系统能力共同存在或消失,也会随着 IDE
一起提供给开发者做联想。
SysCap,全称SystemCapability,即系统能力,指操作系统中每一个相对独立的特性,如蓝牙,WIFI,NFC,摄像头等,都是系统能力之一。每个系统能力对应多个
API,随着目标设备是否支持该系统能力共同存在或消失,也会随着DevEco Studio
一起提供给开发者做联想。
![
image-20220326064841782
](
figures/image-20220326064841782.png
)
开发者可以在
[
SysCap列表
](
../reference/syscap-list.md
)
中查询OpenHarmony的能力集。
### 支持能力集,联想能力集与要求能力集
支持能力集,联想能力集与要求能力集都是系统能力的集合。
支持能力集描述的是设备能力,要求能力集描述的是应用能力。若应用A的要求能力集是设备N的支持能力集的子集,则应用A可分发到设备N上安装运行,否则不能分发。
联想能力集是该应用开发时,
IDE 可联想的 API
所在的系统能力集合。
联想能力集是该应用开发时,
DevEco Studio可联想的API
所在的系统能力集合。
![
image-20220326064913834
](
figures/image-20220326064913834.png
)
### 设备与支持能力集
每个设备根据其硬件能力,对应不同的支持能力集。
SDK
将设备分为两组,典型设备和自定义设备,典型设备的支持能力集由 OpenHarmony
来定义,自定义设备由设备厂商给出。
SDK
将设备分为两组,典型设备和自定义设备,典型设备的支持能力集由OpenHarmony
来定义,自定义设备由设备厂商给出。
![
image-20220326064955505
](
figures/image-20220326064955505.png
)
### 设备与SDK能力的对应
SDK
提供全量的 API 给 IDE,IDE 通过开发者的项目支持的设备,找到该设备的支持能力集,筛选支持能力集包含的 API 提供给开发者做
联想。
SDK
向DevEco Studio提供全量API,DevEco Studio识别开发者项目中选择的设备形态,找到该设备的支持能力集,筛选支持能力集包含的API并提供API
联想。
![
image-20220326065043006
](
figures/image-20220326065043006.png
)
## SysCap开发指导
### PCID获取
PCID,全称 Product Compatibility ID,包含当前设备支持的 syscap 信息。获取所有设备 PCID 的认证中心正在建设中,目前需要找对应设备的厂商获取该设备的 PCID。
PCID,全称Product Compatibility ID,包含当前设备支持的SysCap信息。获取所有设备PCID的认证中心正在建设中,目前需要找对应设备的厂商获取该设备的PCID。
### PCID导入
DevEco Studio
工程支持 PCID 的导入。导入的 PCID 文件解码后输出的 syscap 会被写入 syscap.json
文件中。
DevEco Studio
工程支持PCID的导入。导入的PCID文件解码后输出的SysCap会被写入syscap.json
文件中。
在工程目录右键后选择
Import Product Compatibility ID,即可上传 PCID 文件并导入至 syscap.json
中。
在工程目录右键后选择
Import Product Compatibility ID,即可上传PCID文件并导入至syscap.json
中。
![
20220329-103626
](
figures/20220329-103626.gif
)
### 配置联想能力集和要求能力集
IDE
会根据创建的工程所支持的设置自动配置联想能力集和要求能力集,开发者也可以自行修改。
对于联想能力集,开发者通过添加更多的系统能力,在
IDE 中可以使用更多的 API,但要注意这些 API
可能在设备上不支持,使用前需要判断。
DevEco Studio
会根据创建的工程所支持的设置自动配置联想能力集和要求能力集,开发者也可以自行修改。
对于联想能力集,开发者通过添加更多的系统能力,在
DevEco Studio中可以使用更多的API,但要注意这些API
可能在设备上不支持,使用前需要判断。
对于要求能力集,开发者修改时要十分慎重,修改不当会导致应用无法分发到目标设备上。
```
json
...
...
@@ -91,51 +79,44 @@ IDE 会根据创建的工程所支持的设置自动配置联想能力集和要
}
```
### 单设备应用开发
默认应用的联想能力集,要求系统能力集和设备的支持系统能力集相等,开发者修改要求能力集需要慎重。
![
image-20220326065124911
](
figures/image-20220326065124911.png
)
### 跨设备应用开发
默认应用的联想能力集是多个设备支持能力集的并集,要求能力集则是交集。
![
image-20220326065201867
](
figures/image-20220326065201867.png
)
### 判断 API 是否可以使用
首先我们定义了 API canIUse
帮助开发者来判断该工程是否支持某个特定的syscap。
-
方法1:OpenHarmony定义了API canIUse
帮助开发者来判断该工程是否支持某个特定的syscap。
```
if (canIUse("SystemCapability.ArkUI.ArkUI.Full")) {
console.log("该应用支持SystemCapability.ArkUI.ArkUI.Full");
} else {
console.log("该应用不支持SystemCapability.ArkUI.ArkUI.Full");
}
```
开发者可通过 import 的方式将模块导入,若当前设备不支持该模块,import 的结果为 undefined,开发者在使用其 API 时,需要判断其是否存在。
```
if (canIUse("SystemCapability.ArkUI.ArkUI.Full")) {
console.log("该应用支持SystemCapability.ArkUI.ArkUI.Full");
} else {
console.log("该应用不支持SystemCapability.ArkUI.ArkUI.Full");
}
```
```
import geolocation from '@ohos.geolocation';
if (geolocation) {
geolocation.getCurrentLocation((location) => {
console.log(location.latitude, location.longitude);
});
} else {
console.log('该设备不支持位置信息');
}
```
-
方法2:开发者可通过 import 的方式将模块导入,若当前设备不支持该模块,import 的结果为 undefined,开发者在使用其 API 时,需要判断其是否存在。
```
import geolocation from '@ohos.geolocation';
if (geolocation) {
geolocation.getCurrentLocation((location) => {
console.log(location.latitude, location.longitude);
});
} else {
console.log('该设备不支持位置信息');
}
```
除此之外,开发者可以通过API参考文档查询API接口所属的SysCap。
### 不同设备相同能力的差异检查
...
...
@@ -159,7 +140,6 @@ authenticator.execute('FACE_ONLY', 'S1', (err, result) => {
})
```
### 设备间的SysCap差异如何产生的
设备的SysCap因产品解决方案厂商拼装的部件组合不同而不同,整体流程如下图:
...
...
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
07c46324
...
...
@@ -231,6 +231,7 @@
-
[
@ohos.batteryStatistics (耗电统计)
](
js-apis-batteryStatistics.md
)
-
[
@ohos.brightness (屏幕亮度)
](
js-apis-brightness.md
)
-
[
@ohos.deviceInfo (设备信息)
](
js-apis-device-info.md
)
-
[
@ohos.devicestatus (设备状态感知框架)
](
js-apis-stationary.md
)
-
[
@ohos.distributedHardware.deviceManager (设备管理)
](
js-apis-device-manager.md
)
-
[
@ohos.geoLocationManager (位置服务)
](
js-apis-geoLocationManager.md
)
-
[
@ohos.multimodalInput.inputConsumer (组合按键)
](
js-apis-inputconsumer.md
)
...
...
@@ -311,6 +312,7 @@
-
[
@ohos.reminderAgent (后台代理提醒)
](
js-apis-reminderAgent.md
)
-
[
@ohos.systemParameter (系统属性)
](
js-apis-system-parameter.md
)
-
[
@ohos.usb (USB管理)
](
js-apis-usb-deprecated.md
)
-
[
@ohos.workScheduler (延迟任务调度)
](
js-apis-workScheduler.md
)
-
[
@system.app (应用上下文)
](
js-apis-system-app.md
)
-
[
@system.battery (电量信息)
](
js-apis-system-battery.md
)
-
[
@system.bluetooth (蓝牙)
](
js-apis-system-bluetooth.md
)
...
...
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
浏览文件 @
07c46324
# AbilityRunningInfo
AbilityRunningInfo模块提供对Ability运行的相关信息和状态
进行设置和查询的能力
。
AbilityRunningInfo模块提供对Ability运行的相关信息和状态
的定义
。
> **说明:**
>
...
...
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @
07c46324
...
...
@@ -339,13 +339,15 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any})
**示例:**
```
js
class
myAbility
extends
Ability
{
onSaveState
(
reason
,
wantParam
)
{
console
.
log
(
'
onSaveState
'
);
wantParams
[
"
myData
"
]
=
"
my1234567
"
;
return
AbilityConstant
.
OnSaveResult
.
RECOVERY_AGREE
;
}
}
import
AbilityConstant
from
'
@ohos.application.AbilityConstant
'
class
myAbility
extends
Ability
{
onSaveState
(
reason
,
wantParam
)
{
console
.
log
(
'
onSaveState
'
);
wantParam
[
"
myData
"
]
=
"
my1234567
"
;
return
AbilityConstant
.
OnSaveResult
.
RECOVERY_AGREE
;
}
}
```
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md
浏览文件 @
07c46324
...
...
@@ -22,7 +22,7 @@ abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
### addAbilityMonitor<sup>9+</sup>
addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback
\<
void>): void
addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback
\<
void>): void
;
添加AbilityMonitor实例(callback形式)
...
...
@@ -30,7 +30,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
**参数:**
| 参数名 | 类型 | 必填
说明
| 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor |
[
AbilityMonitor
](
js-apis-application-abilityMonitor.md#AbilityMonitor
)
| 是 |
[
AbilityMonitor
](
js-apis-application-abilityMonitor.md#AbilityMonitor
)
实例 |
| callback | AsyncCallback
\<
void> | 是 | 表示指定的回调方法 |
...
...
@@ -55,11 +55,9 @@ abilityDelegator.addAbilityMonitor(monitor, (err : any) => {
});
```
### addAbilityMonitor<sup>9+</sup>
addAbilityMonitor(monitor: AbilityMonitor): Promise
\<
void>
addAbilityMonitor(monitor: AbilityMonitor): Promise
\<
void>
;
添加AbilityMonitor实例(promise形式)
...
...
@@ -101,7 +99,7 @@ abilityDelegator.addAbilityMonitor(monitor).then(() => {
### removeAbilityMonitor<sup>9+</sup>
removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback
\<
void>): void
removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback
\<
void>): void
;
删除已经添加的AbilityMonitor实例(callback形式)
...
...
@@ -138,7 +136,7 @@ abilityDelegator.removeAbilityMonitor(monitor, (err : any) => {
### removeAbilityMonitor<sup>9+</sup>
removeAbilityMonitor(monitor: AbilityMonitor): Promise
\<
void>
removeAbilityMonitor(monitor: AbilityMonitor): Promise
\<
void>
;
删除已经添加的AbilityMonitor实例(promise形式)
...
...
@@ -146,7 +144,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor |
[
AbilityMonitor
](
js-apis-application-abilityMonitor.md#AbilityMonitor
)
| 是 |
[
AbilityMonitor
](
js-apis-application-abilityMonitor.md#AbilityMonitor
)
实例 |
...
...
@@ -180,7 +178,7 @@ abilityDelegator.removeAbilityMonitor(monitor).then(() => {
### waitAbilityMonitor<sup>9+</sup>
waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback
\<
Ability>): void
waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback
\<
UIAbility>): void;
等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期,并返回ability实例(callback形式)
...
...
@@ -191,7 +189,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<Ability>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor |
[
AbilityMonitor
](
js-apis-application-abilityMonitor.md#AbilityMonitor
)
| 是 |
[
AbilityMonitor
](
js-apis-application-abilityMonitor.md#AbilityMonitor
)
实例 |
| callback | AsyncCallback
\<
[
Ability
](
js-apis-application-ability.md#Ability
)
> | 是 | 表示指定的回调方法 |
| callback | AsyncCallback
\<
[
UI
Ability
](
js-apis-application-ability.md#Ability
)
> | 是 | 表示指定的回调方法 |
**示例:**
...
...
@@ -213,11 +211,9 @@ abilityDelegator.waitAbilityMonitor(monitor, (err : any, data : any) => {
});
```
### waitAbilityMonitor<sup>9+</sup>
waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback
\<
Ability>): void
waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback
\<
UIAbility>): void;
设置等待时间,等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期,并返回ability实例(callback形式)
...
...
@@ -229,7 +225,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor |
[
AbilityMonitor
](
js-apis-application-abilityMonitor.md#AbilityMonitor
)
| 是 |
[
AbilityMonitor
](
js-apis-application-abilityMonitor.md#AbilityMonitor
)
实例 |
| timeout | number | 是 | 最大等待时间,单位毫秒(ms) |
| callback | AsyncCallback
\<
[
Ability
](
js-apis-application-ability.md#Ability
)
> | 是 | 表示指定的回调方法 |
| callback | AsyncCallback
\<
[
UI
Ability
](
js-apis-application-ability.md#Ability
)
> | 是 | 表示指定的回调方法 |
**示例:**
...
...
@@ -256,7 +252,7 @@ abilityDelegator.waitAbilityMonitor(monitor, timeout, (err : any, data : any) =>
### waitAbilityMonitor<sup>9+</sup>
waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise
\<
Ability>
waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise
\<
UIAbility>;
设置等待时间,等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期,并返回ability实例(promise形式)
...
...
@@ -273,7 +269,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<Ability>
| 类型 | 说明 |
| ----------------------------------------------------------- | -------------------------- |
| Promise
\<
[
Ability
](
js-apis-application-ability.md#Ability
)
> | 以Promise形式返回Ability。 |
| Promise
\<
[
UI
Ability
](
js-apis-application-ability.md#Ability
)
> | 以Promise形式返回Ability。 |
**示例:**
...
...
@@ -299,7 +295,7 @@ abilityDelegator.waitAbilityMonitor(monitor).then((data : any) => {
### getAppContext<sup>9+</sup>
getAppContext(): Context
getAppContext(): Context
;
获取应用Context
...
...
@@ -324,7 +320,7 @@ var context = abilityDelegator.getAppContext();
### getAbilityState<sup>9+</sup>
getAbilityState(ability:
Ability): number
getAbilityState(ability:
UIAbility): number;
获取指定ability的生命周期状态
...
...
@@ -334,7 +330,7 @@ getAbilityState(ability: Ability): number
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------- | ---- | --------------- |
| ability |
[
Ability
](
js-apis-application-ability.md#Ability
)
| 是 | 指定Ability对象 |
| ability |
[
UI
Ability
](
js-apis-application-ability.md#Ability
)
| 是 | 指定Ability对象 |
**返回值:**
...
...
@@ -361,7 +357,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### getCurrentTopAbility<sup>9+</sup>
getCurrentTopAbility(callback: AsyncCallback
\<
Ability>): void
getCurrentTopAbility(callback: AsyncCallback
\<
UIAbility>): void;
获取当前应用顶部ability(callback形式)
...
...
@@ -371,7 +367,7 @@ getCurrentTopAbility(callback: AsyncCallback\<Ability>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------ |
| callback | AsyncCallback
\<
[
Ability
](
js-apis-application-ability.md#Ability
)
> | 是 | 表示指定的回调方法 |
| callback | AsyncCallback
\<
[
UI
Ability
](
js-apis-application-ability.md#Ability
)
> | 是 | 表示指定的回调方法 |
**示例:**
...
...
@@ -390,7 +386,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### getCurrentTopAbility<sup>9+</sup>
getCurrentTopAbility(): Promise
\<
Ability>
getCurrentTopAbility(): Promise
\<
UIAbility>;
获取当前应用顶部ability(promise形式)
...
...
@@ -400,7 +396,7 @@ getCurrentTopAbility(): Promise\<Ability>
| 类型 | 说明 |
| ----------------------------------------------------------- | -------------------------------------- |
| Promise
\<
[
Ability
](
js-apis-application-ability.md#Ability
)
> | 以Promise形式返回当前应用顶部ability。 |
| Promise
\<
[
UI
Ability
](
js-apis-application-ability.md#Ability
)
> | 以Promise形式返回当前应用顶部ability。 |
**示例:**
...
...
@@ -419,7 +415,7 @@ abilityDelegator.getCurrentTopAbility().then((data : any) => {
### startAbility<sup>9+</sup>
startAbility(want: Want, callback: AsyncCallback
\<
void>): void
startAbility(want: Want, callback: AsyncCallback
\<
void>): void
;
启动指定ability(callback形式)
...
...
@@ -451,7 +447,7 @@ abilityDelegator.startAbility(want, (err : any, data : any) => {
### startAbility<sup>9+</sup>
startAbility(want: Want): Promise
\<
void>
startAbility(want: Want): Promise
\<
void>
;
启动指定ability(promise形式)
...
...
@@ -488,7 +484,7 @@ abilityDelegator.startAbility(want).then((data: any) => {
### doAbilityForeground<sup>9+</sup>
doAbilityForeground(ability:
Ability, callback: AsyncCallback
\<
boolean>): void
doAbilityForeground(ability:
UIAbility, callback: AsyncCallback
\<
void>): void;
调度指定ability生命周期状态到Foreground状态(callback形式)
...
...
@@ -498,8 +494,8 @@ doAbilityForeground(ability: Ability, callback: AsyncCallback\<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------- |
| ability |
Ability
| 是 | 指定Ability对象 |
| callback | AsyncCallback
\<
boolean>
| 是 | 表示指定的回调方法
<br/>
\-
true:成功
<br/>
\-
false:失败 |
| ability |
UIAbility
| 是 | 指定Ability对象 |
| callback | AsyncCallback
\<
void>
| 是 | 表示指定的回调方法
<br/>
\-
true:成功
<br/>
\-
false:失败 |
**示例:**
...
...
@@ -521,7 +517,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### doAbilityForeground<sup>9+</sup>
doAbilityForeground(ability:
Ability): Promise
\<
boolean>
doAbilityForeground(ability:
UIAbility): Promise
\<
void>;
调度指定ability生命周期状态到Foreground状态(promise形式)
...
...
@@ -531,7 +527,7 @@ doAbilityForeground(ability: Ability): Promise\<boolean>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | --------------- |
| ability | Ability | 是 | 指定Ability对象 |
| ability |
UI
Ability | 是 | 指定Ability对象 |
**返回值:**
...
...
@@ -559,7 +555,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### doAbilityBackground<sup>9+</sup>
doAbilityBackground(ability:
Ability, callback: AsyncCallback
\<
boolean>): void
doAbilityBackground(ability:
UIAbility, callback: AsyncCallback
\<
void>): void;
调度指定ability生命周期状态到Background状态(callback形式)
...
...
@@ -569,8 +565,8 @@ doAbilityBackground(ability: Ability, callback: AsyncCallback\<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------------------------- |
| ability | Ability | 是 | 指定Ability对象 |
| callback | AsyncCallback
\<
boolean
> | 是 | 表示指定的回调方法
<br/>
\-
true:成功
<br/>
\-
false:失败 |
| ability |
UI
Ability | 是 | 指定Ability对象 |
| callback | AsyncCallback
\<
void
> | 是 | 表示指定的回调方法
<br/>
\-
true:成功
<br/>
\-
false:失败 |
**示例:**
...
...
@@ -592,7 +588,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### doAbilityBackground<sup>9+</sup>
doAbilityBackground(ability:
Ability): Promise
\<
boolean>
doAbilityBackground(ability:
UIAbility): Promise
\<
void>;
调度指定ability生命周期状态到Background状态(promise形式)
...
...
@@ -602,7 +598,7 @@ doAbilityBackground(ability: Ability): Promise\<boolean>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | --------------- |
| ability | Ability | 是 | 指定Ability对象 |
| ability |
UI
Ability | 是 | 指定Ability对象 |
**返回值:**
...
...
@@ -630,7 +626,7 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
### printSync<sup>9+</sup>
printSync(msg: string): void
printSync(msg: string): void
;
打印日志信息到单元测试终端控制台
...
...
@@ -656,7 +652,7 @@ abilityDelegator.printSync(msg);
### print
print(msg: string, callback: AsyncCallback
\<
void>): void
print(msg: string, callback: AsyncCallback
\<
void>): void
;
打印日志信息到单元测试终端控制台(callback形式)
...
...
@@ -685,7 +681,7 @@ abilityDelegator.print(msg, (err : any) => {
### print
print(msg: string): Promise
\<
void>
print(msg: string): Promise
\<
void>
;
打印日志信息到单元测试终端控制台(promise形式)
...
...
@@ -719,7 +715,7 @@ abilityDelegator.print(msg).then(() => {
### executeShellCommand
executeShellCommand(cmd: string, callback: AsyncCallback
\<
ShellCmdResult>): void
executeShellCommand(cmd: string, callback: AsyncCallback
\<
ShellCmdResult>): void
;
执行指定的shell命令(callback形式)
...
...
@@ -748,7 +744,7 @@ abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => {
### executeShellCommand
executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback
\<
ShellCmdResult>): void
executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback
\<
ShellCmdResult>): void
;
指定超时时间,并执行指定的shell命令(callback形式)
...
...
@@ -779,7 +775,7 @@ abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => {
### executeShellCommand
executeShellCommand(cmd: string, timeoutSecs?: number): Promise
\<
ShellCmdResult>
executeShellCommand(cmd: string, timeoutSecs?: number): Promise
\<
ShellCmdResult>
;
指定超时时间,并执行指定的shell命令(promise形式)
...
...
@@ -815,7 +811,7 @@ abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => {
### finishTest<sup>9+</sup>
finishTest(msg: string, code: number, callback: AsyncCallback
\<
void>): void
finishTest(msg: string, code: number, callback: AsyncCallback
\<
void>): void
;
结束测试并打印日志信息到单元测试终端控制台(callback形式)
...
...
@@ -845,7 +841,7 @@ abilityDelegator.finishTest(msg, 0, (err : any) => {
### finishTest<sup>9+</sup>
finishTest(msg: string, code: number): Promise
\<
void>
finishTest(msg: string, code: number): Promise
\<
void>
;
结束测试并打印日志信息到单元测试终端控制台(promise形式)
...
...
@@ -886,7 +882,7 @@ addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<vo
**参数:**
| 参数名 | 类型 | 必填
说明
| 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor |
[
AbilityStageMonitor
](
#abilitystagemonitor
)
| 是 |
[
AbilityStageMonitor
](
#abilitystagemonitor
)
实例 |
| callback | AsyncCallback
\<
void> | 是 | 表示指定的回调方法 |
...
...
@@ -955,7 +951,7 @@ removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\
**参数:**
| 参数名 | 类型 | 必填
说明
| 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor |
[
AbilityStageMonitor
](
#abilitystagemonitor
)
| 是 |
[
AbilityStageMonitor
](
#abilitystagemonitor
)
实例 |
| callback | AsyncCallback
\<
void> | 是 | 表示指定的回调方法 |
...
...
@@ -1024,7 +1020,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<A
**参数:**
| 参数名 | 类型 | 必填
说明
| 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| monitor |
[
AbilityStageMonitor
](
#abilitystagemonitor
)
| 是 |
[
AbilityStageMonitor
](
#abilitystagemonitor
)
实例 |
| callback | AsyncCallback
\<
AbilityStage> | 是 | 成功返回AbilityStage对象,失败返回空。 |
...
...
@@ -1062,7 +1058,7 @@ waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| monitor |
[
AbilityStageMonitor
](
#abilitystagemonitor
)
| 是 |
[
AbilityStageMonitor
](
#abilitystagemonitor
)
实例 |
| timeout | number |
否
| 超时最大等待时间,以毫秒为单位。 |
| timeout | number |
是
| 超时最大等待时间,以毫秒为单位。 |
**返回值:**
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md
浏览文件 @
07c46324
...
...
@@ -156,16 +156,18 @@ onAbilityContinue(ability: Ability): void;
**示例:**
```
js
import
Ability
from
"
@ohos.application.Ability
"
;
export
default
class
MyAbility
extends
Ability
{
onCreate
()
{
console
.
log
(
"
MyAbility onCreate
"
)
let
AbilityLifecycleCallback
=
{
onAbilityCreate
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityCreate ability:
"
+
JSON
.
stringify
(
ability
));
},
```
js
import
AbilityStage
from
"
@ohos.application.AbilityStage
"
;
var
lifecycleid
;
export
default
class
MyAbilityStage
extends
AbilityStage
{
onCreate
()
{
console
.
log
(
"
MyAbilityStage onCreate
"
)
let
AbilityLifecycleCallback
=
{
onAbilityCreate
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityCreate ability:
"
+
JSON
.
stringify
(
ability
));
},
onWindowStageCreate
(
ability
,
windowStage
){
console
.
log
(
"
AbilityLifecycleCallback onWindowStageCreate ability:
"
+
JSON
.
stringify
(
ability
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageCreate windowStage:
"
+
JSON
.
stringify
(
windowStage
));
...
...
@@ -182,30 +184,30 @@ onAbilityContinue(ability: Ability): void;
console
.
log
(
"
AbilityLifecycleCallback onWindowStageDestroy ability:
"
+
JSON
.
stringify
(
ability
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageDestroy windowStage:
"
+
JSON
.
stringify
(
windowStage
));
},
onAbilityDestroy
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityDestroy ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityForeground
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityForeground ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityBackground
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityBackground ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityContinue
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityContinue ability:
"
+
JSON
.
stringify
(
ability
));
}
}
// 1.通过context属性获取applicationContext
let
applicationContext
=
this
.
context
.
getApplicationContext
();
// 2.通过applicationContext注册监听应用内生命周期
let
lifecycleid
=
applicationContext
.
registerAbilityLifecycleCallback
(
AbilityLifecycleCallback
);
console
.
log
(
"
registerAbilityLifecycleCallback number:
"
+
JSON
.
stringify
(
lifecycleid
));
},
onDestroy
()
{
let
applicationContext
=
this
.
context
.
getApplicationContext
();
applicationContext
.
unregisterAbilityLifecycleCallback
(
lifecycleid
,
(
error
,
data
)
=>
{
console
.
log
(
"
unregisterAbilityLifecycleCallback success, err:
"
+
JSON
.
stringify
(
error
));
});
}
}
```
\ No newline at end of file
onAbilityDestroy
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityDestroy ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityForeground
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityForeground ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityBackground
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityBackground ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityContinue
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityContinue ability:
"
+
JSON
.
stringify
(
ability
));
}
}
// 1.通过context属性获取applicationContext
let
applicationContext
=
this
.
context
.
getApplicationContext
();
// 2.通过applicationContext注册监听应用内生命周期
lifecycleid
=
applicationContext
.
registerAbilityLifecycleCallback
(
AbilityLifecycleCallback
);
console
.
log
(
"
registerAbilityLifecycleCallback number:
"
+
JSON
.
stringify
(
lifecycleid
));
}
onDestroy
()
{
let
applicationContext
=
this
.
context
.
getApplicationContext
();
applicationContext
.
unregisterAbilityLifecycleCallback
(
lifecycleid
,
(
error
,
data
)
=>
{
console
.
log
(
"
unregisterAbilityLifecycleCallback success, err:
"
+
JSON
.
stringify
(
error
));
});
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md
浏览文件 @
07c46324
...
...
@@ -15,7 +15,6 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力,
let
applicationContext
=
this
.
context
.
getApplicationContext
();
```
## ApplicationContext.registerAbilityLifecycleCallback
registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback):
**number**
;
...
...
@@ -38,7 +37,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**
**示例:**
```
js
```
js
import
Ability
from
"
@ohos.application.Ability
"
;
var
lifecycleId
;
...
...
@@ -46,36 +45,36 @@ var lifecycleId;
export
default
class
MyAbility
extends
Ability
{
onCreate
()
{
console
.
log
(
"
MyAbility onCreate
"
)
let
AbilityLifecycleCallback
=
{
onAbilityCreate
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityCreate ability:
"
+
JSON
.
stringify
(
ability
));
let
AbilityLifecycleCallback
=
{
onAbilityCreate
(
ability
)
{
console
.
log
(
"
AbilityLifecycleCallback onAbilityCreate ability:
"
+
JSON
.
stringify
(
ability
));
},
onWindowStageCreate
(
ability
,
windowStage
){
console
.
log
(
"
AbilityLifecycleCallback onWindowStageCreate ability:
"
+
JSON
.
stringify
(
ability
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageCreate windowStage:
"
+
JSON
.
stringify
(
windowStage
));
onWindowStageCreate
(
ability
,
windowStage
)
{
console
.
log
(
"
AbilityLifecycleCallback onWindowStageCreate ability:
"
+
JSON
.
stringify
(
ability
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageCreate windowStage:
"
+
JSON
.
stringify
(
windowStage
));
},
onWindowStageActive
(
ability
,
windowStage
){
console
.
log
(
"
AbilityLifecycleCallback onWindowStageActive ability:
"
+
JSON
.
stringify
(
ability
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageActive windowStage:
"
+
JSON
.
stringify
(
windowStage
));
onWindowStageActive
(
ability
,
windowStage
)
{
console
.
log
(
"
AbilityLifecycleCallback onWindowStageActive ability:
"
+
JSON
.
stringify
(
ability
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageActive windowStage:
"
+
JSON
.
stringify
(
windowStage
));
},
onWindowStageInactive
(
ability
,
windowStage
){
onWindowStageInactive
(
ability
,
windowStage
)
{
console
.
log
(
"
AbilityLifecycleCallback onWindowStageInactive ability:
"
+
JSON
.
stringify
(
ability
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageInactive windowStage:
"
+
JSON
.
stringify
(
windowStage
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageInactive windowStage:
"
+
JSON
.
stringify
(
windowStage
));
},
onWindowStageDestroy
(
ability
,
windowStage
){
onWindowStageDestroy
(
ability
,
windowStage
)
{
console
.
log
(
"
AbilityLifecycleCallback onWindowStageDestroy ability:
"
+
JSON
.
stringify
(
ability
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageDestroy windowStage:
"
+
JSON
.
stringify
(
windowStage
));
console
.
log
(
"
AbilityLifecycleCallback onWindowStageDestroy windowStage:
"
+
JSON
.
stringify
(
windowStage
));
},
onAbilityDestroy
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityDestroy ability:
"
+
JSON
.
stringify
(
ability
));
onAbilityDestroy
(
ability
)
{
console
.
log
(
"
AbilityLifecycleCallback onAbilityDestroy ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityForeground
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityForeground ability:
"
+
JSON
.
stringify
(
ability
));
onAbilityForeground
(
ability
)
{
console
.
log
(
"
AbilityLifecycleCallback onAbilityForeground ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityBackground
(
ability
){
console
.
log
(
"
AbilityLifecycleCallback onAbilityBackground ability:
"
+
JSON
.
stringify
(
ability
));
onAbilityBackground
(
ability
)
{
console
.
log
(
"
AbilityLifecycleCallback onAbilityBackground ability:
"
+
JSON
.
stringify
(
ability
));
},
onAbilityContinue
(
ability
){
onAbilityContinue
(
ability
)
{
console
.
log
(
"
AbilityLifecycleCallback onAbilityContinue ability:
"
+
JSON
.
stringify
(
ability
));
}
}
...
...
@@ -84,16 +83,9 @@ export default class MyAbility extends Ability {
// 2.通过applicationContext注册监听应用内生命周期
lifecycleId
=
applicationContext
.
registerAbilityLifecycleCallback
(
AbilityLifecycleCallback
);
console
.
log
(
"
registerAbilityLifecycleCallback number:
"
+
JSON
.
stringify
(
lifecycleId
));
},
onDestroy
()
{
let
applicationContext
=
this
.
context
.
getApplicationContext
();
applicationContext
.
unregisterAbilityLifecycleCallback
(
lifecycleId
,
(
error
,
data
)
=>
{
console
.
log
(
"
unregisterAbilityLifecycleCallback success, err:
"
+
JSON
.
stringify
(
error
));
});
}
}
```
```
## ApplicationContext.unregisterAbilityLifecycleCallback
...
...
@@ -112,14 +104,21 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb
**示例:**
```
js
let
applicationContext
=
this
.
context
.
getApplicationContext
();
let
lifecycleId
=
1
;
console
.
log
(
"
stage applicationContext:
"
+
JSON
.
stringify
(
applicationContext
));
applicationContext
.
unregisterAbilityLifecycleCallback
(
lifecycleId
,
(
error
,
data
)
=>
{
console
.
log
(
"
unregisterAbilityLifecycleCallback success, err:
"
+
JSON
.
stringify
(
error
));
});
```
```
js
import
Ability
from
"
@ohos.application.Ability
"
;
var
lifecycleId
;
export
default
class
MyAbility
extends
Ability
{
onDestroy
()
{
let
applicationContext
=
this
.
context
.
getApplicationContext
();
console
.
log
(
"
stage applicationContext:
"
+
JSON
.
stringify
(
applicationContext
));
applicationContext
.
unregisterAbilityLifecycleCallback
(
lifecycleId
,
(
error
,
data
)
=>
{
console
.
log
(
"
unregisterAbilityLifecycleCallback success, err:
"
+
JSON
.
stringify
(
error
));
});
}
}
```
## ApplicationContext.registerEnvironmentCallback
...
...
@@ -143,7 +142,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**;
**示例:**
```
js
```
js
import
Ability
from
"
@ohos.application.Ability
"
;
var
callbackId
;
...
...
@@ -163,14 +162,8 @@ export default class MyAbility extends Ability {
callbackId
=
applicationContext
.
registerEnvironmentCallback
(
EnvironmentCallback
);
console
.
log
(
"
registerEnvironmentCallback number:
"
+
JSON
.
stringify
(
callbackId
));
}
onDestroy
()
{
let
applicationContext
=
globalThis
.
applicationContext
;
applicationContext
.
unregisterEnvironmentCallback
(
callbackId
,
(
error
,
data
)
=>
{
console
.
log
(
"
unregisterEnvironmentCallback success, err:
"
+
JSON
.
stringify
(
error
));
});
}
}
```
```
## ApplicationContext.unregisterEnvironmentCallback
...
...
@@ -189,10 +182,17 @@ unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<*
**示例:**
```
js
let
applicationContext
=
this
.
context
.
getApplicationContext
();
let
callbackId
=
1
;
applicationContext
.
unregisterEnvironmentCallback
(
callbackId
,
(
error
,
data
)
=>
{
console
.
log
(
"
unregisterEnvironmentCallback success, err:
"
+
JSON
.
stringify
(
error
));
});
```
```
js
import
Ability
from
"
@ohos.application.Ability
"
;
var
callbackId
;
export
default
class
MyAbility
extends
Ability
{
onDestroy
()
{
let
applicationContext
=
this
.
context
.
getApplicationContext
();
applicationContext
.
unregisterEnvironmentCallback
(
callbackId
,
(
error
,
data
)
=>
{
console
.
log
(
"
unregisterEnvironmentCallback success, err:
"
+
JSON
.
stringify
(
error
));
});
}
}
```
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @
07c46324
...
...
@@ -67,17 +67,10 @@ createBundleContext(bundleName: string): Context;
**示例:**
```
js
import
Ability
from
'
@ohos.application.Ability
'
class
MainAbility
extends
Ability
{
onWindowStageCreate
(
windowStage
)
{
let
test
=
"
com.example.test
"
;
let
context
=
this
.
context
.
createBundleContext
(
test
);
}
}
let
test
=
"
com.example.test
"
;
let
context
=
this
.
context
.
createBundleContext
(
test
);
```
## Context.createModuleContext
createModuleContext(moduleName: string): Context;
...
...
@@ -101,17 +94,10 @@ createModuleContext(moduleName: string): Context;
**示例:**
```
js
import
Ability
from
'
@ohos.application.Ability
'
class
MainAbility
extends
Ability
{
onWindowStageCreate
(
windowStage
)
{
let
moduleName
=
"
module
"
;
let
context
=
this
.
context
.
createModuleContext
(
moduleName
);
}
}
let
moduleName
=
"
module
"
;
let
context
=
this
.
context
.
createModuleContext
(
moduleName
);
```
## Context.createModuleContext
createModuleContext(bundleName: string, moduleName: string): Context;
...
...
@@ -138,15 +124,9 @@ createModuleContext(bundleName: string, moduleName: string): Context;
**示例:**
```
js
import
Ability
from
'
@ohos.application.Ability
'
class
MainAbility
extends
Ability
{
onWindowStageCreate
(
windowStage
)
{
let
bundleName
=
"
com.example.bundle
"
;
let
moduleName
=
"
module
"
;
let
context
=
this
.
context
.
createModuleContext
(
bundleName
,
moduleName
);
}
}
let
bundleName
=
"
com.example.bundle
"
;
let
moduleName
=
"
module
"
;
let
context
=
this
.
context
.
createModuleContext
(
bundleName
,
moduleName
);
```
## Context.getApplicationContext
...
...
@@ -166,16 +146,9 @@ getApplicationContext(): ApplicationContext;
**示例:**
```
js
import
Ability
from
'
@ohos.application.Ability
'
class
MainAbility
extends
Ability
{
onWindowStageCreate
(
windowStage
)
{
let
applicationContext
=
this
.
context
.
getApplicationContext
();
}
}
let
applicationContext
=
this
.
context
.
getApplicationContext
();
```
## AreaMode
访问的文件分区,每个文件分区有对应自己的内容。
...
...
zh-cn/application-dev/reference/apis/js-apis-application-quickFixManager.md
浏览文件 @
07c46324
...
...
@@ -9,7 +9,7 @@ quickFixManager模块提供快速修复的能力,快速修复是OpenHarmony提
## 导入模块
```
import quickFixManager from '@ohos.app
lication
.quickFixManager';
import quickFixManager from '@ohos.app
.ability
.quickFixManager';
```
## HapModuleQuickFixInfo
...
...
@@ -65,7 +65,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>, callback: AsyncCallback\<v
**示例:**
```
js
import
quickFixManager
from
'
@ohos.app
lication
.quickFixManager
'
import
quickFixManager
from
'
@ohos.app
.ability
.quickFixManager
'
let
hapModuleQuickFixFiles
=
[
"
/data/storage/el2/base/entry.hqf
"
]
quickFixManager
.
applyQuickFix
(
hapModuleQuickFixFiles
,
(
error
)
=>
{
...
...
@@ -104,7 +104,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>): Promise\<void>;
**示例:**
```
js
import
quickFixManager
from
'
@ohos.app
lication
.quickFixManager
'
import
quickFixManager
from
'
@ohos.app
.ability
.quickFixManager
'
let
hapModuleQuickFixFiles
=
[
"
/data/storage/el2/base/entry.hqf
"
]
quickFixManager
.
applyQuickFix
(
hapModuleQuickFixFiles
).
then
(()
=>
{
...
...
@@ -136,7 +136,7 @@ getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback\<Applicat
**示例:**
```
js
import
quickFixManager
from
'
@ohos.app
lication
.quickFixManager
'
import
quickFixManager
from
'
@ohos.app
.ability
.quickFixManager
'
let
bundleName
=
"
bundleName
"
quickFixManager
.
getApplicationQuickFixInfo
(
bundleName
,
(
error
,
data
)
=>
{
...
...
@@ -175,7 +175,7 @@ getApplicationQuickFixInfo(bundleName: string): Promise\<ApplicationQuickFixInfo
**示例:**
```
js
import
quickFixManager
from
'
@ohos.app
lication
.quickFixManager
'
import
quickFixManager
from
'
@ohos.app
.ability
.quickFixManager
'
let
bundleName
=
"
bundleName
"
quickFixManager
.
getApplicationQuickFixInfo
(
bundleName
).
then
((
data
)
=>
{
...
...
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
07c46324
...
...
@@ -487,7 +487,7 @@ async function createTonePlayerBefore(){
## AudioSamplingRate<sup>8+</sup>
枚举,音频采样率。
枚举,音频采样率
,具体设备支持的采样率规格可能不同
。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
...
...
@@ -706,7 +706,7 @@ async function createTonePlayerBefore(){
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Device
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------------- | ---- |
---- |
-------------------------------------------------------- |
| ---------- | ----------------------------------- | ---- |-------------------------------------------------------- |
| mute | boolean | 是 | 回调返回系统麦克风静音状态,true为静音,false为非静音。 |
## ConnectType<sup>9+</sup>
...
...
@@ -1920,7 +1920,7 @@ getCurrentAudioRendererInfoArray(callback: AsyncCallback<AudioRendererChangeI
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | -------- | --------------------------- |
| callback | AsyncCallback
<
[
AudioRendererChangeInfoArray
](
#audiorendererchangeinfoarray9
)
>
| 是 | 回调函数,返回当前音频渲染器的信息。 |
...
...
@@ -2014,7 +2014,7 @@ getCurrentAudioCapturerInfoArray(callback: AsyncCallback<AudioCapturerChangeI
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ---------- | ----------------------------------- | --------- | -------------------------------------------------------- |
| callback | AsyncCallback
<
[
AudioCapturerChangeInfoArray
](
#audiocapturerchangeinfoarray9
)
>
| 是 | 回调函数,返回当前音频采集器的信息。 |
...
...
@@ -2104,7 +2104,7 @@ on(type: "audioRendererChange", callback: Callback<AudioRendererChangeInfoArr
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ---------- | --------- | ------------------------------------------------------------------------ |
| type | string | 是 | 事件类型,支持的事件
`'audioRendererChange'`
:当音频渲染器发生更改时触发。 |
| callback | Callback
<
[
AudioRendererChangeInfoArray
](
#audiorendererchangeinfoarray9
)
>
| 是 | 回调函数。 |
...
...
@@ -2154,7 +2154,7 @@ off(type: "audioRendererChange"): void
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------- | ---- | ---------------- |
| type | string | 是 | 事件类型,支持的事件
`'audioRendererChange'`
:音频渲染器更改事件。 |
...
...
@@ -2183,7 +2183,7 @@ on(type: "audioCapturerChange", callback: Callback<AudioCapturerChangeInfoArr
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------- | --------- | ----------------------------------------------------------------------- |
| type | string | 是 | 事件类型,支持的事件
`'audioCapturerChange'`
:当音频采集器发生更改时触发。 |
| callback | Callback
<
[
AudioCapturerChangeInfoArray
](
#audiocapturerchangeinfoarray9
)
>
| 是 | 回调函数。 |
...
...
@@ -2232,7 +2232,7 @@ off(type: "audioCapturerChange"): void;
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | -------- | --- | ------------------------------------------------------------- |
| type | string |是 | 事件类型,支持的事件
`'audioCapturerChange'`
:音频采集器更改事件。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md
浏览文件 @
07c46324
...
...
@@ -34,7 +34,7 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ |
| reason | string | 是 | 延迟挂起申请的原因。 |
| callback | Callback
<
void
>
| 是 | 延迟即将超时的回调函数,一般在超时前6秒通过此回调通知应用。 |
...
...
@@ -72,7 +72,7 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>):
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | --------------------------- | ---- | ---------------------------------------- |
| requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用
[
requestSuspendDelay
](
#backgroundtaskmanagerrequestsuspenddelay
)
方法获取。 |
| callback | AsyncCallback
<
number
>
| 是 | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 |
...
...
@@ -103,7 +103,7 @@ getRemainingDelayTime(requestId: number): Promise<number>
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用
[
requestSuspendDelay
](
#backgroundtaskmanagerrequestsuspenddelay
)
方法获取。 |
...
...
@@ -135,7 +135,7 @@ cancelSuspendDelay(requestId: number): void
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用
[
requestSuspendDelay
](
#backgroundtaskmanagerrequestsuspenddelay
)
方法获取。 |
...
...
@@ -159,7 +159,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
| bgMode |
[
BackgroundMode
](
#backgroundmode8
)
| 是 | 向系统申请的后台模式。 |
...
...
@@ -251,7 +251,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
| bgMode |
[
BackgroundMode
](
#backgroundmode8
)
| 是 | 向系统申请的后台模式。 |
...
...
@@ -337,7 +337,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): vo
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动长时任务的结果。 |
...
...
@@ -393,7 +393,7 @@ stopBackgroundRunning(context: Context): Promise<void>
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
...
...
@@ -436,13 +436,76 @@ export default class MainAbility extends Ability {
};
```
## backgroundTaskManager.applyEfficiencyResources<sup>9+</sup>
applyEfficiencyResources(request:
[
EfficiencyResourcesRequest
](
#efficiencyresourcesrequest9
)
): boolean
向系统申请或释放能效资源,使用boolean形式返回结果。
通过EfficiencyResourcesRequest参数中的isApply变量,设置是申请还是释放。
应用使用此接口,需要向应用中心申请获得相应特权。
进程和它所属的应用可以同时申请某一类资源,例如CPU资源,但是应用释放资源的时候会将进程的资源一起释放。
**系统能力**
: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
**系统API**
: 此接口为系统接口。
**参数**
:
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ---------------------------------------- |
| request |
[
EfficiencyResourcesRequest
](
#efficiencyresourcesrequest9
)
| 是 | 请求的必要信息。包括资源类型,超时时间等信息。详见
[
EfficiencyResourcesRequest
](
#efficiencyresourcesrequest9
)
。 |
**返回值**
:
| 类型 | 说明 |
| -------------- | ---------------- |
| boolean | true代表申请成功,false代表申请失败。 |
**示例**
:
```
js
import
backgroundTaskManager
from
'
@ohos.backgroundTaskManager
'
;
let
request
=
{
resourceTypes
:
backgroundTaskManager
.
ResourceType
.
CPU
,
// 如果将isApply置为false,则表示释放资源
isApply
:
true
,
timeOut
:
0
,
reason
:
"
apply
"
,
isPersist
:
true
,
isProcess
:
false
,
};
let
res
=
backgroundTaskManager
.
applyEfficiencyResources
(
request
);
console
.
info
(
"
result of applyEfficiencyResources is:
"
+
res
)
```
## backgroundTaskManager.resetAllEfficiencyResources<sup>9+</sup>
resetAllEfficiencyResources(): void
释放所有已经申请的资源。
应用使用此接口,需要向应用中心申请获得相应特权。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
**系统API**
: 此接口为系统接口。
**示例**
:
```
js
import
backgroundTaskManager
from
'
@ohos.backgroundTaskManager
'
;
backgroundTaskManager
.
resetAllEfficiencyResources
();
```
## DelaySuspendInfo
延迟挂起信息。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------------- | ------ | ---- | ---------------------------------------- |
| requestId | number | 是 | 延迟挂起的请求ID。 |
| actualDelayTime | number | 是 | 应用的实际挂起延迟时间,以毫秒为单位。
<br/>
一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000。 |
...
...
@@ -452,14 +515,49 @@ export default class MainAbility extends Ability {
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
| 参数名 | 描述 |
| ----------------------- | --------------------- |
| DATA_TRANSFER | 数据传输。 |
| AUDIO_PLAYBACK | 音频播放。 |
| AUDIO_RECORDING | 录音。 |
| LOCATION | 定位导航。 |
| BLUETOOTH_INTERACTION | 蓝牙相关。 |
| MULTI_DEVICE_CONNECTION | 多设备互联。 |
| WIFI_INTERACTION | WLAN相关(此接口为系统接口)。 |
| VOIP | 音视频通话(此接口为系统接口)。 |
| TASK_KEEPING | 计算任务(仅在特定设备生效)。 |
\ No newline at end of file
| 名称 | 值 | 描述 |
| ----------------------- | ---- | --------------------- |
| DATA_TRANSFER | 1 | 数据传输。 |
| AUDIO_PLAYBACK | 2 | 音频播放。 |
| AUDIO_RECORDING | 3 | 录音。 |
| LOCATION | 4 | 定位导航。 |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关。 |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联。 |
| WIFI_INTERACTION | 7 | WLAN相关
<br
/>
此接口为系统接口。 |
| VOIP | 8 | 音视频通话
<br
/>
此接口为系统接口。 |
| TASK_KEEPING | 9 | 计算任务(仅在特定设备生效)。 |
## EfficiencyResourcesRequest<sup>9+</sup>
能效资源申请参数。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
**系统API**
: 此接口为系统接口。
| 名称 | 类型 | 必填 | 说明 |
| --------------- | ------ | ---- | ---------------------------------------- |
| resourceTypes | number | 是 | 申请的资源类型。 |
| isApply | boolean | 是 | 申请资源或者是释放资源。 |
| timeOut | number | 是 | 资源的使用时间,以毫秒为单位。 |
| isPersist | boolean | 否 | 是否永久持有资源,如果是true,那么timeOut就无效。 |
| isProcess | boolean | 否 | 应用申请或者是进程申请。 |
| reason | string | 是 | 申请资源的原因。 |
## ResourceType<sup>9+</sup>
能效资源类型。
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
**系统API**
: 此接口为系统接口。
| 名称 | 值 | 描述 |
| ----------------------- | ---- | --------------------- |
| CPU | 1 | CPU资源,申请后不被挂起。 |
| COMMON_EVENT | 2 | 公共事件,申请后挂起状态下不被代理掉。 |
| TIMER | 4 | 计时器,申请后挂起状态下不被代理掉。 |
| WORK_SCHEDULER | 8 | 延迟任务,申请后有更长的执行时间。 |
| BLUETOOTH | 16 | 蓝牙相关,申请后挂起状态下不被代理掉。 |
| GPS | 32 | GPS相关,申请后挂起状态下不被代理掉。 |
| AUDIO | 64 | 音频资源,申请后挂起状态下不被代理掉。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-cardEmulation.md
浏览文件 @
07c46324
...
...
@@ -5,7 +5,6 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
...
...
@@ -18,7 +17,7 @@ import cardEmulation from '@ohos.nfc.cardEmulation';
**系统能力**
:SystemCapability.Communication.NFC.Core
| 名称 |
默认
值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| HCE | 0 | HCE 卡模拟。 |
| UICC | 1 | SIM 卡模拟。 |
...
...
@@ -40,9 +39,9 @@ isSupported(feature: number): boolean
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| boolean | true: 支持该类型卡模拟,
false: 不支持该类型卡模拟。
|
|
**类型**
|
**说明**
|
| -------- | -------- |
| boolean | true: 支持该类型卡模拟,
false: 不支持该类型卡模拟。
|
## HceService<sup>8+</sup>
...
...
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
浏览文件 @
07c46324
...
...
@@ -5,14 +5,12 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
```
js
import
connectedTag
from
'
@ohos.connectedTag
'
;
```
## connectedTag.init
init(): boolean
...
...
@@ -23,11 +21,11 @@ init(): boolean
**系统能力**
:SystemCapability.Communication.ConnectedTag
-
返回值:
|
**类型**
|
**说明**
|
| -------- | -------- |
| boolean | true:初始化成功,
false:初始化失败。 |
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| boolean | true:初始化成功,
false:初始化失败。 |
## connectedTag.uninit
...
...
@@ -39,11 +37,11 @@ uninit(): boolean
**系统能力**
:SystemCapability.Communication.ConnectedTag
-
返回值:
|
**类型**
|
**说明**
|
| -------- | -------- |
| boolean | true:卸载操作成功,
false:卸载操作失败。 |
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| boolean | true:卸载操作成功,
false:卸载操作失败。 |
## connectedTag.readNdefTag
...
...
@@ -55,19 +53,21 @@ readNdefTag(): Promise<string>
**系统能力**
:SystemCapability.Communication.ConnectedTag
-
返回值:
|
**类型**
|
**说明**
|
| -------- | -------- |
| Promise
<
string
>
| 返回读取有源标签内容。 |
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| Promise
<
string
>
| 返回读取有源标签内容。 |
**示例:**
-
示例
```
import connectedTag from '@ohos.connectedTag';
```
js
import
connectedTag
from
'
@ohos.connectedTag
'
;
connectedTag.readNdefTag().then(result => {
console.log("promise recv ndef response: " + result);
});
```
connectedTag
.
readNdefTag
().
then
(
result
=>
{
console
.
log
(
"
promise recv ndef response:
"
+
result
);
});
```
## connectedTag.readNdefTag
...
...
@@ -79,19 +79,21 @@ readNdefTag(callback: AsyncCallback<string>): void
**系统能力**
:SystemCapability.Communication.ConnectedTag
-
参数
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
string
>
| 是 | 读取有源标签内容回调函数。 |
**参数:**
-
示例
```
import connectedTag from '@ohos.connectedTag';
connectedTag.readNdefTag(result => {
console.log("callback recv ndef response: " + result);
});
```
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
string
>
| 是 | 读取有源标签内容回调函数。 |
**示例:**
```
js
import
connectedTag
from
'
@ohos.connectedTag
'
;
connectedTag
.
readNdefTag
(
result
=>
{
console
.
log
(
"
callback recv ndef response:
"
+
result
);
});
```
## connectedTag.writeNdefTag
...
...
@@ -103,29 +105,32 @@ writeNdefTag(data: string): Promise<void>
**系统能力**
:SystemCapability.Communication.ConnectedTag
-
参数
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| data | string | 是 | 有源标签内容, 长度最大是1024个字节。 |
**参数:**
-
返回值:
|
**类型**
|
**说明**
|
| -------- | -------- |
| Promise
<
void
>
| 无返回值。 |
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| data | string | 是 | 有源标签内容, 长度最大是1024个字节。 |
-
示例
```
import connectedTag from '@ohos.connectedTag';
writeNdefTag.write("010203")
.then((value) => {
// 事件写入正常
console.log(`success to write event: ${value}`);
}).catch((err) => {
// 事件写入异常
console.error(`failed to write event because ${err.code}`);
});
```
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| Promise
<
void
>
| 无返回值。 |
**示例:**
```
js
import
connectedTag
from
'
@ohos.connectedTag
'
;
connectedTag
.
write
(
"
010203
"
)
.
then
((
value
)
=>
{
// 事件写入正常
console
.
log
(
`success to write event:
${
value
}
`
);
}).
catch
((
err
)
=>
{
// 事件写入异常
console
.
error
(
`failed to write event because
${
err
.
code
}
`
);
});
```
## connectedTag.writeNdefTag
...
...
@@ -137,27 +142,29 @@ writeNdefTag(data: string, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.Communication.ConnectedTag
-
参数
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| data | string | 是 | 有源标签内容, 长度最大是1024个字节。 |
| callback | AsyncCallback
<
string
>
| 是 | 读取有源标签内容回调函数。 |
**参数:**
-
示例
```
import connectedTag from '@ohos.connectedTag';
connectedTag.writeNdefTag("010203", (err, value) => {
if (err) {
// 事件写入异常
console.error(`failed to write event because ${err.code}`);
return;
}
// 事件写入正常
console.log(`success to write event: ${value}`);
});
```
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| data | string | 是 | 有源标签内容, 长度最大是1024个字节。 |
| callback | AsyncCallback
<
string
>
| 是 | 读取有源标签内容回调函数。 |
**示例:**
```
js
import
connectedTag
from
'
@ohos.connectedTag
'
;
connectedTag
.
writeNdefTag
(
"
010203
"
,
(
err
,
value
)
=>
{
if
(
err
)
{
// 事件写入异常
console
.
error
(
`failed to write event because
${
err
.
code
}
`
);
return
;
}
// 事件写入正常
console
.
log
(
`success to write event:
${
value
}
`
);
});
```
## connectedTag.on('notify')
...
...
@@ -169,18 +176,12 @@ on(type: "notify", callback: Callback<number>): void
**系统能力**
:SystemCapability.Communication.ConnectedTag
-
参数
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"notify"字符串 |
| callback | Callback
<
number
>
| 是 | 状态改变回调函数。 |
-
状态改变事件的枚举。
|
**枚举值**
|
**说明**
|
| -------- | -------- |
| 0 | NFC离场事件 |
| 1 | NFC进场事件 |
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"notify"字符串 |
| callback | Callback
<
number
>
| 是 | 状态改变回调函数,返回值参见
[
NfcRfType
](
#nfcrftype
)
。 |
## connectedTag.off('notify')
...
...
@@ -192,28 +193,28 @@ off(type: "notify", callback?: Callback<number>): void
**系统能力**
:SystemCapability.Communication.ConnectedTag
-
参数
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"notify"字符串 |
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将“去注册”该事件关联的所有回调函数。 |
**参数:**
-
示例
```
import connectedTag from '@ohos.connectedTag';
var NFC_RF_NOTIFY = "notify";
var recvNfcRfNotifyFunc = result => {
console.info("nfc rf receive state: " + result);
}
// Register event
connectedTag.on(NFC_RF_NOTIFY, recvNfcRfNotifyFunc);
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"notify"字符串 |
| callback | Callback
<
number
>
| 否 | 状态改变回调函数。如果callback不填,将“去注册”该事件关联的所有回调函数。|
**示例:**
```
js
import
connectedTag
from
'
@ohos.connectedTag
'
;
var
recvNfcRfNotifyFunc
=
result
=>
{
console
.
info
(
"
nfc rf receive state:
"
+
result
);
}
// Unregister event
connectedTag.off(NFC_RF_NOTIFY, recvNfcRfNotifyFunc);
```
// Register event
connectedTag
.
on
(
"
notify
"
,
recvNfcRfNotifyFunc
);
// Unregister event
connectedTag
.
off
(
"
notify
"
,
recvNfcRfNotifyFunc
);
```
## NfcRfType
...
...
@@ -221,7 +222,7 @@ off(type: "notify", callback?: Callback<number>): void
**系统能力**
:SystemCapability.Communication.ConnectedTag
| 名称 |
默认
值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| NFC_RF_LEAVE | 0 | NFC离场事件 |
| NFC_RF_ENTER | 1 | NFC进场事件 |
zh-cn/application-dev/reference/apis/js-apis-cryptoFramework.md
浏览文件 @
07c46324
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @
07c46324
...
...
@@ -9,7 +9,6 @@
使用前根据具体情况引入如下模块
```
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
import ohos_data_rdb from '@ohos.data.rdb'
```
...
...
@@ -24,11 +23,11 @@ openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 |
| callback | AsyncCallback
\<
number> | 是 | 被指定的回调方法,返回文件
描述
符。 |
| callback | AsyncCallback
\<
number> | 是 | 被指定的回调方法,返回文件
说明
符。 |
**示例:**
...
...
@@ -56,7 +55,7 @@ openFile(uri: string, mode: string): Promise\<number>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 |
...
...
@@ -65,7 +64,7 @@ openFile(uri: string, mode: string): Promise\<number>
| 类型 | 说明 |
| ---------------- | ---------------- |
| Promise
\<
number> | 返回文件
描述
符。 |
| Promise
\<
number> | 返回文件
说明
符。 |
**示例:**
...
...
@@ -92,7 +91,7 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 |
| uri | string | 是 | 指示要操作的数据的路径。 |
...
...
@@ -125,7 +124,7 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 |
| uri | string | 是 | 指示要操作的数据的路径。 |
...
...
@@ -162,7 +161,7 @@ getType(uri: string, callback: AsyncCallback\<string>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------- | ---- | --------------------------------------------- |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback
\<
string> | 是 | 回调方法,返回与uri指定的数据匹配的MIME类型。 |
...
...
@@ -191,7 +190,7 @@ getType(uri: string): Promise\<string>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 |
...
...
@@ -225,7 +224,7 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
...
...
@@ -258,7 +257,7 @@ getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ---------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
...
...
@@ -294,7 +293,7 @@ normalizeUri(uri: string, callback: AsyncCallback\<string>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback
\<
string> | 是 | 回调方法。如果数据功能支持uri规范化,则返回规范化uri对象;否则返回null。 |
...
...
@@ -323,7 +322,7 @@ normalizeUri(uri: string): Promise\<string>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
...
...
@@ -357,7 +356,7 @@ denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback
\<
string> | 是 | 回调方法。如果反规范化成功,则返回反规范化uri对象。 |
...
...
@@ -388,7 +387,7 @@ denormalizeUri(uri: string): Promise\<string>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
...
...
@@ -422,7 +421,7 @@ notifyChange(uri: string, callback: AsyncCallback\<void>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | -------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback
\<
void> | 是 | 回调方法。 |
...
...
@@ -451,7 +450,7 @@ notifyChange(uri: string): Promise\<void>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 |
...
...
@@ -485,7 +484,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<num
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------------ | ---------------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
...
...
@@ -522,7 +521,7 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------------ | ---------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
...
...
@@ -564,7 +563,7 @@ batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: Async
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------------ | ----------------------- | ---- | -------------------------------- |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | Array
<rdb.ValuesBucket>
| 是 | 指示要插入的数据记录。 |
...
...
@@ -598,7 +597,7 @@ batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<numbe
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------------ | ----------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | Array
<rdb.ValuesBucket>
| 是 | 指示要插入的数据记录。 |
...
...
@@ -637,7 +636,7 @@ delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: Asy
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 |
| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
...
...
@@ -670,7 +669,7 @@ delete(uri: string, predicates?: dataAbility.DataAbilityPredicates): Promise\<nu
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 |
| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
...
...
@@ -708,7 +707,7 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.Data
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
...
...
@@ -749,7 +748,7 @@ update(uri: string, valuesBucket: rdb.ValuesBucket, predicates?: dataAbility.Dat
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
...
...
@@ -795,7 +794,7 @@ query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityP
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| columns | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
...
...
@@ -833,7 +832,7 @@ query(uri: string, columns?: Array\<string>, predicates?: dataAbility.DataAbilit
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| columns | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
...
...
@@ -874,7 +873,7 @@ call(uri: string, method: string, arg: string, extras: PacMap): Promise\<PacMap>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 |
...
...
@@ -910,7 +909,7 @@ call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCa
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 |
...
...
@@ -943,7 +942,7 @@ executeBatch(uri: string, operations: Array\<DataAbilityOperation>, callback: As
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。|
| operations | Array
\<
[
DataAbilityOperation
](
#dataabilityoperation
)
> | 是 | 指示数据操作列表,其中可以包含对数据库的多个操作。 |
...
...
@@ -976,7 +975,7 @@ executeBatch(uri: string, operations: Array\<DataAbilityOperation>): Promise\<Ar
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---------- | -------------------------------| ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。|
| operations | Array
\<
[
DataAbilityOperation
](
#dataabilityoperation
)
> | 是 | 指示数据操作列表,其中可以包含对数据库的多个操作。 |
...
...
@@ -1009,7 +1008,7 @@ dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbi
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
|
名称
| 参数类型 | 必填 | 说明 |
|
参数名
| 参数类型 | 必填 | 说明 |
| ------ | ------ | ------ | ------ |
| [key: string] | number
\|
string
\|
boolean
\|
Array
\<
string
\|
number
\|
boolean
\>
\|
null | Yes| 数据存储在键值对中。|
...
...
@@ -1017,7 +1016,7 @@ dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbi
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 |
参数
类型 | 可读 | 可写 | 必填| 说明 |
| 名称 | 类型 | 可读 | 可写 | 必填| 说明 |
| -------- | -------- | -------- | -------- | --------| -------- |
| uri | string | 是 | 否 | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。 |
| type | featureAbility.DataAbilityOperationType | 是 | 否 | 是 | 指示操作类型。 |
...
...
@@ -1032,7 +1031,7 @@ dataAbilityHelper.executeBatch("dataability:///com.example.jsapidemo.UserDataAbi
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 |
参数
类型 | 可读 | 可写 | 必填 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| uri? | string | 是 | 否 | 否 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx"。 |
| count? | number | 是 | 否 | 否 | 指示受操作影响的行数。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-distributed-data.md
浏览文件 @
07c46324
...
...
@@ -2955,7 +2955,7 @@ get(key: string, callback: AsyncCallback<Uint8Array | string | boolean | numb
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key |string | 是 |要查询数据的key,不能为空且长度不大于
[
MAX_KEY_LENGTH
](
#constants
)
。 |
| callback |AsyncCallback
<
Uint8Array
\|
string
\|
boolean
\|
number
>
)
| 是 |回调函数。返回获取查询的值。 |
| callback |AsyncCallback
<
Uint8Array
\|
string
\|
boolean
\|
number
>
| 是 |回调函数。返回获取查询的值。 |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-distributedKVStore.md
浏览文件 @
07c46324
...
...
@@ -2941,7 +2941,7 @@ get(key: string, callback: AsyncCallback<boolean | string| number | Uint8Array>)
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------- |
| key |string | 是 |要查询数据的key,不能为空且长度不大于
[
MAX_KEY_LENGTH
](
#constants
)
。 |
| callback |AsyncCallback
<
boolean
\|
string
\|
number
\|
Uint8Array
>
)
| 是 |回调函数。返回获取查询的值。 |
| callback |AsyncCallback
<
boolean
\|
string
\|
number
\|
Uint8Array
>
| 是 |回调函数。返回获取查询的值。 |
**错误码:**
...
...
zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceInfo.md
已删除
100644 → 0
浏览文件 @
599b3e15
# 企业设备信息管理
本模块提供企业设备信息管理能力,包括获取设备序列号等。仅企业设备管理员应用才能调用。
> **说明:**
>
> 本模块首批接口从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
<
string
>
| 是 | 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
<
string
>
| 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
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
浏览文件 @
07c46324
...
...
@@ -23,7 +23,6 @@ export default class MainAbility extends Ability {
}
```
## EventHub.on
on(event: string, callback: Function): void;
...
...
zh-cn/application-dev/reference/apis/js-apis-faultLogger.md
浏览文件 @
07c46324
...
...
@@ -12,9 +12,9 @@ import faultLogger from '@ohos.faultLogger'
故障类型枚举。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.Hiview.FaultLogger。
**系统能力:**
SystemCapability.HiviewDFX.Hiview.FaultLogger
| 名称 |
默认
值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| NO_SPECIFIC | 0 | 不区分故障类型 |
| CPP_CRASH | 2 | C++程序故障类型 |
...
...
@@ -25,9 +25,9 @@ import faultLogger from '@ohos.faultLogger'
故障信息数据结构,获取到的故障信息的数据结构。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.HiviewDFX.Hiview.FaultLogger。
**系统能力:**
SystemCapability.HiviewDFX.Hiview.FaultLogger
| 名称 |
参数
类型 | 说明 |
| 名称 | 类型 | 说明 |
| -------- | -------- | -------- |
| pid | number | 故障进程的进程id |
| uid | number | 故障进程的用户id |
...
...
@@ -53,7 +53,7 @@ querySelfFaultLog(faultType: FaultType, callback: AsyncCallback<Array<Faul
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| faultType |
[
FaultType
](
#faulttype
)
| 是 | 输入要查询的故障类型。 |
| callback | AsyncCallback
Array
<
Array
<
[FaultLogInfo](#faultloginfo)
>>
| 是 | 回调函数,在回调函数中获取故障信息数组。
<br/>
-
value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串
| callback | AsyncCallback
<
Array
<
[FaultLogInfo](#faultloginfo)
>>
| 是 | 回调函数,在回调函数中获取故障信息数组。
<br/>
-
value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串
**示例:**
...
...
@@ -138,13 +138,13 @@ query(faultType: FaultType, callback: AsyncCallback<Array<FaultLogInfo>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| faultType |
[
FaultType
](
#faulttype
)
| 是 | 输入要查询的故障类型。 |
| callback | AsyncCallback
Array
<
Array
<
[FaultLogInfo](#faultloginfo)
>>
| 是 | 回调函数,在回调函数中获取故障信息数组。
<br/>
-
value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串
| callback | AsyncCallback
<
Array
<
[FaultLogInfo](#faultloginfo)
>>
| 是 | 回调函数,在回调函数中获取故障信息数组。
<br/>
-
value拿到故障信息数组;value为undefined表示获取过程中出现异常,error返回错误提示字符串
**错误码:**
以下错误码的详细介绍参见
[
ohos.faultLogger错误码
](
../errorcodes/errorcode-faultlogger.md
)
。
| 错误码ID | 错误信息
(此处仅提供错误抛出的关键信息)
|
| 错误码ID | 错误信息 |
| --- | --- |
| 10600001 | The service is not running or broken |
...
...
@@ -201,7 +201,7 @@ query(faultType: FaultType) : Promise<Array<FaultLogInfo>>
以下错误码的详细介绍参见
[
ohos.faultLogger错误码
](
../errorcodes/errorcode-faultlogger.md
)
。
| 错误码ID | 错误信息
(此处仅提供错误抛出的关键信息)
|
| 错误码ID | 错误信息 |
| --- | --- |
| 10600001 | The service is not running or broken |
...
...
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @
07c46324
...
...
@@ -27,7 +27,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>)
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是 | 表示被启动的Ability。 |
| callback | AsyncCallback
\<
number> | 是 | 被指定的回调方法。 |
...
...
@@ -70,7 +70,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<number>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是 | 表示被启动的Ability。 |
...
...
@@ -109,7 +109,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
...
...
@@ -138,7 +138,7 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是 | 表示被启动的Ability。 |
| callback | AsyncCallback
\<
[
AbilityResult
](
#abilityresult
)
> | 是 | 被指定的回调方法。 |
...
...
@@ -179,7 +179,7 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| --------- | ---------------------------------------- | ---- | ------------- |
| parameter |
[
StartAbilityParameter
](
#startabilityparameter
)
| 是 | 表示被启动的Ability |
...
...
@@ -235,7 +235,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| --------- | ------------------------------- | ---- | -------------- |
| parameter |
[
AbilityResult
](
#abilityresult
)
| 是 | 表示被启动的Ability。 |
| callback | AsyncCallback
\<
void> | 是 | 被指定的回调方法。 |
...
...
@@ -287,7 +287,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| --------- | ------------------------------- | ---- | ------------- |
| parameter |
[
AbilityResult
](
#abilityresult
)
| 是 | 表示被启动的Ability |
...
...
@@ -343,7 +343,7 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | ----------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback
\<
boolean> | 是 | 被指定的回调方法。
<br>
如果此Ability当前具有视窗焦点,则返回true;否则返回false。 |
...
...
@@ -389,7 +389,7 @@ getWant(callback: AsyncCallback\<Want>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | ----------------------------- | ---- | --------- |
| callback | AsyncCallback
\<
[
Want
](
js-apis-application-Want.md
)
> | 是 | 被指定的回调方法。 |
...
...
@@ -459,7 +459,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | -------------------- | ---- | -------- |
| callback | AsyncCallback
\<
void> | 是 | 被指定的回调方法 |
...
...
@@ -507,7 +507,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------- | -------------- | ---- | --------------------- |
| request |
[
Want
](
js-apis-application-Want.md
)
| 是 | 表示被连接的ServiceAbility。 |
| options |
[
ConnectOptions
](
#connectoptions
)
| 是 | 被指定的回调方法。 |
...
...
@@ -518,7 +518,7 @@ ConnectOptions类型说明
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
|
名称 | 读写属性 | 类型 | 必填 | 描述
|
|
参数名 | 读写属性 | 类型 | 必填 | 说明
|
| ------------ | ---- | -------- | ---- | ------------------------- |
| onConnect
<sup>
7+
</sup>
| 只读 | function | 是 | 连接成功时的回调函数。 |
| onDisconnect
<sup>
7+
</sup>
| 只读 | function | 是 | 连接失败时的回调函数。 |
...
...
@@ -568,7 +568,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---------- | -------------------- | ---- | ----------------------- |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback
\<
void> | 是 | 被指定的回调方法 |
...
...
@@ -615,7 +615,7 @@ disconnectAbility(connection: number): Promise\<void>
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | ----------------------- |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
...
...
@@ -669,7 +669,7 @@ getWindow(callback: AsyncCallback\<window.Window>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | ----------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback
\<
window.Window> | 是 | 返回与当前Ability对应的窗口。 |
...
...
@@ -713,7 +713,7 @@ onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void;
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ----------- | ----------------- | ---- | -------- |
| elementName | ElementName | 是 | 元素名。 |
| remote | rpc.IRemoteObject | 是 | rpc远程对象。 |
...
...
@@ -756,7 +756,7 @@ onDisconnect(elementName: ElementName): void;
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ----------- | ----------- | ---- | ---- |
| elementName | ElementName | 是 | 元素名。 |
...
...
@@ -798,7 +798,7 @@ ConnectAbility调用失败时的回调函数。
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | --------- |
| code | number | 是 | number类型。 |
...
...
@@ -846,7 +846,7 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称
| 参数 | 描述
|
| 名称
| 值 | 说明
|
| ---------------------------------------- | ---- | ---------------------------------------- |
| WINDOW_MODE_UNDEFINED
<sup>
7+
</sup>
| 0 | 未定义。 |
| WINDOW_MODE_FULLSCREEN
<sup>
7+
</sup>
| 1 | 全屏。 |
...
...
@@ -869,11 +869,11 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 |
参数 | 描述
|
| 名称 |
值 | 说明
|
| ---------------------------- | --------------- | ---------------------------------------- |
| BOUNDS_KEY
<sup>
7+
</sup>
| "abilityBounds" | 窗口显示大小属性的
名称
。 |
| WINDOW_MODE_KEY
<sup>
7+
</sup>
| "windowMode" | 窗口显示模式属性的
名称
。|
| DISPLAY_ID_KEY
<sup>
7+
</sup>
| "displayId" | 窗口显示设备ID属性的
名称
。 |
| BOUNDS_KEY
<sup>
7+
</sup>
| "abilityBounds" | 窗口显示大小属性的
参数名
。 |
| WINDOW_MODE_KEY
<sup>
7+
</sup>
| "windowMode" | 窗口显示模式属性的
参数名
。|
| DISPLAY_ID_KEY
<sup>
7+
</sup>
| "displayId" | 窗口显示设备ID属性的
参数名
。 |
## ErrorCode
...
...
@@ -881,7 +881,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
|
变量
| 值 | 说明 |
|
名称
| 值 | 说明 |
| ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR
<sup>
7+
</sup>
| 0 | 没有错误。 |
| INVALID_PARAMETER
<sup>
7+
</sup>
| -1 | 无效的参数。 |
...
...
@@ -895,7 +895,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
|
变量
| 值 | 说明 |
|
名称
| 值 | 说明 |
| ------------------------ | ---- | ---------------------------------------- |
| TYPE_INSERT
<sup>
7+
</sup>
| 1 | 插入类型。 |
| TYPE_UPDATE
<sup>
7+
</sup>
| 2 | 修改类型。 |
...
...
@@ -908,25 +908,25 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称
| 读写属性 | 类型 | 必填 | 描述
|
| ---------------
-------- |
---- | ------------- | ---- | ------------------------------------- |
| resultCode
<sup>
7+
</sup>
| 只读 | number
| 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误(暂不支持)。 |
| want
<sup>
7+
</sup>
| 只读 |
[
Want
](
js-apis-application-Want.md
)
| 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
| 名称
| 类型 | 可读| 可写 | 必填 | 说明
|
| ---------------
|-------- | --
---- | ------------- | ---- | ------------------------------------- |
| resultCode
<sup>
7+
</sup>
| number| 是 | 否
| 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误(暂不支持)。 |
| want
<sup>
7+
</sup>
|
[
Want
](
js-apis-application-Want.md
)
| 是 | 否
| 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
## StartAbilityParameter
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
|
名称 | 读写属性 | 类型 | 必填 | 描述
|
| ------------------- | ---- | -------------------- | ---- | -------------------------------------- |
| want |
只读 |
[
Want
](
js-apis-application-Want.md
)
| 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting |
只读 | {[key: string]: any}
| 否 | 表示能力的特殊属性,当开发者启动能力时,该属性可以作为调用中的输入参数传递。 |
|
参数名 | 类型 | 可读| 可写 | 必填 | 说明
|
| ------------------- | ----
----
| -------------------- | ---- | -------------------------------------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | 否
| 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting |
{[key: string]: any} | 是 |否
| 否 | 表示能力的特殊属性,当开发者启动能力时,该属性可以作为调用中的输入参数传递。 |
## flags说明
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 |
参数 | 描述
|
| 名称 |
值 | 说明
|
| ------------------------------------ | ---------- | ---------------------------------------- |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-hidebug.md
浏览文件 @
07c46324
...
...
@@ -234,7 +234,7 @@ hidebug.dumpHeapData("heap-20220216");
## 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
| -------- | ------ | ---- | ------------------------------------------------------------ |
| serviceid | number | 是 | 基于该用户输入的service id获取系统服务信息。|
| fd | number | 是 | 文件描述符,该接口会往该fd中写入数据。|
| args | Array
<string>
| 是 | 系统服务的Dump接口所对应的参数列表。|
| args | Array
\
<
string> | 是 | 系统服务的Dump接口所对应的参数列表。|
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-hilog.md
浏览文件 @
07c46324
...
...
@@ -45,7 +45,7 @@ hilog.isLoggable(0x0001, "testTag", hilog.LogLevel.INFO);
**系统能力:**
SystemCapability.HiviewDFX.HiLog
| 名称 |
默认值
| 说明 |
| 名称 |
值
| 说明 |
| ----- | ------ | ------------------------------------------------------------ |
| DEBUG | 3 | 详细的流程记录,通过该级别的日志可以更详细地分析业务流程和定位分析问题。 |
| INFO | 4 | 用于记录业务关键流程节点,可以还原业务的主要运行过程;
<br/>
用于记录可预料的非正常情况信息,如无网络信号、登录失败等。
<br/>
这些日志都应该由该业务内处于支配地位的模块来记录,避免在多个被调用的模块或低级函数中重复记录。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
07c46324
...
...
@@ -613,7 +613,7 @@ try {
showSoftKeyboard(callback: AsyncCallback
<
void
>
): void
显示软键盘。使用callback异步回调。
显示软键盘。
需要与输入框绑定使用。当点击输入框后,才可通过该接口的调用显示出当前输入法的软键盘。
使用callback异步回调。
**需要权限:**
ohos.permission.CONNECT_IME_ABILITY
...
...
@@ -648,9 +648,7 @@ inputMethodController.showSoftKeyboard((err) => {
### showSoftKeyboard<sup>9+</sup>
showSoftKeyboard(): Promise
<
void
>
显示软键盘,使用Promise异步回调。
显示软键盘。需要与输入框绑定使用。当点击输入框后,才可通过该接口的调用显示出当前输入法的软键盘。使用Promise异步回调。
**需要权限:**
ohos.permission.CONNECT_IME_ABILITY
...
...
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @
07c46324
...
...
@@ -192,7 +192,7 @@ media.getFileAssets(imagesFetchOp).then(function(fetchFileResult) {
### on<sup>8+</sup>
on(type: 'deviceChange'
|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|
'remoteFileChange', callback: Callback
<
void
>
): void
on(type: 'deviceChange'
|
'albumChange'
|
'imageChange'
|
'audioChange'
|
'videoChange'
|
'fileChange'
|
'remoteFileChange', callback: Callback
<
void
>
): void
打开媒体库变更通知,使用callback方式返回异步结果。
...
...
@@ -214,7 +214,7 @@ media.on('imageChange', () => {
```
### off<sup>8+</sup>
off(type: 'deviceChange'
|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|
'remoteFileChange', callback?: Callback
<
void
>
): void
off(type: 'deviceChange'
|
'albumChange'
|
'imageChange'
|
'audioChange'
|
'videoChange'
|
'fileChange'
|
'remoteFileChange', callback?: Callback
<
void
>
): void
关闭媒体库变更通知,使用callback方式返回异步结果。
...
...
@@ -2471,25 +2471,25 @@ async function example() {
| 名称 | 值 | 说明 |
| ------------- | ------------------- | ---------------------------------------------------------- |
| ID |
file_id
| 文件编号 |
| RELATIVE_PATH |
relative_path
| 相对公共目录路径 |
| DISPLAY_NAME |
display_name
| 显示名字 |
| PARENT |
parent
| 父目录id |
| MIME_TYPE |
mime_type
| 文件扩展属性 |
| MEDIA_TYPE |
media_type
| 媒体类型 |
| SIZE |
size
| 文件大小(单位:字节) |
| DATE_ADDED |
date_added
| 添加日期(添加文件时间到1970年1月1日的秒数值) |
| DATE_MODIFIED |
date_modified
| 修改日期(修改文件时间到1970年1月1日的秒数值) |
| DATE_TAKEN |
date_taken
| 拍摄日期(文件拍照时间到1970年1月1日的秒数值) |
| TITLE |
title
| 文件标题 |
| ARTIST |
artist
| 作者 |
| AUDIOALBUM |
audio_album
| 专辑 |
| DURATION |
duration
| 持续时间(单位:毫秒) |
| WIDTH |
width
| 图片宽度(单位:像素) |
| HEIGHT |
height
| 图片高度(单位:像素) |
| ORIENTATION |
orientation
| 图片显示方向,即顺时针旋转角度,如0,90,180。(单位:度) |
| ALBUM_ID |
bucket_id
| 文件所归属的相册编号 |
| ALBUM_NAME |
bucket_display_name
| 文件所归属相册名称 |
| ID |
"file_id"
| 文件编号 |
| RELATIVE_PATH |
"relative_path"
| 相对公共目录路径 |
| DISPLAY_NAME |
"display_name"
| 显示名字 |
| PARENT |
"parent"
| 父目录id |
| MIME_TYPE |
"mime_type"
| 文件扩展属性 |
| MEDIA_TYPE |
"media_type"
| 媒体类型 |
| SIZE |
"size"
| 文件大小(单位:字节) |
| DATE_ADDED |
"date_added"
| 添加日期(添加文件时间到1970年1月1日的秒数值) |
| DATE_MODIFIED |
"date_modified"
| 修改日期(修改文件时间到1970年1月1日的秒数值) |
| DATE_TAKEN |
"date_taken"
| 拍摄日期(文件拍照时间到1970年1月1日的秒数值) |
| TITLE |
"title"
| 文件标题 |
| ARTIST |
"artist"
| 作者 |
| AUDIOALBUM |
"audio_album"
| 专辑 |
| DURATION |
"duration"
| 持续时间(单位:毫秒) |
| WIDTH |
"width"
| 图片宽度(单位:像素) |
| HEIGHT |
"height"
| 图片高度(单位:像素) |
| ORIENTATION |
"orientation"
| 图片显示方向,即顺时针旋转角度,如0,90,180。(单位:度) |
| ALBUM_ID |
"bucket_id"
| 文件所归属的相册编号 |
| ALBUM_NAME |
"bucket_display_name"
| 文件所归属相册名称 |
## DirectoryType<sup>8+</sup>
...
...
@@ -2575,7 +2575,7 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ---- | ---- | -------------------- |
| type |
string
| 是 | 是 | 媒体类型,包括:image, video, media,当前仅支持media类型 |
| type |
'image'
|
'video'
|
'media'
| 是 | 是 | 媒体类型,包括:image, video, media,当前仅支持media类型 |
| count | number | 是 | 是 | 媒体选择,count = 1表示单选,count大于1表示多选。 |
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
浏览文件 @
07c46324
...
...
@@ -49,7 +49,8 @@ registerMissionListener(listener: MissionListener): number;
onMissionSnapshotChanged
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionSnapshotChanged-------
"
)},
onMissionMovedToFront
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionMovedToFront-------
"
)},
onMissionIconUpdated
:
function
(
mission
,
icon
)
{
console
.
log
(
"
--------onMissionIconUpdated-------
"
)},
onMissionClosed
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionClosed-------
"
)}
onMissionClosed
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionClosed-------
"
)},
onMissionLabelUpdated
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionLabelUpdated-------
"
)}
};
console
.
log
(
"
registerMissionListener
"
)
var
listenerid
=
missionManager
.
registerMissionListener
(
listener
);
...
...
@@ -84,7 +85,8 @@ unregisterMissionListener(listenerId: number, callback: AsyncCallback<void>
onMissionSnapshotChanged
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionSnapshotChanged-------
"
)},
onMissionMovedToFront
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionMovedToFront-------
"
)},
onMissionIconUpdated
:
function
(
mission
,
icon
)
{
console
.
log
(
"
--------onMissionIconUpdated-------
"
)},
onMissionClosed
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionClosed-------
"
)}
onMissionClosed
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionClosed-------
"
)},
onMissionLabelUpdated
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionLabelUpdated-------
"
)}
};
console
.
log
(
"
registerMissionListener
"
)
var
listenerid
=
missionManager
.
registerMissionListener
(
listener
);
...
...
@@ -128,7 +130,8 @@ unregisterMissionListener(listenerId: number): Promise<void>;
onMissionSnapshotChanged
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionSnapshotChanged-------
"
)},
onMissionMovedToFront
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionMovedToFront-------
"
)},
onMissionIconUpdated
:
function
(
mission
,
icon
)
{
console
.
log
(
"
--------onMissionIconUpdated-------
"
)},
onMissionClosed
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionClosed-------
"
)}
onMissionClosed
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionClosed-------
"
)},
onMissionLabelUpdated
:
function
(
mission
)
{
console
.
log
(
"
--------onMissionLabelUpdated-------
"
)}
};
console
.
log
(
"
registerMissionListener
"
)
var
listenerid
=
missionManager
.
registerMissionListener
(
listener
);
...
...
zh-cn/application-dev/reference/apis/js-apis-nfcController.md
浏览文件 @
07c46324
...
...
@@ -5,10 +5,9 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **导入模块**
```
```
js
import
controller
from
'
@ohos.nfc.controller
'
;
```
...
...
@@ -18,7 +17,7 @@ import controller from '@ohos.nfc.controller';
**系统能力**
:SystemCapability.Communication.NFC.Core
| 名称 |
默认
值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| STATE_OFF | 1 | NFC已关闭状态。 |
| STATE_TURNING_ON | 2 | NFC正在打开状态。 |
...
...
@@ -110,12 +109,10 @@ on(type: "nfcStateChange", callback: Callback<[NfcState](#nfcstate)>): voi
**参数**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"nfcStateChange"字符串。 |
| callback | Callback
<
[NfcState](#nfcstate)
>
| 是 | NFC状态改变通知的回调函数。 |
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"nfcStateChange"字符串。 |
| callback | Callback
<
[NfcState](#nfcstate)
>
| 是 | NFC状态改变通知的回调函数。 |
## controller.off('nfcStateChange')
...
...
@@ -126,41 +123,38 @@ off(type: "nfcStateChange", callback?: Callback<[NfcState](#nfcstate)>): v
**系统能力**
:SystemCapability.Communication.NFC.Core
**参数**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"nfcStateChange"字符串。 |
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 固定填"nfcStateChange"字符串。 |
| callback | Callback
<
[NfcState](#nfcstate)
>
| 否 | NFC状态改变回调函数,可以空缺不填。 |
**示例**
```
js
import
controller
from
'
@ohos.nfc.controller
'
;
// callback key definition
var
NFC_STATE_CALLBACK_KEY
=
"
nfcStateChange
"
;
// register callback to receive the nfc state changed notification
controller
.
on
(
NFC_STATE_CALLBACK_KEY
,
(
err
,
nfcState
)
=>
{
if
(
err
)
{
console
.
log
(
"
controller on callback err:
"
+
err
);
}
else
{
console
.
log
(
"
controller on callback nfcState:
"
+
nfcState
);
}
});
// open nfc, require permission: ohos.permission.MANAGE_SECURE_SETTINGS
if
(
!
controller
.
isNfcOpen
())
{
var
ret
=
controller
.
openNfc
();
console
.
log
(
"
controller openNfc ret:
"
+
ret
);
}
```
js
import
controller
from
'
@ohos.nfc.controller
'
;
// close nfc, require permission: ohos.permission.MANAGE_SECURE_SETTINGS
if
(
controller
.
isNfcOpen
())
{
var
ret
=
controller
.
closeNfc
();
console
.
log
(
"
controller closeNfc ret:
"
+
ret
);
// register callback to receive the nfc state changed notification
controller
.
on
(
"
nfcStateChange
"
,
(
err
,
nfcState
)
=>
{
if
(
err
)
{
console
.
log
(
"
controller on callback err:
"
+
err
);
}
else
{
console
.
log
(
"
controller on callback nfcState:
"
+
nfcState
);
}
// unregister callback
controller
.
off
(
NFC_STATE_CALLBACK_KEY
);
```
});
// open nfc, require permission: ohos.permission.MANAGE_SECURE_SETTINGS
if
(
!
controller
.
isNfcOpen
())
{
var
ret
=
controller
.
openNfc
();
console
.
log
(
"
controller openNfc ret:
"
+
ret
);
}
// close nfc, require permission: ohos.permission.MANAGE_SECURE_SETTINGS
if
(
controller
.
isNfcOpen
())
{
var
ret
=
controller
.
closeNfc
();
console
.
log
(
"
controller closeNfc ret:
"
+
ret
);
}
// unregister callback
controller
.
off
(
"
nfcStateChange
"
);
```
zh-cn/application-dev/reference/apis/js-apis-nfcTag.md
浏览文件 @
07c46324
...
...
@@ -59,6 +59,7 @@ import tag from '@ohos.nfc.tag';
```
## **tag.TagInfo**
在对相关Tag类型卡片进行读写之前,必须先获取TagInfo相关属性值,以确认设备读取到的Tag卡片支持哪些技术类型。这样Tag应用程序才能调用正确的接口和所读取到的Tag卡片进行通信。
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -69,7 +70,7 @@ onCreate(want, launchParam) {
// want is initialized by nfc service, contains tag info for this found tag
var
tagInfo
;
try
{
tag
.
getTagInfo
(
want
);
tag
Info
=
tag
.
getTagInfo
(
want
);
}
catch
(
error
)
{
console
.
log
(
"
tag.getTagInfo catched error:
"
+
error
);
}
...
...
@@ -191,16 +192,19 @@ getIsoDep(tagInfo: [TagInfo](#taginfo)): [IsoDepTag](js-apis-nfctech.md#isoDepTa
**系统能力**
:SystemCapability.Communication.NFC.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------------------------------- |
| taginfo |
[
TagInfo
](
#taginfo
)
| 是 | 包含Tag技术类型和相关参数,从tag.getTagInfo(want: Want)获取。 |
**返回值:**
|
**类型**
|
**说明**
|
| ---------- | ------------------|
|
[
IsoDepTag
](
js-apis-nfctech.md#isodeptag9
)
| IsoDep类型Tag对象,通过该对象访问IsoDep类型的相关接口。 |
**错误码:**
以下错误码的详细介绍请参见
[
NFC错误码
](
../errorcodes/errorcode-nfc.md
)
。
| 错误码ID | 错误信息|
| ------- | -------|
...
...
@@ -215,16 +219,19 @@ getNdef(tagInfo: [TagInfo](#taginfo)): [NdefTag](js-apis-nfctech.md#ndeftag9)
**系统能力**
:SystemCapability.Communication.NFC.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------------------------------- |
| taginfo |
[
TagInfo
](
#taginfo
)
| 是 | 包含Tag技术类型和相关参数,从tag.getTagInfo(want: Want)获取。 |
**返回值:**
|
**类型**
|
**说明**
|
| ---------| -------------- |
|
[
NdefTag
](
js-apis-nfctech.md#ndeftag9
)
| NDEF类型Tag对象,通过该对象访问NDEF类型的相关接口。|
**错误码:**
以下错误码的详细介绍请参见
[
NFC错误码
](
../errorcodes/errorcode-nfc.md
)
。
| 错误码ID | 错误信息|
| ------- | -------|
...
...
@@ -239,11 +246,13 @@ getMifareClassic(tagInfo: [TagInfo](#taginfo)): [MifareClassicTag](js-apis-nfcte
**系统能力**
:SystemCapability.Communication.NFC.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------------------------------- |
| taginfo |
[
TagInfo
](
#taginfo
)
| 是 | 包含Tag技术类型和相关参数,从tag.getTagInfo(want: Want)获取。 |
**返回值:**
|
**类型**
|
**说明**
|
| ----------------- | ------------------------|
|
[
MifareClassicTag
](
js-apis-nfctech.md#mifareclassictag-9
)
| MIFARE Classic类型Tag对象,通过该对象访问MIFARE Classic类型的相关接口。 |
...
...
@@ -268,11 +277,13 @@ getMifareUltralight(tagInfo: [TagInfo](#taginfo)): [MifareUltralightTag](js-apis
| taginfo |
[
TagInfo
](
#taginfo
)
| 是 | 包含Tag技术类型和相关参数,从tag.getTagInfo(want: Want)获取。 |
**返回值:**
|
**类型**
|
**说明**
|
| -------------------- | ---------------------------|
|
[
MifareUltralightTag
](
js-apis-nfctech.md#mifareultralighttag9
)
| MIFARE Ultralight类型Tag对象,通过该对象访问MIFARE Ultralight类型的相关接口。 |
**错误码:**
以下错误码的详细介绍请参见
[
NFC错误码
](
../errorcodes/errorcode-nfc.md
)
。
| 错误码ID | 错误信息|
| ------- | -------|
...
...
@@ -287,11 +298,13 @@ getNdefFormatable(tagInfo: [TagInfo](#taginfo)): [NdefFormatableTag](js-apis-nfc
**系统能力**
:SystemCapability.Communication.NFC.Core
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefFormatableTag
](
js-apis-nfctech.md#ndefformatabletag
)
| NDEF Formatable类型Tag对象,通过该对象访问NDEF Formatable类型的相关接口。 |
**错误码:**
以下错误码的详细介绍请参见
[
NFC错误码
](
../errorcodes/errorcode-nfc.md
)
。
| 错误码ID | 错误信息|
| ------- | -------|
...
...
@@ -306,11 +319,13 @@ getTagInfo(want: [Want](js-apis-application-Want.md#Want)): [TagInfo](#taginfo)
**系统能力**
:SystemCapability.Communication.NFC.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------------------------------- |
| want |
[
Want
](
js-apis-application-Want.md#Want
)
| 是 | 分发Ability时,在系统onCreate入口函数的参数中获取。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
TagInfo
](
#taginfo
)
| TagInfo对象,用于获取不同技术类型的Tag对象。 |
...
...
@@ -331,11 +346,13 @@ makeUriRecord(uri: string): [NdefRecord](#ndefrecord9);
| uri | string | 是 | 写入到NDEF Record里面的数据内容。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefRecord
](
#ndefrecord9
)
| NDEF标签的Record,详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -362,17 +379,20 @@ makeTextRecord(text: string, locale: string): [NdefRecord](#ndefrecord9);
**系统能力**
:SystemCapability.Communication.NFC.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| text | string | 是 | 写入到NDEF Record里面的文本数据内容。 |
| locale | string | 是 | 文本数据内容的编码方式。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefRecord
](
#ndefrecord9
)
| NDEF标签的Record,详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -398,26 +418,29 @@ makeMimeRecord(mimeType: string, mimeData: number[]): [NdefRecord](#ndefrecord9)
根据输入的MIME数据和类型,构建NDEF标签的Record。
**系统能力**
:SystemCapability.Communication.NFC
**系统能力**
:SystemCapability.Communication.NFC
.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| mimeType | string | 是 | 符合RFC规则的MIME类型,比如"text/plain"或"image/jpeg"。 |
| mimeData | number[] | 是 | MIME数据内容,每个number十六进制表示,范围是0x00~0xFF。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefRecord
](
#ndefrecord9
)
| NDEF标签的Record,详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
try
{
let
mimeType
=
"
text/plain
"
;
// change it to be correct.
let
mimeData
=
[
0x01
,
0x02
,
0x03
,
0x04
,
...
];
// change it to be correct.
let
mimeData
=
[
0x01
,
0x02
,
0x03
,
0x04
];
// change it to be correct.
let
ndefRecord
=
tag
.
ndef
.
makeMimeRecord
(
mimeType
,
mimeData
);
if
(
ndefRecord
!=
undefined
)
{
console
.
log
(
"
ndefMessage makeMimeRecord rtdType:
"
+
ndefRecord
.
rtdType
);
...
...
@@ -435,9 +458,10 @@ makeExternalRecord(domainName: string, type: string, externalData: number[]): [N
根据应用程序特定的外部数据,构建NDEF标签的Record。
**系统能力**
:SystemCapability.Communication.NFC
**系统能力**
:SystemCapability.Communication.NFC
.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| domainName | string | 是 | 外部数据发布组织的域名,一般是应用程序的包名。 |
...
...
@@ -445,18 +469,20 @@ makeExternalRecord(domainName: string, type: string, externalData: number[]): [N
| externalData | number[] | 是 | 外部数据内容,每个number十六进制表示,范围是0x00~0xFF。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefRecord
](
#ndefrecord9
)
| NDEF标签的Record,详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
try
{
let
domainName
=
"
ohos.nfc.application
"
;
// change it to be correct.
let
type
=
"
test
"
;
// change it to be correct.
let
externalData
=
[
0x01
,
0x02
,
0x03
,
0x04
,
...
];
// change it to be correct.
let
externalData
=
[
0x01
,
0x02
,
0x03
,
0x04
];
// change it to be correct.
let
ndefRecord
=
tag
.
ndef
.
makeExternalRecord
(
domainName
,
type
,
externalData
);
if
(
ndefRecord
!=
undefined
)
{
console
.
log
(
"
ndefMessage makeExternalRecord rtdType:
"
+
ndefRecord
.
rtdType
);
...
...
@@ -475,19 +501,22 @@ messageToBytes(ndefMessage: [NdefMessage](js-apis-nfctech.md#ndefmessage9)): num
把输入的NDEF消息数据对象,转换为字节格式的数据。
**系统能力**
:SystemCapability.Communication.NFC
**系统能力**
:SystemCapability.Communication.NFC
.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| ndefMessage |
[
NdefMessage
](
js-apis-nfctech.md#ndefmessage9
)
| 是 | NDEF消息数据对象。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| number[] | NDEF消息数据对象,所转换成的字节格式的数据。每个number十六进制表示,范围是0x00~0xFF。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -513,14 +542,16 @@ createNdefMessage(data: number[]): [NdefMessage](js-apis-nfctech.md#ndefmessage9
使用原始字节数据创建NDEF标签的Message。该数据必须符合NDEF Record数据格式,如果不符合格式,则返回的NdeMessage数据对象,所包含的NDE Record列表会为空。
**系统能力**
:SystemCapability.Communication.NFC
**系统能力**
:SystemCapability.Communication.NFC
.Core
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| data | number[] | 是 | 原始字节,每个number十六进制表示,范围是0x00~0xFF。要求必须满足NDEF Record的格式。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefMessage
](
js-apis-nfctech.md#ndefmessage9
)
| NDEF标签的Message,详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
...
...
@@ -548,16 +579,19 @@ createNdefMessage(ndefRecords: NdefRecord[]): [NdefMessage](js-apis-nfctech.md#n
**系统能力**
:SystemCapability.Communication.NFC.Core
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| ndefRecords |
[
NdefRecord
](
js-apis-nfcTag.md#ndefrecord9
)[]
| 是 | NDEF标签的Record列表,详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
|
[
NdefMessage
](
js-apis-nfctech.md#ndefmessage9
)
| NDEF标签的Message,详见NDEF技术规范《NFCForum-TS-NDEF_1.0》。|
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -581,30 +615,30 @@ NFC服务在读取到标签时给出的对象,通过改对象属性,应用
**需要权限**
:ohos.permission.NFC_TAG
|
**
参数名**
|
**类型**
|
**说明**
|
| -------- | -------- | -------- |
| uid
<sup>
9+
</sup>
| number[] | 标签的uid,每个number值是十六进制表示,范围是0x00~0xFF。 |
| technology
<sup>
9+
</sup>
| number[] | 支持的技术类型,每个number值表示所支持技术类型的常量值。 |
| supportedProfiles | number[] | 支持的技术类型,从API9开始不支持,使用technology替代。 |
|
**
名称**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- |
-------- | -------- |
| uid
<sup>
9+
</sup>
| number[] |
是 | 否 |
标签的uid,每个number值是十六进制表示,范围是0x00~0xFF。 |
| technology
<sup>
9+
</sup>
| number[] |
是 | 否 |
支持的技术类型,每个number值表示所支持技术类型的常量值。 |
| supportedProfiles | number[] |
是 | 否 |
支持的技术类型,从API9开始不支持,使用technology替代。 |
## NdefRecord<sup>9+</sup>
NDEF标签Record属性的定义,参考NDEF标签技术规范《NFCForum-TS-NDEF_1.0》的定义细节。
**系统能力**
:SystemCapability.Communication.NFC.Core
|
**
参数名**
|
**类型**
|
**说明**
|
| -------- | -------- | -------- |
| tnf | number | NDEF Record的TNF(Type Name Field)。 |
| rtdType| number[] | NDEF Record的RTD(Record Type Definition)类型值,每个number十六进制表示,范围是0x00~0xFF。 |
| id | number[] | NDEF Record的ID,每个number十六进制表示,范围是0x00~0xFF。|
| payload | number[] | NDEF Record的PAYLOAD,每个number十六进制表示,范围是0x00~0xFF。 |
|
**
名称**
|
**类型**
|
**可读**
|
**可写**
|
**说明**
|
| -------- | -------- | -------- |
-------- | -------- |
| tnf | number |
是 | 否 |
NDEF Record的TNF(Type Name Field)。 |
| rtdType| number[] |
是 | 否 |
NDEF Record的RTD(Record Type Definition)类型值,每个number十六进制表示,范围是0x00~0xFF。 |
| id | number[] |
是 | 否 |
NDEF Record的ID,每个number十六进制表示,范围是0x00~0xFF。|
| payload | number[] |
是 | 否 |
NDEF Record的PAYLOAD,每个number十六进制表示,范围是0x00~0xFF。 |
## 技术类型定义
NFC Tag有多种不同的技术类型,定义常量描述不同的技术类型。
**系统能力**
:SystemCapability.Communication.NFC.Core
|
**
参数名**
|
**常量
值**
|
**说明**
|
|
**
名称**
|
**
值**
|
**说明**
|
| -------- | -------- | -------- |
| NFC_A | 1 | NFC-A (ISO 14443-3A)技术。|
| NFC_B | 2 | NFC-A (ISO 14443-3B)技术。|
...
...
@@ -621,7 +655,7 @@ NDEF Record的TNF(Type Name Field)类型值,参考NDEF标签技术规范《NFC
**系统能力**
:SystemCapability.Communication.NFC.Core
|
**
参数名**
|
**常量
值**
|
**说明**
|
|
**
名称**
|
**
值**
|
**说明**
|
| -------- | -------- | -------- |
| TNF_EMPTY | 0x0 | Empty。|
| TNF_WELL_KNOWN | 0x01 | NFC Forum well-known type [NFC RTD]。|
...
...
@@ -636,7 +670,7 @@ NDEF Record的RTD(Record Type Definition)类型值,参考NDEF标签技术规
**系统能力**
:SystemCapability.Communication.NFC.Core
|
**
参数名**
|
**常量
值**
|
**说明**
|
|
**
名称**
|
**
值**
|
**说明**
|
| -------- | -------- | -------- |
| RTD_TEXT
<sup>
9+
</sup>
| [0x54] | 文本类型的NDEF Record。|
| RTD_URI
<sup>
9+
</sup>
| [0x55] | URI类型的NDEF Record。|
...
...
@@ -646,7 +680,7 @@ NFC Forum标准里面Tag类型的定义。
**系统能力**
:SystemCapability.Communication.NFC.Core
|
**
参数名**
|
**常量
值**
|
**说明**
|
|
**
名称**
|
**
值**
|
**说明**
|
| -------- | -------- | -------- |
| NFC_FORUM_TYPE_1 | 1 | NFC论坛类型1。 |
| NFC_FORUM_TYPE_2 | 2 | NFC论坛类型2。 |
...
...
@@ -659,7 +693,7 @@ MIFARE Classic标签类型的定义。
**系统能力**
:SystemCapability.Communication.NFC.Core
|
**
参数名**
|
**常量
值**
|
**说明**
|
|
**
名称**
|
**
值**
|
**说明**
|
| -------- | -------- | -------- |
| TYPE_UNKNOWN | 0 | 未知的MIFARE类型。 |
| TYPE_CLASSIC | 1 | MIFARE Classic类型。|
...
...
@@ -671,7 +705,7 @@ MIFARE Classic标签存储大小的定义。
**系统能力**
:SystemCapability.Communication.NFC.Core
|
**
参数名**
|
**常量
值**
|
**说明**
|
|
**
名称**
|
**
值**
|
**说明**
|
| -------- | -------- | -------- |
| MC_SIZE_MINI | 320 | 每个标签5个扇区,每个扇区4个块。 |
| MC_SIZE_1K | 1024 | 每个标签16个扇区,每个扇区4个块。|
...
...
@@ -683,9 +717,9 @@ MIFARE Ultralight标签类型的定义。
**系统能力**
:SystemCapability.Communication.NFC.Core
|
**
参数名**
|
**常量
值**
|
**说明**
|
|
**
名称**
|
**
值**
|
**说明**
|
| -------- | -------- | -------- |
| TYPE_UNKOWN | 0 | 未知的 MIFARE 类型。 |
| TYPE_UNK
N
OWN | 0 | 未知的 MIFARE 类型。 |
| TYPE_ULTRALIGHT | 1 | MIFARE Ultralight类型。|
| TYPE_ULTRALIGHT_C | 2 | MIFARE UltralightC 类型。 |
<!--no_check-->
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-nfctech.md
浏览文件 @
07c46324
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @
07c46324
...
...
@@ -27,8 +27,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>):
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter |
[
StartAbilityParameter
](
js-apis-featureAbility.md#startabilityparameter
)
| 是 | 指示启动的ability |
| callback | AsyncCallback
\<
void> | 是 | 被指定的回调方法 |
...
...
@@ -59,8 +58,6 @@ particleAbility.startAbility(
)
```
## particleAbility.startAbility
startAbility(parameter: StartAbilityParameter): Promise
\<
void>;
...
...
@@ -71,8 +68,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<void>;
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter |
[
StartAbilityParameter
](
js-apis-featureAbility.md#startabilityparameter
)
| 是 | 指示启动的ability |
...
...
@@ -117,7 +113,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback
\<
void> | 是 | 表示被指定的回调方法 |
...
...
@@ -169,7 +165,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| :--- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
...
...
@@ -386,7 +382,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ------- | -------------- | ---- | ---------------------------- |
| request |
[
Want
](
js-apis-application-Want.md
)
| 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 |
...
...
@@ -396,7 +392,7 @@ connectAbility(request: Want, options:ConnectOptions): number
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
|
名称 | 读写属性 | 类型 | 必填 | 描述
|
|
参数名 | 读写属性 | 类型 | 必填 | 说明
|
| ------------ | ---- | -------- | ---- | ------------------------- |
| onConnect | 只读 | function | 是 | 连接成功时的回调函数。 |
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数。 |
...
...
@@ -546,7 +542,7 @@ particleAbility.disconnectAbility(connId).then((data) => {
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
|
变量
| 值 | 说明 |
|
名称
| 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| INVALID_PARAMETER | -1 | 无效的参数。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md
浏览文件 @
07c46324
...
...
@@ -32,7 +32,7 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ |
| reason | string | 是 | 延迟挂起申请的原因。 |
| callback | Callback
<
void
>
| 是 | 延迟即将超时的回调函数,一般在超时前6秒通过此回调通知应用。 |
...
...
@@ -86,7 +86,7 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>):
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | --------------------------- | ---- | ---------------------------------------- |
| requestId | number | 是 | 延迟挂起的请求ID。 |
| callback | AsyncCallback
<
number
>
| 是 | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 |
...
...
@@ -137,7 +137,7 @@ getRemainingDelayTime(requestId: number): Promise<number>
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。 |
...
...
@@ -188,7 +188,7 @@ cancelSuspendDelay(requestId: number): void
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。 |
...
...
@@ -231,7 +231,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
| bgMode |
[
BackgroundMode
](
#backgroundmode
)
| 是 | 向系统申请的后台模式。 |
...
...
@@ -305,7 +305,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
| bgMode |
[
BackgroundMode
](
#backgroundmode
)
| 是 | 向系统申请的后台模式。 |
...
...
@@ -378,7 +378,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): vo
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动长时任务的结果。 |
...
...
@@ -434,7 +434,7 @@ stopBackgroundRunning(context: Context): Promise<void>
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。
<br>
FA模型的应用Context定义见
[
Context
](
js-apis-Context.md
)
。
<br>
Stage模型的应用Context定义见
[
Context
](
js-apis-ability-context.md
)
。 |
...
...
@@ -492,7 +492,7 @@ applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresour
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ---------------------------------------- |
| request |
[
EfficiencyResourcesRequest
](
#efficiencyresourcesrequest
)
| 是 | 请求的必要信息。包括资源类型,超时时间等信息。详见
[
EfficiencyResourcesRequest
](
#efficiencyresourcesrequest
)
。 |
...
...
@@ -570,7 +570,7 @@ try {
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------------- | ------ | ---- | ---------------------------------------- |
| requestId | number | 是 | 延迟挂起的请求ID。 |
| actualDelayTime | number | 是 | 应用的实际挂起延迟时间,以毫秒为单位。
<br/>
一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000。 |
...
...
@@ -580,7 +580,7 @@ try {
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
|
参数名 | 参数
值 | 描述 |
|
名称 |
值 | 描述 |
| ----------------------- | ---- | --------------------- |
| DATA_TRANSFER | 1 | 数据传输。 |
| AUDIO_PLAYBACK | 2 | 音频播放。 |
...
...
@@ -600,7 +600,7 @@ try {
**系统API**
: 此接口为系统接口。
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------------- | ------ | ---- | ---------------------------------------- |
| resourceTypes | number | 是 | 申请的资源类型。 |
| isApply | boolean | 是 | 申请资源或者是释放资源。 |
...
...
@@ -617,13 +617,13 @@ try {
**系统API**
: 此接口为系统接口。
|
参数名
| 描述 |
| ----------------------- | --------------------- |
| CPU | CPU资源,申请后不被挂起。 |
| COMMON_EVENT | 公共事件,申请后挂起状态下不被代理掉。 |
| TIMER | 计时器,申请后挂起状态下不被代理掉。 |
| WORK_SCHEDULER | 延迟任务,申请后有更长的执行时间。 |
| BLUETOOTH | 蓝牙相关,申请后挂起状态下不被代理掉。 |
| GPS | GPS相关,申请后挂起状态下不被代理掉。 |
| AUDIO | 音频资源,申请后挂起状态下不被代理掉。 |
|
名称 | 值
| 描述 |
| ----------------------- | ----
| ----
----------------- |
| CPU |
1 |
CPU资源,申请后不被挂起。 |
| COMMON_EVENT |
2 |
公共事件,申请后挂起状态下不被代理掉。 |
| TIMER |
4 |
计时器,申请后挂起状态下不被代理掉。 |
| WORK_SCHEDULER |
8 |
延迟任务,申请后有更长的执行时间。 |
| BLUETOOTH |
16 |
蓝牙相关,申请后挂起状态下不被代理掉。 |
| GPS |
32 |
GPS相关,申请后挂起状态下不被代理掉。 |
| AUDIO |
64 |
音频资源,申请后挂起状态下不被代理掉。 |
zh-cn/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md
浏览文件 @
07c46324
...
...
@@ -26,7 +26,7 @@ startWork(work: WorkInfo): void
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------- |
| work |
[
WorkInfo
](
#workinfo
)
| 是 | 指示要添加到执行队列的工作。 |
...
...
@@ -77,7 +77,7 @@ stopWork(work: WorkInfo, needCancel?: boolean): void
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ---------- | --------------------- | ---- | ---------- |
| work |
[
WorkInfo
](
#workinfo
)
| 是 | 指示要停止的工作。 |
| needCancel | boolean | 是 | 是否需要取消的工作。 |
...
...
@@ -127,7 +127,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ---------------------------------------- |
| workId | number | 是 | work的id。 |
| callback | AsyncCallback
\<
[
WorkInfo
](
#workinfo
)
> | 是 | 指定的callback回调方法。如果指定的工作Id有效,则返回从WorkSchedulerService获取的有效工作状态;否则返回null。 |
...
...
@@ -170,7 +170,7 @@ getWorkStatus(workId: number): Promise\<WorkInfo>
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| workId | number | 是 | work的id。 |
...
...
@@ -216,7 +216,7 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------- |
| callback | AsyncCallback
\<
void> | 是 | 指定的callback回调方法。返回与应用程序关联的所有工作。 |
...
...
@@ -326,7 +326,7 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------- |
| workId | number | 是 | work的id。 |
| callback | AsyncCallback
\<
void> | 是 | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。 |
...
...
@@ -372,7 +372,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**参数**
:
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| workId | number | 是 | work的id。 |
...
...
@@ -413,7 +413,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
|
参数名
| 类型 | 必填 | 说明 |
|
名称
| 类型 | 必填 | 说明 |
| --------------- | --------------------------------- | ---- | ---------------- |
| workId | number | 是 | 当前工作的ID |
| bundleName | string | 是 | 延迟任务包名 |
...
...
@@ -437,45 +437,45 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 说明 |
| ---------------------- | ----------------------- |
| NETWORK_TYPE_ANY | 表示这个触发条件是任何类型的网络连接。 |
| NETWORK_TYPE_MOBILE | 表示这个触发条件是Mobile网络连接。 |
| NETWORK_TYPE_WIFI | 表示这个触发条件是Wifi类型的网络连接。 |
| NETWORK_TYPE_BLUETOOTH | 表示这个触发条件是Bluetooth网络连接。 |
| NETWORK_TYPE_WIFI_P2P | 表示这个触发条件是Wifi P2P网络连接。 |
| NETWORK_TYPE_ETHERNET | 表示这个触发条件是有线网络连接。 |
| 名称 |
值 |
说明 |
| ---------------------- | ----
| ----
------------------- |
| NETWORK_TYPE_ANY |
0 |
表示这个触发条件是任何类型的网络连接。 |
| NETWORK_TYPE_MOBILE |
1 |
表示这个触发条件是Mobile网络连接。 |
| NETWORK_TYPE_WIFI |
2 |
表示这个触发条件是Wifi类型的网络连接。 |
| NETWORK_TYPE_BLUETOOTH |
3 |
表示这个触发条件是Bluetooth网络连接。 |
| NETWORK_TYPE_WIFI_P2P |
4 |
表示这个触发条件是Wifi P2P网络连接。 |
| NETWORK_TYPE_ETHERNET |
5 |
表示这个触发条件是有线网络连接。 |
## ChargingType
触发工作的充电类型。
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 说明 |
| ------------------------- | -------------------- |
| CHARGING_PLUGGED_ANY | 表示这个触发条件是任何类型的充电器连接。 |
| CHARGING_PLUGGED_AC | 表示这个触发条件是直流充电器连接。 |
| CHARGING_PLUGGED_USB | 表示这个触发条件是USB充连接。 |
| CHARGING_PLUGGED_WIRELESS | 表示这个触发条件是无线充电器连接。 |
| 名称 |
值 |
说明 |
| ------------------------- | ----
| ----
---------------- |
| CHARGING_PLUGGED_ANY |
0 |
表示这个触发条件是任何类型的充电器连接。 |
| CHARGING_PLUGGED_AC |
1 |
表示这个触发条件是直流充电器连接。 |
| CHARGING_PLUGGED_USB |
2 |
表示这个触发条件是USB充连接。 |
| CHARGING_PLUGGED_WIRELESS |
3 |
表示这个触发条件是无线充电器连接。 |
## BatteryStatus
触发工作的电池状态。
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 说明 |
| -------------------------- | -------------------------- |
| BATTERY_STATUS_LOW | 表示这个触发条件是低电告警。 |
| BATTERY_STATUS_OKAY | 表示这个触发条件是从低电恢复到正常电量。 |
| BATTERY_STATUS_LOW_OR_OKAY | 表示这个触发条件是从低电恢复到正常电量或者低电告警。 |
| 名称 |
值 |
说明 |
| -------------------------- | ----
| ----
---------------------- |
| BATTERY_STATUS_LOW |
0 |
表示这个触发条件是低电告警。 |
| BATTERY_STATUS_OKAY |
1 |
表示这个触发条件是从低电恢复到正常电量。 |
| BATTERY_STATUS_LOW_OR_OKAY |
2 |
表示这个触发条件是从低电恢复到正常电量或者低电告警。 |
## StorageRequest
触发工作的存储状态。
**系统能力**
:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 说明 |
| ------------------------- | ------------------------------ |
| STORAGE_LEVEL_LOW | 表示这个触发条件是存储空间不足。 |
| STORAGE_LEVEL_OKAY | 表示这个触发条件是从存储空间不足恢复到正常。 |
| STORAGE_LEVEL_LOW_OR_OKAY | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 |
\ No newline at end of file
| 名称 | 值 | 说明 |
| ------------------------- | ---- | ------------------------------ |
| STORAGE_LEVEL_LOW | 0 | 表示这个触发条件是存储空间不足。 |
| STORAGE_LEVEL_OKAY | 1 | 表示这个触发条件是从存储空间不足恢复到正常。 |
| STORAGE_LEVEL_LOW_OR_OKAY | 2 | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-stationary.md
0 → 100644
浏览文件 @
07c46324
# 设备状态感知框架
设备状态感知框架提供设备状态感知能力,包括绝对静止和相对静止。
> **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
js
import
deviceStatus
from
'
@ohos.devicestatus
'
```
## ActivityResponse
服务响应抽象接口。
**系统能力**
SystemCapability.Msdp.DeviceStatus.Stationary
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| state |
[
ActivityState
](
#activitystate
)
| 是 | 否 | 设备状态变化返回值。 |
## ActivityType
设备状态类型。
**系统能力**
SystemCapability.Msdp.DeviceStatus.Stationary
| 名称 | 描述 |
| -------- | -------- |
| still | 绝对静止。 |
| relativeStill | 相对静止。 |
## ActivityEvent
设备状态事件。
**系统能力**
SystemCapability.Msdp.DeviceStatus.Stationary
| 变量 | 值 | 说明 |
| ------------------------------ | ---- | ---------------------------------------- |
| ENTER | 1 | 进入。 |
| EXIT | 2 | 退出。 |
| ENTER_EXIT | 3 | 进入和退出。 |
## ActivityState
设备状态返回值。
**系统能力**
SystemCapability.Msdp.DeviceStatus.Stationary
| 变量 | 值 | 说明 |
| ------------------------------ | ---- | ---------------------------------------- |
| ENTER | 1 | 进入。 |
| EXIT | 2 | 退出。 |
## deviceStatus.on('still' | 'relativeStill')
on(activity: ActivityType, event: ActivityEvent, reportLatencyNs: number, callback: Callback
<
ActivityResponse
>
): void
设备状态管理,订阅设备状态服务。
**系统能力**
SystemCapability.Msdp.DeviceStatus.Stationary
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| -------------------- | -------------------------------------------------- | ---- | ---------------------------- |
| activity |
[
ActivityType
](
#activitytype
)
| 是 | 设备状态能力类型。 |
| event |
[
ActivityEvent
](
#activityevent
)
| 是 | 事件类型。 |
| reportLatencyNs | number | 是 | 报告延时。 |
| callback | Callback<
[
ActivityResponse
](
#activityresponse
)
\>
| 是 | 回调函数,接收上报状态变化事件。 |
**示例:**
```
js
var
reportLatencyNs
=
100
;
deviceStatus
.
on
(
'
still
'
,
deviceStatus
.
ActivityEvent
.
ENTER
,
reportLatencyNs
,
(
data
)
=>
{
console
.
log
(
'
data=
'
+
JSON
.
stringify
(
data
));
})
```
## deviceStatus.once('still' | 'relativeStill')
once(activity: ActivityType, callback: Callback
<
ActivityResponse
>
): void
设备状态管理,查询设备状态。
**系统能力**
SystemCapability.Msdp.DeviceStatus.Stationary
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| -------------------- | -------------------------------------------------- | ---- | ---------------------------- |
| activity |
[
ActivityType
](
#activitytype
)
| 是 | 设备状态能力类型。 |
| callback | Callback<
[
ActivityResponse
](
#activityresponse
)
\>
| 是 | 回调函数,接收上报状态变化事件。 |
**示例:**
```
js
deviceStatus
.
once
(
'
still
'
,
(
data
)
=>
{
console
.
log
(
"
data=
"
+
JSON
.
stringify
(
data
));
})
```
## deviceStatus.off('still' | 'relativeStill')
off(activity: ActivityType, event: ActivityEvent, callback?: Callback
<
ActivityResponse
>
): void
设备状态管理,取消订阅设备状态服务。
**系统能力**
SystemCapability.Msdp.DeviceStatus.Stationary
**参数:**
| 名称 | 类型 | 必填 | 说明 |
| -------------------- | -------------------------------------------------- | ---- | ---------------------------- |
| activity |
[
ActivityType
](
#activitytype
)
| 是 | 设备状态能力类型。 |
| event |
[
ActivityEvent
](
#activityevent
)
| 是 | 事件类型。 |
| callback | Callback<
[
ActivityResponse
](
#activityresponse
)
\>
| 否 | 回调函数,接收上报状态变化事件。 |
**示例:**
```
js
deviceStatus
.
off
(
'
still
'
,
deviceStatus
.
ActivityEvent
.
ENTER
);
```
zh-cn/application-dev/reference/apis/js-apis-system-time.md
浏览文件 @
07c46324
...
...
@@ -453,7 +453,7 @@ setTimezone(timezone: string, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | -------------------------- |
| timezone | string | 是 | 系统时区。
|
| timezone | string | 是 | 系统时区。
具体可见
[
支持的系统时区
](
#支持的系统时区
)
。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -482,7 +482,7 @@ setTimezone(timezone: string): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- |
| timezone | string | 是 | 系统时区。 |
| timezone | string | 是 | 系统时区。
具体可见
[
支持的系统时区
](
#支持的系统时区
)
。
|
**返回值:**
...
...
@@ -512,7 +512,7 @@ getTimezone(callback: AsyncCallback<string>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------- | ---- | ------------------------ |
| callback | AsyncCallback
<
string
>
| 是 | 回调函数,返回系统时区。 |
| callback | AsyncCallback
<
string
>
| 是 | 回调函数,返回系统时区。
具体可见
[
支持的系统时区
](
#支持的系统时区
)
。
|
**示例:**
...
...
@@ -538,7 +538,7 @@ getTimezone(): Promise<string>
| 类型 | 说明 |
| --------------------- | ------------------------------------- |
| Promise
<
string
>
| Promise对象,返回系统时区。 |
| Promise
<
string
>
| Promise对象,返回系统时区。
具体可见
[
支持的系统时区
](
#支持的系统时区
)
。
|
**示例:**
...
...
@@ -548,4 +548,42 @@ systemTime.getTimezone().then((data) => {
}).
catch
((
error
)
=>
{
console
.
error
(
`Failed to get system time zone. Cause:`
+
JSON
.
stringify
(
error
));
});
```
\ No newline at end of file
```
## 支持的系统时区
支持的系统时区及各时区与0时区相比的偏移量(单位:h)可见下表。
| 时区 | 偏移量 |
| ------------------------------ | --------------------- |
| Antarctica/McMurdo | 12 |
| America/Argentina/Buenos_Aires | -3 |
| Australia/Sydney | 10 |
| America/Noronha | -2 |
| America/St_Johns | -3 |
| Africa/Kinshasa | 1 |
| America/Santiago | -3 |
| Asia/Shanghai | 8 |
| Asia/Nicosia | 3 |
| Europe/Berlin | 2 |
| America/Guayaquil | -5 |
| Europe/Madrid | 2 |
| Pacific/Pohnpei | 11 |
| America/Godthab | -2 |
| Asia/Jakarta | 7 |
| Pacific/Tarawa | 12 |
| Asia/Almaty | 6 |
| Pacific/Majuro | 12 |
| Asia/Ulaanbaatar | 8 |
| America/Mexico_City | -5 |
| Asia/Kuala_Lumpur | 8 |
| Pacific/Auckland | 12 |
| Pacific/Tahiti | -10 |
| Pacific/Port_Moresby | 10 |
| Asia/Gaza | 3 |
| Europe/Lisbon | 1 |
| Europe/Moscow | 3 |
| Europe/Kiev | 3 |
| Pacific/Wake | 12 |
| America/New_York | -4 |
| Asia/Tashkent | 5 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-system-timer.md
浏览文件 @
07c46324
...
...
@@ -20,7 +20,7 @@ import systemTimer from '@ohos.systemTimer';
| 名称 | 类型 | 值 | 说明 |
| ------------------- | ------ | ---- | ---------------------------- |
| TIMER_TYPE_REALTIME | number | 1 | 系统启动时间定时器。 |
| TIMER_TYPE_REALTIME | number | 1 | 系统启动时间定时器。
(定时器启动时间不能晚于当前设置的系统时间)
|
| TIMER_TYPE_WAKEUP | number | 2 | 唤醒定时器。 |
| TIMER_TYPE_EXACT | number | 4 | 精准定时器。 |
| TIMER_TYPE_IDLE | number | 8 | IDLE模式定时器(暂不支持)。 |
...
...
@@ -33,7 +33,7 @@ import systemTimer from '@ohos.systemTimer';
| 名称 | 类型 | 必填 | 说明 |
| --------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| type | number | 是 | 定时器类型。
<br>
取值为1时,表示为系统启动时间定时器;
<br>
取值为2时,表示为唤醒定时器;
<br>
取值为4时,表示为精准定时器;
<br>
取值为5时,表示为IDLE模式定时器(暂不支持)。 |
| type | number | 是 | 定时器类型。
<br>
取值为1时,表示为系统启动时间定时器
(定时器启动时间不能晚于当前设置的系统时间)
;
<br>
取值为2时,表示为唤醒定时器;
<br>
取值为4时,表示为精准定时器;
<br>
取值为5时,表示为IDLE模式定时器(暂不支持)。 |
| repeat | boolean | 是 | true为循环定时器,false为单次定时器。 |
| interval | number | 否 | 如果是循环定时器,repeat值应大于5000毫秒,非重复定时器置为0。 |
| wantAgent |
[
WantAgent
](
js-apis-wantAgent.md
)
| 否 | 设置通知的WantAgent,定时器到期后通知。(支持拉起应用MainAbility,暂不支持拉起ServiceAbility。) |
...
...
zh-cn/application-dev/reference/apis/js-apis-tagSession.md
浏览文件 @
07c46324
...
...
@@ -30,18 +30,20 @@ getTagInfo(): tag.TagInfo
**系统能力**
:SystemCapability.Communication.NFC.Core
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| TagInfo | NFC服务所提供的Tag数据对象。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', tagInfo is an Object given by nfc service when tag is dispatched.
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
let
tagInfo
=
tag
.
get
XXX
(
tagInfo
).
getTagInfo
();
let
tagInfo
=
tag
.
get
IsoDep
(
tagInfo
).
getTagInfo
();
console
.
log
(
"
tag tagInfo:
"
+
tagInfo
);
```
...
...
@@ -56,18 +58,20 @@ connectTag(): boolean;
**系统能力**
:SystemCapability.Communication.NFC.Core
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| boolean | 连接建立成功返回true,失败返回false。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', tagInfo is an Object given by nfc service when tag is dispatched.
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
let
connectStatus
=
tag
.
get
XXX
(
tagInfo
).
connectTag
();
let
connectStatus
=
tag
.
get
IsoDep
(
tagInfo
).
connectTag
();
console
.
log
(
"
connectStatus:
"
+
connectStatus
);
```
...
...
@@ -82,13 +86,14 @@ reset(): void
**系统能力**
:SystemCapability.Communication.NFC.Core
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', tagInfo is an Object given by nfc service when tag is dispatched.
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
tag
.
get
XXX
(
tagInfo
).
reset
();
tag
.
get
IsoDep
(
tagInfo
).
reset
();
```
### tagSession.isTagConnected
...
...
@@ -102,18 +107,20 @@ isTagConnected(): boolean
**系统能力**
:SystemCapability.Communication.NFC.Core
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| boolean | 已建立连接返回 true,未建立连接返回false。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', tagInfo is an Object given by nfc service when tag is dispatched.
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
let
isTagConnected
=
tag
.
get
XXX
(
tagInfo
).
isTagConnected
();
let
isTagConnected
=
tag
.
get
IsoDep
(
tagInfo
).
isTagConnected
();
console
.
log
(
"
isTagConnected:
"
+
isTagConnected
);
```
...
...
@@ -128,6 +135,7 @@ getMaxSendLength(): number
**系统能力**
:SystemCapability.Communication.NFC.Core
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| number | 可以发送到标签的最大数据长度,非负数。 |
...
...
@@ -139,7 +147,7 @@ import tag from '@ohos.nfc.tag';
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', tagInfo is an Object given by nfc service when tag is dispatched.
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
let
maxSendLen
=
tag
.
get
XXX
(
tagInfo
).
getMaxSendLength
();
let
maxSendLen
=
tag
.
get
IsoDep
(
tagInfo
).
getMaxSendLength
();
console
.
log
(
"
tag maxSendLen:
"
+
maxSendLen
);
```
...
...
@@ -154,18 +162,20 @@ getSendDataTimeout(): number
**系统能力**
:SystemCapability.Communication.NFC.Core
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| number | 发送数据到Tag的等待超时时间,单位是毫秒,非负数。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
// see 'tag.TagInfo' at 'js-apis-nfcTag.md', tagInfo is an Object given by nfc service when tag is dispatched.
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
let
sendDataTimeout
=
tag
.
get
XXX
(
tagInfo
).
getSendDataTimeout
();
let
sendDataTimeout
=
tag
.
get
IsoDep
(
tagInfo
).
getSendDataTimeout
();
console
.
log
(
"
tag sendDataTimeout:
"
+
sendDataTimeout
);
```
...
...
@@ -180,11 +190,13 @@ setSendDataTimeout(timeout: number): boolean
**系统能力**
:SystemCapability.Communication.NFC.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| timeout | number | 是 | 超时时间,单位毫秒,非负值。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| boolean | 设置超时时间成功返回true,设置失败返回false。 |
...
...
@@ -198,7 +210,7 @@ import tag from '@ohos.nfc.tag';
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
let
timeoutMs
=
700
;
// change it to be correct.
let
setStatus
=
tag
.
get
XXX
(
tagInfo
).
setSendDataTimeout
(
timeoutMs
);
let
setStatus
=
tag
.
get
IsoDep
(
tagInfo
).
setSendDataTimeout
(
timeoutMs
);
console
.
log
(
"
tag setSendDataTimeout setStatus:
"
+
setStatus
);
```
...
...
@@ -210,19 +222,22 @@ sendData(data: number[]): Promise<number[]>
**需要权限**
:ohos.permission.NFC_TAG
**系统能力**
:SystemCapability.Communication.NFC
**系统能力**
:SystemCapability.Communication.NFC
.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| data | number[] | 是 | 要发送的指令。每个number十六进制表示,范围是0x00~0xFF。 |
**返回值:**
|
**类型**
|
**说明**
|
| ------------------ | --------------------------|
| Promise
<number
[]
>
| 对端Tag对指令的响应数据。每个number十六进制表示,范围是0x00~0xFF。|
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -230,15 +245,15 @@ import tag from '@ohos.nfc.tag';
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
// connect the tag at first if not connected.
if
(
!
tag
.
get
XXX
(
tagInfo
).
isTagConnected
())
{
if
(
!
tag
.
get
XXX
(
tagInfo
).
connectTag
())
{
if
(
!
tag
.
get
IsoDep
(
tagInfo
).
isTagConnected
())
{
if
(
!
tag
.
get
IsoDep
(
tagInfo
).
connectTag
())
{
console
.
log
(
"
tagSession connectTag failed.
"
);
return
;
}
}
let
cmdData
=
[
0x01
,
0x02
,
...
];
// change the raw data to be correct.
tag
.
get
XXX
(
tagInfo
).
sendData
(
cmdData
).
then
((
response
)
=>
{
let
cmdData
=
[
0x01
,
0x02
,
0x03
,
0x04
];
// change the raw data to be correct.
tag
.
get
IsoDep
(
tagInfo
).
sendData
(
cmdData
).
then
((
response
)
=>
{
console
.
log
(
"
tagSession sendData Promise response:
"
+
response
);
}).
catch
((
err
)
=>
{
console
.
log
(
"
tagSession sendData Promise err:
"
+
err
);
...
...
@@ -253,15 +268,17 @@ sendData(data: number[], callback: AsyncCallback<number[]>): void
**需要权限**
:ohos.permission.NFC_TAG
**系统能力**
:SystemCapability.Communication.NFC
**系统能力**
:SystemCapability.Communication.NFC
.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| data | number[] | 是 | 要发送的指令。每个number十六进制表示,范围是0x00~0xFF。 |
| callback | AsyncCallback
<number
[]
>
| 是 | 回调函数,返回响应数据。每个number十六进制表示,范围是0x00~0xFF。 |
**示例:**
```
js
import
tag
from
'
@ohos.nfc.tag
'
;
...
...
@@ -269,15 +286,15 @@ import tag from '@ohos.nfc.tag';
// the folowing getXXX, can be one of getIsoDep, getNdef, getMifareClassic, ...
// connect the tag at first if not connected.
if
(
!
tag
.
get
XXX
(
tagInfo
).
isTagConnected
())
{
if
(
!
tag
.
get
XXX
(
tagInfo
).
connectTag
())
{
if
(
!
tag
.
get
IsoDep
(
tagInfo
).
isTagConnected
())
{
if
(
!
tag
.
get
IsoDep
(
tagInfo
).
connectTag
())
{
console
.
log
(
"
tagSession connectTag failed.
"
);
return
;
}
}
let
cmdData
=
[
0x01
,
0x02
,
...
];
// change the raw data to be correct.
tag
.
get
XXX
(
tagInfo
).
sendData
(
cmdData
,
(
err
,
response
)
=>
{
let
cmdData
=
[
0x01
,
0x02
,
0x03
,
0x04
];
// change the raw data to be correct.
tag
.
get
IsoDep
(
tagInfo
).
sendData
(
cmdData
,
(
err
,
response
)
=>
{
if
(
err
)
{
console
.
log
(
"
tagSession sendData AsyncCallback err:
"
+
err
);
}
else
{
...
...
zh-cn/application-dev/reference/apis/js-apis-userFileManager.md
浏览文件 @
07c46324
...
...
@@ -1309,7 +1309,7 @@ getThumbnail(size: image.Size, callback: AsyncCallback<image.PixelMap>): v
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ---------------- |
| size |
Size
| 是 | 缩略图尺寸 |
| size |
[
image.Size
](
js-apis-image.md#size
)
| 是 | 缩略图尺寸 |
| callback | AsyncCallback
<
[image.PixelMap](js-apis-image.md#pixelmap7)
>
| 是 | 回调返回缩略图的PixelMap |
**示例:**
...
...
@@ -1352,7 +1352,7 @@ getThumbnail(size?: image.Size): Promise<image.PixelMap>
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------- | ---- | ----- |
| size |
Size
| 否 | 缩略图尺寸 |
| size |
[
image.Size
](
js-apis-image.md#size
)
| 否 | 缩略图尺寸 |
**返回值:**
...
...
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
浏览文件 @
07c46324
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-webview.md
浏览文件 @
07c46324
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
0 → 100644
浏览文件 @
07c46324
此差异已折叠。
点击以展开。
zh-cn/application-dev/security/cryptoFramework-guidelines.md
浏览文件 @
07c46324
...
...
@@ -13,7 +13,7 @@
1.
随机生成算法库密钥对象。该对象可用于后续的加解密等操作。
2.
根据指定数据生成算法库密钥对象(也就是将外部或存储的二进制数据转换为算法库的密钥对象)。该对象可用于后续的加解密等操作。
3.
获取算法库密钥对象的二进制数据,用于存储或传输。
> **说明**:密钥对象Key包括对称密钥SymKey和非对称密钥(公钥PubKey和私钥PriKey),其中公钥和私钥组成密钥对KeyPair。密钥之间的具体关系可参考[
接口声明
](../reference/apis/js-apis-cryptoFramework.md)。
> **说明**:密钥对象Key包括对称密钥SymKey和非对称密钥(公钥PubKey和私钥PriKey),其中公钥和私钥组成密钥对KeyPair。密钥之间的具体关系可参考[
API参考
](../reference/apis/js-apis-cryptoFramework.md)。
**接口及参数说明**
...
...
@@ -107,7 +107,7 @@ function testGenerateAesKey() {
import
cryptoFramework
from
'
@ohos.security.cryptoFramework
'
;
function
convertAsyKey
()
{
let
rsaGenerator
=
c
fm
.
createAsyKeyGenerator
(
"
RSA1024
"
);
let
rsaGenerator
=
c
ryptoFramework
.
createAsyKeyGenerator
(
"
RSA1024
"
);
let
pkval
=
new
Uint8Array
([
48
,
129
,
159
,
48
,
13
,
6
,
9
,
42
,
134
,
72
,
134
,
247
,
13
,
1
,
1
,
1
,
5
,
0
,
3
,
129
,
141
,
0
,
48
,
129
,
137
,
2
,
129
,
129
,
0
,
174
,
203
,
113
,
83
,
113
,
3
,
143
,
213
,
194
,
79
,
91
,
9
,
51
,
142
,
87
,
45
,
97
,
65
,
136
,
24
,
166
,
35
,
5
,
179
,
42
,
47
,
212
,
79
,
111
,
74
,
134
,
120
,
73
,
67
,
21
,
19
,
235
,
80
,
46
,
152
,
209
,
133
,
232
,
87
,
192
,
140
,
18
,
206
,
27
,
106
,
106
,
169
,
106
,
46
,
135
,
111
,
118
,
32
,
129
,
27
,
89
,
255
,
183
,
116
,
247
,
38
,
12
,
7
,
238
,
77
,
151
,
167
,
6
,
102
,
153
,
126
,
66
,
28
,
253
,
253
,
216
,
64
,
20
,
138
,
117
,
72
,
15
,
216
,
178
,
37
,
208
,
179
,
63
,
204
,
39
,
94
,
244
,
170
,
48
,
190
,
21
,
11
,
73
,
169
,
156
,
104
,
193
,
3
,
17
,
100
,
28
,
60
,
50
,
92
,
235
,
218
,
57
,
73
,
119
,
19
,
101
,
164
,
192
,
161
,
197
,
106
,
105
,
73
,
2
,
3
,
1
,
0
,
1
]);
let
pkBlob
=
{
data
:
pkval
};
rsaGenerator
.
convertKey
(
pkBlob
,
null
,
function
(
err
,
keyPair
)
{
...
...
zh-cn/device-dev/kernel/figures/zh-cn_image-20220915140627223.png
查看替换文件 @
599b3e15
浏览文件 @
07c46324
14.3 KB
|
W:
|
H:
13.7 KB
|
W:
|
H:
2-up
Swipe
Onion skin
zh-cn/device-dev/kernel/kernel-standard-newip.md
浏览文件 @
07c46324
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录