WebPubSubEventHandlerOptions interface

パッケージ:

@azure/web-pubsub-express

CloudEvents ハンドラーのオプション。

プロパティ

allowedEndpoints	指定しない場合、既定ではすべてのエンドポイントを許可し、それ以外の場合は指定されたエンドポイントのみを許可します
handleConnect	"接続" イベントを処理します。サービスは応答の続行を待機します。
handleUserEvent	ユーザー イベントを処理します。サービスは応答の続行を待機します。
onConnected	"接続済み" ブロック解除イベントのイベント トリガー。 これはブロック解除イベントであり、サービスは応答を待機しません。
onDisconnected	"disconnected" ブロック解除イベントのイベント トリガー。 これはブロック解除イベントであり、サービスは応答を待機しません。
path	CloudEvents ハンドラーのパスのカスタム サービス パス。

プロパティの詳細

allowedEndpoints

指定しない場合、既定ではすべてのエンドポイントを許可し、それ以外の場合は指定されたエンドポイントのみを許可します

allowedEndpoints?: string[]

プロパティ値

string[]

handleConnect

"接続" イベントを処理します。サービスは応答の続行を待機します。

handleConnect?: (connectRequest: ConnectRequest, connectResponse: ConnectResponseHandler) => void

プロパティ値

(connectRequest: ConnectRequest, connectResponse: ConnectResponseHandler) => void

handleUserEvent

ユーザー イベントを処理します。サービスは応答の続行を待機します。

handleUserEvent?: (userEventRequest: UserEventRequest, userEventResponse: UserEventResponseHandler) => void

プロパティ値

(userEventRequest: UserEventRequest, userEventResponse: UserEventResponseHandler) => void

onConnected

"接続済み" ブロック解除イベントのイベント トリガー。 これはブロック解除イベントであり、サービスは応答を待機しません。

onConnected?: (connectedRequest: ConnectedRequest) => void

プロパティ値

(connectedRequest: ConnectedRequest) => void

onDisconnected

"disconnected" ブロック解除イベントのイベント トリガー。 これはブロック解除イベントであり、サービスは応答を待機しません。

onDisconnected?: (disconnectedRequest: DisconnectedRequest) => void

プロパティ値

(disconnectedRequest: DisconnectedRequest) => void

path

CloudEvents ハンドラーのパスのカスタム サービス パス。

path?: string

プロパティ値

string