抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 发起请求
  • 下载
  • 上传
  • Websocket
  • tt.connectSocket
  • SocketTask
  • SocketTask
  • SocketTask.send
  • SocketTask.close
  • SocketTask.onOpen
  • SocketTask.onClose
  • SocketTask.onError
  • SocketTask.onMessage
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • SocketTask.onMessage
    收藏
    我的收藏

    基础库 1.0.0 开始支持本方法。

    监听 WebSocket 接收到服务器发送信息的事件。

    语法

    SocketTask.onMessage(callback)

    参数说明

    参数为回调函数:

    参数参数类型说明最低支持版本
    callbackfunction连接成功的事件回调1.0.0

    回调函数的参数为 Object 类型,属性如下:

    参数参数类型说明最低支持版本
    datastring / arraybuffer接收到的服务器消息1.0.0
    protocolTypestringwebsocket 使用的协议1.0.0
    socketType"ttnet" / "tradition"websocket 类型1.0.0

    代码示例

    const socketTask = tt.connectSocket({ url: "wss://someurl", success: (res) => { console.log("创建成功", res); }, fail: (res) => { console.log("创建失败", res); }, }); socketTask.onMessage((message) => { // 服务器发送的信息 console.log("message", message); });

    Bug & Tip

    • Tip:WebSocket 服务器接口地址必须是 wss 协议,且域名必须是后台配置的合法域名。
    该文档是否有帮助?