Class RoomJoinRules


  • public class RoomJoinRules
    extends StateEvent<RoomJoinRulesContent>
    A room may be ``public`` meaning anyone can join the room without any prior action. Alternatively, it can be ``invite`` meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, ``knock`` and ``private`` are reserved keywords which are not implemented.
    • Field Detail

      • TYPE

        public static final String TYPE
        A room may be public meaning anyone can join the room without any prior action. Alternatively, it can be invite meaning that a user who wishes to join the room must first receive an invite to the room from someone already inside of the room. Currently, knock and private are reserved keywords which are not implemented.
        See Also:
        Constant Field Values
    • Constructor Detail

      • RoomJoinRules

        public RoomJoinRules()
    • Method Detail

      • getType

        public String getType()
        Description copied from class: Event
        Required. The type of event. This SHOULD be namespaced similar to Java package naming conventions e.g. 'com.example.subdomain.event.type'.
        Specified by:
        getType in class Event<RoomJoinRulesContent>
        Returns:
        The type of the event.