HarmonyOS API:通用能力的接口
版本:v3.1 Beta
FormExtensionContext
更新时间: 2023-02-17 09:19
FormExtensionContext模块是FormExtension的上下文环境,继承自ExtensionContext。
FormExtensionContext模块提供FormExtension具有的接口和能力。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
使用说明
在使用FormExtensionContext的功能前,需要通过FormExtension获取。
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
import formBindingData from '@ohos.app.form.formBindingData';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onAddForm() {
let dataObj1 = {
temperature:"11c",
"time":"11:00"
};
let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1;
}
}
ProcessRunningInfo
更新时间: 2023-03-17 18:27
本模块提供对进程运行信息进行设置和查询的能力。
说明
- 本模块接口从API version 9 开始废弃,建议使用ProcessRunningInformation9+替代。
- 本模块首批接口从API version 8 开始支持。
属性
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
名称 | 类型 | 可读 | 可写 | 说明 |
pid | number | 是 | 否 | 进程ID。 |
uid | number | 是 | 否 | 用户ID。 |
processName | string | 是 | 否 | 进程名称。 |
bundleNames | Array<string> | 是 | 否 | 进程中所有运行的包名称。 |
使用说明
通过appManager中getProcessRunningInfos方法来获取。
示例:
import appManager from '@ohos.application.appManager';
appManager.getProcessRunningInfos().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
ProcessRunningInformation
更新时间: 2023-03-17 18:27
ProcessRunningInformation模块提供对进程运行信息进行设置和查询的能力。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用说明
通过ApplicationContext来获取。
import UIAbility from '@ohos.app.ability.UIAbility';
export default class MyAbility extends UIAbility {
onCreate() {
this.context.getApplicationContext().getProcessRunningInformation((error,data) => {
console.log("getProcessRunningInformation error: " + error.code + " data: " + JSON.stringify(data));
});
}
}
属性
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 可读 | 可写 | 说明 |
pid | number | 是 | 否 | 进程ID。 |
uid | number | 是 | 否 | 用户ID。 |
processName | string | 是 | 否 | 进程名称。 |
bundleNames | Array<string> | 是 | 否 | 进程中所有运行的包名称。 |
ShellCmdResult
更新时间: 2023-02-17 09:19
本模块提供Shell命令执行结果的能力。
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 可读 | 可写 | 说明 |
stdResult | string | 是 | 是 | 标准输出内容。 |
exitCode | number | 是 | 是 | 结果码。 |
使用说明
通过abilityDelegator中的executeShellCommand方法来获取。
示例:
import AbilityDelegatorRegistry from "@ohos.application.abilityDelegatorRegistry";
let abilityDelegator;
let cmd = "cmd";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, (err: any, data: any) => {
console.info("executeShellCommand callback, failed: ", err);
console.info("executeShellCommand callback, success: ", data);
});
TriggerInfo
更新时间: 2023-02-17 09:19
作为trigger的入参定义触发WantAgent所需要的信息。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 必填 | 说明 |
code | number | 是 | result code。 |
want | Want | 否 | Want。 |
permission | string | 否 | 权限定义。 |
extraInfo | {[key: string]: any} | 否 | 额外数据。 |
WantAgentInfo
更新时间: 2023-02-17 09:19
定义触发WantAgent所需要的的信息
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 必填 | 说明 |
wants | Array<Want> | 是 | 将被执行的动作列表。 |
operationType | wantAgent.OperationType | 是 | 动作类型。 |
requestCode | number | 是 | 使用者定义的一个私有值。 |
wantAgentFlags | Array<wantAgent.WantAgentFlags> | 否 | 动作执行属性。 |
extraInfo | {[key: string]: any} | 否 | 额外数据。 |
示例:
import wantAgent from '@ohos.wantAgent';
let wantAgentInfo = {
wants: [
{
deviceId: "",
bundleName: "com.example.apicoverhaptest",
abilityName: "com.example.apicoverhaptest.MainAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true.true,false}",
parameters: {
myKey0: 2222
}
}
],
operationType: wantAgent.OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG],
extraInfo:{
"key": "value"
}
}
wantAgent.getWantAgent(wantAgentInfo).then((data) =>{
console.info("getWantAgent data: " + JSON.stringify(data));
}).catch((err) => {
console.error("getWantAgent err: " + JSON.stringify(err));
})
ContinuationExtraParams
更新时间: 2023-02-17 09:19
本模块提供流转管理入口中设备选择模块所需的过滤参数。
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
ContinuationExtraParams
表示流转管理入口中设备选择模块所需的过滤参数。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.DistributedAbilityManager
名称 | 类型 | 可读 | 可写 | 说明 |
deviceType | Array<string> | 是 | 是 | 表示设备类型。 |
targetBundle | string | 是 | 是 | 表示目标包名。 |
description | string | 是 | 是 | 表示设备过滤的描述。 |
filter | any | 是 | 是 | 表示设备过滤的参数。 |
continuationMode | 是 | 是 | 表示协同的模式。 | |
authInfo | { [key: string]: any } | 是 | 是 | 表示认证的信息。 |
ContinuationResult
更新时间: 2023-02-17 09:19
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
ContinuationResult
表示流转管理入口返回的设备信息。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.DistributedAbilityManager
名称 | 类型 | 可读 | 可写 | 说明 |
id | string | 是 | 是 | 表示设备标识。 |
type | string | 是 | 是 | 表示设备类型。 |
name | string | 是 | 是 | 表示设备名称。 |