WebPubSubGroup interface

Versione dell'API Web PubSub usata da questo client

apiVersion: string

Valore della proprietà

Endpoint Web PubSub a cui il client è connesso

endpoint: string

Valore della proprietà

Nome di questo gruppo

groupName: string

Valore della proprietà

Il nome dell'hub a cui appartiene questo gruppo

hubName: string

Valore della proprietà

Aggiungere una connessione specifica a questo gruppo

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

Parametri

Restituisce

Aggiungere un utente a questo gruppo

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

Parametri

Restituisce

Chiudere tutte le connessioni al gruppo

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

Parametri

Restituisce

Elencare le connessioni in questo gruppo

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

Parametri

Restituisce

Rimuovere una connessione specifica da questo gruppo

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

Parametri

Restituisce

Rimuovere un utente da questo gruppo

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

Parametri

Restituisce

Inviare un messaggio JSON a ogni connessione in questo gruppo

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

Parametri

Restituisce

Inviare un messaggio binario a ogni connessione in questo gruppo

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

Parametri

Restituisce

Inviare un sms a ogni connessione in questo gruppo

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

Parametri

Restituisce