Package sfs3.client.requests

Class FindUsersRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.FindUsersRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class FindUsersRequest
extends BaseRequest

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 those users matching the passed criteria and return them by means of the userFindResult event.

See Also:

• MatchExpression
• SFSEvent.USER_FIND_RESULT

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_EXPRESSION
static final String	KEY_FILTERED_USERS
static final String	KEY_GROUP
static final String	KEY_LIMIT
static final String	KEY_ROOM

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
FindUsersRequest(MatchExpression matchExpr)
FindUsersRequest(MatchExpression matchExpr, Object target)
FindUsersRequest(MatchExpression matchExpr, Object target, short limit)	Creates a new FindUsersRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY_EXPRESSION

public static final String KEY_EXPRESSION

See Also:

• Constant Field Values

Internal

KEY_GROUP

public static final String KEY_GROUP

See Also:

• Constant Field Values

Internal

KEY_ROOM

public static final String KEY_ROOM

See Also:

• Constant Field Values

Internal

KEY_LIMIT

public static final String KEY_LIMIT

See Also:

• Constant Field Values

Internal

KEY_FILTERED_USERS

public static final String KEY_FILTERED_USERS

See Also:

• Constant Field Values

Internal

Constructor Details

FindUsersRequest

public FindUsersRequest(MatchExpression matchExpr,
 Object target,
 short limit)

Creates a new FindUsersRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.

Parameters:

matchExpr - A matching expression that the system will use to retrieve the users.

target - The name of a Group or a single Room object where to search for matching users; if null, the search is performed in the whole Zone.

limit - The maximum size of the list of users that will be returned by the userFindResult event. If 0, all the found users are returned.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• Room
• SFSEvent.USER_FIND_RESULT

FindUsersRequest

public FindUsersRequest(MatchExpression matchExpr)

See Also:

• FindUsersRequest(MatchExpression, Object, short)

FindUsersRequest

public FindUsersRequest(MatchExpression matchExpr,
 Object target)

See Also:

• FindUsersRequest(MatchExpression, Object, short)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal