getActiveRoom()

Availability:

Flash Player 6.0
SmartFoxServer Lite / Basic / Pro

Usage:

smartFox.getActiveRoom()

Description:

Return the room object representing the room where the user is currently in.

NOTE: SmartFoxServer allows users to be logged in two or more rooms at the same time. If your multiuser application makes use of this feature this API method becomes useless and you should track the room ID(s) of your clients manually, for example by keeping them in an array.

Parameters:

none    

Returns:

The Room object.

Example:

var room = smartFox.getActiveRoom()

See also: