WebPubSubGroup interface
Özellikler
| api |
Bu istemci tarafından kullanılan Web PubSub API sürümü |
| endpoint | Bu istemcinin bağlı olduğu Web PubSub uç noktası |
| group |
Bu grubun adı |
| hub |
Bu grubun ait olduğu hub'ın adı |
Yöntemler
| add |
Bu gruba belirli bir bağlantı ekle |
| add |
Bu gruba kullanıcı ekle |
| close |
Gruba yönelik tüm bağlantıları kapatma |
| list |
Bu gruptaki bağlantıları listeleme |
| remove |
Bu gruptan belirli bir bağlantıyı kaldır |
| remove |
Bu gruptan bir kullanıcıyı kaldır |
| send |
Bu gruptaki her bağlantıya json iletisi gönder |
| send |
Bu gruptaki her bağlantıya ikili ileti gönder |
| send |
Bu gruptaki her bağlantıya kısa mesaj gönder |
Özellik Ayrıntıları
apiVersion
Bu istemci tarafından kullanılan Web PubSub API sürümü
apiVersion: string
Özellik Değeri
string
endpoint
Bu istemcinin bağlı olduğu Web PubSub uç noktası
endpoint: string
Özellik Değeri
string
groupName
Bu grubun adı
groupName: string
Özellik Değeri
string
hubName
Bu grubun ait olduğu hub'ın adı
hubName: string
Özellik Değeri
string
Yöntem Ayrıntıları
addConnection(string, GroupAddConnectionOptions)
Bu gruba belirli bir bağlantı ekle
function addConnection(connectionId: string, options?: GroupAddConnectionOptions): Promise<void>
Parametreler
- connectionId
-
string
Bu gruba eklenecek bağlantı kimliği
- options
- GroupAddConnectionOptions
Ek seçenekler
Döndürülenler
Promise<void>
addUser(string, GroupAddUserOptions)
Bu gruba kullanıcı ekle
function addUser(username: string, options?: GroupAddUserOptions): Promise<void>
Parametreler
- username
-
string
Eklenecek kullanıcı adı
- options
- GroupAddUserOptions
Ek seçenekler
Döndürülenler
Promise<void>
closeAllConnections(GroupCloseAllConnectionsOptions)
Gruba yönelik tüm bağlantıları kapatma
function closeAllConnections(options?: GroupCloseAllConnectionsOptions): Promise<void>
Parametreler
- options
- GroupCloseAllConnectionsOptions
Ek seçenekler
Döndürülenler
Promise<void>
listConnections(GroupListConnectionsOptions)
Bu gruptaki bağlantıları listeleme
function listConnections(options?: GroupListConnectionsOptions): Promise<PagedAsyncIterableIterator<WebPubSubGroupMember, WebPubSubGroupMember[], PageSettings>>
Parametreler
- options
- GroupListConnectionsOptions
Bağlantıları listelemek için ek seçenekler
Döndürülenler
removeConnection(string, GroupRemoveConnectionOptions)
Bu gruptan belirli bir bağlantıyı kaldır
function removeConnection(connectionId: string, options?: GroupRemoveConnectionOptions): Promise<void>
Parametreler
- connectionId
-
string
Bu gruptan kaldırılacak bağlantı kimliği
- options
- GroupRemoveConnectionOptions
Ek seçenekler
Döndürülenler
Promise<void>
removeUser(string, GroupRemoveUserOptions)
Bu gruptan bir kullanıcıyı kaldır
function removeUser(username: string, options?: GroupRemoveUserOptions): Promise<void>
Parametreler
- username
-
string
Kaldırılacak kullanıcı adı
- options
- GroupRemoveUserOptions
Ek seçenekler
Döndürülenler
Promise<void>
sendToAll(JSONTypes, GroupSendToAllOptions)
Bu gruptaki her bağlantıya json iletisi gönder
function sendToAll(message: JSONTypes, options?: GroupSendToAllOptions): Promise<void>
Parametreler
- message
- JSONTypes
Gönderilecek ileti
- options
- GroupSendToAllOptions
Ek seçenekler
Döndürülenler
Promise<void>
sendToAll(RequestBodyType, GroupSendToAllOptions)
Bu gruptaki her bağlantıya ikili ileti gönder
function sendToAll(message: RequestBodyType, options?: GroupSendToAllOptions): Promise<void>
Parametreler
- message
- RequestBodyType
Gönderilecek ikili ileti
- options
- GroupSendToAllOptions
Ek seçenekler
Döndürülenler
Promise<void>
sendToAll(string, GroupSendTextToAllOptions)
Bu gruptaki her bağlantıya kısa mesaj gönder
function sendToAll(message: string, options: GroupSendTextToAllOptions): Promise<void>
Parametreler
- message
-
string
Gönderilecek ileti
- options
- GroupSendTextToAllOptions
Ek seçenekler
Döndürülenler
Promise<void>