@azure/web-pubsub package

Классы

AzureKeyCredential	Учетные данные на основе статического ключа, поддерживающие обновление базового значения ключа.
WebPubSubServiceClient	Клиент для подключения к концентратору Web PubSub

Интерфейсы

ClientTokenResponse	Ответ, содержащий маркер клиента.
GenerateClientTokenOptions	Параметры создания маркера для подключения клиента к службе Azure Web Pubsub.
GroupAddConnectionOptions	Параметры добавления соединения в группу.
GroupAddUserOptions	Параметры добавления пользователя в группу.
GroupAdminClientOptions	Параметры создания клиента GroupAdmin.
GroupCloseAllConnectionsOptions	Параметры закрытия всех подключений к группе.
GroupHasUserOptions	Параметры проверки того, находится ли пользователь в группе
GroupListConnectionsOptions	Варианты перечисления соединений в группе.
GroupRemoveConnectionOptions	Параметры удаления подключения из группы
GroupRemoveUserOptions	Параметры удаления пользователя из группы
GroupSendTextToAllOptions	Параметры отправки текстовых сообщений в группу..
GroupSendToAllOptions	Параметры отправки сообщений в группу.
HasConnectionOptions	Параметры проверки наличия подключения.
HubCloseAllConnectionsOptions	Параметры закрытия всех подключений к концентратору.
HubCloseConnectionOptions	Параметры закрытия подключения к концентратору.
HubCloseUserConnectionsOptions	Параметры закрытия всех подключений пользователя к концентратору.
HubGrantPermissionOptions	Параметры предоставления разрешений для подключения
HubHasGroupOptions	Параметры проверки наличия группы.
HubHasPermissionOptions	Параметры проверки наличия указанного разрешения для подключения
HubHasUserOptions	Параметры проверки наличия пользователя.
HubRemoveUserFromAllGroupsOptions	Параметры удаления пользователя из всех групп.
HubRevokePermissionOptions	Параметры отзыва разрешений из подключения
HubSendTextToAllOptions	Параметры отправки текстовых сообщений в центры.
HubSendTextToConnectionOptions	Параметры отправки текстового сообщения в соединение.
HubSendTextToUserOptions	Параметры отправки текстового сообщения пользователю.
HubSendToAllOptions	Параметры отправки сообщений в центры.
HubSendToConnectionOptions	Параметры отправки сообщения в определенное соединение.
HubSendToUserOptions	Параметры отправки сообщения пользователю.
WebPubSubGroup
WebPubSubGroupMember	Подключение в группе в службе Web PubSub.
WebPubSubServiceClientLogOptions	Параметры настройки параметров ведения журнала.
WebPubSubServiceClientOptions	Параметры создания клиента HubAdmin.

Псевдонимы типа

JSONTypes	Типы, которые можно сериализовать и отправить в формате JSON.
Permission
WebPubSubClientProtocol	Тип запрашиваемой конечной точки клиента.

Функции

odata(TemplateStringsArray, unknown[])

Экранирует выражение фильтра odata, чтобы избежать ошибок с помощью строковых литерала. Пример использования:

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

Сведения о функции

odata(TemplateStringsArray, unknown[])

Экранирует выражение фильтра odata, чтобы избежать ошибок с помощью строковых литерала. Пример использования:

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

Параметры

strings: TemplateStringsArray

Массив строк для выражения

values: unknown[]

Массив значений для выражения

Возвращаемое значение

string