@azure/web-pubsub-client package

Classes

InvocationError

Erro lançado quando uma invocação falha ou é cancelada.

SendMessageError

Erro ao enviar mensagem com falha

WebPubSubClient

O cliente WebPubSub

Interfaces

AbortGroupStreamOptions

Abortar as opções de stream em grupo.

AckMessage

A mensagem de ack

AckMessageError

Detalhes do erro no AckMessage

CancelInvocationMessage

Cancelar mensagem de invocação

ConnectedMessage

Mensagem conectada

DisconnectedMessage

Mensagem desconectada

EndGroupStreamOptions

Fim das opções de stream em grupo.

GetClientAccessUrlOptions

As opções de início

GroupDataMessage

Mensagem de dados de grupo

GroupStateItem

A entrada de estado de uma única conexão dentro de um grupo

GroupStateSnapshotMessage

Mensagem de snapshot de estado do grupo, enviada após um sucesso do subscribeGroupState

GroupStateUpdateMessage

Mensagem de atualização de estado do grupo, enviada quando o estado de uma conexão muda

GroupStream

Um único stream de grupo de entrada.

GroupStreamMessage

Um fragmento de entrada de um fluxo de grupo.

GroupStreamSubscription

Assinatura devolvida por client.onGroupStream(...).

GroupStreamWriteOptions

Opções de escrita em grupos de stream.

GroupStreamWriter

Abstração de escritor de fluxo de grupo para enviar um fluxo lógico para um grupo.

InvocationErrorOptions
InvokeEventOptions

Invocar opções de operação de evento

InvokeEventResult

Resultado do invokeEvent

InvokeMessage

Invocar mensagem

InvokeResponseError

Detalhes do erro de resposta de invocar

InvokeResponseMessage

Invocar mensagem de resposta

JoinGroupMessage

Mensagem de grupo de junção

JoinGroupOptions

Opções de operação de grupo de junção

LeaveGroupMessage

Deixar mensagem de grupo

LeaveGroupOptions

Deixar opções de operação de grupo

OnConnectedArgs

Parâmetro do retorno de chamada OnConnected

OnDisconnectedArgs

Parâmetro do retorno de chamada OnDisconnected

OnGroupDataMessageArgs

Parâmetro do retorno de chamada OnGroupDataMessage

OnGroupStreamOptions

Opções que controlam como os fluxos de grupo recebidos são rastreados e despachados para um único callback registrado via client.onGroupStream(callback, options).

A granularidade é de dois níveis:

  • Os valores das opções são escopados para o registro (ou seja, por handler): cada onGroupStream chamada carrega seus próprios valores, e diferentes handlers podem usar valores diferentes.
  • Os efeitos de opção são aplicados independentemente a cada fluxo, identificados por seu (group, streamId) par. Fluxos simultâneos — mesmo dois fluxos no mesmo grupo observados pelo mesmo manipulador — cada um tem seu próprio temporizador ocioso e seu próprio handleFromStart portão. Nada é compartilhado ou agregado entre streams ou grupos.
OnRejoinGroupFailedArgs

Parâmetro de retorno de chamada de RejoinGroupFailed

OnServerDataMessageArgs

Parâmetro do retorno de chamada OnDataMessage

OnStoppedArgs

Parâmetro de retorno de chamada onStopped

OpenGroupStreamOptions

Opções de operação openGroupStream.

PingMessage

Mensagem de ping

PongMessage

A mensagem do Pong

SendEventMessage

Enviar mensagem de evento personalizada

SendEventOptions

Opções de operação de evento de envio

SendMessageErrorOptions
SendToGroupMessage

Enviar para mensagem de grupo

SendToGroupOptions

Enviar para opções de operação de grupo

SequenceAckMessage

Mensagem de ack de sequência

ServerDataMessage

Mensagem de dados do servidor

SetGroupStateMessage

Set mensagem de estado do grupo

StartOptions

As opções de início

StartStreamOptions

Descritor de fluxo anexado a um quadro de controle sendToGroup que abre um fluxo.

StreamAckMessage

Mensagem de stream ack.

StreamClosedMessage

Mensagem encerrada da transmissão.

StreamDataError

Detalhe do erro do fluxo.

StreamDataMessage

Mensagem de dados de stream. Uma carga útil com representa apenas streamId um keepalive.

StreamEndError

Erro no fim do fluxo que um fluxo de saída pode enviar ao serviço. O serviço decide a classificação de erro de alto nível do nome.

StreamEndMessage

Mensagem encerrada da transmissão.

StreamInfo

Metadados do fluxo anexados a uma mensagem de dados downstream.

StreamNackMessage

Mensagem de nack em streaming.

SubscribeGroupStateMessage

Mensagem de estado do grupo de assinatura

UnsubscribeGroupStateMessage

Mensagem de descredenciamento do estado do grupo

WebPubSubClientCredential

A credencial WebPubSubClient

WebPubSubClientOptions

As opções do cliente

WebPubSubClientProtocol

A interface a ser implementada para um subprotocol web pubsub

WebPubSubMessageBase

O comum da mensagem do web pubsub

WebPubSubResult

O resultado da ack

WebPubSubRetryOptions

As opções de repetição

Aliases de tipo

DownstreamMessageType

Tipos de mensagens downstream

JSONTypes

Tipos que podem ser serializados e enviados como JSON.

RetryMode

Descreve o tipo de Modo de Repetição

UpstreamMessageType

Tipos de mensagens upstream

WebPubSubDataType

O tipo de dados

WebPubSubMessage

A mensagem do web pubsub

Funções

WebPubSubJsonProtocol()

Retornar o protocolo "json.webpubsub.azure.v1"

WebPubSubJsonReliableProtocol()

Retornar o protocolo "json.reliable.webpubsub.azure.v1"

Detalhes da função

WebPubSubJsonProtocol()

Retornar o protocolo "json.webpubsub.azure.v1"

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Retornos

WebPubSubJsonReliableProtocol()

Retornar o protocolo "json.reliable.webpubsub.azure.v1"

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Retornos