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

#import <AdminMessageRequest.h>

Inherits GenericMessageRequest.

Instance Methods

(id) - initWithMessage:recipientMode:params:
 

Class Methods

(id) + requestWithMessage:recipientMode:params:
 
(id) + requestWithMessage:recipientMode:
 

Detailed Description

Send a Admin Message to a specific User or groups of Users

The sender must have the admin privileges to be able to send these kinds of messages. The recipient parameter can be used to specify if the message is sent to a User, a Room, the Room Group or the whole Zone.

See also
MessageRecipientMode

Method Documentation

◆ initWithMessage:recipientMode:params:

- (id) initWithMessage: (NSString *)  message
recipientMode: (MessageRecipientMode *)  recipientMode
params: (id <ISFSObject>)  params 

Initializes the request instance.

Parameters
message(NSString *) the admin message
recipientMode(MessageRecipientMode *) the recipient mode (message can be sent to single User, a Room, the whole Room Group or the Zone)
params(id <ISFSObject>) custom extra parameters (optional)
See also
MessageRecipientMode
ModeratorMessageRequest

◆ requestWithMessage:recipientMode:

+ (id) requestWithMessage: (NSString *)  message
recipientMode: (MessageRecipientMode *)  recipientMode 

Initializes and returns the request

Parameters
message(NSString *) the admin message
recipientMode(MessageRecipientMode *) the recipient mode (message can be sent to single User, a Room, the whole Room Group or the Zone)
See also
MessageRecipientMode
ModeratorMessageRequest

◆ requestWithMessage:recipientMode:params:

+ (id) requestWithMessage: (NSString *)  message
recipientMode: (MessageRecipientMode *)  recipientMode
params: (id <ISFSObject>)  params 

Initializes and returns the request

Parameters
message(NSString *) the admin message
recipientMode(MessageRecipientMode *) the recipient mode (message can be sent to single User, a Room, the whole Room Group or the Zone)
params(id <ISFSObject>) custom extra parameters (optional)
See also
MessageRecipientMode
ModeratorMessageRequest