@azure/web-pubsub-client package

Clases

InvocationError

Error lanzado cuando una invocación falla o se cancela.

SendMessageError

Error al enviar el mensaje

WebPubSubClient

El cliente WebPubSub

Interfaces

AbortGroupStreamOptions

Abortar las opciones de stream de grupo.

AckMessage

Mensaje de confirmación

AckMessageError

Detalles del error en AckMessage

CancelInvocationMessage

Cancelar mensaje de invocación

ConnectedMessage

Mensaje conectado

DisconnectedMessage

Mensaje desconectado

EndGroupStreamOptions

Terminar las opciones de stream del grupo.

GetClientAccessUrlOptions

Las opciones de inicio

GroupDataMessage

Mensaje de datos de grupo

GroupStateItem

La entrada de estado de una sola conexión dentro de un grupo

GroupStateSnapshotMessage

Mensaje de instantánea de estado del grupo, enviado tras un suscripción exitoso a GroupState

GroupStateUpdateMessage

Mensaje de actualización de estado del grupo, enviado cuando cambia el estado de una conexión

GroupStream

Un solo flujo de grupo entrante.

GroupStreamMessage

Un fragmento entrante de un flujo grupal.

GroupStreamSubscription

Suscripción devuelto por client.onGroupStream(...).

GroupStreamWriteOptions

Opciones de escritura de stream en grupo.

GroupStreamWriter

Abstracción de escritor de flujo de grupo para enviar un flujo lógico a un grupo.

InvocationErrorOptions
InvokeEventOptions

Opciones de operación de evento invocado

InvokeEventResult

Resultado de invokeEvent

InvokeMessage

Invocar mensaje

InvokeResponseError

Detalles del error de respuesta de invocación

InvokeResponseMessage

Invocar mensaje de respuesta

JoinGroupMessage

Mensaje unirse al grupo

JoinGroupOptions

Opciones de operación unirse al grupo

LeaveGroupMessage

Dejar el mensaje de grupo

LeaveGroupOptions

Dejar las opciones de operación de grupo

OnConnectedArgs

Parámetro de devolución de llamada OnConnected

OnDisconnectedArgs

Parámetro de devolución de llamada OnDisconnected

OnGroupDataMessageArgs

Parámetro de devolución de llamada OnGroupDataMessage

OnGroupStreamOptions

Opciones que controlan cómo se rastrean y despachan los flujos de grupo entrantes para una sola llamada registrada vía client.onGroupStream(callback, options).

La granularidad es de dos niveles:

  • Los valores de la opción se asignan al registro (es decir, por manejador): cada onGroupStream llamada lleva sus propios valores, y diferentes manejadores pueden usar valores distintos.
  • Los efectos de opción se aplican de forma independiente a cada flujo, identificados por su (group, streamId) par. Los flujos concurrentes — incluso dos flujos en el mismo grupo observados por el mismo manejador — tienen cada uno su propio temporizador inactivo y su propia handleFromStart puerta. Nada se comparte ni agrega entre flujos o grupos.
OnRejoinGroupFailedArgs

Parámetro de devolución de llamada RejoinGroupFailed

OnServerDataMessageArgs

Parámetro de devolución de llamada OnDataMessage

OnStoppedArgs

Parámetro de devolución de llamada OnStopped

OpenGroupStreamOptions

Opciones operativas de openGroupStream.

PingMessage

Mensaje de ping

PongMessage

El mensaje del pong

SendEventMessage

Enviar mensaje de evento personalizado

SendEventOptions

Opciones de operación de envío de eventos

SendMessageErrorOptions
SendToGroupMessage

Enviar al mensaje de grupo

SendToGroupOptions

Opciones de operación de envío a grupo

SequenceAckMessage

Mensaje de confirmación de secuencia

ServerDataMessage

Mensaje de datos del servidor

SetGroupStateMessage

Mensaje de estado del grupo Set

StartOptions

Las opciones de inicio

StartStreamOptions

Descriptor de flujo adjunto a un marco de control sendToGroup que abre un flujo.

StreamAckMessage

Mensaje de transmisión de ack.

StreamClosedMessage

Mensaje cerrado de stream.

StreamDataError

Detalle de error de stream.

StreamDataMessage

Mensaje de datos en streaming. Una carga útil con solo streamId representa un keepalive.

StreamEndError

Error de final de flujo que un flujo saliente puede enviar al servicio. El servicio decide la clasificación de nombre de error de alto nivel.

StreamEndMessage

Mensaje de fin de transmisión.

StreamInfo

Metadatos del flujo adjuntos a un mensaje de datos aguas abajo.

StreamNackMessage

Mensaje de nack en streaming.

SubscribeGroupStateMessage

Mensaje de estado de suscripción al grupo

UnsubscribeGroupStateMessage

Mensaje de darse de baja del estado del grupo

WebPubSubClientCredential

Credencial de WebPubSubClient

WebPubSubClientOptions

Opciones de cliente

WebPubSubClientProtocol

Interfaz que se va a implementar para un subprotocolo de web pubsub

WebPubSubMessageBase

El común de mensajes de web pubsub

WebPubSubResult

Resultado de la confirmación

WebPubSubRetryOptions

Las opciones de reintento

Alias de tipos

DownstreamMessageType

Tipos para mensajes de bajada

JSONTypes

Tipos que se pueden serializar y enviar como JSON.

RetryMode

Describe el tipo modo de reintento.

UpstreamMessageType

Tipos para mensajes ascendentes

WebPubSubDataType

El tipo de datos

WebPubSubMessage

Mensaje de web pubsub

Funciones

WebPubSubJsonProtocol()

Devuelve el protocolo "json.webpubsub.azure.v1".

WebPubSubJsonReliableProtocol()

Devuelve el protocolo "json.reliable.webpubsub.azure.v1".

Detalles de la función

WebPubSubJsonProtocol()

Devuelve el protocolo "json.webpubsub.azure.v1".

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Devoluciones

WebPubSubJsonReliableProtocol()

Devuelve el protocolo "json.reliable.webpubsub.azure.v1".

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Devoluciones