---
name: "getMapList"
mode: "kit"
versionRequirements:
  - { name: "MapKit", version: "2.1.0" }
  - { name: "@ray-js/ray", version: "1.2.10" }
platform:
  - "iOS"
  - "Android"
async: true
title: "map.getMapList - 获取可跳转第三方地图的地图类型"
---

## getMapList

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

> [PLATFORM] iOS, Android

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

### 描述

获取可打开的第三方地图类型

### 参数

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `maps` | `string[]` | `3.0.5` | 支持的地图厂商，目前支持：BMK: 百度地图, MA: 高德地图, TENCENT: 腾讯地图, Google: 谷歌地图 |

#### fail 回调参数

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

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

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


### 示例代码

#### 基础调用

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

const { getMapList } = map;

getMapList({
  success: (result) => {
    console.log('getMapList success', result);
  },
  fail: (error) => {
    console.log('getMapList fail', error.errorMsg);
  },
});
```