HarmonyOS API:已停止维护的接口

joytrian
发布于 2023-4-12 18:11
浏览
0收藏

版本:v3.1 Beta

@system.app (应用上下文)

更新时间: 2023-02-17 09:19


说明

  • 从API Version 7 开始,该接口不再维护,推荐使用新接口。
  • 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import app from '@system.app';

app.getInfo

getInfo(): AppResponse

获取当前应用配置文件中声明的信息。

说明

从API Version 7开始,推荐使用@ohos.bundle。

系统能力: SystemCapability.ArkUI.ArkUI.Lite

返回值:

参数类型

说明

​AppResponse​

定义AppResponse信息。

示例:

export default {    
  getInfo(){        
    var info = app.getInfo();        
      console.log(JSON.stringify(info));    
  } 
}

app.terminate

terminate(): void

退出当前Ability。

说明

从API Version 7开始,推荐使用@ohos.ability.featureAbility。

系统能力: SystemCapability.ArkUI.ArkUI.Lite

示例:

export default {    
  terminate(){        
    app.terminate();    
  }}

app.setImageCacheCount7+

setImageCacheCount(value: number): void

设置内存中缓存解码后图片的数量上限,提升再次加载同源图片的加载速度。如果不设置则默认为0,不进行缓存。缓存采用内置的LRU策略,新图片加载后,如果超过缓存上限,会删除最久未再次加载的缓存。建议根据应用内存需求,设置合理缓存数量,数字过大可能导致内存使用过高。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名

类型

必填

说明

value

number

内存中解码后图片的缓存数量。

示例:

// app.ets
import app from '@system.app';

export default {
    onCreate() { 
        app.setImageCacheCount(100)    // 设置解码后图片内存缓存上限为100张
        console.info('Application onCreate')
    },
    onDestroy() {
        console.info('Application onDestroy')
    },
}

app.setImageRawDataCacheSize7+

setImageRawDataCacheSize(value: number): void

设置内存中缓存解码前图片数据的大小上限,单位为字节,提升再次加载同源图片的加载速度。如果不设置则默认为0,不进行缓存。缓存采用内置的LRU策略,新图片加载后,如果解码前数据超过缓存上限,会删除最久未再次加载的图片数据缓存。建议根据应用内存需求,设置合理缓存上限,过大可能导致应用内存使用过高。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名

类型

必填

说明

value

number

内存中解码前图片数据的缓存大小,单位为字节。

示例:

// app.ets
import app from '@system.app';

export default {
    onCreate() {
        app.setImageRawDataCacheSize(104857600) 
        // 设置解码前图片数据内存缓存上限为100MB (100MB=100*1024*1024B=104857600B)
        console.info('Application onCreate')
    },
    onDestroy() {
        console.info('Application onDestroy')
    },
}

app.setImageFileCacheSize7+

setImageFileCacheSize(value: number): void

设置图片文件缓存的大小上限,单位为字节,提升再次加载同源图片的加载速度,特别是对网络图源、缩略图会有较明显提升。如果不设置则默认为100MB。缓存采用内置的LRU策略,新图片加载后,如果超过文件缓存上限,会按照时间由远到近删除缓存图片文件直到缓存图片大小满足缓存上限。建议根据应用实际需求,设置合理文件缓存上限,数字过大可能导致磁盘空间占用过高。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名

类型

必填

说明

value

number

图片文件的缓存大小,单位为字节。

示例:

// app.ets
import app from '@system.app';

export default {  
    onCreate() {    
        app.setImageFileCacheSize(209715200) 
        // 设置图片文件数据缓存上限为200MB (200MB=200*1024*1024B=209715200B) 
        console.info('Application onCreate')
    },  
    onDestroy() {
        console.info('Application onDestroy')
    },
}

AppResponse

定义AppResponse信息。

系统能力: 以下各项对应的系统能力有所不同,详见下表。

名称

参数类型

必填

说明

appID6+

string

表示应用的包名,用于标识应用的唯一性。

系统能力: SystemCapability.ArkUI.ArkUI.Full

appName

string

表示应用的名称。

系统能力: SystemCapability.ArkUI.ArkUI.Lite

versionName

string

表示应用的版本名称。

系统能力: SystemCapability.ArkUI.ArkUI.Lite

versionCode

number

表示应用的版本号。

系统能力: SystemCapability.ArkUI.ArkUI.Lite

screenOnVisible(deprecated)

screenOnVisible(options?: ScreenOnVisibleOptions)

定义屏幕唤醒时是否保持应用可见。

该接口从API Version 8 开始废弃。

系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

名称

类型

必填

说明

options

ScreenOnVisibleOptions

当启动保活时,锁屏时将阻止系统返回桌面显示,以保持屏幕唤醒时应用可见。

ScreenOnVisibleOptions

定义屏幕上可见接口的选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

名称

参数类型

必填

说明

visible

boolean

是否启动保活,默认值false。

success

() => void

接口调用成功的回调函数。

fail

(data: string, code: number) => void

接口调用失败的回调函数。

complete

() => void

接口调用结束的回调函数。

RequestFullWindowOptions

定义RequestFullWindow接口的选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

名称

参数类型

必填

说明

duration

number

定义动画选项的数量。

@system.battery (电量信息)

更新时间: 2023-02-17 09:19


该模块提供充电状态及剩余电量的查询功能。


说明

  • 从API Version 6开始不再维护,建议使用​​@ohos.batteryInfo​​替代。
  • 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import battery from '@system.battery';

battery.getStatus

getStatus(options?: GetStatusOptions): void;

获取设备当前的充电状态及剩余电量。

系统能力: SystemCapability.PowerManager.BatteryManager.Core

参数:

参数名

类型

必填

说明

options

​GetStatusOptions​

包含接口调用结果的对象。

示例:

battery.getStatus({
    success: function(data) {
        console.log('success get battery level:' + data.level);
    },
    fail: function(data, code) {
        console.error('fail to get battery level code:' + code + ', data: ' + data);
    }
});

GetStatusOptions

包含接口调用结果的对象。

参数名

类型

必填

说明

success

(data: ​​BatteryResponse​​) => void

接口调用成功的回调函数,data为​​BatteryResponse​​类型的返回值。

fail

(data: string, code: number) => void

接口调用失败的回调函数。data为错误信息,code为错误码。

complete

() => void

接口调用结束的回调函数。

BatteryResponse

包含充电状态及剩余电量的对象。

参数名

类型

说明

charging

boolean

当前电池是否在充电中。

level

number

当前电池的电量,取值范围:0.00 - 1.00 。


文章转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-system-battery-0000001477981497-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001477981497__导入模块​

已于2023-4-12 18:11:22修改
收藏
回复
举报
回复