@azure/web-pubsub package

Classes

AzureKeyCredential	Informations d’identification statiques basées sur une clé qui prend en charge la mise à jour de la valeur de clé sous-jacente.
WebPubSubServiceClient	Client pour la connexion à un hub Web PubSub

Interfaces

ClientTokenResponse	Réponse contenant le jeton client.
GenerateClientTokenOptions	Options de génération d’un jeton pour connecter un client au service Azure Web Pubsub.
GroupAddConnectionOptions	Options d’ajout d’une connexion à un groupe.
GroupAddUserOptions	Options d’ajout d’un utilisateur à un groupe.
GroupAdminClientOptions	Options de construction d’un client GroupAdmin.
GroupCloseAllConnectionsOptions	Options de fermeture de toutes les connexions à un groupe.
GroupHasUserOptions	Options pour vérifier si un utilisateur se trouve dans un groupe
GroupListConnectionsOptions	Options permettant de répertorier les connexions dans un groupe.
GroupRemoveConnectionOptions	Options de suppression d’une connexion d’un groupe
GroupRemoveUserOptions	Options de suppression d’un utilisateur d’un groupe
GroupSendTextToAllOptions	Options d’envoi de sms à un groupe..
GroupSendToAllOptions	Options d’envoi de messages à un groupe.
HasConnectionOptions	Options permettant de vérifier si une connexion existe.
HubCloseAllConnectionsOptions	Options de fermeture de toutes les connexions à un hub.
HubCloseConnectionOptions	Options de fermeture d’une connexion à un hub.
HubCloseUserConnectionsOptions	Options de fermeture de toutes les connexions d’un utilisateur à un hub.
HubGrantPermissionOptions	Options d’octroi d’autorisations à une connexion
HubHasGroupOptions	Options permettant de vérifier si un groupe existe.
HubHasPermissionOptions	Options pour vérifier si une connexion a l’autorisation spécifiée
HubHasUserOptions	Options permettant de vérifier si un utilisateur existe.
HubRemoveUserFromAllGroupsOptions	Options de suppression d’un utilisateur de tous les groupes.
HubRevokePermissionOptions	Options de révocation des autorisations d’une connexion
HubSendTextToAllOptions	Options d’envoi de sms vers des hubs.
HubSendTextToConnectionOptions	Options d’envoi d’un sms à une connexion.
HubSendTextToUserOptions	Options d’envoi d’un sms à un utilisateur.
HubSendToAllOptions	Options d’envoi de messages à des hubs.
HubSendToConnectionOptions	Options d’envoi d’un message à une connexion spécifique.
HubSendToUserOptions	Options d’envoi d’un message à un utilisateur.
WebPubSubGroup
WebPubSubGroupMember	Une connexion dans un groupe dans le service Web PubSub.
WebPubSubServiceClientLogOptions	Options pour configurer les options de journalisation.
WebPubSubServiceClientOptions	Options de construction d’un client HubAdmin.

Alias de type

JSONTypes	Types qui peuvent être sérialisés et envoyés en tant que JSON.
Permission
WebPubSubClientProtocol	Type de point de terminaison client demandé.

Functions

odata(TemplateStringsArray, unknown[])

Échappe une expression de filtre odata pour éviter les erreurs avec des littéraux de chaîne de guillemets. Exemple d’utilisation :

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

Informations relatives à la fonction

odata(TemplateStringsArray, unknown[])

Échappe une expression de filtre odata pour éviter les erreurs avec des littéraux de chaîne de guillemets. Exemple d’utilisation :

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

Paramètres

strings: TemplateStringsArray

Tableau de chaînes pour l’expression

values: unknown[]

Tableau de valeurs pour l’expression

Retours

string