GenerateClientTokenOptions interface

Paquete:: @azure/web-pubsub

Opciones para generar un token para conectar un cliente al servicio Azure Web Pubsub.

Extends: OperationOptions

Propiedades

clientProtocol	Tipo de protocolo del cliente `default`: cliente WebPubSub predeterminado. Dirección URL de conexión de cliente de ejemplo: wss://exampleHost.com/client/hubs/exampleHub `mqtt`: cliente MQTT. Dirección URL de conexión de cliente de ejemplo: wss://exampleHost.com/client/mqtt/hubs/exampleHub
expirationTimeInMinutes	Minutos hasta que expire el token.
groups	Grupos que se van a unir cuando el cliente se conecta
roles	Los roles que tendrá la conexión con el token generado. Los roles conceden al cliente permisos iniciales para salir, unirse o publicar en grupos cuando se usa el subprotocolo pubSub `webpubsub.joinLeaveGroup`: el cliente puede unirse o dejar cualquier grupo `webpubsub.sendToGroup`: el cliente puede enviar mensajes a cualquier grupo `webpubsub.joinLeaveGroup.<group>`: el cliente puede unirse o dejar `<group>` de grupo `webpubsub.sendToGroup.<group>`: el cliente puede enviar mensajes al grupo `<group>` https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions
userId	UserId para el cliente.

Propiedades heredadas

abortSignal	Señal que se puede usar para anular las solicitudes.
onResponse	Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
requestOptions	Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.
serializerOptions	Opciones para invalidar el comportamiento de serialización o des serialización.
tracingOptions	Opciones que se usan al habilitar el seguimiento.

Detalles de las propiedades

clientProtocol

Tipo de protocolo del cliente

default: cliente WebPubSub predeterminado. Dirección URL de conexión de cliente de ejemplo: wss://exampleHost.com/client/hubs/exampleHub
mqtt: cliente MQTT. Dirección URL de conexión de cliente de ejemplo: wss://exampleHost.com/client/mqtt/hubs/exampleHub

clientProtocol?: WebPubSubClientProtocol

Valor de propiedad

WebPubSubClientProtocol

expirationTimeInMinutes

Minutos hasta que expire el token.

expirationTimeInMinutes?: number

Valor de propiedad

number

groups

Grupos que se van a unir cuando el cliente se conecta

groups?: string[]

Valor de propiedad

string[]

roles

Los roles que tendrá la conexión con el token generado. Los roles conceden al cliente permisos iniciales para salir, unirse o publicar en grupos cuando se usa el subprotocolo pubSub

webpubsub.joinLeaveGroup: el cliente puede unirse o dejar cualquier grupo
webpubsub.sendToGroup: el cliente puede enviar mensajes a cualquier grupo
webpubsub.joinLeaveGroup.<group>: el cliente puede unirse o dejar <group> de grupo
webpubsub.sendToGroup.<group>: el cliente puede enviar mensajes al grupo <group>

https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions

roles?: string[]

Valor de propiedad

string[]

userId

UserId para el cliente.

userId?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

heredado de OperationOptions.abortSignal

onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

RawResponseCallback

heredado de OperationOptions.onResponse

requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado de OperationOptions.requestOptions

serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

heredado de OperationOptions.serializerOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

heredado de OperationOptions.tracingOptions