Class SFS2X.Requests.MessageRecipientMode
The recipient/s of moderator and administrator messages.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
SFS2X.Requests.MessageRecipientMode(mode, target)
Creates a new MessageRecipientMode instance.
|
Field Summary
Class Detail
SFS2X.Requests.MessageRecipientMode(mode, target)
Creates a new MessageRecipientMode instance.
The instance must be passed as recipientMode parameter to the ModeratorMessageRequest() and AdminMessageRequest() classes constructors.
- Parameters:
- {Number} mode
- One of the costants contained in this class, describing the recipient mode.
- {*} target
- The moderator/administrator message recipient/s, according to the selected recipient mode.
Field Detail
{Number}
mode
Returns the selected recipient mode.
{*}
target
Returns the moderator/administrator message target, according to the selected recipient mode.
<static> <constant>
SFS2X.Requests.MessageRecipientMode.TO_GROUP
The moderator/administrator message will be sent to all the clients who subscribed a specific Room Group.
A Group id must be passed as target parameter to the class constructor.
- See also:
- SFS2X.Entities.SFSRoom#groupId
<static> <constant>
SFS2X.Requests.MessageRecipientMode.TO_ROOM
The moderator/administrator message will be sent to all the users in a specific Room.
A SFSRoom instance must be passed as target parameter to the class constructor.
- See also:
- SFS2X.Entities.SFSRoom
<static> <constant>
SFS2X.Requests.MessageRecipientMode.TO_USER
The moderator/administrator message will be sent to a specific user.
A SFSUser instance must be passed as target parameter to the class constructor.
- See also:
- SFS2X.Entities.SFSUser
<static> <constant>
SFS2X.Requests.MessageRecipientMode.TO_ZONE
The moderator/administrator message will be sent to all the users in the Zone.
null can be passed as target parameter, in fact it will be ignored.