开发
API

SocketTask.send

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

WebSocket 发送给服务端数据的方法。

语法

SocketTask.send(options)

参数说明

options 为 Object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
datastring / arraybuffer--数据内容1.0.0
successfunction--接口调用成功的回调函数1.0.0
failfunction--接口调用失败的回调函数1.0.0
completefunction--接口调用结束的回调函数(成功、失败都会执行)1.0.0

回调成功

参数为 Object 类型,属性如下:

参数参数类型说明最低支持版本
errMsgstring回调信息1.0.0

回调失败

参数为 Object 类型,属性如下:

参数参数类型说明最低支持版本
errMsgstring回调信息1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

<!-- index.ttml -->
  <view>
    <button size="default" bindtap="socketConnect">创建 WebSocket </button>
    <input value="{{inputValue}}" bindinput="inputChange"></input>
    <button size="default" bindtap="sendSocket"> 发送 WebSocket 数据 </button>
  <view>
let socketTask;
Page({
  data: {
    inputValue: "",
  },
  socketConnect() {
    socketTask = tt.connectSocket({
      url: "wss://someurl",
      success: (res) => {
        console.log("创建成功", res);
      },
      fail: (res) => {
        console.log("创建失败", res);
      },
    });
  },
  sendSocket() {
    // 向 websocket 发送信息
    console.log("---- send", this.data.inputValue);
    if (socketTask) {
      // send 发送的数据必须是 object类型
      socketTask.send({
        // 具体发送的数据的 key 必须是 data
        data: this.data.inputValue,
        success: (res) => {
          // 发送成功的回调
          console.log("send success", res);
        },
        fail: (res) => {
          // 发送成功的回调
          console.log("send success", res);
        },
      });
    }
  },
  inputChange(e) {
    this.setData({
      inputValue: e.detail.value,
    });
  },
});

Bug & Tip

  • Tip:WebSocket 服务器接口地址必须是 wss 协议,且域名必须是后台配置的合法域名。请参考网络请求使用说明
  • Tip:本方法没有消息长度限制,只取决于服务端。
点击纠错
评价此篇文档