@azure/web-pubsub package

Klassen

AzureKeyCredential	Een referentie op basis van statische sleutels die ondersteuning biedt voor het bijwerken van de onderliggende sleutelwaarde.
WebPubSubServiceClient	Client voor het maken van verbinding met een Web PubSub-hub

Interfaces

ClientTokenResponse	Een antwoord met het clienttoken.
GenerateClientTokenOptions	Opties voor het genereren van een token om een client te verbinden met de Azure Web Pubsub-service.
GroupAddConnectionOptions	Opties voor het toevoegen van een verbinding aan een groep.
GroupAddUserOptions	Opties voor het toevoegen van een gebruiker aan een groep.
GroupAdminClientOptions	Opties voor het maken van een GroupAdmin-client.
GroupCloseAllConnectionsOptions	Opties voor het sluiten van alle verbindingen met een groep.
GroupHasUserOptions	Opties voor het controleren of een gebruiker zich in een groep bevindt
GroupListConnectionsOptions	Opties voor het weergeven van verbindingen in een groep.
GroupRemoveConnectionOptions	Opties voor het verwijderen van een verbinding uit een groep
GroupRemoveUserOptions	Opties voor het verwijderen van een gebruiker uit een groep
GroupSendTextToAllOptions	Opties voor het verzenden van sms-berichten naar een groep.
GroupSendToAllOptions	Opties voor het verzenden van berichten naar een groep.
HasConnectionOptions	Opties voor het controleren of er een verbinding bestaat.
HubCloseAllConnectionsOptions	Opties voor het sluiten van alle verbindingen met een hub.
HubCloseConnectionOptions	Opties voor het sluiten van een verbinding met een hub.
HubCloseUserConnectionsOptions	Opties voor het sluiten van alle verbindingen van een gebruiker met een hub.
HubGrantPermissionOptions	Opties voor het verlenen van machtigingen aan een verbinding
HubHasGroupOptions	Opties voor het controleren of er een groep bestaat.
HubHasPermissionOptions	Opties voor het controleren of een verbinding de opgegeven machtiging heeft
HubHasUserOptions	Opties voor het controleren of er een gebruiker bestaat.
HubRemoveUserFromAllGroupsOptions	Opties voor het verwijderen van een gebruiker uit alle groepen.
HubRevokePermissionOptions	Opties voor het intrekken van machtigingen vanuit een verbinding
HubSendTextToAllOptions	Opties voor het verzenden van sms-berichten naar hubs.
HubSendTextToConnectionOptions	Opties voor het verzenden van een sms-bericht naar een verbinding.
HubSendTextToUserOptions	Opties voor het verzenden van een sms-bericht naar een gebruiker.
HubSendToAllOptions	Opties voor het verzenden van berichten naar hubs.
HubSendToConnectionOptions	Opties voor het verzenden van een bericht naar een specifieke verbinding.
HubSendToUserOptions	Opties voor het verzenden van een bericht naar een gebruiker.
WebPubSubGroup
WebPubSubGroupMember	Een verbinding in een groep in de Web PubSub-service.
WebPubSubServiceClientLogOptions	Opties voor het configureren van de logboekregistratieopties.
WebPubSubServiceClientOptions	Opties voor het maken van een HubAdmin-client.

Type-aliassen

JSONTypes	Typen die kunnen worden geserialiseerd en verzonden als JSON.
Permission
WebPubSubClientProtocol	Het type clienteindpunt dat wordt aangevraagd.

Functies

odata(TemplateStringsArray, unknown[])

Escapet een odata-filterexpressie om fouten met letterlijke tekenreeksen te voorkomen. Voorbeeldgebruik: 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}`;

Functiedetails

odata(TemplateStringsArray, unknown[])

Escapet een odata-filterexpressie om fouten met letterlijke tekenreeksen te voorkomen. Voorbeeldgebruik:

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

Parameters

strings

TemplateStringsArray

Matrix van tekenreeksen voor de expressie

values

unknown[]

Matrix met waarden voor de expressie

Retouren

string