UserEventResponseHandler interface

包:

@azure/web-pubsub-express

用于设置用户事件响应的处理程序

方法

fail(400 | 401 | 500, string)	返回失败的响应，服务将关闭客户端 WebSocket 连接。
setState(string, unknown)	设置连接的状态
success(string | ArrayBuffer, "binary" | "text" | "json")	返回要传递到客户端 WebSocket 连接的数据的成功响应。

方法详细信息

fail(400 | 401 | 500, string)

返回失败的响应，服务将关闭客户端 WebSocket 连接。

function fail(code: 400 | 401 | 500, detail?: string)

参数

code

400 | 401 | 500

代码可以是 400 用户错误、401 未经授权和 500 服务器错误。

detail

string

错误的详细信息。

setState(string, unknown)

设置连接的状态

function setState(name: string, value: unknown)

参数

name

string

状态的名称

value

unknown

状态的值

success(string | ArrayBuffer, "binary" | "text" | "json")

返回要传递到客户端 WebSocket 连接的数据的成功响应。

function success(data?: string | ArrayBuffer, dataType?: "binary" | "text" | "json")

参数

data

string | ArrayBuffer

要返回到客户端的有效负载数据。 如果消息是 JSON 对象，则将其字符串化。

dataType

"binary" | "text" | "json"

有效负载数据的类型。