@azure/web-pubsub-client package
Classes
| InvocationError |
Error thrown when an invocation fails or is cancelled. |
| SendMessageError |
Error when sending message failed |
| WebPubSubClient |
The WebPubSub client |
Interfaces
| AckMessage |
The ack message |
| AckMessageError |
Error detail in AckMessage |
| CancelInvocationMessage |
Cancel invocation message |
| ConnectedMessage |
Connected message |
| DisconnectedMessage |
Disconnected message |
| GetClientAccessUrlOptions |
The start options |
| GroupDataMessage |
Group data message |
| InvocationErrorOptions | |
| InvokeEventOptions |
Invoke event operation options |
| InvokeEventResult |
Result of invokeEvent |
| InvokeMessage |
Invoke message |
| InvokeResponseError |
Invoke response error details |
| InvokeResponseMessage |
Invoke response message |
| JoinGroupMessage |
Join group message |
| JoinGroupOptions |
Join group operation options |
| LeaveGroupMessage |
Leave group message |
| LeaveGroupOptions |
Leave group operation options |
| OnConnectedArgs |
Parameter of OnConnected callback |
| OnDisconnectedArgs |
Parameter of OnDisconnected callback |
| OnGroupDataMessageArgs |
Parameter of OnGroupDataMessage callback |
| OnRejoinGroupFailedArgs |
Parameter of RejoinGroupFailed callback |
| OnServerDataMessageArgs |
Parameter of OnDataMessage callback |
| OnStoppedArgs |
Parameter of OnStopped callback |
| PingMessage |
Ping message |
| PongMessage |
The pong message |
| SendEventMessage |
Send custom event message |
| SendEventOptions |
Send event operation options |
| SendMessageErrorOptions | |
| SendToGroupMessage |
Send to group message |
| SendToGroupOptions |
Send to group operation options |
| SequenceAckMessage |
Sequence ack message |
| ServerDataMessage |
Server data message |
| StartOptions |
The start options |
| WebPubSubClientCredential |
The WebPubSubClient credential |
| WebPubSubClientOptions |
The client options |
| WebPubSubClientProtocol |
The interface to be implemented for a web pubsub subprotocol |
| WebPubSubMessageBase |
The common of web pubsub message |
| WebPubSubResult |
The ack result |
| WebPubSubRetryOptions |
The retry options |
Type Aliases
| DownstreamMessageType |
Types for downstream messages |
| JSONTypes |
Types which can be serialized and sent as JSON. |
| RetryMode |
Describes the Retry Mode type |
| UpstreamMessageType |
Types for upstream messages |
| WebPubSubDataType |
The data type |
| WebPubSubMessage |
The web pubsub message |
Functions
| Web |
Return the "json.webpubsub.azure.v1" protocol |
| Web |
Return the "json.reliable.webpubsub.azure.v1" protocol |
Function Details
WebPubSubJsonProtocol()
Return the "json.webpubsub.azure.v1" protocol
function WebPubSubJsonProtocol(): WebPubSubClientProtocolReturns
WebPubSubJsonReliableProtocol()
Return the "json.reliable.webpubsub.azure.v1" protocol
function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol