| Package | com.smartfoxserver.v2.requests |
| Class | public class MessageRecipientMode |
| Inheritance | MessageRecipientMode  Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| mode : int [read-only]
Returns the selected recipient mode. | MessageRecipientMode | ||
| target : * [read-only]
Returns the moderator/administrator message target, according to the selected recipient mode. | MessageRecipientMode | ||
| Method | Defined By | ||
|---|---|---|---|
MessageRecipientMode(mode:int, target:*)
Creates a new MessageRecipientMode instance. | MessageRecipientMode | ||
| Constant | Defined By | ||
|---|---|---|---|
| TO_GROUP : int = 2 [static]
The moderator/administrator message will be sent to all the clients who subscribed a specific Room Group. | MessageRecipientMode | ||
| TO_ROOM : int = 1 [static]
The moderator/administrator message will be sent to all the users in a specific Room. | MessageRecipientMode | ||
| TO_USER : int = 0 [static]
The moderator/administrator message will be sent to a specific user. | MessageRecipientMode | ||
| TO_ZONE : int = 3 [static]
The moderator/administrator message will be sent to all the users in the Zone. | MessageRecipientMode | ||
| mode | property |
mode:int [read-only] Returns the selected recipient mode.
public function get mode():int| target | property |
target:* [read-only] Returns the moderator/administrator message target, according to the selected recipient mode.
public function get target():*| MessageRecipientMode | () | Constructor |
public function MessageRecipientMode(mode:int, target:*)Creates a new MessageRecipientMode instance. The instance must be passed as recipientMode parameter to the ModeratorMessageRequest() and AdminMessageRequest() classes constructors.
Parametersmode:int — One of the constants contained in this class, describing the recipient mode.
| |
target:* — The moderator/administrator message recipient/s, according to the selected recipient mode.
|
See also
| TO_GROUP | Constant |
public static const TO_GROUP:int = 2The 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
| TO_ROOM | Constant |
public static const TO_ROOM:int = 1The moderator/administrator message will be sent to all the users in a specific Room. A Room instance must be passed as target parameter to the class constructor.
See also
| TO_USER | Constant |
public static const TO_USER:int = 0The moderator/administrator message will be sent to a specific user. A User instance must be passed as target parameter to the class constructor.
See also
| TO_ZONE | Constant |
public static const TO_ZONE:int = 3
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.