1# HdiLpfenceGeofence 2 3 4## 概述 5 6为低功耗围栏服务提供地理围栏的API。 7 8本模块接口提供添加圆形和多边形地理围栏，删除地理围栏，获取地理围栏状态信息，获取设备地理位置等功能。本模块可在AP休眠状态下持续工作。 9 10应用场景：判断用户设备是否达到某个精确地理位置区域，从而进行一些后续服务，如门禁卡的切换、定制消息的提醒等。 11 12**Since:** 13 144.0 15 16**Version:** 17 181.0 19 20 21## 汇总 22 23 24### 文件 25 26 | 名称 | 描述 | 27| -------- | -------- | 28| [GeofenceTypes.idl](_geofence_types_8idl.md) | 定义地理围栏使用的数据类型。 | 29| [IGeofenceCallback.idl](_i_geofence_callback_8idl.md) | 定义地理围栏模块回调接口。 | 30| [IGeofenceIntf.idl](_i_geofence_intf_8idl.md) | 声明基站围栏模块提供的API，用于添加多种地理围栏，删除地理围栏，获取地理围栏状态信息，获取设备地理位置，下发基站离线数据库。 | 31 32 33### 类 34 35 | 名称 | 描述 | 36| -------- | -------- | 37| [Point](_point.md) | struct<br/>定义位置坐标的数据结构。 | 38| [GeofenceCircleRequest](_geofence_circle_request.md) | struct<br/>定义添加圆形地理围栏的数据结构。 | 39| [GeofencePolygonRequest](_geofence_polygon_request.md) | struct<br/>定义添加多边形地理围栏的数据结构。 | 40| [GeofenceResult](_geofence_result.md) | struct<br/>定义添加或删除地理围栏执行结果的数据结构。 | 41| [OfflineDb](_offline_db.md) | struct<br/>定义下发基站离线数据库的数据结构。 | 42| [GeoLocationInfo](_geo_location_info.md) | struct<br/>定义设备具体位置信息的数据结构。 | 43| [GeofenceSize](_geofence_size.md) | struct<br/>定义地理围栏使用信息的数据结构。 | 44| [CurrentCell](_current_cell.md) | struct<br/>定义设备驻留的基站主区信息的数据结构。 | 45| [NeighborCell](_neighbor_cell.md) | struct<br/>定义设备驻留的基站邻区信息的数据结构。 | 46| [GeofenceCellInfo](_geofence_cell_info.md) | struct<br/>定义设备驻留的基站小区信息的数据结构。 | 47| [RequestCellDb](_request_cell_db.md) | struct<br/>定义请求基站离线数据库数据的数据结构。 | 48| [IGeofenceCallback](interface_i_geofence_callback.md) | interface<br/>导入地理围栏模块的数据类型。 | 49| [IGeofenceInterface](interface_i_geofence_interface.md) | interface<br/>导入地理围栏模块的数据类型。 | 50 51 52### 枚举 53 54 | 名称 | 描述 | 55| -------- | -------- | 56| [GeofenceTransition](#geofencetransition) {<br/>GEOFENCE_TRANSITION_ENTERED = (1 << 0) , GEOFENCE_TRANSITION_EXITED = (1 << 1) , GEOFENCE_TRANSITION_UNCERTAIN = (1 << 2) , GEOFENCE_TRANSITION_DWELL = (1 << 3) ,<br/>GEOFENCE_TRANSITION_INDOOR = (1 << 4) , GEOFENCE_TRANSITION_OUTDOOR = (1 << 5)<br/>} | 枚举可关注的地理围栏状态事件。 | 57| [GeofenceAttribute](#geofenceattribute) { GEOFENCE_ATTRI_COORDINATE_WGS84 = 16 } | 枚举地理围栏支持的设置项。 | 58| [GeofenceAccuracy](#geofenceaccuracy) { ACCURACY_FINE = 1 , ACCURACY_BALANCE = 2 , ACCURACY_COARSE = 3 } | 枚举地理围栏支持的精度模式。 | 59| [GeofenceCellType](#geofencecelltype) { GEOFENCE_CELL_G4 = 0 , GEOFENCE_CELL_NR = 1 } | 枚举移动通信技术代。 | 60| [GeofenceLocSource](#geofencelocsource) {<br/>GEOFENCE_GNSS = 1 , GEOFENCE_WIFI = 2 , GEOFENCE_SENSOR = 4 , GEOFENCE_CELL = 8 ,<br/>GEOFENCE_BT = 16<br/>} | 枚举位置信息来源。 | 61 62 63### 关键字 64 65 | 名称 | 描述 | 66| -------- | -------- | 67| package ohos.hdi.location.lpfence.geofence.v1_0 | 地理围栏模块接口的包路径。 | 68 69 70## 枚举类型说明 71 72 73### GeofenceAccuracy 74 75 76``` 77enum GeofenceAccuracy 78``` 79 80**描述:** 81 82枚举地理围栏支持的精度模式。 83 84 | 枚举值 | 描述 | 85| -------- | -------- | 86| ACCURACY_FINE | 高精度模式，GNSS模块接收GPS定位信号频率为1秒1次，功耗较高。 | 87| ACCURACY_BALANCE | 中精度模式，GNSS模块接收GPS定位信号频率为60秒1次，功耗较低。 | 88| ACCURACY_COARSE | 低精度模式，只使用基站定位，不依赖GNSS模块。 | 89 90 91### GeofenceAttribute 92 93 94``` 95enum GeofenceAttribute 96``` 97 98**描述:** 99 100枚举地理围栏支持的设置项。 101 102 | 枚举值 | 描述 | 103| -------- | -------- | 104| GEOFENCE_ATTRI_COORDINATE_WGS84 | 地理位置使用WGS-84地心坐标系。 | 105 106 107### GeofenceCellType 108 109 110``` 111enum GeofenceCellType 112``` 113 114**描述:** 115 116枚举移动通信技术代。 117 118 | 枚举值 | 描述 | 119| -------- | -------- | 120| GEOFENCE_CELL_G4 | 第2、3、4代移动通信技术 | 121| GEOFENCE_CELL_NR | 第5代移动通信技术 | 122 123 124### GeofenceLocSource 125 126 127``` 128enum GeofenceLocSource 129``` 130 131**描述:** 132 133枚举位置信息来源。 134 135 | 枚举值 | 描述 | 136| -------- | -------- | 137| GEOFENCE_GNSS | 位置信息来源于GNSS模块 | 138| GEOFENCE_WIFI | 位置信息来源于Wi-Fi模块 | 139| GEOFENCE_SENSOR | 位置信息来源于Sensor模块 | 140| GEOFENCE_CELL | 位置信息来源于基站模块 | 141| GEOFENCE_BT | 位置信息来源于蓝牙模块 | 142 143 144### GeofenceTransition 145 146 147``` 148enum GeofenceTransition 149``` 150 151**描述:** 152 153枚举可关注的地理围栏状态事件。 154 155 | 枚举值 | 描述 | 156| -------- | -------- | 157| GEOFENCE_TRANSITION_ENTERED | 设备在地理围栏范围内。 | 158| GEOFENCE_TRANSITION_EXITED | 设备在地理围栏范围外。 | 159| GEOFENCE_TRANSITION_UNCERTAIN | 无法确定设备与地理围栏位置关系。 | 160| GEOFENCE_TRANSITION_DWELL | 设备在地理围栏内，且持续徘徊一段时间。 | 161| GEOFENCE_TRANSITION_INDOOR | 设备在地理围栏内，且在室内。 | 162| GEOFENCE_TRANSITION_OUTDOOR | 设备在地理围栏内，且在室外。 | 163