@azure/web-pubsub package

Třídy

AzureKeyCredential

Přihlašovací údaje založené na statickém klíči, které podporují aktualizaci hodnoty základního klíče.

WebPubSubServiceClient

Klient pro připojení k centru Web PubSub

Rozhraní

ClientTokenResponse

Odpověď obsahující token klienta.

GenerateClientTokenOptions

Možnosti generování tokenu pro připojení klienta ke službě Azure Web Pubsub

GroupAddConnectionOptions

Možnosti přidání připojení ke skupině

GroupAddUserOptions

Možnosti pro přidání uživatele do skupiny

GroupAdminClientOptions

Možnosti pro vytvoření klienta GroupAdmin

GroupCloseAllConnectionsOptions

Možnosti pro zavření všech připojení ke skupině

GroupHasUserOptions

Možnosti kontroly, jestli je uživatel ve skupině

GroupListConnectionsOptions

Možnosti pro výpis spojení ve skupině.

GroupRemoveConnectionOptions

Možnosti odebrání připojení ze skupiny

GroupRemoveUserOptions

Možnosti pro odebrání uživatele ze skupiny

GroupSendTextToAllOptions

Možnosti pro odesílání textových zpráv skupině.

GroupSendToAllOptions

Možnosti pro odesílání zpráv do skupiny

HasConnectionOptions

Možnosti kontroly, jestli připojení existuje.

HubCloseAllConnectionsOptions

Možnosti pro zavření všech připojení k centru

HubCloseConnectionOptions

Možnosti pro zavření připojení k centru

HubCloseUserConnectionsOptions

Možnosti pro zavření všech připojení uživatele k centru

HubGrantPermissionOptions

Možnosti udělení oprávnění k připojení

HubHasGroupOptions

Možnosti kontroly, jestli skupina existuje.

HubHasPermissionOptions

Možnosti kontroly, jestli má připojení zadané oprávnění

HubHasUserOptions

Možnosti kontroly, jestli uživatel existuje.

HubRemoveUserFromAllGroupsOptions

Možnosti pro odebrání uživatele ze všech skupin

HubRevokePermissionOptions

Možnosti odvolání oprávnění z připojení

HubSendTextToAllOptions

Možnosti odesílání textových zpráv do center

HubSendTextToConnectionOptions

Možnosti odeslání textové zprávy do připojení

HubSendTextToUserOptions

Možnosti odeslání textové zprávy uživateli

HubSendToAllOptions

Možnosti odesílání zpráv do center

HubSendToConnectionOptions

Možnosti odeslání zprávy konkrétnímu připojení

HubSendToUserOptions

Možnosti odeslání zprávy uživateli

WebPubSubGroup
WebPubSubGroupMember

Připojení ve skupině ve službě Web PubSub.

WebPubSubServiceClientLogOptions

Možnosti konfigurace možností protokolování

WebPubSubServiceClientOptions

Možnosti pro vytvoření klienta HubAdmin

Aliasy typu

JSONTypes

Typy, které lze serializovat a posílat jako JSON.

Permission
WebPubSubClientProtocol

Typ požadovaného koncového bodu klienta.

Funkce

odata(TemplateStringsArray, unknown[])

Uvozuje výraz filtru odata, aby nedocházelo k chybám s řetězcovými literály. Příklad použití:

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

Podrobnosti funkce

odata(TemplateStringsArray, unknown[])

Uvozuje výraz filtru odata, aby nedocházelo k chybám s řetězcovými literály. Příklad použití:

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

Parametry

strings

TemplateStringsArray

Pole řetězců pro výraz

values

unknown[]

Pole hodnot pro výraz

Návraty

string