WebPubSubGroup interface
속성
| api |
이 클라이언트에서 사용 중인 Web PubSub API 버전 |
| endpoint | 이 클라이언트가 연결된 Web PubSub 엔드포인트 |
| group |
이 그룹의 이름 |
| hub |
이 그룹이 속한 허브의 이름 |
메서드
| add |
이 그룹에 특정 연결 추가 |
| add |
이 그룹에 사용자 추가 |
| close |
그룹에 대한 모든 연결 닫기 |
| list |
이 그룹의 연결 나열 |
| remove |
이 그룹에서 특정 연결 제거 |
| remove |
이 그룹에서 사용자 제거 |
| send |
이 그룹의 모든 연결에 json 메시지 보내기 |
| send |
이 그룹의 모든 연결에 이진 메시지 보내기 |
| send |
이 그룹의 모든 연결에 문자 메시지 보내기 |
속성 세부 정보
apiVersion
이 클라이언트에서 사용 중인 Web PubSub API 버전
apiVersion: string
속성 값
string
endpoint
이 클라이언트가 연결된 Web PubSub 엔드포인트
endpoint: string
속성 값
string
groupName
이 그룹의 이름
groupName: string
속성 값
string
hubName
이 그룹이 속한 허브의 이름
hubName: string
속성 값
string
메서드 세부 정보
addConnection(string, GroupAddConnectionOptions)
이 그룹에 특정 연결 추가
function addConnection(connectionId: string, options?: GroupAddConnectionOptions): Promise<void>
매개 변수
- connectionId
-
string
이 그룹에 추가할 연결 ID
- options
- GroupAddConnectionOptions
추가 옵션
반환
Promise<void>
addUser(string, GroupAddUserOptions)
이 그룹에 사용자 추가
function addUser(username: string, options?: GroupAddUserOptions): Promise<void>
매개 변수
- username
-
string
추가할 사용자 이름
- options
- GroupAddUserOptions
추가 옵션
반환
Promise<void>
closeAllConnections(GroupCloseAllConnectionsOptions)
그룹에 대한 모든 연결 닫기
function closeAllConnections(options?: GroupCloseAllConnectionsOptions): Promise<void>
매개 변수
- options
- GroupCloseAllConnectionsOptions
추가 옵션
반환
Promise<void>
listConnections(GroupListConnectionsOptions)
이 그룹의 연결 나열
function listConnections(options?: GroupListConnectionsOptions): Promise<PagedAsyncIterableIterator<WebPubSubGroupMember, WebPubSubGroupMember[], PageSettings>>
매개 변수
- options
- GroupListConnectionsOptions
연결 나열을 위한 추가 옵션
반환
removeConnection(string, GroupRemoveConnectionOptions)
이 그룹에서 특정 연결 제거
function removeConnection(connectionId: string, options?: GroupRemoveConnectionOptions): Promise<void>
매개 변수
- connectionId
-
string
이 그룹에서 제거할 연결 ID
- options
- GroupRemoveConnectionOptions
추가 옵션
반환
Promise<void>
removeUser(string, GroupRemoveUserOptions)
이 그룹에서 사용자 제거
function removeUser(username: string, options?: GroupRemoveUserOptions): Promise<void>
매개 변수
- username
-
string
제거할 사용자 이름
- options
- GroupRemoveUserOptions
추가 옵션
반환
Promise<void>
sendToAll(JSONTypes, GroupSendToAllOptions)
이 그룹의 모든 연결에 json 메시지 보내기
function sendToAll(message: JSONTypes, options?: GroupSendToAllOptions): Promise<void>
매개 변수
- message
- JSONTypes
보낼 메시지
- options
- GroupSendToAllOptions
추가 옵션
반환
Promise<void>
sendToAll(RequestBodyType, GroupSendToAllOptions)
이 그룹의 모든 연결에 이진 메시지 보내기
function sendToAll(message: RequestBodyType, options?: GroupSendToAllOptions): Promise<void>
매개 변수
- message
- RequestBodyType
보낼 이진 메시지
- options
- GroupSendToAllOptions
추가 옵션
반환
Promise<void>
sendToAll(string, GroupSendTextToAllOptions)
이 그룹의 모든 연결에 문자 메시지 보내기
function sendToAll(message: string, options: GroupSendTextToAllOptions): Promise<void>
매개 변수
- message
-
string
보낼 메시지
- options
- GroupSendTextToAllOptions
추가 옵션
반환
Promise<void>