@azure/web-pubsub package

Classes

AzureKeyCredential	Uma credencial baseada em chave estática que oferece suporte à atualização do valor da chave subjacente.
WebPubSubServiceClient	Cliente para conexão a um hub Web PubSub

Interfaces

ClientTokenResponse	Uma resposta que contém o token do cliente.
GenerateClientTokenOptions	Opções para gerar um token para conectar um cliente ao serviço Azure Web Pubsub.
GroupAddConnectionOptions	Opções para adicionar uma ligação a um grupo.
GroupAddUserOptions	Opções para adicionar um usuário a um grupo.
GroupAdminClientOptions	Opções para construir um cliente GroupAdmin.
GroupCloseAllConnectionsOptions	Opções para fechar todas as conexões com um grupo.
GroupHasUserOptions	Opções para verificar se um usuário está em um grupo
GroupListConnectionsOptions	Opções para listar conexões em um grupo.
GroupRemoveConnectionOptions	Opções para remover uma ligação de um grupo
GroupRemoveUserOptions	Opções para remover um utilizador de um grupo
GroupSendTextToAllOptions	Opções para enviar mensagens de texto para um grupo..
GroupSendToAllOptions	Opções para enviar mensagens a um grupo.
HasConnectionOptions	Opções para verificar se existe uma ligação.
HubCloseAllConnectionsOptions	Opções para fechar todas as conexões com um hub.
HubCloseConnectionOptions	Opções para fechar uma conexão com um hub.
HubCloseUserConnectionsOptions	Opções para fechar todas as conexões de um usuário com um hub.
HubGrantPermissionOptions	Opções para conceder permissões a uma conexão
HubHasGroupOptions	Opções para verificar se existe um grupo.
HubHasPermissionOptions	Opções para verificar se uma conexão tem a permissão especificada
HubHasUserOptions	Opções para verificar se um usuário existe.
HubRemoveUserFromAllGroupsOptions	Opções para remover um usuário de todos os grupos.
HubRevokePermissionOptions	Opções para revogar permissões de uma conexão
HubSendTextToAllOptions	Opções para enviar mensagens de texto para hubs.
HubSendTextToConnectionOptions	Opções para enviar uma mensagem de texto para uma conexão.
HubSendTextToUserOptions	Opções para enviar uma mensagem de texto a um utilizador.
HubSendToAllOptions	Opções para enviar mensagens para hubs.
HubSendToConnectionOptions	Opções para enviar uma mensagem para uma conexão específica.
HubSendToUserOptions	Opções para enviar uma mensagem a um utilizador.
WebPubSubGroup
WebPubSubGroupMember	Uma conexão em um grupo no serviço Web PubSub.
WebPubSubServiceClientLogOptions	Opções para configurar as opções de registo.
WebPubSubServiceClientOptions	Opções para construir um cliente HubAdmin.

Aliases de Tipo

JSONTypes	Tipos que podem ser serializados e enviados como JSON.
Permission
WebPubSubClientProtocol	O tipo de ponto de extremidade do cliente que está sendo solicitado.

Funções

odata(TemplateStringsArray, unknown[])

Escapa de uma expressão de filtro odata para evitar erros com literais de cadeia de caracteres entre aspas. Exemplo de uso:

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

Detalhes de Função

odata(TemplateStringsArray, unknown[])

Escapa de uma expressão de filtro odata para evitar erros com literais de cadeia de caracteres entre aspas. Exemplo de uso:

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

Parâmetros

strings: TemplateStringsArray

Matriz de cadeias de caracteres para a expressão

values: unknown[]

Matriz de valores para a expressão

Devoluções

string