Package org.jivesoftware.openfire.muc

Enum Role

  • All Implemented Interfaces:
    Serializable, Comparable<Role>
    public enum Role
extends Enum<Role>
    A temporary position or privilege level within a room, distinct from a user's long-lived affiliation with the room. A role lasts only for the duration of an occupant's visit to a room.

    • Enum Constant Detail

      • moderator

        public static final Role moderator
        Runs moderated discussions. Is allowed to kick users, grant and revoke voice, etc.

      • participant

        public static final Role participant
        A normal occupant of the room. An occupant who does not have administrative privileges; in a moderated room, a participant is further defined as having voice

      • visitor

        public static final Role visitor
        An occupant who does not have voice (can't speak in the room)

      • none

        public static final Role none
        An occupant who does not permission to stay in the room (was banned)

    • Method Detail

      • values

        public static Role[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Role c : Role.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Role valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getValue

        public int getValue()
        Returns the value for the role.
        Returns:
        the value.

      • valueOf

        public static Role valueOf​(int value)
        Returns the affiliation associated with the specified value.
        Parameters:
        value - the value.
        Returns:
        the associated affiliation.