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"

ペイロード データの型。