harmony 鸿蒙ICollector

2025-06-16
浏览 (12)

ICollector

概述

定义采集器标准API接口。接口可用于获取执行器信息，取消认证，采集数据，发送消息等。

起始版本： 5.0

相关模块：HdfPinAuth

汇总

Public 成员函数

名称	描述
GetExecutorInfo ([out] struct ExecutorInfo executorInfo)	获取执行器信息。
OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo)	完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。
Cancel ([in] unsigned long scheduleId)	取消操作请求。
SendMessage ([in] unsigned long scheduleId, [in] int srcRole, [in] unsigned char[] msg)	发送消息。
SetData ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data, [in] int resultCode)	设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。
Collect ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj)	Collect 采集口令数据。

成员函数说明

Cancel()

ICollector::Cancel ([in] unsigned long scheduleId)

描述

取消操作请求。

起始版本： 5.0

参数:

名称	描述
scheduleId	调度ID，用于标识一次操作请求的调度过程。

返回：

0 表示操作成功。

非0 表示操作失败。

Collect()

ICollector::Collect ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj )

描述

Collect 采集口令数据。

起始版本： 5.0

参数:

名称	描述
scheduleId	调度ID，用于标识一次操作请求的调度过程。
extraInfo	其他相关信息，用于支持信息扩展。
callbackObj	回调对象IExecutorCallback。

返回：

0 表示操作成功。

非0 表示操作失败。

GetExecutorInfo()

ICollector::GetExecutorInfo ([out] struct ExecutorInfo executorInfo)

描述

获取执行器信息。

起始版本： 5.0

参数:

名称	描述
executorInfo	标识执行器信息 ExecutorInfo。

返回：

0 表示操作成功。

非0 表示操作失败。

OnRegisterFinish()

ICollector::OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo )

描述

完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。

参数:

名称	描述
templateIdList	用户认证框架内由该执行器注册的口令凭据模版ID列表。
frameworkPublicKey	用户认证框架的公钥，用于校验用户认证框架私钥签名的信息。
extraInfo	其他相关信息，用于支持信息扩展。

返回：

0 表示操作成功。

非0 表示操作失败。

SendMessage()

ICollector::SendMessage ([in] unsigned long scheduleId, [in] int srcRole, [in] unsigned char[] msg )

描述

发送消息。

起始版本： 5.0

参数:

名称	描述
scheduleId	调度ID，用于标识一次操作请求的调度过程。
srcRole	源执行器角色ExecutorRole。
msg	消息。

返回：

0 表示操作成功。

非0 表示操作失败。

SetData()

ICollector::SetData ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data, [in] int resultCode )

描述

设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。

起始版本： 5.0

参数:

名称	描述
scheduleId	调度ID，用于标识一次操作请求的调度过程。
authSubType	口令子类型，如六位数字PIN码等PinAuthTypes。
data	口令数据。
resultCode	返回结果状态码。