参数说明
消息参数说明
消息体示例:
{
emitName: 'api',
apiArr: {
apiName: 'tradePay',
apiType: 'customApi',
options: {
payOptions: {
tradeNO: '123213',
},
callBackEmitName: 'payComplete',
callBackOptions: {
test: '123',
},
},
},
}
emitName:事件名称
值为:api、ping、pong、close、personNumberChange
- api:执行宿主能力方法
- pong 服务端心跳返回的事件
- ping 发送服务端的心跳事件
- close 关闭连接
- personNumberChange 连接房间的人数改变
连接websocket需要每隔5秒向服务端发送ping消息,服务端也是每隔5秒向用户端发送pong消息,若10秒之内服务端没有收到ping消息,服务端会关闭该连接
apiArr:api数组或对象
apiArr为数组时会依次执行传递的方法
apiType:api类型
值为:uniApi、routerApi、customApi
- uniApi:框架提供的通用方法
- routerApi:框架提供的是接口路由相关的方法
- customApi:框架根据业务提供的自定义处理的方法
apiName:调用的方法名称
options:传递的参数
uniApi、routerApi和部分customApi方法都有通用的2个参数callBackEmitName和callBackOptionscallBackEmitName:方法调用返回事件名(方法调用完成后,向调用方发送的消息体的事件名),传递了此参数才会有返回事件
返回参数说明:
{
emitName:callBackEmitName, //调用传递的回调事件名
options:{
type:'success' | 'fail' // success成功,fail失败
res // 成功或失败调用返回的结果,具体调用对应的api查看,如果调用时传递了callBackOptions,也会携带在此参数上
}
}
callBackOptions:方法调用返回事件携带返回的参数(方法调用结束,返回的参数)
修改于 2 个月前