Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
478aa079
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
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看板
提交
478aa079
编写于
3月 22, 2022
作者:
H
HelloCrease
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update test error
Signed-off-by:
N
HelloCrease
<
lian15@huawei.com
>
上级
76e65e91
变更
8
展开全部
显示空白变更内容
内联
并排
Showing
8 changed file
with
2462 addition
and
2458 deletion
+2462
-2458
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+571
-571
zh-cn/application-dev/reference/apis/js-apis-i18n.md
zh-cn/application-dev/reference/apis/js-apis-i18n.md
+483
-483
zh-cn/application-dev/reference/apis/js-apis-intl.md
zh-cn/application-dev/reference/apis/js-apis-intl.md
+240
-240
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
...pplication-dev/reference/apis/js-apis-resource-manager.md
+218
-208
zh-cn/application-dev/reference/apis/js-apis-sensor.md
zh-cn/application-dev/reference/apis/js-apis-sensor.md
+722
-728
zh-cn/application-dev/reference/apis/js-apis-update.md
zh-cn/application-dev/reference/apis/js-apis-update.md
+104
-104
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
+50
-50
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
...n/application-dev/reference/apis/js-apis-workScheduler.md
+74
-74
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
478aa079
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @
478aa079
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-intl.md
浏览文件 @
478aa079
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
浏览文件 @
478aa079
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-sensor.md
浏览文件 @
478aa079
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @
478aa079
...
...
@@ -31,14 +31,14 @@ getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ----
----
|
| ----------- | --------------------------- | ---- | ---- |
| upgradeFile | string | 是 | 升级文件 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是 | 升级类型 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ----
----
|
| ------------------- | ---- |
|
[
Updater
](
#updater
)
| 升级对象 |
**示例:**
...
...
@@ -62,7 +62,7 @@ getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | -----
-----
|
| ----------- | --------------------------- | ---- | ----- |
| upgradeFile | string | 是 | 升级文件 |
| device | string | 是 | 待升级设备 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是 | 升级类型 |
...
...
@@ -70,7 +70,7 @@ getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes
**返回值:**
| 类型 | 说明 |
| ------------------- | ----
----
|
| ------------------- | ---- |
|
[
Updater
](
#updater
)
| 升级对象 |
**示例:**
...
...
@@ -94,7 +94,7 @@ getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateType
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | -----
-----
|
| ----------- | --------------------------- | ---- | ----- |
| upgradeFile | string | 是 | 升级文件 |
| device | string | 是 | 待升级设备 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是 | 升级类型 |
...
...
@@ -102,7 +102,7 @@ getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateType
**返回值:**
| 类型 | 说明 |
| ------------------- | ----
----
|
| ------------------- | ---- |
|
[
Updater
](
#updater
)
| 升级对象 |
**示例:**
...
...
@@ -128,7 +128,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------
-------- | ---- | ---------
--------- |
| -------- | ----------------------------------------
| ---- |
--------- |
| callback | AsyncCallback
<
[
NewVersionInfo
](
#newversioninfo
)
>
| 否 | 回调返回新版本信息 |
**示例:**
...
...
@@ -153,7 +153,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
**返回值:**
| 类型 | 说明 |
| ----------------------------------------
--- | ---------
---------------- |
| ----------------------------------------
|
---------------- |
| Promise
\<
[
NewVersionInfo
](
#newversioninfo
)
> | Promise,用于异步获取结果 |
**示例:**
...
...
@@ -179,7 +179,7 @@ checkNewVersion(callback: AsyncCallback\<NewVersionInfo>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------
--------- | ---- | ---------
--------- |
| -------- | ----------------------------------------
| ---- |
--------- |
| callback | AsyncCallback
\<
[
NewVersionInfo
](
#newversioninfo
)
> | 否 | 回调返回新版本信息 |
**示例:**
...
...
@@ -204,7 +204,7 @@ checkNewVersion(): Promise\<NewVersionInfo>
**返回值:**
| 类型 | 说明 |
| ----------------------------------------
--- | ---------
---------------- |
| ----------------------------------------
|
---------------- |
| Promise
\<
[
NewVersionInfo
](
#newversioninfo
)
> | Promise函数返回新版本信息 |
**示例:**
...
...
@@ -230,7 +230,7 @@ verifyUpdatePackage(upgradeFile: string, certsFile: string): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---------
---------
|
| ----------- | ------ | ---- | --------- |
| upgradeFile | string | 是 | 待校验的升级包路径 |
| certsFile | string | 是 | 证书路径 |
...
...
@@ -254,7 +254,7 @@ rebootAndCleanUserData(): Promise\<number>
**返回值:**
| 类型 | 说明 |
| ---------------- | -------------------
------------
|
| ---------------- | ------------------- |
| Promise
\<
number> | Promise示例,用于异步获取结果。 |
**示例:**
...
...
@@ -300,7 +300,7 @@ applyNewVersion(): Promise\<number>
**返回值:**
| 类型 | 说明 |
| ---------------- | -------------------
------------
|
| ---------------- | ------------------- |
| Promise
\<
number> | Promise示例,用于异步获取结果。 |
**示例:**
...
...
@@ -356,7 +356,7 @@ updater.download();
### upgrade
up
dater.up
grade():void
upgrade():void
启动升级。
...
...
@@ -384,7 +384,7 @@ setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\<number>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ------
------
|
| -------- | ----------------------------- | ---- | ------ |
| policy |
[
UpdatePolicy
](
#updatepolicy
)
| 是 | 设置升级策略 |
| callback | AsyncCallback
\<
number> | 是 | 回调返回结果 |
...
...
@@ -415,13 +415,13 @@ setUpdatePolicy(policy: UpdatePolicy): Promise\<number>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | ------
------
|
| ------ | ----------------------------- | ---- | ------ |
| policy |
[
UpdatePolicy
](
#updatepolicy
)
| 是 | 设置升级策略 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ---------------
--------
|
| ---------------- | --------------- |
| Promise
\<
number> | Promise函数返回设置结果 |
**示例:**
...
...
@@ -452,7 +452,7 @@ getUpdatePolicy(callback: AsyncCallback\<UpdatePolicy>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------
----- | ---- | ----------
---------- |
| -------- | ----------------------------------------
| ---- |
---------- |
| callback | AsyncCallback
\<
[
UpdatePolicy
](
#updatepolicy
)
> | 否 | 回调返回升级策略信息 |
**示例:**
...
...
@@ -477,7 +477,7 @@ getUpdatePolicy(): Promise\<UpdatePolicy>
**返回值:**
| 类型 | 说明 |
| --------------------------------------- | -----------------
----------
|
| --------------------------------------- | ----------------- |
| Promise
\<
[
UpdatePolicy
](
#updatepolicy
)
> | Promise函数返回升级策略信息 |
**示例:**
...
...
@@ -499,7 +499,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**
:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 说明 |
| -----
- | ---
----- |
| -----
|
----- |
| OTA | OTA升级 |
| patch | 补丁升级 |
...
...
@@ -510,7 +510,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**
:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| -------------------- | ----
-- | -------
------- |
| -------------------- | ----
|
------- |
| PACKAGE_TYPE_NORMAL | 1 | 通用升级包 |
| PACKAGE_TYPE_BASE | 2 | 基础升级包 |
| PACKAGE_TYPE_CUST | 3 | 定制升级包 |
...
...
@@ -526,7 +526,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**
:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ----
-- | ----
---- |
| ------------------- | ----
|
---- |
| INSTALL_MODE_NORMAL | 0 | 正常升级 |
| INSTALL_MODE_NIGHT | 1 | 夜间升级 |
| INSTALL_MODE_AUTO | 2 | 自动升级 |
...
...
@@ -538,7 +538,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**
:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ----
-- | --------
-------- |
| ------------------- | ----
|
-------- |
| VERSION_STATUS_ERR | -1 | 检测版本时出错 |
| VERSION_STATUS_NEW | 0 | 检测到新版本 |
| VERSION_STATUS_NONE | 1 | 没有检测到新版本 |
...
...
@@ -551,7 +551,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**
:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | -------
-------
|
| ------------------- | --------------------------- | ---- | ------- |
| autoDownload | bool | 是 | 自动升级开关 |
| installMode |
[
InstallMode
](
#installmode
)
| 是 | 安装模式 |
| autoUpgradeInterval | Array
\<
number> | 是 | 自动升级时间段 |
...
...
@@ -563,7 +563,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**
:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ----------------------------------------
--- | ---- | ----
---- |
| --------------- | ----------------------------------------
| ---- |
---- |
| status |
[
NewVersionStatus
](
#newversionstatus
)
| 是 | 升级状态 |
| errMsg | string | 是 | 错误信息 |
| checkResults | Array
<
[
CheckResult
](
#checkresult
)
>
| 是 | 检测结果 |
...
...
@@ -576,7 +576,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**
:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ----------------------------- | ---- | ------
------
|
| ------------- | ----------------------------- | ---- | ------ |
| versionName | string | 是 | 版本名称 |
| versionCode | number | 是 | 版本编码 |
| size | number | 是 | 版本大小 |
...
...
@@ -591,6 +591,6 @@ update.getUpdatePolicy().then(value => {
**系统能力**
:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------
-- | ---- | ----
------------- |
| ------------- | ------
| ---- |
------------- |
| descriptionId | string | 是 | 版本versionId信息 |
| content | string | 是 | 版本changelog信息 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @
478aa079
...
...
@@ -22,18 +22,18 @@ vibrate(duration: number): Promise<void>
**系统能力**
:SystemCapability.Sensors.MiscDevice
-
参数:
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| duration | number | 是
| 指示马达振动的持续时间。 |
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ----
-------- |
| duration | number | 是
| 指示马达振动的持续时间。 |
-
返回值:
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
void
>
| 指示触发振动是否成功。 |
**返回值:**
| 类型 | 说明
|
| ------------------- | ---
-------- |
| Promise
<
void
>
| 指示触发振动是否成功。 |
-
示例:
**示例:**
```
vibrator.vibrate(1000).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
...
...
@@ -53,13 +53,13 @@ vibrate(duration: number, callback?: AsyncCallback<void>): void
**系统能力**
:SystemCapability.Sensors.MiscDevice
-
参数:
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| duration | number | 是 | 指示马达振动的持续时间。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达执行振动的回调函数,指示触发振动是否成功。 |
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ---------------
-------- |
| duration | number | 是 | 指示马达振动的持续时间。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达执行振动的回调函数,指示触发振动是否成功。 |
-
示例:
**示例:**
```
vibrator.vibrate(1000,function(error){
if(error){
...
...
@@ -81,17 +81,17 @@ vibrate(effectId: EffectId): Promise<void>
**系统能力**
:SystemCapability.Sensors.MiscDevice
-
参数:
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| effectId |
[
EffectId
](
#effectid
)
| 是
| 指示马达振动效果的字符串。 |
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | -----
-------- |
| effectId |
[
EffectId
](
#effectid
)
| 是
| 指示马达振动效果的字符串。 |
-
返回值:
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
void
>
| 指示触发振动是否成功。 |
**返回值:**
| 类型 | 说明
|
| ------------------- | ---
-------- |
| Promise
<
void
>
| 指示触发振动是否成功。 |
-
示例:
**示例:**
```
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
...
...
@@ -111,13 +111,13 @@ vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void
**系统能力**
:SystemCapability.Sensors.MiscDevice
-
参数:
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 指示马达振动效果的字符串。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达执行振动的回调函数,指示触发振动是否成功。 |
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ---------------
-------- |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 指示马达振动效果的字符串。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达执行振动的回调函数,指示触发振动是否成功。 |
-
示例:
**示例:**
```
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
if(error){
...
...
@@ -139,17 +139,17 @@ stop(stopMode: VibratorStopMode): Promise<void>
**系统能力**
:SystemCapability.Sensors.MiscDevice
-
参数:
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是
| 指示马达要停止指定的振动模式。 |
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------------------- | ---- | -------
-------- |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是
| 指示马达要停止指定的振动模式。 |
-
返回值:
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
void
>
| 指示停止振动是否成功。 |
**返回值:**
| 类型 | 说明
|
| ------------------- | ---
-------- |
| Promise
<
void
>
| 指示停止振动是否成功。 |
-
示例:
**示例:**
```
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
...
...
@@ -169,13 +169,13 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;
**系统能力**
:SystemCapability.Sensors.MiscDevice
-
参数:
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 指示马达要停止指定的振动模式。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达停止振动的回调函数,指示停止振动是否成功。 |
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------------------- | ---- | ---------------
-------- |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 指示马达要停止指定的振动模式。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达停止振动的回调函数,指示停止振动是否成功。 |
-
示例:
**示例:**
```
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){
...
...
@@ -194,7 +194,7 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| --------
| -------- |
-------- |
| --------
---------- | -------------------- | -------
-------- |
| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | 调整定时器时振动器的振动效果。 |
...
...
@@ -205,6 +205,6 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| --------
| -------- |
-------- |
| --------
----------------- | -------- | --------------------------------
-------- |
| VIBRATOR_STOP_MODE_TIME | "time" | 停止模式为duration模式的振动。即触发振动时参数类型为number,参数本身为指示振动持续时间的触发方式。 |
| VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId,参数本身为指示马达振动效果的字符串的触发方式。 |
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
浏览文件 @
478aa079
...
...
@@ -20,13 +20,13 @@ startWork(work: WorkInfo): boolean
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ----
---- | -------- | -------- |
-------- |
| ----
| --------------------- | ---- | ------
-------- |
| work |
[
WorkInfo
](
#workinfo
)
| 是 | 指示要添加到执行队列的工作。 |
**返回值**
:
| 类型 | 说明 |
| -------
- |
-------- |
| -------
| ------------------------
-------- |
| boolean | 如果工作成功添加到执行队列,则返回true,否则返回false。 |
**示例**
:
...
...
@@ -55,14 +55,14 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| --------
| -------- | -------- |
-------- |
| --------
-- | --------------------- | ---- | --
-------- |
| work |
[
WorkInfo
](
#workinfo
)
| 是 | 指示要停止的工作。 |
|
needCancel|boolean| 是| 是否需要取消的工作。
|
|
needCancel | boolean | 是 | 是否需要取消的工作。
|
**返回值**
:
| 类型 | 说明 |
| -------
- |
-------- |
| -------
| ---------------
-------- |
| boolean | 如果成功,则返回true,否则返回false。 |
**示例**
:
...
...
@@ -91,9 +91,9 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------
| -------- |
-------- |
| -------- | --------
----------------------------- | ---- | --------------------------------
-------- |
| workId | number | 是 | work的id。 |
|
callback|AsyncCallback
\<
[
WorkInfo
](
#workinfo
)
>| 是| 指定的callback回调方法。如果指定的工作Id有效,则返回从WorkSchedulerService获取的有效工作状态;否则返回null。
|
|
callback | AsyncCallback
\<
[
WorkInfo
](
#workinfo
)
> | 是 | 指定的callback回调方法。如果指定的工作Id有效,则返回从WorkSchedulerService获取的有效工作状态;否则返回null。
|
**示例**
:
...
...
@@ -110,7 +110,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
```
## workScheduler.getWorkStatus
getWorkStatus(workI
D
: number): Promise
\<
WorkInfo>
getWorkStatus(workI
d
: number): Promise
\<
WorkInfo>
获取工作的最新状态,使用Promise形式返回。
...
...
@@ -119,13 +119,13 @@ getWorkStatus(workID: number): Promise\<WorkInfo>
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ------
-- | -------- | ----
---- | -------- |
| ------
| ------ |
---- | -------- |
| workId | number | 是 | work的id。 |
**返回值**
:
| 类型 | 说明 |
| --------
|
-------- |
| --------
----------------------- | --------------------------------
-------- |
| Promise
\<
[
WorkInfo
](
#workinfo
)
> | 指定的Promise回调方法。如果指定的工作ID有效,则返回从WorkSchedulerService获取的有效工作状态;否则返回null。 |
**示例**
:
...
...
@@ -150,13 +150,13 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------
| -------- |
-------- |
|
callback|AsyncCallback
\<
void>| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。
|
| -------- | --------
------------ | ---- | -----------------------
-------- |
|
callback | AsyncCallback
\<
void> | 是 | 指定的callback回调方法。返回与应用程序关联的所有工作。
|
**返回值**
:
| 类型 | 说明 |
| --------
|
-------- |
| --------
--------------------- | -------
-------- |
| Array
\<
[
WorkInfo
](
#workinfo
)
> | 返回与应用程序关联的所有工作。 |
**示例**
:
...
...
@@ -181,8 +181,8 @@ obtainAllWorks(): Promise<Array\<WorkInfo>>
**返回值**
:
| 类型 | 说明 |
| --------
|
-------- |
| Promise
<Array
\<[
WorkInfo
](
#workinfo
)
>
> |
指定的Promise回调方法。返回与应用程序关联的所有工作。
|
| --------
------------------------------ | ----------------------
-------- |
| Promise
<Array
\<[
WorkInfo
](
#workinfo
)
>
> |
指定的Promise回调方法。返回与应用程序关联的所有工作。
|
**示例**
:
...
...
@@ -218,14 +218,14 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------
| -------- |
-------- |
| -------- | --------
------------ | ---- | --------------------------------
-------- |
| workId | number | 是 | work的id。 |
|
callback|AsyncCallback
\<
void>| 是| 指定的callback回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。
|
|
callback | AsyncCallback
\<
void> | 是 | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。
|
**返回值**
:
| 类型 | 说明 |
| -------
- |
-------- |
| -------
| --------------------------------
-------- |
| boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。 |
**示例**
:
...
...
@@ -250,14 +250,14 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**参数**
:
| 参数名 | 类型 | 必填 | 说明 |
| ------
-- | -------- | ----
---- | -------- |
| ------
| ------ |
---- | -------- |
| workId | number | 是 | work的id。 |
**返回值**
:
| 类型 | 说明 |
| --------
|
-------- |
| Promise
\<
boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。|
| --------
--------- | --------------------------------
-------- |
| Promise
\<
boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。
|
**示例**
:
...
...
@@ -277,56 +277,56 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**系统能力**
:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
| 参数名 | 类型 | 必填 | 说明 |
| --------
| -------- | -------- |
-------- |
|
workId |number |是 |当前工作的ID
|
|
bundleName |string |是| 延迟任务包名
|
|
abilityName | string| 是| 延迟任务回调通知的组件名(必填)
|
|
networkType |
[
NetworkType
](
#networktype
)
| 否| 网络类型
|
|
isCharging | boolean| 否|是否充电
|
|
chargerType |
[
ChargingType
](
#chargingtype
)
| 否|充电类型
|
|
batteryLevel | number| 否|电量
|
|
batteryStatus|
[
BatteryStatus
](
#batterystatus
)
| 否|电池状态
|
|
storageRequest|
[
StorageRequest
](
#storagerequest
)
| 否|存储状态
|
|
isRepeat|boolean|否|是否循环任务
|
|
repeatCycleTime |number|否|循环间隔
|
|
repeatCount |number|否|循环次数
|
| --------
------- | --------------------------------- | ---- | --------
-------- |
|
workId | number | 是 | 当前工作的ID
|
|
bundleName | string | 是 | 延迟任务包名
|
|
abilityName | string | 是 | 延迟任务回调通知的组件名(必填)
|
|
networkType |
[
NetworkType
](
#networktype
)
| 否 | 网络类型
|
|
isCharging | boolean | 否 | 是否充电
|
|
chargerType |
[
ChargingType
](
#chargingtype
)
| 否 | 充电类型
|
|
batteryLevel | number | 否 | 电量
|
|
batteryStatus |
[
BatteryStatus
](
#batterystatus
)
| 否 | 电池状态
|
|
storageRequest |
[
StorageRequest
](
#storagerequest
)
| 否 | 存储状态
|
|
isRepeat | boolean | 否 | 是否循环任务
|
|
repeatCycleTime | number | 否 | 循环间隔
|
|
repeatCount | number | 否 | 循环次数
|
## NetworkType
触发工作的网络类型。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明
|
| -------- | -------- |
-------- |
|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 |表示这个触发条件是有线网络连接。
|
| 名称 | 默认值 | 说明
|
| ---------------------- | ---- | ---------------
-------- |
| 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 |0| 表示这个触发条件是任何类型的充电器连接。
|
|CHARGING_PLUGGED_AC |1 |表示这个触发条件是直流充电器连接。
|
|CHARGING_PLUGGED_USB |2 |表示这个触发条件是USB充连接。
|
|CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。
|
| 名称 | 默认值 | 说明
|
| ------------------------- | ---- | ------------
-------- |
| CHARGING_PLUGGED_ANY | 0 | 表示这个触发条件是任何类型的充电器连接。
|
| CHARGING_PLUGGED_AC | 1 | 表示这个触发条件是直流充电器连接。
|
| CHARGING_PLUGGED_USB | 2 | 表示这个触发条件是USB充连接。
|
| CHARGING_PLUGGED_WIRELESS | 3 | 表示这个触发条件是无线充电器连接。
|
## BatteryStatus
触发工作的电池状态。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明
|
| -------- | -------- |
-------- |
|BATTERY_STATUS_LOW |0 |表示这个触发条件是低电告警。
|
|BATTERY_STATUS_OKAY |1| 表示这个触发条件是从低电恢复到正常电量。
|
|BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。
|
| 名称 | 默认值 | 说明
|
| -------------------------- | ---- | ------------------
-------- |
| BATTERY_STATUS_LOW | 0 | 表示这个触发条件是低电告警。
|
| BATTERY_STATUS_OKAY | 1 | 表示这个触发条件是从低电恢复到正常电量。
|
| BATTERY_STATUS_LOW_OR_OKAY | 2 | 表示这个触发条件是从低电恢复到正常电量或者低电告警。
|
## StorageRequest
触发工作的存储状态。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录