Package io.github.ma1uta.matrix.client.model.filter

Class RoomEventFilter

  • public class RoomEventFilter
extends Object
    Room event filter.

    • Field Detail

      • limit

        private Long limit
        The maximum number of events to return.

      • notSenders

        private List<String> notSenders
        A list of sender IDs to exclude. If this list is absent then no senders are excluded. A matching sender will be excluded even if it is listed in the 'senders' filter.

      • notTypes

        private List<String> notTypes
        A list of event types to exclude. If this list is absent then no event types are excluded. A matching type will be excluded even if it is listed in the 'types' filter. A '*' can be used as a wildcard to match any sequence of characters.

      • senders

        private List<String> senders
        A list of senders IDs to include. If this list is absent then all senders are included.

      • types

        private List<String> types
        A list of event types to include. If this list is absent then all event types are included. A '*' can be used as a wildcard to match any sequence of characters.

      • lazyLoadMembers

        private Boolean lazyLoadMembers
        If true, the only m.room.member events returned in the state section of the /sync response are those which are definitely necessary for a client to display the sender of the timeline events in that response. If false, m.room.member events are not filtered. By default, servers should suppress duplicate redundant lazy-loaded m.room.member events from being sent to a given client across multiple calls to /sync, given that most clients cache membership events (see include_redundant_members to change this behaviour).

      • includeRedundantMembers

        private Boolean includeRedundantMembers
        If true, the state section of the /sync response will always contain the m.room.member events required to display the sender of the timeline events in that response, assuming lazy_load_members is enabled. This means that redundant duplicate member events may be returned across multiple calls to /sync. This is useful for naive clients who never track membership data. If false, duplicate m.room.member events may be suppressed by the server across multiple calls to /sync. If lazy_load_members is false this field is ignored.

      • notRooms

        private List<String> notRooms
        A list of room IDs to exclude. If this list is absent then no rooms are excluded. A matching room will be excluded even if it is listed in the 'rooms' filter.

      • rooms

        private List<String> rooms
        A list of room IDs to include. If this list is absent then all rooms are included.

      • containsUrl

        private Boolean containsUrl
        If true, includes only events with a url key in their content. If false, excludes those events.

    • Constructor Detail

      • RoomEventFilter

        public RoomEventFilter()

    • Method Detail

      • getLimit

        public Long getLimit()

      • setLimit

        public void setLimit​(Long limit)

      • getNotSenders

        public List<String> getNotSenders()

      • setNotSenders

        public void setNotSenders​(List<String> notSenders)

      • setNotTypes

        public void setNotTypes​(List<String> notTypes)

      • setSenders

        public void setSenders​(List<String> senders)

      • setTypes

        public void setTypes​(List<String> types)

      • getLazyLoadMembers

        public Boolean getLazyLoadMembers()

      • setLazyLoadMembers

        public void setLazyLoadMembers​(Boolean lazyLoadMembers)

      • getIncludeRedundantMembers

        public Boolean getIncludeRedundantMembers()

      • setIncludeRedundantMembers

        public void setIncludeRedundantMembers​(Boolean includeRedundantMembers)

      • setNotRooms

        public void setNotRooms​(List<String> notRooms)

      • setRooms

        public void setRooms​(List<String> rooms)

      • getContainsUrl

        public Boolean getContainsUrl()

      • setContainsUrl

        public void setContainsUrl​(Boolean containsUrl)