HarmonyOS API:系统基础能力
版本:v3.1 Beta
@ohos.hiTraceMeter (性能打点)
更新时间: 2023-02-17 09:19
本模块提供了跟踪进程轨迹,度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import hiTraceMeter from '@ohos.hiTraceMeter';
hiTraceMeter.startTrace
startTrace(name: string, taskId: number): void
标记一个预跟踪耗时任务的开始。
如果有多个相同name的任务需要跟踪或者对同一个任务要跟踪多次,并且任务同时被执行,则每次调用startTrace的taskId不相同。
如果具有相同name的任务是串行执行的,则taskId可以相同。具体示例可参考hiTraceMeter.finishTrace中的示例。
系统能力: SystemCapability.HiviewDFX.HiTrace
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 要跟踪的任务名称 |
taskId | number | 是 | 任务id |
示例:
hiTraceMeter.startTrace("myTestFunc", 1);
hiTraceMeter.finishTrace
finishTrace(name: string, taskId: number): void
标记一个预跟踪耗时任务的结束。
finishTrace的name和taskId必须与流程开始的startTrace对应参数值一致。
系统能力: SystemCapability.HiviewDFX.HiTrace
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 要跟踪的任务名称 |
taskId | number | 是 | 任务id。 |
示例:
hiTraceMeter.finishTrace("myTestFunc", 1);
// 跟踪并行执行的同名任务
hiTraceMeter.startTrace("myTestFunc", 1);
// 业务流程......
hiTraceMeter.startTrace("myTestFunc", 2); // 第二个跟踪的任务开始,同时第一个跟踪的同名任务还没结束,出现了并行执行,对应接口的taskId需要不同。
// 业务流程......
hiTraceMeter.finishTrace("myTestFunc", 1);
// 业务流程......
hiTraceMeter.finishTrace("myTestFunc", 2);
// 跟踪串行执行的同名任务
hiTraceMeter.startTrace("myTestFunc", 1);
// 业务流程......
hiTraceMeter.finishTrace("myTestFunc", 1); // 第一个跟踪的任务结束
// 业务流程......
hiTraceMeter.startTrace("myTestFunc", 1); // 第二个跟踪的同名任务开始,同名的待跟踪任务串行执行。
// 业务流程......
hiTraceMeter.finishTrace("myTestFunc", 1);
hiTraceMeter.traceByValue
traceByValue(name: string, count: number): void
用来标记一个预跟踪的数值变量,该变量的数值会不断变化。
系统能力: SystemCapability.HiviewDFX.HiTrace
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 要跟踪的数值变量名称 |
count | number | 是 | 变量的值 |
示例:
let traceCount = 3;
hiTraceMeter.traceByValue("myTestCount", traceCount);
traceCount = 4;
hiTraceMeter.traceByValue("myTestCount", traceCount);
//业务流程......
@ohos.InputMethodExtensionAbility (InputMethodExtensionAbility)
更新时间: 2023-02-17 09:19
开发者可通过继承本模块开发自己的输入法应用并管理输入法应用生命周期。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
属性
系统能力: SystemCapability.MiscServices.InputMethodFramework
名称 | 类型 | 可读 | 可写 | 说明 |
context | 是 | 否 | InputMethodExtension的上下文环境,继承自ExtensionContext。 |
InputMethodExtensionAbility.onCreate
onCreate(want: Want): void
Extension生命周期回调,在拉起Extension输入法应用时调用,执行初始化输入法应用操作。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
want | Want | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
示例:
class InputMethodExt extends InputMethodExtensionAbility {
onCreate(want) {
console.log('onCreate, want:' + want.abilityName);
}
}
InputMethodExtensionAbility.onDestroy
onDestroy(): void
Extension生命周期回调,在销毁输入法应用时回调,执行资源清理等操作。
系统能力: SystemCapability.MiscServices.InputMethodFramework
示例:
class InputMethodExt extends InputMethodExtensionAbility {
onDestroy() {
console.log('onDestroy');
}
}
@ohos.InputMethodExtensionContext (InputMethodExtensionContext)
更新时间: 2023-02-17 09:19
InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境,继承自ExtensionContext。
InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口,包括启动、停止、绑定、解绑Ability。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import InputMethodExtensionContext from '@ohos.InputMethodExtensionContext';
使用说明
在使用InputMethodExtensionContext的功能前,需要通过InputMethodExtensionAbility子类实例获取。
import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility';
class MainAbility extends InputMethodExtensionAbility {
onCreate() {
let context = this.context;
}
}
InputMethodExtensionContext.destroy
destroy(callback: AsyncCallback<void>): void
停止输入法应用自身。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<void> | 是 | 回调函数。当停止输入法应用自身成功时,err为undefined;否则为错误对象。 |
示例:
this.context.destroy((err) => {
console.log('destroy result:' + JSON.stringify(err));
});
InputMethodExtensionContext.destroy
destroy(): Promise<void>
停止输入法应用自身。通过Promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
返回值:
类型 | 说明 |
Promise<void> | 无返回结果的Promise对象。 |
示例:
this.context.destroy().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
@ohos.InputMethodSubtype (输入法子类型)
更新时间: 2023-02-17 09:19
本模块提供对输入法子类型的属性管理。输入法应用子类型的含义,如:输入法的中文版、英文版、大写模式、小写模式等都属于输入法的子类型。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import InputMethodSubtype from '@ohos.InputMethodSubtype';
属性
属性值。
系统能力: SystemCapability.MiscServices.InputMethodFramework
名称 | 类型 | 可读 | 可写 | 必选 | 说明 |
label | string | 是 | 否 | 否 | 输入法子类型的标签。 |
name | string | 是 | 否 | 是 | 输入法子类型的名字。 |
id | string | 是 | 否 | 是 | 输入法子类型的id。 |
mode | string | 是 | 否 | 否 | 输入法子类型的模式,包括upper(大写)和lower(小写)。 |
locale | string | 是 | 否 | 是 | 输入法子类型的方言版本。 |
language | string | 是 | 否 | 是 | 输入法子类型的语言。 |
icon | string | 是 | 否 | 否 | 输入法子类型的图标。 |
iconId | number | 是 | 否 | 否 | 输入法子类型的图标id。 |
extra | object | 是 | 是 | 是 | 输入法子类型的其他信息。 |