Package sfs3.client.requests

Class MessageRecipientMode

java.lang.Object
sfs3.client.requests.MessageRecipientMode
public class MessageRecipientMode extends Object
The MessageRecipientMode class is used to specify the recipient/s of moderator and administrator messages. Read the constants descriptions for more informations.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    TO_GROUP
    The moderator/administrator message will be sent to all the clients who subscribed a specific Room Group.
    static final int
    TO_ROOM
    The moderator/administrator message will be sent to all the users in a specific Room.
    static final int
    TO_USER
    The moderator/administrator message will be sent to a specific user.
    static final int
    TO_ZONE
    The moderator/administrator message will be sent to all the users in the Zone.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MessageRecipientMode(int mode, Object target)
    Creates a new MessageRecipientMode instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMode()
    Returns the selected recipient mode.
    Object
    getTarget()
    Returns the moderator/administrator message target, according to the selected recipient mode.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • TO_USER

      public static final int TO_USER
      The 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_ROOM

      public static final int TO_ROOM
      The 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_GROUP

      public static final int 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:

    • TO_ZONE

      public static final int 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.
      See Also:

  • Constructor Details

    • MessageRecipientMode

      public MessageRecipientMode(int mode, Object target)
      Creates a new MessageRecipientMode instance. The instance must be passed as recipientMode parameter to the ModeratorMessageRequest() and AdminMessageRequest() classes constructors.
      Parameters:
      mode - 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:

  • Method Details

    • getMode

      public int getMode()
      Returns the selected recipient mode.

    • getTarget

      public Object getTarget()
      Returns the moderator/administrator message target, according to the selected recipient mode.