GenerateClientTokenOptions interface

Paket:: @azure/web-pubsub

Optionen zum Generieren eines Tokens zum Verbinden eines Clients mit dem Azure Web Pubsub-Dienst.

Extends: OperationOptions

Eigenschaften

clientProtocol	Der Protokolltyp des Clients `default`: WebPubSub-Standardclient. Beispiel-Clientverbindungs-URL: wss://exampleHost.com/client/hubs/exampleHub `mqtt`: MQTT-Client. Beispiel-Clientverbindungs-URL: wss://exampleHost.com/client/mqtt/hubs/exampleHub
expirationTimeInMinutes	Minuten bis zum Ablauf des Tokens.
groups	Die Gruppen, die beitreten sollen, wenn der Client eine Verbindung herstellt
roles	Die Rollen, über die die Verbindung mit dem generierten Token verfügt. Rollen erteilen dem Client anfängliche Berechtigungen zum Verlassen, Beitreten oder Veröffentlichen in Gruppen bei Verwendung des PubSub-Unterprotocols `webpubsub.joinLeaveGroup`: Der Client kann einer beliebigen Gruppe beitreten oder diese verlassen. `webpubsub.sendToGroup`: Der Client kann Nachrichten an eine beliebige Gruppe senden. `webpubsub.joinLeaveGroup.<group>`: Der Client kann gruppen `<group>` beitreten oder verlassen. `webpubsub.sendToGroup.<group>`: Der Client kann Nachrichten an Gruppen-`<group>` senden. https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions
userId	Die UserId für den Client.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onResponse	Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
serializerOptions	Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

clientProtocol

Der Protokolltyp des Clients

default: WebPubSub-Standardclient. Beispiel-Clientverbindungs-URL: wss://exampleHost.com/client/hubs/exampleHub
mqtt: MQTT-Client. Beispiel-Clientverbindungs-URL: wss://exampleHost.com/client/mqtt/hubs/exampleHub

clientProtocol?: WebPubSubClientProtocol

Eigenschaftswert

WebPubSubClientProtocol

expirationTimeInMinutes

Minuten bis zum Ablauf des Tokens.

expirationTimeInMinutes?: number

Eigenschaftswert

number

groups

Die Gruppen, die beitreten sollen, wenn der Client eine Verbindung herstellt

groups?: string[]

Eigenschaftswert

string[]

roles

Die Rollen, über die die Verbindung mit dem generierten Token verfügt. Rollen erteilen dem Client anfängliche Berechtigungen zum Verlassen, Beitreten oder Veröffentlichen in Gruppen bei Verwendung des PubSub-Unterprotocols

webpubsub.joinLeaveGroup: Der Client kann einer beliebigen Gruppe beitreten oder diese verlassen.
webpubsub.sendToGroup: Der Client kann Nachrichten an eine beliebige Gruppe senden.
webpubsub.joinLeaveGroup.<group>: Der Client kann gruppen <group> beitreten oder verlassen.
webpubsub.sendToGroup.<group>: Der Client kann Nachrichten an Gruppen-<group> senden.

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

roles?: string[]

Eigenschaftswert

string[]

userId

Die UserId für den Client.

userId?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

von OperationOptions.abortSignal geerbt

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

von OperationOptions.onResponse geerbt

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Von OperationOptions.requestOptions geerbt

serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

von OperationOptions.serializerOptions geerbt

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

von OperationOptions.tracingOptions geerbt