@azure/web-pubsub-client package

Error thrown when an invocation fails or is cancelled.

Error when sending message failed

The WebPubSub client

Abort group stream options.

The ack message

Error detail in AckMessage

Cancel invocation message

Connected message

Disconnected message

End group stream options.

The start options

Group data message

A single connection's state entry within a group

Group state snapshot message, sent after a successful subscribeGroupState

Group state update message, pushed when a connection's state changes

A single inbound group stream.

One inbound fragment of a group stream.

Subscription returned by client.onGroupStream(...).

Group stream write options.

Group stream writer abstraction for sending one logical stream to a group.

Invoke event operation options

Result of invokeEvent

Invoke message

Invoke response error details

Invoke response message

Join group message

Join group operation options

Leave group message

Leave group operation options

Parameter of OnConnected callback

Parameter of OnDisconnected callback

Parameter of OnGroupDataMessage callback

Options controlling how inbound group streams are tracked and dispatched for a single callback registered via client.onGroupStream(callback, options).

Granularity is two-level:

• The option values are scoped to the registration (i.e. per handler): each onGroupStream call carries its own values, and different handlers may use different values.
• The option effects are applied independently to each stream, identified by its (group, streamId) pair. Concurrent streams — even two streams in the same group observed by the same handler — each get their own idle timer and their own handleFromStart gate. Nothing is shared or aggregated across streams or across groups.

Parameter of RejoinGroupFailed callback

Parameter of OnDataMessage callback

Parameter of OnStopped callback

openGroupStream operation options.

Ping message

The pong message

Send custom event message

Send event operation options

Send to group message

Send to group operation options

Sequence ack message

Server data message

Set group state message

The start options

Stream descriptor attached to a sendToGroup control frame that opens a stream.

Stream ack message.

Stream closed message.

Stream error detail.

Stream data message. A payload with only streamId represents a keepalive.

Stream end error that an outbound stream can send to the service. The service decides the high-level error name classification.

Stream end message.

Stream metadata attached to a downstream data message.

Stream nack message.

Subscribe group state message

Unsubscribe group state message

The WebPubSubClient credential

The client options

The interface to be implemented for a web pubsub subprotocol

The common of web pubsub message

The ack result

The retry options

Types for downstream messages

Types which can be serialized and sent as JSON.

Describes the Retry Mode type

Types for upstream messages

The data type

The web pubsub message

Return the "json.webpubsub.azure.v1" protocol

Return the "json.reliable.webpubsub.azure.v1" protocol