com.tencent.map.geolocation

## 类 TencentGeofence

- java.lang.Object
- - com.tencent.map.geolocation.TencentGeofence

-     public class TencentGeofence
      extends java.lang.Object

  地理围栏.

  地理围栏表示一片地理位置区域, 用户设备进入或退出该区域后会触发相应的地理围栏事件, 应用程序可捕获感兴趣的地理围栏事件并执行相应操作(比如通过声音或振动提示用户).

  地理围栏支持圆形地理围栏、多边形地理围栏和行政区划地理围栏三种。 公共参数包括：

  - Tag: 唯一的字符串. 用于标识和区分当前各个已设置的地理围栏
  - 有效期: 单位为 ms(毫秒). 超过有效期的围栏会被自动清除, 应根据使用场景选择合理的值, 建议取值 3-6小时
  - 类型：包括Circle、Polygon和District三种类型
  圆形地理围栏参数包括:
  - 中心点坐标: GCJ-02 坐标系下经纬度. 用于指定目的地的精确位置
  - 半径: 表示区域大小, 单位为 m(米). 考虑到实际定位精度水平, 建议取值 500-1500米
  多边形地理围栏参数包括：
  - 边界坐标点 :GCJ-02 坐标系下经纬度边界坐标，最少传3个，且不能重复经纬度
  行政区划地理围栏参数包括：
  - 行政区划关键字: 支持行政区划名称或adcode, 如"北京"或"130681"

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static class` | `TencentGeofence.Builder` 用于生成 TencentGeofence 的 Builder.
    `static class` | `TencentGeofence.CircleFence` 圆形地理围栏类
    `static interface` | `TencentGeofence.DistrictFence` 行政区划地理围栏
    `static class` | `TencentGeofence.FencePoint` 地理围栏点类型
    `static class` | `TencentGeofence.PolygonFence` 多边形地理围栏

  - ### 字段概要

    字段
    限定符和类型 | 字段和说明
    --- | ---
    `static java.lang.String` | `ERROR_CODE`
    `static int` | `ERROR_KEYWORD_EMPTY`
    `static int` | `ERROR_KEYWORD_INVALID`
    `static java.lang.String` | `ERROR_MESSAGE`
    `static int` | `ERROR_OK`
    `static int` | `ERROR_POLYGON_INSUFFICIENT`
    `static int` | `ERROR_POLYGON_INVALID`
    `static int` | `ERROR_REQUEST_FAILED`
    `static int` | `GEOFENCE_TYPE_CIRCLE`
    `static int` | `GEOFENCE_TYPE_DISTRICT`
    `static int` | `GEOFENCE_TYPE_POLYGON`

  - ### 方法概要

    所有方法 实例方法 具体方法 已过时的方法
    限定符和类型 | 方法和说明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `TencentGeofence.CircleFence` | `getCircleFence()` 返回圆形围栏对象 仅当Type为GEOFENCE_TYPE_CIRCLE有效
    `TencentGeofence.DistrictFence` | `getDistrictFence()` 返回行政区划围栏对象 仅当Type为GEOFENCE_TYPE_DISTRICT有效
    `long` | `getDuration()` 返回有效期, 单位为 ms(毫秒).
    `long` | `getExpireAt()` 返回过期时间, 过期时间 = 有效期 + SystemClock.elapsedRealtime()
    `double` | `getLatitude()` 已过时。
    `double` | `getLongitude()` 已过时。
    `TencentGeofence.PolygonFence` | `getPolygonFence()` 返回多边形围栏对象 仅当Type为GEOFENCE_TYPE_POLYGON有效
    `float` | `getRadius()` 已过时。
    `java.lang.String` | `getTag()` 返回唯一标识.
    `int` | `getType()` 返回地理围栏类型
    `int` | `hashCode()`
    `java.lang.String` | `toString()`

    - ### 从类继承的方法 java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### 字段详细资料

    - #### GEOFENCE_TYPE_CIRCLE

          public static final int GEOFENCE_TYPE_CIRCLE

      另请参阅:
        常量字段值

    - #### GEOFENCE_TYPE_POLYGON

          public static final int GEOFENCE_TYPE_POLYGON

      另请参阅:
        常量字段值

    - #### GEOFENCE_TYPE_DISTRICT

          public static final int GEOFENCE_TYPE_DISTRICT

      另请参阅:
        常量字段值

    - #### ERROR_OK

          public static final int ERROR_OK

      另请参阅:
        常量字段值

    - #### ERROR_KEYWORD_EMPTY

          public static final int ERROR_KEYWORD_EMPTY

      另请参阅:
        常量字段值

    - #### ERROR_REQUEST_FAILED

          public static final int ERROR_REQUEST_FAILED

      另请参阅:
        常量字段值

    - #### ERROR_POLYGON_INSUFFICIENT

          public static final int ERROR_POLYGON_INSUFFICIENT

      另请参阅:
        常量字段值

    - #### ERROR_POLYGON_INVALID

          public static final int ERROR_POLYGON_INVALID

      另请参阅:
        常量字段值

    - #### ERROR_KEYWORD_INVALID

          public static final int ERROR_KEYWORD_INVALID

      另请参阅:
        常量字段值

    - #### ERROR_CODE

          public static final java.lang.String ERROR_CODE

      另请参阅:
        常量字段值

    - #### ERROR_MESSAGE

          public static final java.lang.String ERROR_MESSAGE

      另请参阅:
        常量字段值

  - ### 方法详细资料

    - #### getLatitude

          @Deprecated
          public double getLatitude()

      已过时。
      返回纬度 仅当Type为GEOFENCE_TYPE_CIRCLE有效 废弃，建议使用getCircleFence.getLatitude

    - #### getLongitude

          @Deprecated
          public double getLongitude()

      已过时。
      返回经度 仅当Type为GEOFENCE_TYPE_CIRCLE有效 废弃，建议使用getCircleFence.getLongitude

    - #### getRadius

          @Deprecated
          public float getRadius()

      已过时。
      返回半径, 单位为 m(米) 仅当Type为GEOFENCE_TYPE_CIRCLE有效 废弃，建议使用getCircleFence.getRadius

    - #### getCircleFence

          public TencentGeofence.CircleFence getCircleFence()

      返回圆形围栏对象 仅当Type为GEOFENCE_TYPE_CIRCLE有效

    - #### getPolygonFence

          public TencentGeofence.PolygonFence getPolygonFence()

      返回多边形围栏对象 仅当Type为GEOFENCE_TYPE_POLYGON有效

    - #### getDistrictFence

          public TencentGeofence.DistrictFence getDistrictFence()

      返回行政区划围栏对象 仅当Type为GEOFENCE_TYPE_DISTRICT有效

    - #### getExpireAt

          public long getExpireAt()

      返回过期时间, 过期时间 = 有效期 + SystemClock.elapsedRealtime()
      另请参阅:
        `SystemClock.elapsedRealtime()`

    - #### getDuration

          public long getDuration()

      返回有效期, 单位为 ms(毫秒).

    - #### getType

          public int getType()

      返回地理围栏类型
      另请参阅:
        `GEOFENCE_TYPE_CIRCLE`, `GEOFENCE_TYPE_POLYGON`

    - #### getTag

          public java.lang.String getTag()

      返回唯一标识.

    - #### equals

          public boolean equals(java.lang.Object obj)

      覆盖:
        `equals` 在类中 `java.lang.Object`

    - #### hashCode

          public int hashCode()

      覆盖:
        `hashCode` 在类中 `java.lang.Object`

    - #### toString

          public java.lang.String toString()

      覆盖:
        `toString` 在类中 `java.lang.Object`