FindUsersRequest

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

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

Constructor

new FindUsersRequest(matchExpr, targetopt, limitopt)

Creates a new instance of the FindUsersRequest 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 Users.
targetstring | SFSRoom<optional>
nullThe name of a Group or a single SFSRoom object where to search for matching Users; if null, the search is performed in the whole Zone.
limitnumber<optional>
0The maximum size of the list of Users that will be returned; if 0, the maximum number set in server configuration is returned.
See
Fires: