HarmonyOS API：通用能力的接口

joytrian

发布于 2023-3-31 17:50

浏览

0收藏

版本：v3.1 Beta

@ohos.app.ability.ConfigurationConstant (ConfigurationConstant)

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

ConfigurationConstant模块提供配置信息枚举值定义的能力。

说明

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant';

ConfigurationConstant.ColorMode

使用时通过ConfigurationConstant.ColorMode获取。

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

名称	值	说明
COLOR_MODE_NOT_SET	-1	未设置颜色模式。
COLOR_MODE_DARK	0	深色模式。
COLOR_MODE_LIGHT	1	浅色模式。

ConfigurationConstant.Direction⁹⁺

使用时通过ConfigurationConstant.Direction获取。

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

名称	值	说明
DIRECTION_NOT_SET	-1	未设置方向。
DIRECTION_VERTICAL	0	垂直方向。
DIRECTION_HORIZONTAL	1	水平方向。

ConfigurationConstant.ScreenDensity⁹⁺

使用时通过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.app.ability.errorManager (ErrorManager)

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

ErrorManager模块提供对错误观察器的注册和注销的能力。

说明

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import errorManager from '@ohos.app.ability.errorManager'

ErrorManager.on

on(type: "error", observer: ErrorObserver): number;

注册错误观测器。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
type	string	是	调用接口类型
observer	ErrorObserver	是	返回观察者的数字代码。

示例：

var observer = {
    onUnhandledException(errorMsg) {
        console.log('onUnhandledException, errorMsg: ', errorMsg)
    }
}
try {
    errorManager.on("error", observer);
} catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
}

ErrorManager.off

off(type: "error", observerId: number, callback: AsyncCallback<void>): void;

注销错误观测器。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
type	string	是	调用接口类型
observerId	number	是	返回观察者的数字代码。
callback	AsyncCallback<void>	是	表示指定的回调方法。

示例：

var observerId = 100;

function unregisterErrorObserverCallback(err) {
    if (err) {
        console.log('------------ unregisterErrorObserverCallback ------------', err);
    }
}
try {
    errorManager.off("error", observerId, unregisterErrorObserverCallback);
} catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
}

ErrorManager.off

off(type: "error", observerId: number): Promise<void>;

注销错误观测器。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
type	string	是	调用接口类型
observerId	number	是	返回观察者的数字代码。

返回值：

类型	说明
Promise<void>	返回执行结果。

示例：

var observerId = 100;
try {
    errorManager.off("error", observerId)
        .then((data) => {
            console.log('----------- unregisterErrorObserver success ----------', data);
        })
        .catch((err) => {
            console.log('----------- unregisterErrorObserver fail ----------', err);
    })
} catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
}

@ohos.app.ability.Want (Want)

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

Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。

说明

本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import Want from '@ohos.app.ability.Want';

属性

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

名称	类型	必填	说明
deviceId	string	否	表示运行指定Ability的设备ID。
bundleName	string	否	表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。
abilityName	string	否	表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。
uri	string	否	表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。
type	string	否	表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。
flags	number	否	表示处理Want的方式。默认传数字，具体参考：flags说明。
action	string	否	表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。
parameters	{[key: string]: any}	否	表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值： ohos.aafwk.callerPid 表示拉起方的pid。 ohos.aafwk.param.callerToken 表示拉起方的token。 ohos.aafwk.param.callerUid 表示bundleInfo中的uid，应用包里应用程序的uid。
entities	Array<string>	否	表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。
moduleName	string	否	表示待启动的Ability所属的模块（module）。

示例：

基础用法

  var want = {
      "deviceId": "", // deviceId为空表示本设备
      "bundleName": "com.extreme.test",
      "abilityName": "MainAbility",
      "moduleName": "entry" // moduleName非必选
  };
  this.context.startAbility(want, (error) => {
      // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
      console.log("error.code = " + error.code)
  })

通过自定字段传递数据, 以下为当前支持类型。

字符串（String）

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForString: "str",
    },
}

数字（Number）

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForInt: 100,
        keyForDouble: 99.99,
    },
}

布尔（Boolean）

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForBool: true,
    },
}

对象（Object）

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForObject: {
            keyForObjectString: "str",
            keyForObjectInt: -200,
            keyForObjectDouble: 35.5,
            keyForObjectBool: false,
        },
    },
}

数组（Array）

let want = {
    bundleName: "com.example.demo",
    abilityName: "com.example.demo.MainAbility",
    parameters: {
        keyForArrayString: ["str1", "str2", "str3"],
        keyForArrayInt: [100, 200, 300, 400],
        keyForArrayDouble: [0.1, 0.2],
        keyForArrayObject: [{obj1: "aaa"}, {obj2: 100}],
    },
}

文件描述符（FD）

    import fileio from '@ohos.fileio';
    var fd;
    try {
        fd = fileio.openSync("/data/storage/el2/base/haps/pic.png");
    } catch(e) {
        console.log("openSync fail:" + JSON.stringify(e));
    }
    var want = {
        "deviceId": "", // deviceId为空表示本设备
        "bundleName": "com.extreme.test",
        "abilityName": "MainAbility",
        "moduleName": "entry", // moduleName非必选
        "parameters": {
            "keyFd":{"type":"FD", "value":fd}
        }
    };
    this.context.startAbility(want, (error) => {
        // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
        console.log("error.code = " + error.code)
    })

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-app-ability-want-0000001427902596-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001427902596__属性

分类

标签

已于2023-3-31 17:50:22修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：通用能力的接口

@ohos.app.ability.ConfigurationConstant (ConfigurationConstant)

导入模块

ConfigurationConstant.ColorMode

ConfigurationConstant.Direction⁹⁺

ConfigurationConstant.ScreenDensity⁹⁺

@ohos.app.ability.errorManager (ErrorManager)

导入模块

ErrorManager.on

ErrorManager.off

ErrorManager.off

@ohos.app.ability.Want (Want)

导入模块

属性

目录

订阅鸿蒙技术特刊，精选内容抢先看

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：通用能力的接口

@ohos.app.ability.ConfigurationConstant (ConfigurationConstant)

导入模块

ConfigurationConstant.ColorMode

ConfigurationConstant.Direction9+

ConfigurationConstant.ScreenDensity9+

@ohos.app.ability.errorManager (ErrorManager)

导入模块

ErrorManager.on

ErrorManager.off

ErrorManager.off

@ohos.app.ability.Want (Want)

导入模块

属性

目录

订阅鸿蒙技术特刊，精选内容抢先看

ConfigurationConstant.Direction⁹⁺

ConfigurationConstant.ScreenDensity⁹⁺