1 Star 0 Fork 5.1K

youguilin / docs

forked from OpenHarmony / docs 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
应用打点.md 33.58 KB
一键复制 编辑 原始数据 按行查看 历史
mamingshuai 提交于 2021-06-02 01:00 . update OpenHarmony 2.0 Canary

应用打点

导入模块

import hiappevent from '@ohos.hiappevent';

权限

方法

write(string, EventType, any..., AsyncCallback<number>)

应用事件打点,将事件信息写入到当天的事件文件中,可接收类型为不定参数的事件参数,使用callback方式作为异步方法。

参数:

参数名

类型

必填

说明

eventName

string

应用事件名称。

eventType

EventType

应用事件类型。

params

any...

应用事件的参数,按顺序输入事件的参数名与参数值。参数名的类型只能为string类型,参数值的类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。

callback

AsyncCallback<number>

回调函数,可以在回调函数中处理接口返回值。

  • 返回值为0表示事件参数校验成功,事件正常异步写入事件文件;
  • 大于0表示事件存在异常参数,事件在忽略异常参数后再异步写入事件文件;
  • 小于0表示事件校验失败,不执行事件异步打点操作。

示例:

hiappevent.write("testEvent", hiappevent.EventType.FAULT, "intData", 100, "strData", "strValue", (err, value) => {
    if (err) {
        // 事件写入异常:事件存在异常参数或者事件校验失败不执行写入
        console.error(`failed to write event because ${err}`);
        return;
    }

    // 事件写入正常
    console.log(`success to write event: ${value}`);
});

write(string, EventType, any...)

应用事件打点,将事件信息写入到当天的事件文件中,可接收类型为不定参数的事件参数,使用promise方式作为异步方法。

参数:

参数名

类型

必填

说明

eventName

string

应用事件名称。

eventType

EventType

应用事件类型。

params

any...

应用事件的参数,按顺序输入事件的参数名与参数值。参数名的类型只能为string类型,参数值的类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。

返回值:

类型

说明

Promise<void>

Promise函数

示例:

hiappevent.write("testEvent", hiappevent.EventType.FAULT, "intData", 100, "strData", "strValue")
    .then((value) => {
        // 事件写入正常
        console.log(`success to write event: ${value}`);
    }).catch((err) => {
        // 事件写入异常:事件存在异常参数或者事件校验失败不执行写入
        console.error(`failed to write event because ${err}`);
    });

writeJson(string, EventType, object, AsyncCallback<number>)

应用事件打点,将事件信息写入到当天的事件文件中,可接收类型为JSON对象的事件参数,使用callback方式作为异步方法。

参数:

参数名

类型

必填

说明

eventName

string

应用事件名称。

eventType

EventType

应用事件类型。

jsonParam

object

应用事件的参数,key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。

callback

AsyncCallback<number>

回调函数,可以在回调函数中处理接口返回值。

  • 返回值为0表示事件参数校验成功,事件正常异步写入事件文件;
  • 大于0表示事件存在异常参数,事件在忽略异常参数后再异步写入事件文件;
  • 小于0表示事件校验失败,不执行事件异步打点操作。

示例:

hiappevent.writeJson("testEvent", hiappevent.EventType.FAULT, {"intData":100, "strData":"strValue"}, (err, value) => {
    if (err) {
        // 事件写入异常:事件存在异常参数或者事件校验失败不执行写入
        console.error(`failed to write event because ${err}`);
        return;
    }

    // 事件写入正常
    console.log(`success to write event: ${value}`);
});

writeJson(string, EventType, object)

应用事件打点,将事件信息写入到当天的事件文件中,可接收类型为JSON对象的事件参数,使用promise方式作为异步方法。

参数:

参数名

类型

必填

说明

eventName

string

应用事件名称。

eventType

EventType

应用事件类型。

jsonParam

object

应用事件的参数,key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。

返回值:

类型

说明

Promise<void>

Promise函数

示例:

hiappevent.writeJson("testEvent", hiappevent.EventType.FAULT, {"intData":100, "strData":"strValue"})
    .then((value) => {
        // 事件写入正常
        console.log(`success to write event: ${value}`);
    }).catch((err) => {
        // 事件写入异常:事件存在异常参数或者事件校验失败不执行写入
        console.error(`failed to write event because ${err}`);
    });

枚举

EventType

用于表示事件类型。

名称

默认值

说明

FAULT

1

故障类型事件。

STATISTIC

2

统计类型事件。

SECURITY

3

安全类型事件。

BEHAVIOR

4

系统行为事件。

1
https://gitee.com/yougl/docs.git
git@gitee.com:yougl/docs.git
yougl
docs
docs
master

搜索帮助