---
name: "onSocketMessageReceived"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "1.2.6" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "onSocketMessageReceived - socket 消息通道消息上报"
---

## onSocketMessageReceived

> [VERSION] DeviceKit >= 1.2.6 | @ray-js/ray >= 0.6.23

> [PLATFORM] iOS, Android

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

### 描述

socket消息通道消息上报

### 参数

`(listener: Function)`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `listener` | `(params: SocketResponse) => void` | 是 | - |  |

### 引用对象

##### `interface` SocketResponse

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `message` | `Record<string, Record<string, any>>` | `1.2.6` | 消息内容 |
| `deviceId` | `string` | `1.2.6` | 设备 id |
| `type` | `number` | `1.2.6` | 局域网消息 type |


### 示例代码

#### 基础调用

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

const { onSocketMessageReceived } = device;

onSocketMessageReceived((res) => {
  console.log('onSocketMessageReceived', res);
});
```