Share via

WebPubSubHubProperties interface

  • Reference
Package:
@azure/arm-webpubsub

Properties of a hub.

Properties

anonymousConnectPolicy

The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".
eventHandlers

Event handler of a hub.
eventListeners

Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.
webSocketKeepAliveIntervalInSeconds

The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds.

Property Details

anonymousConnectPolicy

The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".

anonymousConnectPolicy?: string

Property Value

string

eventHandlers

Event handler of a hub.

eventHandlers?: EventHandler[]

Property Value

EventHandler[]

eventListeners

Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.

eventListeners?: EventListener_2[]

Property Value

EventListener[]

webSocketKeepAliveIntervalInSeconds

The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds.

webSocketKeepAliveIntervalInSeconds?: number

Property Value

number