1# HdiGeofence
2
3
4## 概述
5
6定义GNSS地理围栏接口。
7
8上层GNSS服务模块可以使用这个模块的接口来添加地理围栏，删除地理围栏，以及监视地理围栏状态的变化。
9
10**起始版本：** 3.2
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [GeofenceTypes.idl](_geofence_types_8idl.md) | 定义地理围栏模块接口使用到的数据结构。 |
21| [IGeofenceCallback.idl](_i_geofence_callback_8idl.md) | 定义回调函数用于上报地理围栏服务是否可用、地理围栏事件、地理围栏操作结果等。 |
22| [IGeofenceInterface.idl](_i_geofence_interface_8idl.md) | 定义接口用于添加围栏，删除围栏，设置围栏回调函数等。 |
23
24
25### 类
26
27| 名称 | 描述 |
28| -------- | -------- |
29| struct  [GeofenceInfo](_geofence_info.md) | 定义地理围栏的参数。 |
30| struct  [LocationInfo](_location_info.md) | 定义位置信息结构体。 |
31| interface  [IGeofenceCallback](interface_i_geofence_callback.md) | 定义回调函数用于上报地理围栏服务是否可用、地理围栏事件、地理围栏操作结果等。 |
32| interface  [IGeofenceInterface](interface_i_geofence_interface.md) | 定义接口用于添加围栏，删除围栏，设置围栏回调函数等。 |
33
34
35### 枚举
36
37| 名称 | 描述 |
38| -------- | -------- |
39| [GeofenceEvent](#geofenceevent) { GEOFENCE_EVENT_UNCERTAIN = 1 , GEOFENCE_EVENT_ENTERED = 2 , GEOFENCE_EVENT_EXITED = 4 } | 定义监控的地理围栏事件类型。 |
40| [GeofenceOperateResult](#geofenceoperateresult) {<br/>OPERATION_SUCCESS = 0 , OPERATION_ERROR_UNKNOWN = -100 , OPERATION_ERROR_TOO_MANY_GEOFENCES = -101 , OPERATION_ERROR_GEOFENCE_INDEX_EXISTS = -102 , OPERATION_ERROR_PARAMS_INVALID = -103<br/>} | 定义地理围栏操作的错误码。 |
41| [GeofenceOperateType](#geofenceoperatetype) { TYPE_ADD = 1 , TYPE_DELETE = 2 } | 定义地理围栏的操作类型。 |
42
43
44## 枚举类型说明
45
46
47### GeofenceEvent
48
49```
50enum GeofenceEvent
51```
52
53**描述**
54
55
56定义监控的地理围栏事件类型。
57
58**起始版本：** 3.2
59
60| 枚举值 | 描述 |
61| -------- | -------- |
62| GEOFENCE_EVENT_UNCERTAIN | 状态不确定 |
63| GEOFENCE_EVENT_ENTERED | 进入围栏 |
64| GEOFENCE_EVENT_EXITED | 退出围栏 |
65
66
67### GeofenceOperateResult
68
69```
70enum GeofenceOperateResult
71```
72
73**描述**
74
75
76定义地理围栏操作的错误码。
77
78**起始版本：** 3.2
79
80| 枚举值 | 描述 |
81| -------- | -------- |
82| OPERATION_SUCCESS | 操作成功 |
83| OPERATION_ERROR_UNKNOWN | 未知错误 |
84| OPERATION_ERROR_TOO_MANY_GEOFENCES | 围栏个数超过限制 |
85| OPERATION_ERROR_GEOFENCE_INDEX_EXISTS | 围栏ID重复 |
86| OPERATION_ERROR_PARAMS_INVALID | 入参错误 |
87
88
89### GeofenceOperateType
90
91```
92enum GeofenceOperateType
93```
94
95**描述**
96
97
98定义地理围栏的操作类型。
99
100**起始版本：** 3.2
101
102| 枚举值 | 描述 |
103| -------- | -------- |
104| TYPE_ADD | 添加围栏 |
105| TYPE_DELETE | 删除围栏 |
106