WebPubSubServiceClient class

Paket:: @azure/web-pubsub

Client zum Herstellen einer Verbindung mit einem Web PubSub-Hub

Konstruktoren

WebPubSubServiceClient(string, AzureKeyCredential | TokenCredential, string, WebPubSubServiceClientOptions)

Erstellt eine Instanz eines WebPubSubServiceClient zum Senden von Nachrichten und zum Verwalten von Gruppen, Verbindungen und Benutzern.

Beispielverwendung:

import { AzureKeyCredential, WebPubSubServiceClient } from "@azure/web-pubsub";

const key = new AzureKeyCredential("<Key>");
const serviceClient = new WebPubSubServiceClient("<Endpoint>", key, "<hubName>");

WebPubSubServiceClient(string, string, WebPubSubServiceClientOptions)

Erstellt eine Instanz eines WebPubSubServiceClient zum Senden von Nachrichten und zum Verwalten von Gruppen, Verbindungen und Benutzern.

Beispielverwendung:

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

const serviceClient = new WebPubSubServiceClient("<ConnectionString>", "<hubName>");

Eigenschaften

apiVersion	Die Web PubSub-API-Version, die von diesem Client verwendet wird
endpoint	Der Web PubSub-Endpunkt, mit dem dieser Client verbunden ist
hubName	Der Name des Hubs, mit dem dieser Client verbunden ist

Methoden

addConnectionsToGroups(string[], string, GroupAddConnectionOptions)	Hinzufügen gefilterter Verbindungen zu mehreren Gruppen
closeAllConnections(HubCloseAllConnectionsOptions)	Schließen aller Verbindungen mit diesem Hub
closeConnection(string, HubCloseConnectionOptions)	Schließen einer bestimmten Verbindung zu diesem Hub
closeUserConnections(string, HubCloseUserConnectionsOptions)	Schließen aller Verbindungen mit der angegebenen Benutzer-ID
connectionExists(string, HasConnectionOptions)	Überprüfen, ob eine bestimmte Verbindung mit diesem Hub verbunden ist
getClientAccessToken(GenerateClientTokenOptions)	Generieren Sie ein Token für einen Client, um eine Verbindung mit dem Azure Web PubSub-Dienst herzustellen.
grantPermission(string, Permission, HubGrantPermissionOptions)	Erteilen von Berechtigungen für eine Verbindung
group(string)	Abrufen eines Clients für eine Gruppe
groupExists(string, HubHasGroupOptions)	Überprüfen Sie, ob eine bestimmte Gruppe vorhanden ist (d. h. über aktive Verbindungen verfügt).
hasPermission(string, Permission, HubHasPermissionOptions)	Überprüfen, ob die Verbindung über die angegebene Berechtigung verfügt
removeConnectionFromAllGroups(string, HubCloseConnectionOptions)	Entfernen einer bestimmten Verbindung aus allen Gruppen, denen sie beigetreten sind
removeConnectionsFromGroups(string[], string, GroupRemoveConnectionOptions)	Entfernen gefilterter Verbindungen aus mehreren Gruppen
removeUserFromAllGroups(string, HubCloseConnectionOptions)	Entfernen eines bestimmten Benutzers aus allen Gruppen, denen er beigetreten ist
revokePermission(string, Permission, HubRevokePermissionOptions)	Widerrufen von Berechtigungen aus einer Verbindung
sendToAll(JSONTypes, HubSendToAllOptions)	Übertragen sie eine JSON-Nachricht an alle Verbindungen auf diesem Hub.
sendToAll(RequestBodyType, HubSendToAllOptions)	Übertragen einer binären Nachricht an alle Verbindungen auf diesem Hub.
sendToAll(string, HubSendTextToAllOptions)	Übertragen einer Sms an alle Verbindungen auf diesem Hub.
sendToConnection(string, JSONTypes, HubSendToConnectionOptions)	Senden einer binärnachricht an eine bestimmte Verbindung
sendToConnection(string, RequestBodyType, HubSendTextToConnectionOptions \| HubSendToConnectionOptions)	Senden einer binärnachricht an eine bestimmte Verbindung
sendToConnection(string, string, HubSendTextToConnectionOptions)	Senden einer Sms an eine bestimmte Verbindung
sendToUser(string, JSONTypes, HubSendToUserOptions)	Senden einer JSON-Nachricht an einen bestimmten Benutzer
sendToUser(string, RequestBodyType, HubSendTextToUserOptions \| HubSendToUserOptions)	Senden einer binärnachricht an einen bestimmten Benutzer
sendToUser(string, string, HubSendTextToUserOptions)	Senden einer Sms an einen bestimmten Benutzer
userExists(string, HubHasUserOptions)	Überprüfen Sie, ob ein bestimmter Benutzer mit diesem Hub verbunden ist.

Details zum Konstruktor

WebPubSubServiceClient(string, AzureKeyCredential | TokenCredential, string, WebPubSubServiceClientOptions)

Erstellt eine Instanz eines WebPubSubServiceClient zum Senden von Nachrichten und zum Verwalten von Gruppen, Verbindungen und Benutzern.

Beispielverwendung:

import { AzureKeyCredential, WebPubSubServiceClient } from "@azure/web-pubsub";

const key = new AzureKeyCredential("<Key>");
const serviceClient = new WebPubSubServiceClient("<Endpoint>", key, "<hubName>");

new WebPubSubServiceClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, hubName: string, options?: WebPubSubServiceClientOptions)

Parameter

endpoint: string

Der Endpunkt, mit dem eine Verbindung hergestellt werden soll

credential: AzureKeyCredential | TokenCredential

Ein AzureKeyCredential-Dienstschlüssel mit Ihrem Dienstschlüssel

hubName: string

Der Name des Hubs, mit dem eine Verbindung hergestellt werden soll.

options: WebPubSubServiceClientOptions

Optionen zum Konfigurieren der HTTP-Pipeline

WebPubSubServiceClient(string, string, WebPubSubServiceClientOptions)

Erstellt eine Instanz eines WebPubSubServiceClient zum Senden von Nachrichten und zum Verwalten von Gruppen, Verbindungen und Benutzern.

Beispielverwendung:

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

const serviceClient = new WebPubSubServiceClient("<ConnectionString>", "<hubName>");

new WebPubSubServiceClient(connectionString: string, hubName: string, options?: WebPubSubServiceClientOptions)

Parameter

connectionString: string

Die Verbindungszeichenfolge

hubName: string

Der Name des Hubs, mit dem eine Verbindung hergestellt werden soll. Wird "_default" nicht angegeben, wird verwendet.

options: WebPubSubServiceClientOptions

Optionen zum Konfigurieren der HTTP-Pipeline

Details zur Eigenschaft

apiVersion

Die Web PubSub-API-Version, die von diesem Client verwendet wird

apiVersion: string

Eigenschaftswert

string

endpoint

Der Web PubSub-Endpunkt, mit dem dieser Client verbunden ist

endpoint: string

Eigenschaftswert

string

hubName

Der Name des Hubs, mit dem dieser Client verbunden ist

hubName: string

Eigenschaftswert

string

Details zur Methode

addConnectionsToGroups(string[], string, GroupAddConnectionOptions)

Hinzufügen gefilterter Verbindungen zu mehreren Gruppen

function addConnectionsToGroups(groups: string[], filter: string, options?: GroupAddConnectionOptions): Promise<void>

Parameter

groups: string[]

Eine Liste der Gruppen, zu denen Zielverbindungen hinzugefügt werden

filter: string

Ein OData-Filter, der Zielverbindungen erfüllt

options: GroupAddConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

closeAllConnections(HubCloseAllConnectionsOptions)

Schließen aller Verbindungen mit diesem Hub

function closeAllConnections(options?: HubCloseAllConnectionsOptions): Promise<void>

Parameter

options: HubCloseAllConnectionsOptions

Weitere Optionen

Gibt zurück

Promise<void>

closeConnection(string, HubCloseConnectionOptions)

Schließen einer bestimmten Verbindung zu diesem Hub

function closeConnection(connectionId: string, options?: HubCloseConnectionOptions): Promise<void>

Parameter

connectionId: string

Verbindungs-ID zum Schließen

options: HubCloseConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

closeUserConnections(string, HubCloseUserConnectionsOptions)

Schließen aller Verbindungen mit der angegebenen Benutzer-ID

function closeUserConnections(userId: string, options?: HubCloseUserConnectionsOptions): Promise<void>

Parameter

userId: string

options: HubCloseUserConnectionsOptions

Weitere Optionen

Gibt zurück

Promise<void>

connectionExists(string, HasConnectionOptions)

Überprüfen, ob eine bestimmte Verbindung mit diesem Hub verbunden ist

function connectionExists(connectionId: string, options?: HasConnectionOptions): Promise<boolean>

Parameter

connectionId: string

Zu überprüfende Verbindungs-ID

options: HasConnectionOptions

Weitere Optionen

Gibt zurück

Promise<boolean>

getClientAccessToken(GenerateClientTokenOptions)

Generieren Sie ein Token für einen Client, um eine Verbindung mit dem Azure Web PubSub-Dienst herzustellen.

function getClientAccessToken(options?: GenerateClientTokenOptions): Promise<ClientTokenResponse>

Parameter

options: GenerateClientTokenOptions

Weitere Optionen

Gibt zurück

Promise<ClientTokenResponse>

grantPermission(string, Permission, HubGrantPermissionOptions)

Erteilen von Berechtigungen für eine Verbindung

function grantPermission(connectionId: string, permission: Permission, options?: HubGrantPermissionOptions): Promise<void>

Parameter

connectionId: string

Die Verbindungs-ID zum Erteilen von Berechtigungen für

permission: Permission

options: HubGrantPermissionOptions

Weitere Optionen

Gibt zurück

Promise<void>

group(string)

Abrufen eines Clients für eine Gruppe

function group(groupName: string): WebPubSubGroup

Parameter

groupName: string

Der Name der Gruppe, mit der eine Verbindung hergestellt werden soll.

Gibt zurück

WebPubSubGroup

groupExists(string, HubHasGroupOptions)

Überprüfen Sie, ob eine bestimmte Gruppe vorhanden ist (d. h. über aktive Verbindungen verfügt).

function groupExists(groupName: string, options?: HubHasGroupOptions): Promise<boolean>

Parameter

groupName: string

Der zu überprüfende Gruppenname

options: HubHasGroupOptions

Weitere Optionen

Gibt zurück

Promise<boolean>

hasPermission(string, Permission, HubHasPermissionOptions)

Überprüfen, ob die Verbindung über die angegebene Berechtigung verfügt

function hasPermission(connectionId: string, permission: Permission, options?: HubHasPermissionOptions): Promise<boolean>

Parameter

connectionId: string

Die Verbindungs-ID zum Überprüfen der Berechtigung

permission: Permission

options: HubHasPermissionOptions

Weitere Optionen

Gibt zurück

Promise<boolean>

removeConnectionFromAllGroups(string, HubCloseConnectionOptions)

Entfernen einer bestimmten Verbindung aus allen Gruppen, denen sie beigetreten sind

function removeConnectionFromAllGroups(connectionId: string, options?: HubCloseConnectionOptions): Promise<void>

Parameter

connectionId: string

Die Verbindungs-ID, die aus allen Gruppen entfernt werden soll

options: HubCloseConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

removeConnectionsFromGroups(string[], string, GroupRemoveConnectionOptions)

Entfernen gefilterter Verbindungen aus mehreren Gruppen

function removeConnectionsFromGroups(groups: string[], filter: string, options?: GroupRemoveConnectionOptions): Promise<void>

Parameter

groups: string[]

Eine Liste der Gruppen, aus denen Zielverbindungen entfernt werden

filter: string

Ein OData-Filter, der Zielverbindungen erfüllt

options: GroupRemoveConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

removeUserFromAllGroups(string, HubCloseConnectionOptions)

Entfernen eines bestimmten Benutzers aus allen Gruppen, denen er beigetreten ist

function removeUserFromAllGroups(userId: string, options?: HubCloseConnectionOptions): Promise<void>

Parameter

userId: string

Die Benutzer-ID, die aus allen Gruppen entfernt werden soll

options: HubCloseConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

revokePermission(string, Permission, HubRevokePermissionOptions)

Widerrufen von Berechtigungen aus einer Verbindung

function revokePermission(connectionId: string, permission: Permission, options?: HubRevokePermissionOptions): Promise<void>

Parameter

connectionId: string

Die Verbindungs-ID zum Widerrufen von Berechtigungen von

permission: Permission

options: HubRevokePermissionOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToAll(JSONTypes, HubSendToAllOptions)

Übertragen sie eine JSON-Nachricht an alle Verbindungen auf diesem Hub.

function sendToAll(message: JSONTypes, options?: HubSendToAllOptions): Promise<void>

Parameter

message: JSONTypes

Die zu sendende JSON-Nachricht

options: HubSendToAllOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToAll(RequestBodyType, HubSendToAllOptions)

Übertragen einer binären Nachricht an alle Verbindungen auf diesem Hub.

function sendToAll(message: RequestBodyType, options?: HubSendToAllOptions): Promise<void>

Parameter

message: RequestBodyType

Die zu sendende Nachricht

options: HubSendToAllOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToAll(string, HubSendTextToAllOptions)

Übertragen einer Sms an alle Verbindungen auf diesem Hub.

function sendToAll(message: string, options: HubSendTextToAllOptions): Promise<void>

Parameter

message: string

Die zu sendende Textnachricht

options: HubSendTextToAllOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToConnection(string, JSONTypes, HubSendToConnectionOptions)

Senden einer binärnachricht an eine bestimmte Verbindung

function sendToConnection(connectionId: string, message: JSONTypes, options?: HubSendToConnectionOptions): Promise<void>

Parameter

connectionId: string

Verbindungs-ID zum Senden an

message: JSONTypes

Die JSON-Nachricht

options: HubSendToConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToConnection(string, RequestBodyType, HubSendTextToConnectionOptions | HubSendToConnectionOptions)

Senden einer binärnachricht an eine bestimmte Verbindung

function sendToConnection(connectionId: string, message: RequestBodyType, options?: HubSendTextToConnectionOptions | HubSendToConnectionOptions): Promise<void>

Parameter

connectionId: string

Verbindungs-ID zum Senden an

message: RequestBodyType

Die binäre Nachricht

options: HubSendTextToConnectionOptions | HubSendToConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToConnection(string, string, HubSendTextToConnectionOptions)

Senden einer Sms an eine bestimmte Verbindung

function sendToConnection(connectionId: string, message: string, options: HubSendTextToConnectionOptions): Promise<void>

Parameter

connectionId: string

Verbindungs-ID zum Senden an

message: string

Die Textnachricht

options: HubSendTextToConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToUser(string, JSONTypes, HubSendToUserOptions)

Senden einer JSON-Nachricht an einen bestimmten Benutzer

function sendToUser(username: string, message: JSONTypes, options?: HubSendToUserOptions): Promise<void>

Parameter

username: string

Benutzername, an den gesendet werden soll

message: JSONTypes

Die zu sendende Josn-Nachricht

options: HubSendToUserOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToUser(string, RequestBodyType, HubSendTextToUserOptions | HubSendToUserOptions)

Senden einer binärnachricht an einen bestimmten Benutzer

function sendToUser(username: string, message: RequestBodyType, options?: HubSendTextToUserOptions | HubSendToUserOptions): Promise<void>

Parameter

username: string

Der Benutzername, an den gesendet werden soll

message: RequestBodyType

Die zu sendende binärnachricht

options: HubSendTextToUserOptions | HubSendToUserOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToUser(string, string, HubSendTextToUserOptions)

Senden einer Sms an einen bestimmten Benutzer

function sendToUser(username: string, message: string, options: HubSendTextToUserOptions): Promise<void>

Parameter

username: string

Benutzername, an den gesendet werden soll

message: string

Die zu sendende Textnachricht

options: HubSendTextToUserOptions

Weitere Optionen

Gibt zurück

Promise<void>

userExists(string, HubHasUserOptions)

Überprüfen Sie, ob ein bestimmter Benutzer mit diesem Hub verbunden ist.

function userExists(username: string, options?: HubHasUserOptions): Promise<boolean>

Parameter

username: string

Der benutzername, auf den gesucht werden soll

options: HubHasUserOptions

Weitere Optionen

Gibt zurück

Promise<boolean>