Global

Type Definitions

ConnectAckResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"connect_ack"	Success response type identifier
`user`	string	Connected username
`room`	string	Initial room
`users`	Array.<string>	Users in initial room
`rooms`	Array.<string>	All available rooms

Source:

chat.js, line 93

ConnectErrorResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"connect_error"	Error response type identifier
`message`	string	Error description message

Source:

chat.js, line 87

ConnectResponse

Type:

ConnectErrorResponse | ConnectAckResponse

Source:

chat.js, line 102

ConnectionResult

Type:

Object

Properties:

Name	Type	Attributes	Description
`success`	boolean		Operation status
`message`	string	<optional>	Optional error message

Source:

chat.js, line 45

JoinAckResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"join_ack"	Success response type identifier
`user`	string	Connected username
`room`	string	Room name (with # prefix)
`users`	Array.<string>	Array of users in the room
`wasAlreadyInRoom`	boolean	Flag if user was already in room
`allRooms`	Array.<string>	List of all available rooms

Source:

chat.js, line 113

JoinErrorResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"join_error"	Error response type identifier
`message`	string	Error description message

Source:

chat.js, line 107

JoinResponse

Type:

JoinErrorResponse | JoinAckResponse

Source:

chat.js, line 123

JoinResult

Type:

Object

Properties:

Name	Type	Attributes	Description
`success`	boolean		Operation status
`message`	string	<optional>	Optional error message
`users`	Array.<string>		List of users in room
`wasAlreadyInRoom`	boolean		Was user already in room

Source:

chat.js, line 52

LeaveRoomResult

Type:

Object

Properties:

Name	Type	Attributes	Description
`success`	boolean		Operation status
`message`	string	<optional>	Optional error message
`users`	Array.<string>		Remaining users in room
`roomDeleted`	boolean		Whether room was deleted
`leftCurrent`	boolean		Whether left current room
`disconnected`	boolean		Whether user fully disconnected

Source:

chat.js, line 61

MyRoomsAckResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"myrooms_ack"	Success response type identifier
`success`	boolean	Operation status
`rooms`	Array.<RoomInfo>	List of rooms with metadata

Source:

chat.js, line 191

MyRoomsErrorResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"myrooms_error"	Error response type identifier
`message`	string	Error description message

Source:

chat.js, line 185

MyRoomsResponse

Type:

MyRoomsErrorResponse | MyRoomsAckResponse

Source:

chat.js, line 198

PartAckResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"part_ack"	Success response type identifier
`user`	string	Username who left
`room`	string	Room name that was left
`users`	Array.<string>	Remaining users in room (empty if room deleted)
`leftCurrent`	boolean	Whether user left their current room
`roomDeleted`	boolean	Whether room was deleted (no users left)
`disconnected`	boolean	Whether user fully disconnected (left all rooms)

Source:

chat.js, line 134

PartErrorResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"part_error"	Error response type identifier
`message`	string	Error description message

Source:

chat.js, line 128

PartResponse

Type:

PartErrorResponse | PartAckResponse

Source:

chat.js, line 145

QuitAckResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"quit_ack"	Success response type identifier

Source:

chat.js, line 175

QuitErrorResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"quit_error"	Error response type identifier
`message`	string	Error description message

Source:

chat.js, line 169

QuitResponse

Type:

QuitErrorResponse | QuitAckResponse

Source:

chat.js, line 180

RoomInfo

Type:

Object

Properties:

Name	Type	Description
`name`	string	Room name with # prefix
`userCount`	number	Number of users in room
`isCurrent`	boolean	Whether this is current room

Source:

chat.js, line 72

SendAckResponse

Type:

Object

Properties:

Name	Type	Description
`type`	"send_ack"	Success response type identifier
`user`	string	Sender username
`text`	string	Acknowledged message

Source:

chat.js, line 157

SendErrorResponse

Type:

Object

Properties:

Name	Type	Attributes	Description
`type`	"send_error"		Error response type identifier
`message`	string		Error description message
`originalText`	string	<optional>	Original message content

Source:

chat.js, line 150

SendResponse

Type:

SendAckResponse | SendErrorResponse

Source:

chat.js, line 164

UserRoomsResult

Type:

Object

Properties:

Name	Type	Description
`success`	boolean	Operation status
`rooms`	Array.<RoomInfo>	List of rooms with metadata

Source:

chat.js, line 79