@azure/web-pubsub-client package

Classes

InvocationError

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

SendMessageError

Erro ao enviar mensagem falhou

WebPubSubClient

O cliente WebPubSub

Interfaces

AbortGroupStreamOptions

Abortar as opções de stream de grupo.

AckMessage

A mensagem ack

AckMessageError

Detalhe 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 do grupo

GroupStateItem

Entrada de estado de uma única ligação dentro de um grupo

GroupStateSnapshotMessage

Mensagem de snapshot do estado do grupo, enviada após um subscritorGroupState bem-sucedido

GroupStateUpdateMessage

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

GroupStream

Um único stream de grupo de entrada.

GroupStreamMessage

Um fragmento de entrada de um fluxo de grupo.

GroupStreamSubscription

Subscrição devolvida por client.onGroupStream(...).

GroupStreamWriteOptions

Opções de escrita de fluxo em grupo.

GroupStreamWriter

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

InvocationErrorOptions
InvokeEventOptions

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

InvokeEventResult

Resultado do invokeEvent

InvokeMessage

Invocar mensagem

InvokeResponseError

Detalhes do erro de resposta invocar

InvokeResponseMessage

Invocar mensagem de resposta

JoinGroupMessage

Mensagem de adesão ao grupo

JoinGroupOptions

Opções de operação de ingresso em grupo

LeaveGroupMessage

Deixar mensagem de grupo

LeaveGroupOptions

Deixe as 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 de retorno de chamada OnGroupDataMessage

OnGroupStreamOptions

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

A granularidade é de dois níveis:

  • Os valores das opções são atribuídos ao registo (ou seja, por handler): cada onGroupStream chamada tem os seus próprios valores, e diferentes handlers podem usar valores diferentes.
  • Os efeitos de opção são aplicados independentemente a cada fluxo, identificados pelo seu (group, streamId) par. Fluxos simultâneos — mesmo dois fluxos no mesmo grupo observados pelo mesmo handler — têm cada um o seu próprio temporizador de inatividade e o seu próprio handleFromStart gate. Nada é partilhado ou agregado entre streams ou grupos.
OnRejoinGroupFailedArgs

Parâmetro de retorno de chamada RejoinGroupFailed

OnServerDataMessageArgs

Parâmetro de retorno de chamada OnDataMessage

OnStoppedArgs

Parâmetro de retorno de chamada OnStopped

OpenGroupStreamOptions

Opções operacionais do openGroupStream.

PingMessage

Mensagem de ping

PongMessage

A mensagem do Pong

SendEventMessage

Enviar mensagem de evento personalizada

SendEventOptions

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

SendMessageErrorOptions
SendToGroupMessage

Enviar para mensagem de grupo

SendToGroupOptions

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

SequenceAckMessage

Seqüência ack mensagem

ServerDataMessage

Mensagem de dados do servidor

SetGroupStateMessage

Mensagem de estado do grupo Set

StartOptions

As opções de início

StartStreamOptions

Descritor de fluxo associado a um quadro de controlo sendToGroup que abre um fluxo.

StreamAckMessage

Mensagem de stream ack.

StreamClosedMessage

Mensagem de stream encerrada.

StreamDataError

Detalhe do erro do fluxo.

StreamDataMessage

Transmitir mensagem de dados. Uma carga útil com representa apenas streamId um keepalive.

StreamEndError

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

StreamEndMessage

Mensagem terminada da transmissão.

StreamInfo

Metadados do fluxo anexados a uma mensagem de dados a jusante.

StreamNackMessage

Transmitir mensagem de nack.

SubscribeGroupStateMessage

Mensagem de estado de subscrever grupo

UnsubscribeGroupStateMessage

Mensagem de desinscrição do estado do grupo

WebPubSubClientCredential

A credencial WebPubSubClient

WebPubSubClientOptions

As opções do cliente

WebPubSubClientProtocol

A interface a ser implementada para um subprotocolo web pubsub

WebPubSubMessageBase

O comum da mensagem web pubsub

WebPubSubResult

O resultado ack

WebPubSubRetryOptions

As opções de repetição

Aliases de Tipo

DownstreamMessageType

Tipos de mensagens a jusante

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 web pubsub

Funções

WebPubSubJsonProtocol()

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

WebPubSubJsonReliableProtocol()

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

Detalhes de Função

WebPubSubJsonProtocol()

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

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Devoluções

WebPubSubJsonReliableProtocol()

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

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Devoluções