GenericMessageType.h File Reference

Doxygen only documents namespace-scope entities (enums, aliases, constants, free functions) in a header that carries this block. More...

#include <cstdint>

Enumerations
enum class	sfs3::requests::MessageRecipientMode : int32_t { ToUser = 0 , ToRoom = 1 , ToGroup = 2 , ToZone = 3 }
	Describes the recipients of a moderator or administrator message. More...

Detailed Description

Doxygen only documents namespace-scope entities (enums, aliases, constants, free functions) in a header that carries this block.

Enumeration Type Documentation

MessageRecipientMode

enum class sfs3::requests::MessageRecipientMode : int32_t

strong

Describes the recipients of a moderator or administrator message.

The mode is not chosen directly: it follows from which ModeratorMessageRequest or AdminMessageRequest constructor is used, each of which takes the matching target type (a User, a Room, a Group id, or nothing at all for the whole Zone).

See also

ModeratorMessageRequest

AdminMessageRequest

Enumerator
ToUser	The message is sent to one specific user.
ToRoom	The message is sent to all the users in one Room.
ToGroup	The message is sent to all the clients who subscribed a specific Room Group.
ToZone	The message is sent to all the users in the Zone.