Class Filter
- java.lang.Object
-
- io.github.ma1uta.matrix.client.model.search.Filter
-
public class Filter extends Object
Filter.
-
-
Field Summary
Fields Modifier and Type Field Description private Boolean
containsUrl
If true, includes only events with a url key in their content.private Boolean
includeRedundantMembers
If true, sends all membership events for all events, even if they have already been sent to the client.private Boolean
lazyLoadMembers
If true, enables lazy-loading of membership events.private Long
limit
The maximum number of events to return.private List<String>
notRooms
A list of room IDs to exclude.private List<String>
notSenders
A list of sender IDs to exclude.private List<String>
notTypes
A list of event types to exclude.private List<String>
rooms
A list of room IDs to include.private List<String>
senders
A list of senders IDs to include.private List<String>
types
A list of event types to include.
-
Constructor Summary
Constructors Constructor Description Filter()
-
Method Summary
Modifier and Type Method Description Boolean
getContainsUrl()
Boolean
getIncludeRedundantMembers()
Boolean
getLazyLoadMembers()
Long
getLimit()
List<String>
getNotRooms()
List<String>
getNotSenders()
List<String>
getNotTypes()
List<String>
getRooms()
List<String>
getSenders()
List<String>
getTypes()
void
setContainsUrl(Boolean containsUrl)
void
setIncludeRedundantMembers(Boolean includeRedundantMembers)
void
setLazyLoadMembers(Boolean lazyLoadMembers)
void
setLimit(Long limit)
void
setNotRooms(List<String> notRooms)
void
setNotSenders(List<String> notSenders)
void
setNotTypes(List<String> notTypes)
void
setRooms(List<String> rooms)
void
setSenders(List<String> senders)
void
setTypes(List<String> types)
-
-
-
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, enables lazy-loading of membership events. See Lazy-loading room members for more information. Defaults to false.
-
includeRedundantMembers
private Boolean includeRedundantMembers
If true, sends all membership events for all events, even if they have already been sent to the client. Does not apply unless lazy_load_members is true. See Lazy- loading room members for more information. Defaults to false.
-
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. Defaults to false.
-
-
Method Detail
-
getLimit
public Long getLimit()
-
setLimit
public void setLimit(Long limit)
-
getLazyLoadMembers
public Boolean getLazyLoadMembers()
-
setLazyLoadMembers
public void setLazyLoadMembers(Boolean lazyLoadMembers)
-
getIncludeRedundantMembers
public Boolean getIncludeRedundantMembers()
-
setIncludeRedundantMembers
public void setIncludeRedundantMembers(Boolean includeRedundantMembers)
-
getContainsUrl
public Boolean getContainsUrl()
-
setContainsUrl
public void setContainsUrl(Boolean containsUrl)
-
-