GenerateClientTokenOptions interface

Paquet:: @azure/web-pubsub

Options de génération d’un jeton pour connecter un client au service Azure Web Pubsub.

Extends: OperationOptions

Propriétés

clientProtocol	Type de protocole du client `default`: client WebPubSub par défaut. Exemple d’URL de connexion cliente : wss://exampleHost.com/client/hubs/exampleHub `mqtt`: client MQTT. Exemple d’URL de connexion du client : wss://exampleHost.com/client/mqtt/hubs/exampleHub
expirationTimeInMinutes	Minutes jusqu’à l’expiration du jeton.
groups	Groupes à joindre lorsque le client se connecte
roles	Rôles que la connexion avec le jeton généré aura. Les rôles donnent aux clients les autorisations initiales pour quitter, joindre ou publier dans des groupes lors de l’utilisation du sous-protocole PubSub `webpubsub.joinLeaveGroup`: le client peut rejoindre ou quitter n’importe quel groupe `webpubsub.sendToGroup`: le client peut envoyer des messages à n’importe quel groupe `webpubsub.joinLeaveGroup.<group>`: le client peut rejoindre ou quitter le groupe `<group>` `webpubsub.sendToGroup.<group>`: le client peut envoyer des messages au groupe `<group>` https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions
userId	UserId pour le client.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
onResponse	Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions	Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
serializerOptions	Options permettant de remplacer le comportement de sérialisation/de désérialisation.
tracingOptions	Options utilisées lorsque le suivi est activé.

Détails de la propriété

clientProtocol

Type de protocole du client

default: client WebPubSub par défaut. Exemple d’URL de connexion cliente : wss://exampleHost.com/client/hubs/exampleHub
mqtt: client MQTT. Exemple d’URL de connexion du client : wss://exampleHost.com/client/mqtt/hubs/exampleHub

clientProtocol?: WebPubSubClientProtocol

Valeur de propriété

WebPubSubClientProtocol

expirationTimeInMinutes

Minutes jusqu’à l’expiration du jeton.

expirationTimeInMinutes?: number

Valeur de propriété

number

groups

Groupes à joindre lorsque le client se connecte

groups?: string[]

Valeur de propriété

string[]

roles

Rôles que la connexion avec le jeton généré aura. Les rôles donnent aux clients les autorisations initiales pour quitter, joindre ou publier dans des groupes lors de l’utilisation du sous-protocole PubSub

webpubsub.joinLeaveGroup: le client peut rejoindre ou quitter n’importe quel groupe
webpubsub.sendToGroup: le client peut envoyer des messages à n’importe quel groupe
webpubsub.joinLeaveGroup.<group>: le client peut rejoindre ou quitter le groupe <group>
webpubsub.sendToGroup.<group>: le client peut envoyer des messages au groupe <group>

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

roles?: string[]

Valeur de propriété

string[]

userId

UserId pour le client.

userId?: string

Valeur de propriété

string

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

héritée de OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

héritée de OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

héritée de OperationOptions.requestOptions

serializerOptions

Options permettant de remplacer le comportement de sérialisation/de désérialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

héritée de OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

héritée de OperationOptions.tracingOptions