SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
BuddyMessageRequest Class Reference

#import <BuddyMessageRequest.h>

Inherits GenericMessageRequest.

Instance Methods

(id) - initWithMessage:targetBuddy:params:
 

Class Methods

(id) + requestWithMessage:targetBuddy:params:
 
(id) + requestWithMessage:targetBuddy:
 

Detailed Description

BuddyMessage(s) are similar to private chat messages but are specifically designed for the Buddy List system.

They don't require any Room parameter, nor do they require that Users are joined into any particular Room. Additionally the Buddy Message performs specific validation such as making sure that the recipient is in the User's BuddyList and verifies the Buddy block status.

Method Documentation

◆ requestWithMessage:targetBuddy:

+ (id) requestWithMessage: (NSString *)  message
targetBuddy: (id <Buddy>)  targetBuddy 

Send a Buddy Message to the server

Parameters
messagethe message
targetBuddythe recipient of the message
See also
[ISFSEvents onBuddyMessage:]
AddBuddyRequest
RemoveBuddyRequest
BlockBuddyRequest

◆ requestWithMessage:targetBuddy:params:

+ (id) requestWithMessage: (NSString *)  message
targetBuddy: (id <Buddy>)  targetBuddy
params: (id <ISFSObject>)  params 

Send a Buddy Message to the server

Parameters
messagethe message
targetBuddythe recipient of the message
paramscustom parameters (e.g. the textfield font and color, a sender avatar id, or any other data...)
See also
[ISFSEvents onBuddyMessage:]
AddBuddyRequest
RemoveBuddyRequest
BlockBuddyRequest