SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
KickUserRequest.h
1 //
2 // KickUserRequest.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 
12 #import "BaseRequest.h"
13 
14 EXTERN NSString * const KickUserRequest_KEY_USER_ID;
15 EXTERN NSString * const KickUserRequest_KEY_MESSAGE;
16 EXTERN NSString * const KickUserRequest_KEY_DELAY;
17 
18 /** Kicks a User out of the server (for moderators and admins only)
19 
20  Allows to send a custom message and to set a delay in seconds.
21  */
22 @interface KickUserRequest : BaseRequest {
23 
24 @private
25  NSInteger _userId;
26  NSString *_message;
27  NSInteger _delay;
28 }
29 
30 
31 -(id)initWithUserId:(NSInteger)userId message:(NSString *)message delaySeconds:(NSInteger)delaySeconds;
32 
33 /**
34  @param userId the id of the User to be kicked out of the server
35  @param message a custom kick message, if nil, the message configured on the server side will be used
36  @param delaySeconds a delay in seconds between the message (immediate) and the kick (delayed). Default is 5 seconds
37 
38  @see BanUserRequest
39 
40  */
41 +(id)requestWithUserId:(NSInteger)userId message:(NSString *)message delaySeconds:(NSInteger)delaySeconds;
42 +(id)requestWithUserId:(NSInteger)userId;
43 
44 @end
KickUserRequest
Definition: KickUserRequest.h:22