@azure/web-pubsub package

Klasser

AzureKeyCredential	En statisk nyckelbaserad autentiseringsuppgift som stöder uppdatering av det underliggande nyckelvärdet.
WebPubSubServiceClient	Klient för att ansluta till en Web PubSub-hubb

Gränssnitt

ClientTokenResponse	Ett svar som innehåller klienttoken.
GenerateClientTokenOptions	Alternativ för att generera en token för att ansluta en klient till Azure Web Pubsub-tjänsten.
GroupAddConnectionOptions	Alternativ för att lägga till en anslutning till en grupp.
GroupAddUserOptions	Alternativ för att lägga till en användare i en grupp.
GroupAdminClientOptions	Alternativ för att konstruera en GroupAdmin-klient.
GroupCloseAllConnectionsOptions	Alternativ för att stänga alla anslutningar till en grupp.
GroupHasUserOptions	Alternativ för att kontrollera om en användare finns i en grupp
GroupListConnectionsOptions	Alternativ för att lista anslutningar i en grupp.
GroupRemoveConnectionOptions	Alternativ för att ta bort en anslutning från en grupp
GroupRemoveUserOptions	Alternativ för att ta bort en användare från en grupp
GroupSendTextToAllOptions	Alternativ för att skicka textmeddelanden till en grupp..
GroupSendToAllOptions	Alternativ för att skicka meddelanden till en grupp.
HasConnectionOptions	Alternativ för att kontrollera om det finns en anslutning.
HubCloseAllConnectionsOptions	Alternativ för att stänga alla anslutningar till en hubb.
HubCloseConnectionOptions	Alternativ för att stänga en anslutning till en hubb.
HubCloseUserConnectionsOptions	Alternativ för att stänga alla en användares anslutningar till en hubb.
HubGrantPermissionOptions	Alternativ för att bevilja behörigheter till en anslutning
HubHasGroupOptions	Alternativ för att kontrollera om en grupp finns.
HubHasPermissionOptions	Alternativ för att kontrollera om en anslutning har den angivna behörigheten
HubHasUserOptions	Alternativ för att kontrollera om en användare finns.
HubRemoveUserFromAllGroupsOptions	Alternativ för att ta bort en användare från alla grupper.
HubRevokePermissionOptions	Alternativ för att återkalla behörigheter från en anslutning
HubSendTextToAllOptions	Alternativ för att skicka textmeddelanden till hubbar.
HubSendTextToConnectionOptions	Alternativ för att skicka ett textmeddelande till en anslutning.
HubSendTextToUserOptions	Alternativ för att skicka ett textmeddelande till en användare.
HubSendToAllOptions	Alternativ för att skicka meddelanden till hubbar.
HubSendToConnectionOptions	Alternativ för att skicka ett meddelande till en specifik anslutning.
HubSendToUserOptions	Alternativ för att skicka ett meddelande till en användare.
WebPubSubGroup
WebPubSubGroupMember	En anslutning i en grupp i Web PubSub-tjänsten.
WebPubSubServiceClientLogOptions	Alternativ för att konfigurera loggningsalternativen.
WebPubSubServiceClientOptions	Alternativ för att konstruera en HubAdmin-klient.

Typalias

JSONTypes	Typer som kan serialiseras och skickas som JSON.
Permission
WebPubSubClientProtocol	Den typ av klientslutpunkt som begärs.

Funktioner

odata(TemplateStringsArray, unknown[])

Undflyr ett odatafilteruttryck för att undvika fel med att citera strängliteraler. Exempel på användning:

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

Funktionsinformation

odata(TemplateStringsArray, unknown[])

Undflyr ett odatafilteruttryck för att undvika fel med att citera strängliteraler. Exempel på användning:

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

Parametrar

strings: TemplateStringsArray

Matris med strängar för uttrycket

values: unknown[]

Matris med värden för uttrycket

Returer

string