SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
PublicMessageRequest.h
1 //
2 // PublicMessageRequest.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 "GenericMessageRequest.h"
13 
14 /** Sends a chat Public Message to other users in the Room
15 
16  Public Messages are broadcast to all users in the specified Room
17  An optional custom SFSObject can be sent together with the message. The extra parameters can be used to transmit information
18  about the font and color of the message or any other properties that are relevant to the message.
19  */
20 @interface PublicMessageRequest : GenericMessageRequest {
21 
22 }
23 
24 
25 -(id)initWithMessage:(NSString *)message params:(id <ISFSObject>)params targetRoom:(id <Room>)targetRoom;
26 /**
27 
28  @param message the chat message
29  @param params custom extra parameters (optional)
30  @param targetRoom the target room (optional). By default it is used the last joined Room
31 
32  @see [ISFSEvents onPublicMessage:]
33  @see PrivateMessageRequest
34 
35  */
36 +(id)requestWithMessage:(NSString *)message params:(id <ISFSObject>)params targetRoom:(id <Room>)targetRoom;
37 +(id)requestWithMessage:(NSString *)message;
38 @end
PublicMessageRequest
Definition: PublicMessageRequest.h:20