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