SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
FindRoomsRequest.h
1 //
2 // FindRoomsRequest.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 FindRoomsRequest_KEY_EXPRESSION;
14 EXTERN NSString * const FindRoomsRequest_KEY_GROUP;
15 EXTERN NSString * const FindRoomsRequest_KEY_LIMIT;
16 EXTERN NSString * const FindRoomsRequest_KEY_FILTERED_ROOMS;
17 
18 @class MatchExpression;
19 
20 /** Search Rooms in the system by matching their variables and properties against a MatchExpression
21 
22  @see MatchExpression
23  */
24 @interface FindRoomsRequest : BaseRequest {
25 
26 
27  MatchExpression *_matchExpr;
28  NSString *_groupId;
29  NSInteger _limit;
30 
31 }
32 
33 -(id)initWithExpr:(MatchExpression *)expr groupId:(NSString *)groupId limit:(NSInteger)limit;
34 /**
35  @param expr the match expression
36  @param groupId the id of the Room Group where to perform the search, if null the search will be Zone-wide (default)
37  @param limit the number of results wanted. Zero means no limit, we will get all results (default)
38 
39  @see [ISFSEvent onRoomFindResult:]
40  @see MatchExpression
41  @see RoomProperties
42 
43  */
44 +(id)requestWithExpr:(MatchExpression *)expr groupId:(NSString *)groupId limit:(NSInteger)limit;
45 +(id)requestWithExpr:(MatchExpression *)expr;
46 
47 @end
MatchExpression
Definition: MatchExpression.h:42
FindRoomsRequest
Definition: FindRoomsRequest.h:24