GenerateClientTokenOptions interface

Pakket:

@azure/web-pubsub

Opties voor het genereren van een token om een client te verbinden met de Azure Web Pubsub-service.

Uitbreiding

OperationOptions

Eigenschappen

clientProtocol	Het protocoltype van de client default: Standaard WebPubSub-client. Voorbeeld van clientverbindings-URL: wss://exampleHost.com/client/hubs/exampleHub mqtt: MQTT-client. Voorbeeld van clientverbindings-URL: wss://exampleHost.com/client/mqtt/hubs/exampleHub
expirationTimeInMinutes	Minuten totdat het token verloopt.
groups	De groepen die moeten worden gekoppeld wanneer de client verbinding maakt
roles	De rollen die de verbinding met het gegenereerde token hebben. Rollen geven de client initiële machtigingen om groepen te verlaten, eraan deel te nemen of te publiceren wanneer ze PubSub-subprotocol gebruiken webpubsub.joinLeaveGroup: de client kan lid worden van een groep of een groep verlaten webpubsub.sendToGroup: de client kan berichten verzenden naar elke groep webpubsub.joinLeaveGroup.<group>: de client kan deelnemen aan of de groep verlaten <group> webpubsub.sendToGroup.<group>: de client kan berichten verzenden naar de groep <group> https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions
userId	De userId voor de client.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
serializerOptions	Opties voor het overschrijven van serialisatie/deserialisatiegedrag.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

clientProtocol

Het protocoltype van de client

• default: Standaard WebPubSub-client. Voorbeeld van clientverbindings-URL: wss://exampleHost.com/client/hubs/exampleHub
• mqtt: MQTT-client. Voorbeeld van clientverbindings-URL: wss://exampleHost.com/client/mqtt/hubs/exampleHub

clientProtocol?: WebPubSubClientProtocol

Waarde van eigenschap

WebPubSubClientProtocol

expirationTimeInMinutes

Minuten totdat het token verloopt.

expirationTimeInMinutes?: number

Waarde van eigenschap

number

groups

De groepen die moeten worden gekoppeld wanneer de client verbinding maakt

groups?: string[]

Waarde van eigenschap

string[]

roles

De rollen die de verbinding met het gegenereerde token hebben. Rollen geven de client initiële machtigingen om groepen te verlaten, eraan deel te nemen of te publiceren wanneer ze PubSub-subprotocol gebruiken

• webpubsub.joinLeaveGroup: de client kan lid worden van een groep of een groep verlaten
• webpubsub.sendToGroup: de client kan berichten verzenden naar elke groep
• webpubsub.joinLeaveGroup.<group>: de client kan deelnemen aan of de groep verlaten <group>
• webpubsub.sendToGroup.<group>: de client kan berichten verzenden naar de groep <group>

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

roles?: string[]

Waarde van eigenschap

string[]

userId

De userId voor de client.

userId?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

serializerOptions

Opties voor het overschrijven van serialisatie/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

overgenomen van OperationOptions.serializerOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions