WebPubSubEventHandlerOptions interface

The options for the CloudEvents handler.

Properties

allowedEndpoints	If not specified, by default allow all the endpoints, otherwise only allow specified endpoints
handleConnect	Handle 'connect' event, the service waits for the response to proceed.
handleUserEvent	Handle user events, the service waits for the response to proceed.
onConnected	Event trigger for "connected" unblocking event. This is an unblocking event and the service does not wait for the response.
onDisconnected	Event triggers for "disconnected" unblocking event. This is an unblocking event and the service does not wait for the response.
path	Custom serving path for the path of the CloudEvents handler.

If not specified, by default allow all the endpoints, otherwise only allow specified endpoints

allowedEndpoints?: string[]

string[]

Handle 'connect' event, the service waits for the response to proceed.

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

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

Handle user events, the service waits for the response to proceed.

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

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

Event trigger for "connected" unblocking event. This is an unblocking event and the service does not wait for the response.

onConnected?: (connectedRequest: ConnectedRequest) => void

(connectedRequest: ConnectedRequest) => void

Event triggers for "disconnected" unblocking event. This is an unblocking event and the service does not wait for the response.

onDisconnected?: (disconnectedRequest: DisconnectedRequest) => void

(disconnectedRequest: DisconnectedRequest) => void

Custom serving path for the path of the CloudEvents handler.

path?: string

string