ConnectResponseHandler interface
設定 connect 事件回應的處理程式
方法
| fail(400 | 401 | 500, string) | 傳回失敗的回應,服務將會拒絕用戶端 WebSocket 連線。 |
| fail |
返回帶有 MQTT 回應屬性的失敗回應,服務將拒絕用戶端 WebSocket 連接。 |
| set |
設定連線的狀態 |
| success(Connect |
傳回服務的成功回應。 |
方法詳細資料
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
連接事件的回應,其中包含預設的 WebPubSub 或 MQTT 回應屬性。
setState(string, unknown)
設定連線的狀態
function setState(name: string, value: unknown)
參數
- name
-
string
狀態的名稱
- value
-
unknown
狀態的值
success(ConnectResponse | MqttConnectResponse)
傳回服務的成功回應。
function success(response?: ConnectResponse | MqttConnectResponse)
參數
- response
connect 事件的回應。