SocketTask.offMessage

2026-08-06 06:12

Unlisten to the event of receiving server messages by WebSocket.

Prerequisites:

Supported SDK versions：

Android: 2.67.0
iOS: 2.80.0

Supported types of mini programs: DSL

Parameters

Function listener

The listener function passed to the SocketTask.onMessage JSAPI. If this parameter is not passed, all listeners will be removed.

Sample code

copy
const socketTask = my.connectSocket({
  url: 'wss://...',  //The url must start with ws:// or wss://
  multiple: true
});
const listener = (res) => {
  console.log('socketTask.onMessage received the message',res.data);
}
socketTask.onMessage(listener);
// remove the specified listener
socketTask.offMessage(listener);
// remove all listeners
socketTask.offMessage();