sse

createSse

closeSse

概述

sse封装了服务器推送事件（Server-Sent Events）,它是一种用于从服务器向客户端推送实时数据的HTML5技术，可以实现ChatGPT打字机效果。

接口

createSse

创建SSE连接，并实时监听服务器数据

createSse({params},callback(ret, err))

params

url：

  • 类型：字符串
  • 描述：(必填项) 服务端SSE地址。

header：

  • 类型：字符串
  • 描述：(可选项) http头信息。

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
    index: 0,
    evenType : '',//onOpen onEvent onClosed onFailure
    id :'' ,
    event : '',
    data : '',
    errMsg: ''
}

err：

  • 类型：JSON对象
  • 内部字段：
{
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('sse');
obj.createSse({
    url : ''
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeSse

关闭SSE连接

closeSse({params},callback(ret, err))

params

index：

  • 类型：字符串
  • 描述：(必填项) 需要关闭的SSE连接序号。
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
}

err：

  • 类型：JSON对象
  • 内部字段：
{
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('sse');
obj.closeSse({
    index: 0
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/11/18