@azure/web-pubsub package

Klassen

AzureKeyCredential	Statische Schlüsselbasierte Anmeldeinformationen, die das Aktualisieren des zugrunde liegenden Schlüsselwerts unterstützen.
WebPubSubServiceClient	Client zum Herstellen einer Verbindung mit einem Web PubSub-Hub

Schnittstellen

ClientTokenResponse	Eine Antwort, die das Clienttoken enthält.
GenerateClientTokenOptions	Optionen zum Generieren eines Tokens zum Verbinden eines Clients mit dem Azure Web Pubsub-Dienst.
GroupAddConnectionOptions	Optionen zum Hinzufügen einer Verbindung zu einer Gruppe.
GroupAddUserOptions	Optionen zum Hinzufügen eines Benutzers zu einer Gruppe.
GroupAdminClientOptions	Optionen zum Erstellen eines GroupAdmin-Clients.
GroupCloseAllConnectionsOptions	Optionen zum Schließen aller Verbindungen mit einer Gruppe.
GroupHasUserOptions	Optionen zum Überprüfen, ob sich ein Benutzer in einer Gruppe befindet
GroupListConnectionsOptions	Optionen zum Auflisten von Verbindungen in einer Gruppe.
GroupRemoveConnectionOptions	Optionen zum Entfernen einer Verbindung aus einer Gruppe
GroupRemoveUserOptions	Optionen zum Entfernen eines Benutzers aus einer Gruppe
GroupSendTextToAllOptions	Optionen zum Senden von Textnachrichten an eine Gruppe..
GroupSendToAllOptions	Optionen zum Senden von Nachrichten an eine Gruppe.
HasConnectionOptions	Optionen zum Überprüfen, ob eine Verbindung vorhanden ist.
HubCloseAllConnectionsOptions	Optionen zum Schließen aller Verbindungen mit einem Hub.
HubCloseConnectionOptions	Optionen zum Schließen einer Verbindung mit einem Hub.
HubCloseUserConnectionsOptions	Optionen zum Schließen aller Verbindungen eines Benutzers mit einem Hub.
HubGrantPermissionOptions	Optionen zum Erteilen von Berechtigungen für eine Verbindung
HubHasGroupOptions	Optionen zum Überprüfen, ob eine Gruppe vorhanden ist.
HubHasPermissionOptions	Optionen zum Überprüfen, ob eine Verbindung über die angegebene Berechtigung verfügt
HubHasUserOptions	Optionen zum Überprüfen, ob ein Benutzer vorhanden ist.
HubRemoveUserFromAllGroupsOptions	Optionen zum Entfernen eines Benutzers aus allen Gruppen.
HubRevokePermissionOptions	Optionen zum Widerrufen von Berechtigungen aus einer Verbindung
HubSendTextToAllOptions	Optionen zum Senden von Textnachrichten an Hubs.
HubSendTextToConnectionOptions	Optionen zum Senden einer Textnachricht an eine Verbindung.
HubSendTextToUserOptions	Optionen zum Senden einer Textnachricht an einen Benutzer.
HubSendToAllOptions	Optionen zum Senden von Nachrichten an Hubs.
HubSendToConnectionOptions	Optionen zum Senden einer Nachricht an eine bestimmte Verbindung.
HubSendToUserOptions	Optionen zum Senden einer Nachricht an einen Benutzer.
WebPubSubGroup
WebPubSubGroupMember	Eine Verbindung in einer Gruppe im Web PubSub-Dienst.
WebPubSubServiceClientLogOptions	Optionen zum Konfigurieren der Protokollierungsoptionen.
WebPubSubServiceClientOptions	Optionen zum Erstellen eines HubAdmin-Clients.

Typaliase

JSONTypes	Typen, die als JSON serialisiert und gesendet werden können.
Permission
WebPubSubClientProtocol	Der Typ des angeforderten Clientendpunkts.

Functions

odata(TemplateStringsArray, unknown[])

Maskiert einen odata-Filterausdruck, um Fehler beim Anführen von Zeichenfolgenliteralen zu vermeiden. Beispielverwendung: import { odata } from "@azure/web-pubsub"; const userId = "vic's"; const anonymous = null; const length = 3; const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;

Details zur Funktion

odata(TemplateStringsArray, unknown[])

Maskiert einen odata-Filterausdruck, um Fehler beim Anführen von Zeichenfolgenliteralen zu vermeiden. Beispielverwendung:

import { odata } from "@azure/web-pubsub";

const userId = "vic's";
const anonymous = null;
const length = 3;
const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;

function odata(strings: TemplateStringsArray, values: unknown[]): string

Parameter

strings

TemplateStringsArray

Array von Zeichenfolgen für den Ausdruck

values

unknown[]

Array von Werten für den Ausdruck

Gibt zurück

string