1# IWififenceCallback
2
3
4## 概述
5
6定义Wi-Fi围栏模块的回调函数
7
8用户在开启Wi-Fi围栏功能前，需要先注册该回调函数。当Wi-Fi围栏状态发生变化时，会通过回调函数进行上报。
9
10**起始版本：** 4.0
11
12**相关模块：**[HdiLpfenceWififence](_hdi_lpfence_wififence.md)
13
14
15## 汇总
16
17
18### Public 成员函数
19
20| 名称 | 描述 |
21| -------- | -------- |
22| [OnWififenceChanged](#onwififencechanged) ([in] int wififenceId, [in] int transition, [in] long timeStamp) | 定义Wi-Fi围栏状态变化的回调函数。 |
23| [OnGetWififenceSizeCb](#ongetwififencesizecb) ([in] struct [WififenceSize](_wififence_size.md) size) | 定义Wi-Fi围栏使用信息的回调函数。 |
24| [OnWififenceReset](#onwififencereset) () | 定义低功耗围栏服务复位事件通知的回调函数。 |
25
26
27## 成员函数说明
28
29
30### OnGetWififenceSizeCb()
31
32```
33IWififenceCallback::OnGetWififenceSizeCb ([in] struct WififenceSize size)
34```
35
36**描述**
37
38
39定义Wi-Fi围栏使用信息的回调函数。
40
41获取Wi-Fi围栏使用信息时，会通过该回调函数进行上报。
42
43**起始版本：** 4.0
44
45**参数:**
46
47| 名称 | 描述 |
48| -------- | -------- |
49| size | 基站围栏使用信息。详见[WififenceSize](_wififence_size.md)定义。 |
50
51**返回：**
52
53如果回调函数上报数据成功，则返回0。
54
55如果回调函数上报数据失败，则返回负值。
56
57
58### OnWififenceChanged()
59
60```
61IWififenceCallback::OnWififenceChanged ([in] int wififenceId, [in] int transition, [in] long timeStamp )
62```
63
64**描述**
65
66
67定义Wi-Fi围栏状态变化的回调函数。
68
69设备与Wi-Fi围栏的状态关系发生变化时，会通过该回调函数进行上报。
70
71**起始版本：** 4.0
72
73**参数:**
74
75| 名称 | 描述 |
76| -------- | -------- |
77| wififenceId | Wi-Fi围栏ID号。 |
78| transition | Wi-Fi围栏变化的状态。详见[WififenceTransition](_hdi_lpfence_wififence.md#wififencetransition)定义。 |
79| timeStamp | 时间戳。 |
80
81**返回：**
82
83如果调用成功，则返回0。
84
85如果调用失败，则返回负值。
86
87
88### OnWififenceReset()
89
90```
91IWififenceCallback::OnWififenceReset ()
92```
93
94**描述**
95
96
97定义低功耗围栏服务复位事件通知的回调函数。
98
99低功耗围栏服务发生复位时会通过该回调函数进行事件上报。
100
101**起始版本：** 4.0
102
103**返回：**
104
105如果回调函数调用成功，则返回0。
106
107如果回调函数调用失败，则返回负值。
108