---
name: "unregisterGeofence"
mode: "kit"
deprecated: true
versionRequirements:
  - { name: "MapKit", version: "3.0.1" }
  - { name: "@ray-js/ray", version: "1.2.10" }
platform:
  - "iOS"
  - "Android"
async: true
title: "map.unregisterGeofence - 取消地理围栏"
---

## unregisterGeofence

> [DEPRECATED] **已废弃**: unregister

> [VERSION] MapKit >= 3.0.1 | @ray-js/ray >= 1.2.10

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

取消地理围栏 权限: [scope.location]

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `geoTitle` | `string` | 否 | - | `3.9.1` | 地理围栏名称 |
| `longitude` | `number` | 否 | `0.0` | `3.9.1` | 经度 |
| `latitude` | `number` | 否 | `0.0` | `3.9.1` | 纬度 |
| `radius` | `number` | 否 | `0` | `3.9.1` | 半径 |
| `geofenceId` | `string` | 否 | - | `3.9.1` | id |
| `type` | `number` | 否 | `0` | `3.9.1` | 半径 0:进度地理围栏 1：离开地理围栏 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 示例代码

#### 基础调用

```tsx
import { map } from '@ray-js/ray'

const { unregisterGeofence } = map;

unregisterGeofence({
  geofenceId: 'fence_001',
  success: () => {
    console.log('unregisterGeofence success');
  },
  fail: (error) => {
    console.log('unregisterGeofence fail', error.errorMsg);
  },
});
```