new connectionRoomObj()
This is a gateway object connecting connections to the rooms they are in.
- Source:
- easyrtc_public_obj.js, line 1925
Members
-
<static> connectionRoomObj.events
-
Expose all event functions
- Source:
- easyrtc_public_obj.js, line 1942
-
<static> connectionRoomObj.util
-
Expose all utility functions
- Source:
- easyrtc_public_obj.js, line 1950
Methods
-
<static> connectionRoomObj.emitRoomDataDelta(isLeavingRoom)
-
Emits the roomData message with a clientListDelta for the current connection to other connections in the same room.
Parameters:
Name Type Description isLeavingRoomboolean Is connection leaving the room? - Source:
- easyrtc_public_obj.js, line 2024
-
<static> connectionRoomObj.generateRoomDataDelta(isLeavingRoom)
-
Generated the roomData[room] message with a clientListDelta for the current connection to other connections in the same room.
Parameters:
Name Type Description isLeavingRoomboolean Is connection leaving the room? - Source:
- easyrtc_public_obj.js, line 2057
-
<static> connectionRoomObj.getApp() → {Object}
-
Returns the application object to which the connection belongs. Note that unlike most EasyRTC functions, this returns a value and does not use a callback.
- Source:
- easyrtc_public_obj.js, line 1959
Returns:
The application object- Type
- Object
-
<static> connectionRoomObj.getAppName() → {string}
-
Returns the application name for the application to which the connection belongs. Note that unlike most EasyRTC functions, this returns a value and does not use a callback.
- Source:
- easyrtc_public_obj.js, line 1970
Returns:
The application name- Type
- string
-
<static> connectionRoomObj.getConnection() → {Object}
-
Returns the connection object to which the connection belongs. Note that unlike most EasyRTC functions, this returns a value and does not use a callback.
- Source:
- easyrtc_public_obj.js, line 1981
Returns:
The application object- Type
- Object
-
<static> connectionRoomObj.getRoom() → {Object}
-
Returns the room object to which the connection belongs. Note that unlike most EasyRTC functions, this returns a value and does not use a callback.
- Source:
- easyrtc_public_obj.js, line 1992
Returns:
The room object- Type
- Object
-
<static> connectionRoomObj.leaveRoom(next)
-
Leaves the current room. Any room variables will be lost.
Parameters:
Name Type Argument Description nextnextCallback <optional>
A success callback of form next(err). - Source:
- easyrtc_public_obj.js, line 2003
-
<static> connectionRoomObj.setApiField(isLeavingRoom)
-
Sets the API field for the current connection in a room.
Parameters:
Name Type Description isLeavingRoomboolean Is connection leaving the room? - Source:
- easyrtc_public_obj.js, line 2093