HarmonyOS API:通用能力的接口
版本:v3.1 Beta
@ohos.application.Configuration (Configuration)
更新时间: 2023-02-17 09:19
定义环境变化信息。
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块从API version 9废弃,替换模块为@ohos.app.ability.Configuration (Configuration)
导入模块
import Configuration from '@ohos.application.Configuration'
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
名称 | 类型 | 可读 | 可写 | 说明 |
language8+ | string | 是 | 是 | 表示应用程序的当前语言。 |
colorMode8+ | 是 | 是 | 表示深浅色模式,取值范围:浅色模式(COLOR_MODE_LIGHT),深色模式(COLOR_MODE_DARK)。默认为浅色。 | |
direction9+ | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 | |
screenDensity9+ | 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。 | |
displayId9+ | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
hasPointerDevice9+ | boolean | 是 | 否 | 指示指针类型设备是否已连接,如键鼠、触控板等。 |
具体字段描述参考ohos.application.Configuration.d.ts文件
示例:
import hilog from '@ohos.hilog';
import Ability from '@ohos.application.Ability'
import Window from '@ohos.window'
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
}
onDestroy() {
}
onWindowStageCreate(windowStage: Window.WindowStage) {
let envCallback = {
onConfigurationUpdated(config) {
console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`)
let language = config.language;
let colorMode = config.colorMode;
let direction = config.direction;
let screenDensity = config.screenDensity;
let displayId = config.displayId;
let hasPointerDevice = config.hasPointerDevice;
}
};
let applicationContext = this.context.getApplicationContext();
applicationContext.registerEnvironmentCallback(envCallback);
windowStage.loadContent('pages/index', (err, data) => {
if (err.code) {
hilog.isLoggable(0x0000, 'testTag', hilog.LogLevel.ERROR);
hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
return;
}
hilog.isLoggable(0x0000, 'testTag', hilog.LogLevel.INFO);
hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
});
}
}
@ohos.application.ConfigurationConstant (ConfigurationConstant)
更新时间: 2023-02-17 09:19
ConfigurationConstant模块提供配置信息枚举值定义的能力。
说明
本模块首批接口从API version 8开始支持,从API version 9废弃,替换模块为@ohos.app.ability.ConfigurationConstant (ConfigurationConstant)。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import ConfigurationConstant from '@ohos.application.ConfigurationConstant';
ConfigurationConstant.ColorMode
使用时通过ConfigurationConstant.ColorMode获取。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
名称 | 值 | 说明 |
COLOR_MODE_NOT_SET | -1 | 未设置颜色模式。 |
COLOR_MODE_DARK | 0 | 深色模式。 |
COLOR_MODE_LIGHT | 1 | 浅色模式。 |
ConfigurationConstant.Direction9+
使用时通过ConfigurationConstant.Direction获取。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
名称 | 值 | 说明 |
DIRECTION_NOT_SET | -1 | 未设置方向。 |
DIRECTION_VERTICAL | 0 | 垂直方向。 |
DIRECTION_HORIZONTAL | 1 | 水平方向。 |
ConfigurationConstant.ScreenDensity9+
使用时通过ConfigurationConstant.ScreenDensity获取。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
名称 | 值 | 说明 |
SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。 |
SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。 |
SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。 |
SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。 |
SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。 |
SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。 |
SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。 |
@ohos.application.formBindingData (卡片数据绑定类)
更新时间: 2023-02-17 09:19
卡片数据绑定模块提供卡片数据绑定的能力。包括FormBindingData对象的创建、相关信息的描述。
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
从API version 9 开始不再维护,建议使用FormBindingData替代。
导入模块
import formBindingData from '@ohos.application.formBindingData';
FormBindingData
FormBindingData相关描述。
系统能力:SystemCapability.Ability.Form
名称 | 类型 | 必填 | 说明 |
data | Object | 是 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 |
createFormBindingData
createFormBindingData(obj?: Object | string): FormBindingData
创建一个FormBindingData对象。
系统能力:SystemCapability.Ability.Form
参数:
参数名 | 类型 | 必填 | 说明 |
obj | Object|string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。其中图片数据以"formImages"作为标识,内容为图片标识与图片文件描述符的键值对{"formImages": {"key1": fd1, "key2": fd2}} |
返回值:
类型 | 说明 |
根据传入数据创建的FormBindingData对象。 |
示例:
import featureAbility from '@ohos.ability.featureAbility';
import fileio from '@ohos.fileio';
let context=featureAbility.getContext();
context.getOrCreateLocalDir((err,data)=>{
let path=data+"/xxx.jpg";
let fd = fileio.openSync(path);
let obj = {
"temperature": "21°",
"formImages": {"image": fd}
};
let formBindingDataObj = formBindingData.createFormBindingData(obj);
})