未验证 提交 585ebe04 编写于 作者: O openharmony_ci 提交者: Gitee

!19884 内容格式调整

Merge pull request !19884 from ningning/master
...@@ -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&lt;boolean&gt;): void; isDeviceInStandby(callback: AsyncCallback&lt;boolean&gt;): void;
当前设备是否进入待机低功耗续航模式,使用Callback异步回调。 当前设备是否进入待机低功耗续航模式,使用Callback异步回调。
...@@ -39,19 +41,22 @@ isDeviceInStandby(callback: AsyncCallback&lt;boolean&gt;): void; ...@@ -39,19 +41,22 @@ isDeviceInStandby(callback: AsyncCallback&lt;boolean&gt;): void;
**示例** **示例**
try{ ```js
deviceStandby.isDeviceInStandby((err, res) => { try{
if (err) { deviceStandby.isDeviceInStandby((err, res) => {
console.log('DEVICE_STANDBY isDeviceInStandby callback failed. code is: ' + err.code + ',message is: ' + err.message); if (err) {
} else { console.log('DEVICE_STANDBY isDeviceInStandby callback failed. code is: ' + err.code + ',message is: ' + err.message);
console.log('DEVICE_STANDBY isDeviceInStandby callback succeeded, result: ' + JSON.stringify(res)); } else {
} console.log('DEVICE_STANDBY isDeviceInStandby callback succeeded, result: ' + JSON.stringify(res));
}); }
} catch(error) { });
console.log('DEVICE_STANDBY isDeviceInStandby throw error, code is: ' + error.code + ',message is: ' + error.message); } catch(error) {
} console.log('DEVICE_STANDBY isDeviceInStandby throw error, code is: ' + error.code + ',message is: ' + error.message);
}
```
## deviceStandby.isDeviceInStandby ## deviceStandby.isDeviceInStandby
isDeviceInStandby(): Promise&lt;boolean&gt; isDeviceInStandby(): Promise&lt;boolean&gt;
当前设备是否进入待机低功耗续航模式,使用Promise异步回调。 当前设备是否进入待机低功耗续航模式,使用Promise异步回调。
...@@ -64,7 +69,7 @@ isDeviceInStandby(): Promise&lt;boolean&gt; ...@@ -64,7 +69,7 @@ isDeviceInStandby(): Promise&lt;boolean&gt;
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------------------------------- | | --------------------- | ---------------------------------------- |
| Promise&lt;boolean&gt; | 指定的Promise回调方法返回是否进入待机低功耗续航模式。| | Promise&lt;boolean&gt; | 指定的Promise回调方法返回是否进入待机低功耗续航模式。|
**错误码** **错误码**
...@@ -80,17 +85,20 @@ isDeviceInStandby(): Promise&lt;boolean&gt; ...@@ -80,17 +85,20 @@ isDeviceInStandby(): Promise&lt;boolean&gt;
**示例** **示例**
try{ ```js
deviceStandby.isDeviceInStandby().then( res => { try{
console.log('DEVICE_STANDBY isDeviceInStandby promise succeeded, result: ' + JSON.stringify(res)); deviceStandby.isDeviceInStandby().then( res => {
}).catch( err => { console.log('DEVICE_STANDBY isDeviceInStandby promise succeeded, result: ' + JSON.stringify(res));
console.log('DEVICE_STANDBY isDeviceInStandby promise failed. code is: ' + err.code + ',message is: ' + err.message); }).catch( err => {
}); console.log('DEVICE_STANDBY isDeviceInStandby promise failed. code is: ' + err.code + ',message is: ' + err.message);
} catch (error) { });
console.log('DEVICE_STANDBY isDeviceInStandby throw error, code is: ' + error.code + ',message is: ' + error.message); } catch (error) {
} 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&lt;Exempted ...@@ -105,8 +113,8 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array&lt;Exempted
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ | | -------- | -------------------- | ---- | ------------------------------ |
| [ResourceType](#resourcetype)|number | 是 | 资源类型 | | [ResourceTypes](#resourcetype)|number | 是 | 资源类型。 |
| callback | AsyncCallback<Array&lt;[ExemptedAppInfo](#exemptedappinfo)&gt;> | 是 |豁免应用信息 | | callback | AsyncCallback<Array&lt;[ExemptedAppInfo](#exemptedappinfo)&gt;> | 是 |豁免应用信息 |
**错误码** **错误码**
...@@ -122,22 +130,25 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array&lt;Exempted ...@@ -122,22 +130,25 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback<Array&lt;Exempted
**示例** **示例**
try{ ```js
deviceStandby.getExemptedApps(resourceTypes, (err, res) => { try{
if (err) { deviceStandby.getExemptedApps(resourceTypes, (err, res) => {
console.log('DEVICE_STANDBY getExemptedApps callback failed. code is: ' + err.code + ',message is: ' + err.message); if (err) {
} else { console.log('DEVICE_STANDBY getExemptedApps callback failed. code is: ' + err.code + ',message is: ' + err.message);
console.log('DEVICE_STANDBY getExemptedApps callback success.'); } else {
for (let i = 0; i < res.length; i++) { console.log('DEVICE_STANDBY getExemptedApps callback success.');
console.log('DEVICE_STANDBY getExemptedApps callback result ' + JSON.stringify(res[i])); for (let i = 0; i < res.length; i++) {
} console.log('DEVICE_STANDBY getExemptedApps callback result ' + JSON.stringify(res[i]));
} }
}); }
} catch (error) { });
console.log('DEVICE_STANDBY getExemptedApps throw error, code is: ' + error.code + ',message is: ' + error.message); } catch (error) {
} 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&lt;ExemptedAppInfo&gt;>; ...@@ -152,13 +163,13 @@ getExemptedApps(resourceTypes: number): Promise<Array&lt;ExemptedAppInfo&gt;>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ | | -------- | -------------------- | ---- | ------------------------------ |
| [ResourceType](#resourcetype)|number | 是 |资源类型| | [ResourceTypes](#resourcetype)|number | 是 |资源类型。|
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------------------------------- | | --------------------- | ---------------------------------------- |
| Promise<Array&lt;[ExemptedAppInfo](#exemptedappinfo)&gt;> | 豁免应用信息 | | Promise<Array&lt;[ExemptedAppInfo](#exemptedappinfo)&gt;> | 豁免应用信息 |
**错误码** **错误码**
...@@ -177,20 +188,23 @@ getExemptedApps(resourceTypes: number): Promise<Array&lt;ExemptedAppInfo&gt;>; ...@@ -177,20 +188,23 @@ getExemptedApps(resourceTypes: number): Promise<Array&lt;ExemptedAppInfo&gt;>;
**示例** **示例**
try{ ```js
deviceStandby.getExemptedApps(resourceTypes).then( res => { try{
console.log('DEVICE_STANDBY getExemptedApps promise success.'); deviceStandby.getExemptedApps(resourceTypes).then( res => {
for (let i = 0; i < res.length; i++) { console.log('DEVICE_STANDBY getExemptedApps promise success.');
console.log('DEVICE_STANDBY getExemptedApps promise result ' + JSON.stringify(res[i])); for (let i = 0; i < res.length; i++) {
} console.log('DEVICE_STANDBY getExemptedApps promise result ' + JSON.stringify(res[i]));
}).catch( err => { }
console.log('DEVICE_STANDBY getExemptedApps promise failed. code is: ' + err.code + ',message is: ' + err.message); }).catch( err => {
}); console.log('DEVICE_STANDBY getExemptedApps promise failed. code is: ' + err.code + ',message is: ' + err.message);
} catch (error) { });
console.log('DEVICE_STANDBY getExemptedApps throw error, code is: ' + error.code + ',message is: ' + error.message); } catch (error) {
} 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
resourceTypes: 1, let resRequest = {
uid:10003, resourceTypes: 1,
name:"com.example.app", uid:10003,
duration:10, name:"com.example.app",
reason:"apply", duration:10,
}; reason:"apply",
// 异步方法promise方式 };
try{ // 异步方法promise方式
deviceStandby.requestExemptionResource(resRequest).then( () => { try{
console.log('DEVICE_STANDBY requestExemptionResource promise succeeded.'); deviceStandby.requestExemptionResource(resRequest).then( () => {
}).catch( err => { console.log('DEVICE_STANDBY requestExemptionResource promise succeeded.');
console.log('DEVICE_STANDBY requestExemptionResource promise failed. code is: ' + err.code + ',message is: ' + err.message); }).catch( err => {
}); console.log('DEVICE_STANDBY requestExemptionResource promise failed. code is: ' + err.code + ',message is: ' + err.message);
} catch (error) { });
console.log('DEVICE_STANDBY requestExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message); } catch (error) {
} console.log('DEVICE_STANDBY requestExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message);
}
// 异步方法callback方式
try{ // 异步方法callback方式
deviceStandby.requestExemptionResource(resRequest, (err) => { try{
if (err) { deviceStandby.requestExemptionResource(resRequest, (err) => {
console.log('DEVICE_STANDBY requestExemptionResource callback failed. code is: ' + err.code + ',message is: ' + err.message); if (err) {
} else { console.log('DEVICE_STANDBY requestExemptionResource callback failed. code is: ' + err.code + ',message is: ' + err.message);
console.log('DEVICE_STANDBY requestExemptionResource callback succeeded.'); } else {
} console.log('DEVICE_STANDBY requestExemptionResource callback succeeded.');
}); }
} catch (error) { });
console.log('DEVICE_STANDBY requestExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message); } catch (error) {
} 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
resourceTypes: 1, let resRequest = {
uid:10003, resourceTypes: 1,
name:"com.demo.app", uid:10003,
duration:10, name:"com.demo.app",
reason:"unapply", duration:10,
}; reason:"unapply",
// 异步方法promise方式 };
try{ // 异步方法promise方式
deviceStandby.releaseExemptionResource(resRequest).then( () => { try{
console.log('DEVICE_STANDBY releaseExemptionResource promise succeeded.'); deviceStandby.releaseExemptionResource(resRequest).then( () => {
}).catch( err => { console.log('DEVICE_STANDBY releaseExemptionResource promise succeeded.');
console.log('DEVICE_STANDBY releaseExemptionResource promise failed. code is: ' + err.code + ',message is: ' + err.message); }).catch( err => {
}); console.log('DEVICE_STANDBY releaseExemptionResource promise failed. code is: ' + err.code + ',message is: ' + err.message);
} catch (error) { });
console.log('DEVICE_STANDBY releaseExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message); } catch (error) {
} console.log('DEVICE_STANDBY releaseExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message);
}
// 异步方法callback方式
try{ // 异步方法callback方式
deviceStandby.releaseExemptionResource(resRequest, (err) => { try{
if (err) { deviceStandby.releaseExemptionResource(resRequest, (err) => {
console.log('DEVICE_STANDBY releaseExemptionResource callback failed. code is: ' + err.code + ',message is: ' + err.message); if (err) {
} else { console.log('DEVICE_STANDBY releaseExemptionResource callback failed. code is: ' + err.code + ',message is: ' + err.message);
console.log('DEVICE_STANDBY releaseExemptionResource callback succeeded.'); } else {
} console.log('DEVICE_STANDBY releaseExemptionResource callback succeeded.');
}); }
} catch (error) { });
console.log('DEVICE_STANDBY releaseExemptionResource throw error, code is: ' + error.code + ',message is: ' + error.message); } catch (error) {
} 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.
先完成此消息的编辑!
想要评论请 注册