SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
FindUsersRequest.h
1 //
2 // FindUsersRequest.h
3 // SFS2X
4 //
5 // Original development by Infosfer Game Technologies Ltd. | http://www.infosfer.com.
6 //
7 // Maintained and developed by A51 Integrated.
8 // Copyright 2012 A51 Integrated | http://a51integrated.com. All rights reserved.
9 //
10 
11 #import "BaseRequest.h"
12 
13 EXTERN NSString * const FindUsersRequest_KEY_EXPRESSION;
14 EXTERN NSString * const FindUsersRequest_KEY_GROUP;
15 EXTERN NSString * const FindUsersRequest_KEY_ROOM;
16 EXTERN NSString * const FindUsersRequest_KEY_LIMIT;
17 EXTERN NSString * const FindUsersRequest_KEY_FILTERED_USERS;
18 
19 @class MatchExpression;
20 /**
21  Search Users in the system by matching their variables and properties against a <MatchExpression>
22  */
23 @interface FindUsersRequest : BaseRequest {
24 
25  MatchExpression *_matchExpr;
26  id _target;
27  NSInteger _limit;
28 }
29 
30 -(id)initWithExpr:(MatchExpression *)expr target:(id)target limit:(NSInteger)limit;
31 
32 
33 /**
34  @param expr the match expression
35  @param target it can be a Room or String (the Group Id), if null the search will done in the whole Zone (default)
36  @param limit the number of results wanted. Zero means no limit, we will get all results (default)
37 
38  @see [ISFSEvent onUserFindResult:]
39  @see UserProperties
40  @see MatchExpression
41 
42  */
43 +(id)requestWithExpr:(MatchExpression *)expr target:(id)target limit:(NSInteger)limit;
44 +(id)requestWithExpr:(MatchExpression *)expr;
45 
46 @end
MatchExpression
Definition: MatchExpression.h:42
FindUsersRequest
Definition: FindUsersRequest.h:23