你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ConnectResponseHandler interface

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

方法

fail(400 | 401 | 500, string)

返回失败的响应,服务将拒绝客户端 WebSocket 连接。

failWith(ConnectErrorResponse | MqttConnectErrorResponse)

返回带有 MQTT 响应属性的失败响应,服务将拒绝客户端 WebSocket 连接。

setState(string, unknown)

设置连接的状态

success(ConnectResponse | MqttConnectResponse)

返回服务的成功响应。

方法详细信息

fail(400 | 401 | 500, string)

返回失败的响应,服务将拒绝客户端 WebSocket 连接。

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

参数

code

400 | 401 | 500

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

detail

string

错误的详细信息。

failWith(ConnectErrorResponse | MqttConnectErrorResponse)

返回带有 MQTT 响应属性的失败响应,服务将拒绝客户端 WebSocket 连接。

function failWith(response: ConnectErrorResponse | MqttConnectErrorResponse)

参数

response

ConnectErrorResponse | MqttConnectErrorResponse

连接事件的响应,其中包含默认的 WebPubSub 或 MQTT 响应属性。

setState(string, unknown)

设置连接的状态

function setState(name: string, value: unknown)

参数

name

string

状态的名称

value

unknown

状态的值

success(ConnectResponse | MqttConnectResponse)

返回服务的成功响应。

function success(response?: ConnectResponse | MqttConnectResponse)

参数

response

ConnectResponse | MqttConnectResponse

连接事件的响应。