@azure/web-pubsub-client package

类

InvocationError	当调用失败或被取消时，会抛出错误。
SendMessageError	发送消息失败时出错
WebPubSubClient	WebPubSub 客户端

接口

AbortGroupStreamOptions	取消组流选项。
AckMessage	确认消息
AckMessageError	AckMessage 中的错误详细信息
CancelInvocationMessage	取消调用消息
ConnectedMessage	已连接消息
DisconnectedMessage	断开连接的消息
EndGroupStreamOptions	结束组流选项。
GetClientAccessUrlOptions	开始选项
GroupDataMessage	对数据消息进行分组
GroupStateItem	单个连接在组内的状态条目
GroupStateSnapshotMessage	组状态快照消息，在成功订阅组状态后发送
GroupStateUpdateMessage	组状态更新消息，连接状态变化时推送
GroupStream	一个单一的入站组流。
GroupStreamMessage	一个组流的入站片段。
GroupStreamSubscription	订阅由 .`client.onGroupStream(...)`
GroupStreamWriteOptions	组流写入选项。
GroupStreamWriter	组流写入抽象用于向一个组发送一个逻辑流。
InvocationErrorOptions
InvokeEventOptions	调用事件操作选项
InvokeEventResult	invokeEvent 的结果
InvokeMessage	Invoke 消息
InvokeResponseError	调用响应错误详情
InvokeResponseMessage	调用响应消息
JoinGroupMessage	加入组消息
JoinGroupOptions	联接组作选项
LeaveGroupMessage	保留组消息
LeaveGroupOptions	保留组作选项
OnConnectedArgs	OnConnected 回调的参数
OnDisconnectedArgs	OnDisconnected 回调的参数
OnGroupDataMessageArgs	OnGroupDataMessage 回调的参数
OnGroupStreamOptions	控制如何跟踪和调度单次回呼的进站组流的选项，注册于 `client.onGroupStream(callback, options)`。粒度是两层次的：选项值是对应注册值的（即每个处理器）：每个 `onGroupStream` 调用携带自己的值，不同处理器可能使用不同的值。选项效应分别独立应用于每个流，通过其 `(group, streamId)` 对来识别。并发流——即使是同一组中由同一处理程序观察的两个流——各自拥有自己的空闲计时器和门 `handleFromStart` 。没有任何信息流或群组之间共享或聚合。
OnRejoinGroupFailedArgs	RejoinGroupFailed 回调的参数
OnServerDataMessageArgs	OnDataMessage 回调的参数
OnStoppedArgs	OnStopped 回调的参数
OpenGroupStreamOptions	开放GroupStream操作选项。
PingMessage	Ping消息
PongMessage	乒乓信息
SendEventMessage	发送自定义事件消息
SendEventOptions	发送事件作选项
SendMessageErrorOptions
SendToGroupMessage	发送到组消息
SendToGroupOptions	发送到组作选项
SequenceAckMessage	序列确认消息
ServerDataMessage	服务器数据消息
SetGroupStateMessage	Set 组状态消息
StartOptions	开始选项
StartStreamOptions	流描述符附加到一个发送组控制框架，用于开启流。
StreamAckMessage	流式 ack 消息。
StreamClosedMessage	流媒体关闭消息。
StreamDataError	流媒体错误详情。
StreamDataMessage	流数据消息。只有 `streamId` 的有效载荷代表保持活状态。
StreamEndError	流结束错误，出流可以发送给服务。服务部门决定高级别错误名称分类。
StreamEndMessage	直播结束消息。
StreamInfo	将流元数据附加到下游数据消息上。
StreamNackMessage	直播 Nack 消息。
SubscribeGroupStateMessage	订阅组状态消息
UnsubscribeGroupStateMessage	取消订阅组状态消息
WebPubSubClientCredential	WebPubSubClient 凭据
WebPubSubClientOptions	客户端选项
WebPubSubClientProtocol	要为 Web pubsub 子协议实现的接口
WebPubSubMessageBase	Web pubsub 消息的常见情况
WebPubSubResult	确认结果
WebPubSubRetryOptions	重试选项

类型别名

DownstreamMessageType	下游消息的类型
JSONTypes	可以序列化和发送为 JSON 的类型。
RetryMode	描述重试模式类型
UpstreamMessageType	上游消息的类型
WebPubSubDataType	数据类型
WebPubSubMessage	Web pubsub 消息

函数

WebPubSubJsonProtocol()	返回“json.webpubsub.azure.v1”协议
WebPubSubJsonReliableProtocol()	返回“json.reliable.webpubsub.azure.v1”协议

WebPubSubJsonProtocol()

返回“json.webpubsub.azure.v1”协议

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

返回

WebPubSubClientProtocol

WebPubSubJsonReliableProtocol()

返回“json.reliable.webpubsub.azure.v1”协议

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

返回

WebPubSubClientProtocol

@azure/web-pubsub-client package

类

接口

类型别名

函数

函数详细信息

WebPubSubJsonProtocol()

返回

WebPubSubJsonReliableProtocol()

返回