SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
BuddyMessageRequest.h
1 //
2 // BuddyMessageRequest.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 "GenericMessageRequest.h"
12 #import "Buddy.h"
13 
14 
15 /** BuddyMessage(s) are similar to private chat messages but are specifically designed for the Buddy List system.
16 
17  They don't require any Room parameter, nor do they require that Users are joined into any particular Room. Additionally the Buddy Message
18  performs specific validation such as making sure that the recipient is in the User's BuddyList and verifies the Buddy block status.
19  */
20 @interface BuddyMessageRequest : GenericMessageRequest {
21 
22 }
23 
24 -(id)initWithMessage:(NSString *)message targetBuddy:(id <Buddy>)targetBuddy params:(id <ISFSObject>)params;
25 
26 /** Send a Buddy Message to the server
27 
28  @param message the message
29  @param targetBuddy the recipient of the message
30  @param params custom parameters (e.g. the textfield font and color, a sender avatar id, or any other data...)
31 
32  @see [ISFSEvents onBuddyMessage:]
33  @see AddBuddyRequest
34  @see RemoveBuddyRequest
35  @see BlockBuddyRequest
36 
37  */
38 +(id)requestWithMessage:(NSString *)message targetBuddy:(id <Buddy>)targetBuddy params:(id <ISFSObject>)params;
39 
40 /** Send a Buddy Message to the server
41 
42  @param message the message
43  @param targetBuddy the recipient of the message
44 
45  @see [ISFSEvents onBuddyMessage:]
46  @see AddBuddyRequest
47  @see RemoveBuddyRequest
48  @see BlockBuddyRequest
49 
50  */
51 +(id)requestWithMessage:(NSString *)message targetBuddy:(id <Buddy>)targetBuddy;
52 
53 @end
BuddyMessageRequest
Definition: BuddyMessageRequest.h:20