WebPubSubGroup interface

Verze rozhraní API Web PubSub, kterou tento klient používá

apiVersion: string

Hodnota vlastnosti

Koncový bod Web PubSub, ke kterému je tento klient připojen

endpoint: string

Hodnota vlastnosti

Název této skupiny

groupName: string

Hodnota vlastnosti

Název centra, do které tato skupina patří

hubName: string

Hodnota vlastnosti

Přidání konkrétního připojení k této skupině

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

Parametry

Návraty

Přidání uživatele do této skupiny

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

Parametry

Návraty

Zavření všech připojení ke skupině

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

Parametry

Návraty

Seznam připojení v této skupině

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

Parametry

Návraty

Odebrání konkrétního připojení z této skupiny

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

Parametry

Návraty

Odebrání uživatele z této skupiny

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

Parametry

Návraty

Odeslání zprávy JSON ke každému připojení v této skupině

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

Parametry

Návraty

Odeslat binární zprávu každému připojení v této skupině

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

Parametry

Návraty

Odeslání textové zprávy ke každému připojení v této skupině

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

Parametry

Návraty