@azure/web-pubsub-client package
Классы
| InvocationError |
Ошибка возникает, когда вызов не удаётся или отменяется. |
| SendMessageError |
Ошибка при отправке сообщения не удалось |
| WebPubSubClient |
Клиент WebPubSub |
Интерфейсы
| AbortGroupStreamOptions |
Отменить варианты группового потока. |
| AckMessage |
Сообщение об ошибке |
| AckMessageError |
Сведения об ошибке в AckMessage |
| CancelInvocationMessage |
Сообщение об отмене вызова |
| ConnectedMessage |
Подключенное сообщение |
| DisconnectedMessage |
Отключенное сообщение |
| EndGroupStreamOptions |
Опции потока в конце группы. |
| GetClientAccessUrlOptions |
Параметры запуска |
| GroupDataMessage |
Сообщение о групповых данных |
| GroupStateItem |
Запись состояния одного соединения внутри группы |
| GroupStateSnapshotMessage |
Сообщение о снимке состояния группы, отправленное после успешной подписки GroupState |
| GroupStateUpdateMessage |
Сообщение об обновлении состояния группы, отправляемое при изменении состояния соединения |
| GroupStream |
Один входящий групповой поток. |
| GroupStreamMessage |
Один входящий фрагмент группового потока. |
| GroupStreamSubscription |
Подписка возвращённа . |
| GroupStreamWriteOptions |
Опции группового потока записи. |
| GroupStreamWriter |
Абстракция группового потока для отправки одного логического потока в группу. |
| InvocationErrorOptions | |
| InvokeEventOptions |
Опции операции событий вызова |
| InvokeEventResult |
Результат invokeEvent |
| InvokeMessage |
Вызов сообщения |
| InvokeResponseError |
Детали ошибки вызова ответа |
| InvokeResponseMessage |
Вызов ответного сообщения |
| JoinGroupMessage |
Сообщение группы присоединения |
| JoinGroupOptions |
Параметры операции объединения групп |
| LeaveGroupMessage |
Оставьте сообщение группы |
| LeaveGroupOptions |
Оставьте параметры операции группы |
| OnConnectedArgs |
Параметр обратного вызова OnConnected |
| OnDisconnectedArgs |
Параметр обратного вызова OnDisconnected |
| OnGroupDataMessageArgs |
Параметр обратного вызова OnGroupDataMessage |
| OnGroupStreamOptions |
Опции, регулирующие отслеживание и отправку входящих групповых потоков для одного обратного вызова, зарегистрированного через Гранулярность двухуровнева:
|
| OnRejoinGroupFailedArgs |
Параметр обратного вызова RejoinGroupFailed |
| OnServerDataMessageArgs |
Параметр обратного вызова OnDataMessage |
| OnStoppedArgs |
Параметр обратного вызова OnStopped |
| OpenGroupStreamOptions |
опции операций openGroupStream. |
| PingMessage |
Пинг-сообщение |
| PongMessage |
Послание понга |
| SendEventMessage |
Отправка пользовательского сообщения о событии |
| SendEventOptions |
Параметры операции отправки событий |
| SendMessageErrorOptions | |
| SendToGroupMessage |
Отправка в группу сообщений |
| SendToGroupOptions |
Параметры операции отправки в группу |
| SequenceAckMessage |
Сообщение о последовательности |
| ServerDataMessage |
Сообщение о данных сервера |
| SetGroupStateMessage |
Сообщение состояния группы |
| StartOptions |
Параметры запуска |
| StartStreamOptions |
Дескриптор потока, прикреплённый к управляющему кадру sendToGroup, который открывает поток. |
| StreamAckMessage |
Транслировать сообщение ACK. |
| StreamClosedMessage |
Трансляция закрытого сообщения. |
| StreamDataError |
Детали ошибок потока. |
| StreamDataMessage |
Потоковое сообщение с данными. Полезная нагрузка с представляет собой только |
| StreamEndError |
Ошибка конца потока, которую исходящий поток может отправить сервису. Сервис определяет классификацию имён на высоком уровне. |
| StreamEndMessage |
Транслируйте сообщение в конце. |
| StreamInfo |
Потоковые метаданные, прикреплённые к следующему сообщению данных. |
| StreamNackMessage |
Транслировать голое сообщение. |
| SubscribeGroupStateMessage |
Сообщение о состоянии группы подписки |
| UnsubscribeGroupStateMessage |
Сообщение о состоянии группы «Отписаться» |
| WebPubSubClientCredential |
Учетные данные WebPubSubClient |
| WebPubSubClientOptions |
Параметры клиента |
| WebPubSubClientProtocol |
Интерфейс, реализованный для подпротокола веб-pubsub |
| WebPubSubMessageBase |
Общее сообщение web pubsub |
| WebPubSubResult |
Результат взлома |
| WebPubSubRetryOptions |
Параметры повтора |
Псевдонимы типа
| DownstreamMessageType |
Типы для подчиненных сообщений |
| JSONTypes |
Типы, которые можно сериализовать и отправить в формате JSON. |
| RetryMode |
Описание типа режима повтора |
| UpstreamMessageType |
Типы для исходящих сообщений |
| WebPubSubDataType |
Тип данных |
| WebPubSubMessage |
Сообщение web pubsub |
Функции
| Web |
Возврат протокола json.webpubsub.azure.v1 |
| Web |
Возврат протокола json.reliable.webpubsub.azure.v1 |
Сведения о функции
WebPubSubJsonProtocol()
Возврат протокола json.webpubsub.azure.v1
function WebPubSubJsonProtocol(): WebPubSubClientProtocol
Возвращаемое значение
WebPubSubJsonReliableProtocol()
Возврат протокола json.reliable.webpubsub.azure.v1
function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol