SmartFoxServer 2X C++ API
Sfs2X::Requests::AdminMessageRequest Class Reference

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

#include <AdminMessageRequest.h>

Inherits Sfs2X::Requests::GenericMessageRequest.

Public Member Functions

 AdminMessageRequest (string message, boost::shared_ptr< MessageRecipientMode > recipientMode, boost::shared_ptr< ISFSObject > parameters)
 
 AdminMessageRequest (string message, boost::shared_ptr< MessageRecipientMode > recipientMode)
 AdminMessageRequest(string, boost::shared_ptr<MessageRecipientMode>, boost::shared_ptr<ISFSObject>) More...
 

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, Core.SFSEvent.ADMIN_MESSAGE

Constructor & Destructor Documentation

◆ AdminMessageRequest() [1/2]

Sfs2X::Requests::AdminMessageRequest::AdminMessageRequest ( string  message,
boost::shared_ptr< MessageRecipientMode recipientMode,
boost::shared_ptr< ISFSObject parameters 
)

Constructor

ptrSmartFox->AddEventListener(SFSEvent::ADMIN_MESSAGE, boost::shared_ptr<EventListenerDelegate> (EventListenerDelegate(CMyClass::OnAdminMessage, (unsigned long long)this));
// Say 'Hello' to every one
boost::shared_ptr<IRequest> request (new AdminMessageRequest("Hello from the Admin!"));
ptrSmartFox->Send(request);
static void OnAdminMessage(unsigned long long ptrContext, boost::shared_ptr<BaseEvent> ptrEvent);
void CMyClass::OnAdminMessage(unsigned long long ptrContext, boost::shared_ptr<BaseEvent> ptrEvent);
{
CMyClass* ptrMyClass = (CMyClass*)ptrContext;
boost::shared_ptr<map<string, boost::shared_ptr<void>>> ptrEventParams = ptrEvent->Params();
boost::shared_ptr<void> ptrEventParamValueSender = (*ptrEventParams)["sender"];
boost::shared_ptr<User> ptrNotifiedSender = ((boost::static_pointer_cast<User>)(ptrEventParamValueSender));
boost::shared_ptr<void> ptrEventParamValueMessage = (*ptrEventParams)["message"];
boost::shared_ptr<string> ptrNotifiedMessage = ((boost::static_pointer_cast<string>)(ptrEventParamValueMessage));
}
Parameters
messagethe admin message
recipientModethe recipient mode (message can be sent to single User, a Room, the whole Room Group or the Zone)
parameterscustom extra parameters
See also
Core.SFSEvent.ADMIN_MESSAGE, MessageRecipientMode, ModeratorMessageRequest

◆ AdminMessageRequest() [2/2]

Sfs2X::Requests::AdminMessageRequest::AdminMessageRequest ( string  message,
boost::shared_ptr< MessageRecipientMode recipientMode 
)