FindRoomsRequest

Retrieves a list of Rooms from the server which match the specified criteria.


By providing a matching expression and a search scope (a Group or the entire Zone), SmartFoxServer can find the Rooms matching the passed criteria and return them through the SFSEvent.ROOM_FIND_RESULT event.

Constructor

new FindRoomsRequest(matchExpr, groupIdopt, limitopt)

Creates a new instance of the FindRoomsRequest class.
Pass the instance to the SmartFox#send method to validate and execute the request.
Parameters:
NameTypeAttributesDefaultDescription
matchExprMatchExpressionA matching expression that the system will use to retrieve the Rooms.
groupIdstring<optional>
nullThe name of the Group where to search for matching Rooms; if null, the search is performed in the whole Zone.
limitnumber<optional>
0The maximum size of the list of Rooms that will be returned; if 0, all found Rooms are returned.