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

    通过 WebSocket 连接发送数据。

    语法

    SocketTask.send(options)

    参数说明

    options 是 object 类型,属性如下:

    属性名类型默认值必填说明
    datastring/ArrayBuffer需要发送的内容
    successFunction接口调用成功的回调函数
    failFunction接口调用失败的回调函数
    completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

    回调成功

    object 类型,属性如下:

    属性类型说明最低支持版本
    errMsgstring"SocketTask.send:ok"1.0.0

    回调失败

    object 类型,属性如下:

    属性类型说明最低支持版本
    errMsgstring"SocketTask.send:fail" + 错误信息1.0.0

    代码示例

    const socketHandler = tt.connectSocket({ url: "wss://somepath", success: (res) => { console.log("connectSocket success", res.socketTaskId); }, fail: (err) => { console.log("connectSocket fail", err); }, }); socketHandler.onOpen(function () { socketHandler.send({ data: "hello world", success: (res) => { console.log("Socket发送数据成功", res); }, fail: (err) => { console.log("Socket发送数据失败", err); }, }); });

    Bug&Tip

    • Tip : 开发者在使用 send 发送数据时,注意只支持 string 和 ArrayBuffer。不要使用 TyepArray,例如 Uint8Array 类型。
    该文档是否有帮助?