1# ICollector
2
3
4## 概述
5
6定义采集器标准API接口。接口可用于获取执行器信息，取消认证，采集数据，发送消息等。
7
8**起始版本：** 5.0
9
10**相关模块：**[HdfPinAuth](_hdf_pin_auth_v20.md)
11
12
13## 汇总
14
15
16### Public 成员函数
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [GetExecutorInfo](#getexecutorinfo) ([out] struct [ExecutorInfo](_executor_info_v20.md) executorInfo) | 获取执行器信息。 |
21| [OnRegisterFinish](#onregisterfinish) ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo) | 完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。 |
22| [Cancel](#cancel) ([in] unsigned long scheduleId) | 取消操作请求。 |
23| [SendMessage](#sendmessage) ([in] unsigned long scheduleId, [in] int srcRole, [in] unsigned char[] msg) | 发送消息。 |
24| [SetData](#setdata) ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data, [in] int resultCode) | 设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。 |
25| [Collect](#collect) ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback_v20.md) callbackObj) | Collect 采集口令数据。 |
26
27
28## 成员函数说明
29
30
31### Cancel()
32
33```
34ICollector::Cancel ([in] unsigned long scheduleId)
35```
36
37**描述**
38
39取消操作请求。
40
41**起始版本：** 5.0
42
43**参数:**
44
45| 名称 | 描述 |
46| -------- | -------- |
47| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
48
49**返回：**
50
510 表示操作成功。
52
53非0 表示操作失败。
54
55
56### Collect()
57
58```
59ICollector::Collect ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj )
60```
61
62**描述**
63
64Collect 采集口令数据。
65
66**起始版本：** 5.0
67
68**参数:**
69
70| 名称 | 描述 |
71| -------- | -------- |
72| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
73| extraInfo | 其他相关信息，用于支持信息扩展。 |
74| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback_v20.md)。 |
75
76**返回：**
77
780 表示操作成功。
79
80非0 表示操作失败。
81
82
83### GetExecutorInfo()
84
85```
86ICollector::GetExecutorInfo ([out] struct ExecutorInfo executorInfo)
87```
88
89**描述**
90
91获取执行器信息。
92
93**起始版本：** 5.0
94
95**参数:**
96
97| 名称 | 描述 |
98| -------- | -------- |
99| executorInfo | 标识执行器信息 [ExecutorInfo](_executor_info_v20.md)。 |
100
101**返回：**
102
1030 表示操作成功。
104
105非0 表示操作失败。
106
107
108### OnRegisterFinish()
109
110```
111ICollector::OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo )
112```
113
114**描述**
115
116完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。
117
118**参数:**
119
120| 名称 | 描述 |
121| -------- | -------- |
122| templateIdList | 用户认证框架内由该执行器注册的口令凭据模版ID列表。 |
123| frameworkPublicKey | 用户认证框架的公钥，用于校验用户认证框架私钥签名的信息。 |
124| extraInfo | 其他相关信息，用于支持信息扩展。 |
125
126**返回：**
127
1280 表示操作成功。
129
130非0 表示操作失败。
131
132
133### SendMessage()
134
135```
136ICollector::SendMessage ([in] unsigned long scheduleId, [in] int srcRole, [in] unsigned char[] msg )
137```
138
139**描述**
140
141发送消息。
142
143**起始版本：** 5.0
144
145**参数:**
146
147| 名称 | 描述 |
148| -------- | -------- |
149| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
150| srcRole | 源执行器角色[ExecutorRole](_hdf_pin_auth_v20.md#executorrole)。 |
151| msg | 消息。 |
152
153**返回：**
154
1550 表示操作成功。
156
157非0 表示操作失败。
158
159
160### SetData()
161
162```
163ICollector::SetData ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data, [in] int resultCode )
164```
165
166**描述**
167
168设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。
169
170**起始版本：** 5.0
171
172**参数:**
173
174| 名称 | 描述 |
175| -------- | -------- |
176| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
177| authSubType | 口令子类型，如六位数字PIN码等[PinAuthTypes](_pin_auth_types_8idl_v20.md)。 |
178| data | 口令数据。 |
179| resultCode | 返回结果状态码。 |
180
181**返回：**
182
1830 表示操作成功。
184
185非0 表示操作失败。
186