WebPubSubGroup interface

Paket:

@azure/web-pubsub

Eigenschaften

apiVersion	Die Web PubSub-API-Version, die von diesem Client verwendet wird
endpoint	Der Web PubSub-Endpunkt, mit dem dieser Client verbunden ist
groupName	Der Name dieser Gruppe
hubName	Der Name des Hubs, zu dem diese Gruppe gehört

Methoden

addConnection(string, GroupAddConnectionOptions)	Hinzufügen einer bestimmten Verbindung zu dieser Gruppe
addUser(string, GroupAddUserOptions)	Hinzufügen eines Benutzers zu dieser Gruppe
closeAllConnections(GroupCloseAllConnectionsOptions)	Schließen aller Verbindungen mit der Gruppe
listConnections(GroupListConnectionsOptions)	Auflisten von Verbindungen in dieser Gruppe
removeConnection(string, GroupRemoveConnectionOptions)	Entfernen einer bestimmten Verbindung aus dieser Gruppe
removeUser(string, GroupRemoveUserOptions)	Entfernen eines Benutzers aus dieser Gruppe
sendToAll(JSONTypes, GroupSendToAllOptions)	Senden einer JSON-Nachricht an jede Verbindung in dieser Gruppe
sendToAll(RequestBodyType, GroupSendToAllOptions)	Senden einer binären Nachricht an jede Verbindung in dieser Gruppe
sendToAll(string, GroupSendTextToAllOptions)	Senden einer Sms an jede Verbindung in dieser Gruppe

Details zur Eigenschaft

apiVersion

Die Web PubSub-API-Version, die von diesem Client verwendet wird

apiVersion: string

Eigenschaftswert

string

endpoint

Der Web PubSub-Endpunkt, mit dem dieser Client verbunden ist

endpoint: string

Eigenschaftswert

string

groupName

Der Name dieser Gruppe

groupName: string

Eigenschaftswert

string

hubName

Der Name des Hubs, zu dem diese Gruppe gehört

hubName: string

Eigenschaftswert

string

Details zur Methode

addConnection(string, GroupAddConnectionOptions)

Hinzufügen einer bestimmten Verbindung zu dieser Gruppe

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

Parameter

connectionId

string

Die Verbindungs-ID, die dieser Gruppe hinzugefügt werden soll

options

GroupAddConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

addUser(string, GroupAddUserOptions)

Hinzufügen eines Benutzers zu dieser Gruppe

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

Parameter

username

string

Der hinzuzufügende Benutzername

options

GroupAddUserOptions

Weitere Optionen

Gibt zurück

Promise<void>

closeAllConnections(GroupCloseAllConnectionsOptions)

Schließen aller Verbindungen mit der Gruppe

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

Parameter

options

GroupCloseAllConnectionsOptions

Weitere Optionen

Gibt zurück

Promise<void>

listConnections(GroupListConnectionsOptions)

Auflisten von Verbindungen in dieser Gruppe

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

Parameter

options

GroupListConnectionsOptions

Zusätzliche Optionen zum Auflisten von Verbindungen

Gibt zurück

Promise<PagedAsyncIterableIterator<WebPubSubGroupMember, WebPubSubGroupMember[], PageSettings>>

removeConnection(string, GroupRemoveConnectionOptions)

Entfernen einer bestimmten Verbindung aus dieser Gruppe

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

Parameter

connectionId

string

Die Verbindungs-ID, die aus dieser Gruppe entfernt werden soll

options

GroupRemoveConnectionOptions

Weitere Optionen

Gibt zurück

Promise<void>

removeUser(string, GroupRemoveUserOptions)

Entfernen eines Benutzers aus dieser Gruppe

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

Parameter

username

string

Der zu entfernende Benutzername

options

GroupRemoveUserOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToAll(JSONTypes, GroupSendToAllOptions)

Senden einer JSON-Nachricht an jede Verbindung in dieser Gruppe

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

Parameter

message

JSONTypes

Die zu sendende Nachricht

options

GroupSendToAllOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToAll(RequestBodyType, GroupSendToAllOptions)

Senden einer binären Nachricht an jede Verbindung in dieser Gruppe

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

Parameter

message

RequestBodyType

Die zu sendende binärnachricht

options

GroupSendToAllOptions

Weitere Optionen

Gibt zurück

Promise<void>

sendToAll(string, GroupSendTextToAllOptions)

Senden einer Sms an jede Verbindung in dieser Gruppe

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

Parameter

message

string

Die zu sendende Nachricht

options

GroupSendTextToAllOptions

Weitere Optionen

Gibt zurück

Promise<void>