Class: SocketRoomHandler
Defined in: socket/room.ts:20
A class to handle socket room events/data.
Constructors
Constructor
new SocketRoomHandler(room, socketId): SocketRoomHandler;
Defined in: socket/room.ts:32
Parameters
| Parameter | Type | Description |
|---|---|---|
room | Room | The Room being used |
socketId | string | The socket ID of the user |
Returns
SocketRoomHandler
Methods
join()
join(user): Promise<SocketRoomHandler>;
Defined in: socket/room.ts:46
This method establishes multiple output actions/events that will ultimately allow a user to join a room. It will send multiple socket events to alert users that a new user has joined and should begin establishing connections with them. Users already in a different room, will be removed from that room when joining a new one.
Parameters
| Parameter | Type | Description |
|---|---|---|
user | User | The User that is joining a room |
Returns
Promise<SocketRoomHandler>
The SocketRoomHandler.
kick()
kick(): SocketRoomHandler;
Defined in: socket/room.ts:95
This method will send a room:kick event to kick the user out of the room
Returns
SocketRoomHandler
The SocketRoomHandler.
leave()
leave(user): SocketRoomHandler;
Defined in: socket/room.ts:119
This method will alert other users that a user is leaving the room and connections should be removed
Parameters
| Parameter | Type | Description |
|---|---|---|
user | User | The User that is requesting leave |
Returns
SocketRoomHandler
The SocketRoomHandler.
request()
request(user, type?): Promise<SocketRoomHandler>;
Defined in: socket/room.ts:145
This method establishes multiple output actions/events that will ultimately allow a user to request to join a room. It will send multiple socket events to alert users that a new user is requesting to join a room and is waiting for approval.
Parameters
| Parameter | Type | Description |
|---|---|---|
user | User | The User that is requesting to join a room |
type? | RoomRequestType | - |
Returns
Promise<SocketRoomHandler>
The SocketRoomHandler.
result()
result(): SocketIOContextOutput;
Defined in: socket/room.ts:201
Returns the socket output
Returns
The output array of the events/actions.