AdminMessageRequest Class Reference
Inherits from | GenericMessageRequest : BaseRequest : NSObject |
Declared in | AdminMessageRequest.h AdminMessageRequest.m |
Overview
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.
Tasks
-
– initWithMessage:recipientMode:params:
Initializes the request instance.
-
+ requestWithMessage:recipientMode:params:
Initializes and returns the request
-
+ requestWithMessage:recipientMode:
Initializes and returns the request
Class Methods
requestWithMessage:recipientMode:
Initializes and returns the request
+ (id)requestWithMessage:(NSString *)message recipientMode:(MessageRecipientMode *)recipientMode
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)
Discussion
Initializes and returns the request
Declared In
AdminMessageRequest.h
requestWithMessage:recipientMode:params:
Initializes and returns the request
+ (id)requestWithMessage:(NSString *)message recipientMode:(MessageRecipientMode *)recipientMode params:(id<ISFSObject>)params
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)
Discussion
Initializes and returns the request
Declared In
AdminMessageRequest.h
Instance Methods
initWithMessage:recipientMode:params:
Initializes the request instance.
- (id)initWithMessage:(NSString *)message recipientMode:(MessageRecipientMode *)recipientMode params:(id<ISFSObject>)params
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)
Discussion
Initializes the request instance.
Declared In
AdminMessageRequest.h