SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
MessageRecipientMode.h
1 //
2 // MessageRecipientMode.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 "Common.h"
13 
14 EXTERN NSInteger const MessageRecipientMode_TO_USER;
15 EXTERN NSInteger const MessageRecipientMode_TO_ROOM;
16 EXTERN NSInteger const MessageRecipientMode_TO_GROUP;
17 EXTERN NSInteger const MessageRecipientMode_TO_ZONE;
18 
19 
20 /** This class is used to specify the recipient mode for Moderator Messages and Administrator Message.
21 
22  There are 4 recipient modes:
23 
24  - <b>TO_USER:</b> the message will be sent to the User (passed as the <i>target</i> parameter)
25  - <b>TO_ROOM:</b> the message will be sent to all Users in the Room (passed as the <i>target</i> parameter)
26  - <b>TO_GROUP: </b> the message will be sent to all Users in the Room Group (passed as a String in the <i>target</i> parameter)
27  - <b>TO_ZONE: </b> the message will be sent to all Users in the Zone (<i>target</i> is ignored)
28 
29  @see ModeratorMessageRequest
30  @see AdminMessageRequest
31 
32  */
33 @interface MessageRecipientMode : NSObject {
34 @private
35  id _target;
36  NSInteger _mode;
37 }
38 
39 @property (readonly) NSInteger mode;
40 @property (strong) id target;
41 
42 -(id)initWithMode:(NSInteger)mode target:(id)target;
43 +(id)recipientModeWithMode:(NSInteger)mode target:(id)target;
44 
45 @end
MessageRecipientMode
Definition: MessageRecipientMode.h:33