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

This class is used to specify the recipient mode for Moderator Messages and Administrator Message. More...

#include <MessageRecipientMode.h>

Public Member Functions

 MessageRecipientMode (long int mode, boost::shared_ptr< User > target)
 Constructor More...
 

Detailed Description

This class is used to specify the recipient mode for Moderator Messages and Administrator Message.

There are 4 recipient modes:

  • TO_USER: the message will be sent to the User (passed as the target parameter)
  • TO_ROOM: the message will be sent to all Users in the Room (passed as the target parameter)
  • TO_GROUP: the message will be sent to all Users in the Room Group (passed as a String in the target parameter)
  • TO_ZONE: the message will be sent to all Users in the Zone (target is ignored)
See also
ModeratorMessageRequest, AdminMessageRequest

Constructor & Destructor Documentation

◆ MessageRecipientMode()

Sfs2X::Requests::MessageRecipientMode::MessageRecipientMode ( long int  mode,
boost::shared_ptr< User target 
)

Constructor

Parameters
modethe recipient mode
targetthe target, depending on the specified recipient mode, as explained in the Class overview