WebPubSubGroup interface

A versão da API Web PubSub que está sendo usada por este cliente

apiVersion: string

Valor de Propriedade

O ponto de extremidade Web PubSub ao qual este cliente está conectado

endpoint: string

Valor de Propriedade

O nome deste grupo

groupName: string

Valor de Propriedade

O nome do hub ao qual esse grupo pertence

hubName: string

Valor de Propriedade

Adicionar uma ligação específica a este grupo

function addConnection(connectionId: string, options?: GroupAddConnectionOptions): Promise<void>

Parâmetros

Devoluções

Adicionar um utilizador a este grupo

function addUser(username: string, options?: GroupAddUserOptions): Promise<void>

Parâmetros

Devoluções

Fechar todas as ligações ao grupo

function closeAllConnections(options?: GroupCloseAllConnectionsOptions): Promise<void>

Parâmetros

Devoluções

Listar conexões neste grupo

function listConnections(options?: GroupListConnectionsOptions): Promise<PagedAsyncIterableIterator<WebPubSubGroupMember, WebPubSubGroupMember[], PageSettings>>

Parâmetros

Devoluções

Remover uma ligação específica deste grupo

function removeConnection(connectionId: string, options?: GroupRemoveConnectionOptions): Promise<void>

Parâmetros

Devoluções

Remover um utilizador deste grupo

function removeUser(username: string, options?: GroupRemoveUserOptions): Promise<void>

Parâmetros

Devoluções

Enviar uma mensagem json para cada conexão neste grupo

function sendToAll(message: JSONTypes, options?: GroupSendToAllOptions): Promise<void>

Parâmetros

Devoluções

Enviar uma mensagem binária para cada conexão neste grupo

function sendToAll(message: RequestBodyType, options?: GroupSendToAllOptions): Promise<void>

Parâmetros

Devoluções

Enviar uma mensagem de texto para cada conexão neste grupo

function sendToAll(message: string, options: GroupSendTextToAllOptions): Promise<void>

Parâmetros

Devoluções