---
name: "getLinkageDeviceList"
mode: "api"
versionRequirements:
  - { name: "基础库", version: "2.14.0" }
title: "device.getLinkageDeviceList - 获取联动设备列表"
---

## getLinkageDeviceList

> [VERSION] 基础库 >= 2.14.0

### 描述

获取家庭下支持联动的设备列表

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `IGetLinkageDeviceList` | 是 | 查询参数 |

### 返回值

类型: `Promise<ILinkageDevice[]>`

支持联动的设备列表

##### ILinkageDevice

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `category` | `string` | 设备品类 |
| `datapoints` | `any[]` | 设备 DP 点列表 |
| `devId` | `string` | 设备 ID |
| `iconUrl` | `string` | 设备图标 URL |
| `name` | `string` | 设备名称 |
| `productId` | `string` | 产品 ID |

### 引用对象

##### `interface` IGetLinkageDeviceList

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `gid` | `number` | 家庭 ID |
| `sourceType` | `string` | 业务范围 |


### 示例代码

#### 获取联动设备列表

```ts
ty.getLinkageDeviceList({
  gid: 123456,
  sourceType: 'dp',
}).then((list) => {
  console.log('联动设备列表', list);
});
```