Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
585ebe04
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看板
未验证
提交
585ebe04
编写于
6月 20, 2023
作者:
O
openharmony_ci
提交者:
Gitee
6月 20, 2023
浏览文件
操作
浏览文件
下载
差异文件
!19884 内容格式调整
Merge pull request !19884 from ningning/master
上级
2858c98a
5a0b49e1
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
145 addition
and
123 deletion
+145
-123
zh-cn/application-dev/reference/apis/js-apis-resourceschedule-deviceStandby.md
.../reference/apis/js-apis-resourceschedule-deviceStandby.md
+145
-123
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-resourceschedule-deviceStandby.md
浏览文件 @
585ebe04
...
@@ -3,14 +3,16 @@
...
@@ -3,14 +3,16 @@
> **说明**:
> **说明**:
>
>
>
-
本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。<br>
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。<br>
## 导入模块
## 导入模块
```
js
```
js
import
deviceStandby
from
'
@ohos.resourceschedule.deviceStandby
'
;
import
deviceStandby
from
'
@ohos.resourceschedule.deviceStandby
'
;
```
```
## deviceStandby.isDeviceInStandby
## deviceStandby.isDeviceInStandby
isDeviceInStandby(callback: AsyncCallback
<
boolean
>
): void;
isDeviceInStandby(callback: AsyncCallback
<
boolean
>
): void;
当前设备是否进入待机低功耗续航模式,使用Callback异步回调。
当前设备是否进入待机低功耗续航模式,使用Callback异步回调。
...
@@ -39,19 +41,22 @@ isDeviceInStandby(callback: AsyncCallback<boolean>): void;
...
@@ -39,19 +41,22 @@ isDeviceInStandby(callback: AsyncCallback<boolean>): void;
**示例**
:
**示例**
:
try{
```
js
deviceStandby.isDeviceInStandby((err, res) => {
try
{
deviceStandby
.
isDeviceInStandby
((
err
,
res
)
=>
{
if
(
err
)
{
if
(
err
)
{
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby callback failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby callback failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
}
else
{
}
else
{
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby callback succeeded, result:
'
+
JSON
.
stringify
(
res
));
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby callback succeeded, result:
'
+
JSON
.
stringify
(
res
));
}
}
});
});
} catch(error) {
}
catch
(
error
)
{
console.log('DEVICE_STANDBY isDeviceInStandby throw error, code is: ' + error.code + ',message is: ' + error.message);
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby throw error, code is:
'
+
error
.
code
+
'
,message is:
'
+
error
.
message
);
}
}
```
## deviceStandby.isDeviceInStandby
## deviceStandby.isDeviceInStandby
isDeviceInStandby(): Promise
<
boolean
>
isDeviceInStandby(): Promise
<
boolean
>
当前设备是否进入待机低功耗续航模式,使用Promise异步回调。
当前设备是否进入待机低功耗续航模式,使用Promise异步回调。
...
@@ -64,7 +69,7 @@ isDeviceInStandby(): Promise<boolean>
...
@@ -64,7 +69,7 @@ isDeviceInStandby(): Promise<boolean>
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------- | ---------------------------------------- |
| --------------------- | ---------------------------------------- |
| Promise
<
boolean
>
| 指定的Promise回调方法
。
返回是否进入待机低功耗续航模式。|
| Promise
<
boolean
>
| 指定的Promise回调方法
,
返回是否进入待机低功耗续航模式。|
**错误码**
:
**错误码**
:
...
@@ -80,17 +85,20 @@ isDeviceInStandby(): Promise<boolean>
...
@@ -80,17 +85,20 @@ isDeviceInStandby(): Promise<boolean>
**示例**
:
**示例**
:
try{
```
js
deviceStandby.isDeviceInStandby().then( res => {
try
{
deviceStandby
.
isDeviceInStandby
().
then
(
res
=>
{
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby promise succeeded, result:
'
+
JSON
.
stringify
(
res
));
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby promise succeeded, result:
'
+
JSON
.
stringify
(
res
));
}).catch( err => {
}).
catch
(
err
=>
{
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby promise failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby promise failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
});
});
} catch (error) {
}
catch
(
error
)
{
console.log('DEVICE_STANDBY isDeviceInStandby throw error, code is: ' + error.code + ',message is: ' + error.message);
console
.
log
(
'
DEVICE_STANDBY isDeviceInStandby throw error, code is:
'
+
error
.
code
+
'
,message is:
'
+
error
.
message
);
}
}
```
## deviceStandby.getExemptedApps
## deviceStandby.getExemptedApps
getExemptedApps(resourceTypes: number, callback: AsyncCallback
<Array
&
lt
;
ExemptedAppInfo
&
gt
;
>
): void;
getExemptedApps(resourceTypes: number, callback: AsyncCallback
<Array
&
lt
;
ExemptedAppInfo
&
gt
;
>
): void;
获取进入待机模式的应用名单,使用Callback异步回调。
获取进入待机模式的应用名单,使用Callback异步回调。
...
@@ -105,8 +113,8 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array<Exempted
...
@@ -105,8 +113,8 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array<Exempted
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ |
| -------- | -------------------- | ---- | ------------------------------ |
|
[
ResourceType
](
#resourcetype
)
|number | 是 | 资源类型
|
|
[
ResourceType
s
](
#resourcetype
)
|number | 是 | 资源类型。
|
| callback | AsyncCallback
<Array
&
lt
;[
ExemptedAppInfo
](
#exemptedappinfo
)&
gt
;
>
| 是 |豁免应用信息 |
| callback | AsyncCallback
<Array
&
lt
;[
ExemptedAppInfo
](
#exemptedappinfo
)&
gt
;
>
| 是 |豁免应用信息
。
|
**错误码**
:
**错误码**
:
...
@@ -122,8 +130,9 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array<Exempted
...
@@ -122,8 +130,9 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array<Exempted
**示例**
:
**示例**
:
try{
```
js
deviceStandby.getExemptedApps(resourceTypes, (err, res) => {
try
{
deviceStandby
.
getExemptedApps
(
resourceTypes
,
(
err
,
res
)
=>
{
if
(
err
)
{
if
(
err
)
{
console
.
log
(
'
DEVICE_STANDBY getExemptedApps callback failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
console
.
log
(
'
DEVICE_STANDBY getExemptedApps callback failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
}
else
{
}
else
{
...
@@ -132,12 +141,14 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array<Exempted
...
@@ -132,12 +141,14 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array<Exempted
console
.
log
(
'
DEVICE_STANDBY getExemptedApps callback result
'
+
JSON
.
stringify
(
res
[
i
]));
console
.
log
(
'
DEVICE_STANDBY getExemptedApps callback result
'
+
JSON
.
stringify
(
res
[
i
]));
}
}
}
}
});
});
} catch (error) {
}
catch
(
error
)
{
console.log('DEVICE_STANDBY getExemptedApps throw error, code is: ' + error.code + ',message is: ' + error.message);
console
.
log
(
'
DEVICE_STANDBY getExemptedApps throw error, code is:
'
+
error
.
code
+
'
,message is:
'
+
error
.
message
);
}
}
```
## deviceStandby.getExemptedApps
## deviceStandby.getExemptedApps
getExemptedApps(resourceTypes: number): Promise
<Array
&
lt
;
ExemptedAppInfo
&
gt
;
>
;
getExemptedApps(resourceTypes: number): Promise
<Array
&
lt
;
ExemptedAppInfo
&
gt
;
>
;
获取进入待机模式的应用名单,使用Promise异步回调。
获取进入待机模式的应用名单,使用Promise异步回调。
...
@@ -152,13 +163,13 @@ getExemptedApps(resourceTypes: number): Promise<Array<ExemptedAppInfo>>;
...
@@ -152,13 +163,13 @@ getExemptedApps(resourceTypes: number): Promise<Array<ExemptedAppInfo>>;
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ |
| -------- | -------------------- | ---- | ------------------------------ |
|
[
ResourceType
](
#resourcetype
)
|number | 是 |资源类型
|
|
[
ResourceType
s
](
#resourcetype
)
|number | 是 |资源类型。
|
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------- | ---------------------------------------- |
| --------------------- | ---------------------------------------- |
| Promise
<Array
&
lt
;[
ExemptedAppInfo
](
#exemptedappinfo
)&
gt
;
>
| 豁免应用信息 |
| Promise
<Array
&
lt
;[
ExemptedAppInfo
](
#exemptedappinfo
)&
gt
;
>
| 豁免应用信息
。
|
**错误码**
:
**错误码**
:
...
@@ -177,20 +188,23 @@ getExemptedApps(resourceTypes: number): Promise<Array<ExemptedAppInfo>>;
...
@@ -177,20 +188,23 @@ getExemptedApps(resourceTypes: number): Promise<Array<ExemptedAppInfo>>;
**示例**
:
**示例**
:
try{
```
js
deviceStandby.getExemptedApps(resourceTypes).then( res => {
try
{
deviceStandby
.
getExemptedApps
(
resourceTypes
).
then
(
res
=>
{
console
.
log
(
'
DEVICE_STANDBY getExemptedApps promise success.
'
);
console
.
log
(
'
DEVICE_STANDBY getExemptedApps promise success.
'
);
for
(
let
i
=
0
;
i
<
res
.
length
;
i
++
)
{
for
(
let
i
=
0
;
i
<
res
.
length
;
i
++
)
{
console
.
log
(
'
DEVICE_STANDBY getExemptedApps promise result
'
+
JSON
.
stringify
(
res
[
i
]));
console
.
log
(
'
DEVICE_STANDBY getExemptedApps promise result
'
+
JSON
.
stringify
(
res
[
i
]));
}
}
}).catch( err => {
}).
catch
(
err
=>
{
console
.
log
(
'
DEVICE_STANDBY getExemptedApps promise failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
console
.
log
(
'
DEVICE_STANDBY getExemptedApps promise failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
});
});
} catch (error) {
}
catch
(
error
)
{
console.log('DEVICE_STANDBY getExemptedApps throw error, code is: ' + error.code + ',message is: ' + error.message);
console
.
log
(
'
DEVICE_STANDBY getExemptedApps throw error, code is:
'
+
error
.
code
+
'
,message is:
'
+
error
.
message
);
}
}
```
## deviceStandby.requestExemptionResource
## deviceStandby.requestExemptionResource
requestExemptionResource(request: ResourceRequest): void;
requestExemptionResource(request: ResourceRequest): void;
应用订阅申请豁免,使应用临时不进入待机管控。
应用订阅申请豁免,使应用临时不进入待机管控。
...
@@ -205,7 +219,7 @@ requestExemptionResource(request: ResourceRequest): void;
...
@@ -205,7 +219,7 @@ requestExemptionResource(request: ResourceRequest): void;
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ |
| -------- | -------------------- | ---- | ------------------------------ |
| request |
[
ResourceRequest
](
#resourcerequest
)
| 是 | 资源请求 |
| request |
[
ResourceRequest
](
#resourcerequest
)
| 是 | 资源请求
。
|
**错误码**
:
**错误码**
:
...
@@ -221,38 +235,41 @@ requestExemptionResource(request: ResourceRequest): void;
...
@@ -221,38 +235,41 @@ requestExemptionResource(request: ResourceRequest): void;
**示例**
:
**示例**
:
let resRequest = {
```
js
let
resRequest
=
{
resourceTypes
:
1
,
resourceTypes
:
1
,
uid
:
10003
,
uid
:
10003
,
name
:
"
com.example.app
"
,
name
:
"
com.example.app
"
,
duration
:
10
,
duration
:
10
,
reason
:
"
apply
"
,
reason
:
"
apply
"
,
};
};
// 异步方法promise方式
// 异步方法promise方式
try{
try
{
deviceStandby.requestExemptionResource(resRequest).then( () => {
deviceStandby
.
requestExemptionResource
(
resRequest
).
then
(
()
=>
{
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource promise succeeded.
'
);
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource promise succeeded.
'
);
}).catch( err => {
}).
catch
(
err
=>
{
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource promise failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource promise failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
});
});
} catch (error) {
}
catch
(
error
)
{
console.log('DEVICE_STANDBY requestExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message);
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource throw error, code is:
'
+
error
.
code
+
'
,message is:
'
+
error
.
message
);
}
}
// 异步方法callback方式
// 异步方法callback方式
try{
try
{
deviceStandby.requestExemptionResource(resRequest, (err) => {
deviceStandby
.
requestExemptionResource
(
resRequest
,
(
err
)
=>
{
if
(
err
)
{
if
(
err
)
{
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource callback failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource callback failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
}
else
{
}
else
{
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource callback succeeded.
'
);
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource callback succeeded.
'
);
}
}
});
});
} catch (error) {
}
catch
(
error
)
{
console.log('DEVICE_STANDBY requestExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message);
console
.
log
(
'
DEVICE_STANDBY requestExemptionResource throw error, code is:
'
+
error
.
code
+
'
,message is:
'
+
error
.
message
);
}
}
```
## deviceStandby.releaseExemptionResource
## deviceStandby.releaseExemptionResource
releaseExemptionResource(request: ResourceRequest): void;
releaseExemptionResource(request: ResourceRequest): void;
取消应用订阅申请豁免。
取消应用订阅申请豁免。
...
@@ -267,7 +284,7 @@ releaseExemptionResource(request: ResourceRequest): void;
...
@@ -267,7 +284,7 @@ releaseExemptionResource(request: ResourceRequest): void;
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ |
| -------- | -------------------- | ---- | ------------------------------ |
| request |
[
ResourceRequest
](
#resourcerequest
)
| 是 | 资源请求 |
| request |
[
ResourceRequest
](
#resourcerequest
)
| 是 | 资源请求
。
|
**错误码**
:
**错误码**
:
...
@@ -283,44 +300,47 @@ releaseExemptionResource(request: ResourceRequest): void;
...
@@ -283,44 +300,47 @@ releaseExemptionResource(request: ResourceRequest): void;
**示例**
:
**示例**
:
let resRequest = {
```
js
let
resRequest
=
{
resourceTypes
:
1
,
resourceTypes
:
1
,
uid
:
10003
,
uid
:
10003
,
name
:
"
com.demo.app
"
,
name
:
"
com.demo.app
"
,
duration
:
10
,
duration
:
10
,
reason
:
"
unapply
"
,
reason
:
"
unapply
"
,
};
};
// 异步方法promise方式
// 异步方法promise方式
try{
try
{
deviceStandby.releaseExemptionResource(resRequest).then( () => {
deviceStandby
.
releaseExemptionResource
(
resRequest
).
then
(
()
=>
{
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource promise succeeded.
'
);
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource promise succeeded.
'
);
}).catch( err => {
}).
catch
(
err
=>
{
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource promise failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource promise failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
});
});
} catch (error) {
}
catch
(
error
)
{
console.log('DEVICE_STANDBY releaseExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message);
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource throw error, code is:
'
+
error
.
code
+
'
,message is:
'
+
error
.
message
);
}
}
// 异步方法callback方式
// 异步方法callback方式
try{
try
{
deviceStandby.releaseExemptionResource(resRequest, (err) => {
deviceStandby
.
releaseExemptionResource
(
resRequest
,
(
err
)
=>
{
if
(
err
)
{
if
(
err
)
{
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource callback failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource callback failed. code is:
'
+
err
.
code
+
'
,message is:
'
+
err
.
message
);
}
else
{
}
else
{
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource callback succeeded.
'
);
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource callback succeeded.
'
);
}
}
});
});
} catch (error) {
}
catch
(
error
)
{
console.log('DEVICE_STANDBY releaseExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message);
console
.
log
(
'
DEVICE_STANDBY releaseExemptionResource throw error, code is:
'
+
error
.
code
+
'
,message is:
'
+
error
.
message
);
}
}
```
## ResourceType
## ResourceType
非待机应用资源枚举。
非待机应用资源枚举。
<br>
**系统API:**
此接口为系统接口。
**需要权限:**
ohos.permission.DEVICE_STANDBY_EXEMPTION
**需要权限:**
ohos.permission.DEVICE_STANDBY_EXEMPTION
**系统API:**
此接口为系统接口。
|名称 |值 |说明|
|名称 |值 |说明|
| ------------ | ------------ |--------------|
| ------------ | ------------ |--------------|
|NETWORK |1 |网络访问资源|
|NETWORK |1 |网络访问资源|
...
@@ -332,28 +352,30 @@ releaseExemptionResource(request: ResourceRequest): void;
...
@@ -332,28 +352,30 @@ releaseExemptionResource(request: ResourceRequest): void;
|FREEZE |64 | 冻结应用资源|
|FREEZE |64 | 冻结应用资源|
## ExemptedAppInfo
## ExemptedAppInfo
豁免应用信息,不进入待机管控的应用信息。
<br>
豁免应用信息,未进入待机管控的应用信息。
**系统API:**
此接口为系统接口。
**需要权限:**
ohos.permission.DEVICE_STANDBY_EXEMPTION
**需要权限:**
ohos.permission.DEVICE_STANDBY_EXEMPTION
**系统API:**
此接口为系统接口。
|名称 |类型 | 必填 |说明 |
|名称 |类型 | 必填 |说明 |
| ------------ | ------------ |------------ | ------------ |
| ------------ | ------------ |------------ | ------------ |
|
resourceTypes
| number | 是 |应用的资源类型 |
|
[
resourceTypes
](
#resourcetype
)
| number | 是 |应用的资源类型 |
|name |string | 是 | 应用名 |
|name |string | 是 | 应用名 |
|duration | number | 是 | 豁免时长 |
|duration | number | 是 | 豁免时长 |
## ResourceRequest
## ResourceRequest
待机资源请求体。
待机资源请求体。
<br>
**系统API:**
此接口为系统接口。
**需要权限:**
ohos.permission.DEVICE_STANDBY_EXEMPTION
**需要权限:**
ohos.permission.DEVICE_STANDBY_EXEMPTION
**系统API:**
此接口为系统接口。
|名称 |类型 | 必填 |说明 |
|名称 |类型 | 必填 |说明 |
| ------------ | ------------ |------------| ------------ |
| ------------ | ------------ |------------| ------------ |
|
resourceTypes
| number | 是 |应用的资源类型 |
|
[
resourceTypes
](
#resourcetype
)
| number | 是 |应用的资源类型 |
|uid | number | 是 |应用uid |
|uid | number | 是 |应用uid |
|name |string | 是 | 应用名称 |
|name |string | 是 | 应用名称 |
|duration | number | 是 | 豁免时长 |
|duration | number | 是 | 豁免时长 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录