@azure/web-pubsub package

Classi

AzureKeyCredential	Credenziali basate su chiavi statiche che supportano l'aggiornamento del valore della chiave sottostante.
WebPubSubServiceClient	Client per la connessione a un hub PubSub Web

Interfacce

ClientTokenResponse	Risposta contenente il token client.
GenerateClientTokenOptions	Opzioni per la generazione di un token per connettere un client al servizio Pubub Web di Azure.
GroupAddConnectionOptions	Opzioni per l'aggiunta di una connessione a un gruppo.
GroupAddUserOptions	Opzioni per l'aggiunta di un utente a un gruppo.
GroupAdminClientOptions	Opzioni per la costruzione di un client GroupAdmin.
GroupCloseAllConnectionsOptions	Opzioni per la chiusura di tutte le connessioni a un gruppo.
GroupHasUserOptions	Opzioni per verificare se un utente si trova in un gruppo
GroupListConnectionsOptions	Opzioni per elencare le connessioni in un gruppo.
GroupRemoveConnectionOptions	Opzioni per la rimozione di una connessione da un gruppo
GroupRemoveUserOptions	Opzioni per la rimozione di un utente da un gruppo
GroupSendTextToAllOptions	Opzioni per l'invio di messaggi di testo a un gruppo.
GroupSendToAllOptions	Opzioni per l'invio di messaggi a un gruppo.
HasConnectionOptions	Opzioni per verificare se esiste una connessione.
HubCloseAllConnectionsOptions	Opzioni per la chiusura di tutte le connessioni a un hub.
HubCloseConnectionOptions	Opzioni per la chiusura di una connessione a un hub.
HubCloseUserConnectionsOptions	Opzioni per chiudere tutte le connessioni di un utente a un hub.
HubGrantPermissionOptions	Opzioni per concedere le autorizzazioni a una connessione
HubHasGroupOptions	Opzioni per verificare se esiste un gruppo.
HubHasPermissionOptions	Opzioni per verificare se una connessione dispone dell'autorizzazione specificata
HubHasUserOptions	Opzioni per verificare se esiste un utente.
HubRemoveUserFromAllGroupsOptions	Opzioni per la rimozione di un utente da tutti i gruppi.
HubRevokePermissionOptions	Opzioni per revocare le autorizzazioni da una connessione
HubSendTextToAllOptions	Opzioni per l'invio di messaggi di testo agli hub.
HubSendTextToConnectionOptions	Opzioni per l'invio di un sms a una connessione.
HubSendTextToUserOptions	Opzioni per l'invio di un SMS a un utente.
HubSendToAllOptions	Opzioni per l'invio di messaggi agli hub.
HubSendToConnectionOptions	Opzioni per l'invio di un messaggio a una connessione specifica.
HubSendToUserOptions	Opzioni per l'invio di un messaggio a un utente.
WebPubSubGroup
WebPubSubGroupMember	Connessione in un gruppo nel servizio Web PubSub.
WebPubSubServiceClientLogOptions	Opzioni per configurare le opzioni di registrazione.
WebPubSubServiceClientOptions	Opzioni per la costruzione di un client HubAdmin.

Alias tipo

JSONTypes	Tipi che possono essere serializzati e inviati come JSON.
Permission
WebPubSubClientProtocol	Tipo di endpoint client richiesto.

Funzioni

odata(TemplateStringsArray, unknown[])

Esegue l'escape di un'espressione di filtro odata per evitare errori con valori letterali stringa tra virgolette. Esempio di utilizzo:

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}`;

Dettagli funzione

odata(TemplateStringsArray, unknown[])

Esegue l'escape di un'espressione di filtro odata per evitare errori con valori letterali stringa tra virgolette. Esempio di utilizzo:

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

Parametri

strings: TemplateStringsArray

Matrice di stringhe per l'espressione

values: unknown[]

Matrice di valori per l'espressione

Restituisce

string