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

Class RoomEventResults

java.lang.Object

io.github.ma1uta.matrix.client.model.search.RoomEventResults

public class RoomEventResults
extends Object

Room events results.

Field Summary

Fields

Modifier and Type	Field	Description
private Long	count	An approximate count of the total number of results found.
private Map<String,Map<String,GroupValue>>	groups	Any groups that were requested.
private List<String>	highlights	List of words which should be highlighted, useful for stemming which may change the query terms.
private String	nextBatch	Token that can be used to get the next batch of results, by passing as the next_batch parameter to the next call.
private List<Result>	results	List of results in the requested order.
private Map<String,List<Event>>	state	The current state for every room in the results.

Constructor Summary

Constructors

Constructor	Description
RoomEventResults()

Method Summary

Modifier and Type	Method	Description
Long	getCount()
Map<String,Map<String,GroupValue>>	getGroups()
List<String>	getHighlights()
String	getNextBatch()
List<Result>	getResults()
Map<String,List<Event>>	getState()
void	setCount(Long count)
void	setGroups(Map<String,Map<String,GroupValue>> groups)
void	setHighlights(List<String> highlights)
void	setNextBatch(String nextBatch)
void	setResults(List<Result> results)
void	setState(Map<String,List<Event>> state)

Methods inherited from class java.lang.Object

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

Field Detail

count

private Long count

An approximate count of the total number of results found.

highlights

private List<String> highlights

List of words which should be highlighted, useful for stemming which may change the query terms.

results

private List<Result> results

List of results in the requested order.

state

private Map<String,List<Event>> state

The current state for every room in the results. This is included if the request had the include_state key set with a value of true.

The string key is the room ID for which the State Event array belongs to.

groups

private Map<String,Map<String,GroupValue>> groups

Any groups that were requested.

The outer string key is the group key requested (eg: room_id or sender). The inner string key is the grouped value (eg: a room's ID or a user's ID).

nextBatch

private String nextBatch

Token that can be used to get the next batch of results, by passing as the next_batch parameter to the next call. If this field is absent, there are no more results.

Constructor Detail

RoomEventResults

public RoomEventResults()

Method Detail

getCount

public Long getCount()

setCount

public void setCount(Long count)

getHighlights

public List<String> getHighlights()

setHighlights

public void setHighlights(List<String> highlights)

getResults

public List<Result> getResults()

setResults

public void setResults(List<Result> results)

getState

public Map<String,List<Event>> getState()

setState

public void setState(Map<String,List<Event>> state)

getGroups

public Map<String,Map<String,GroupValue>> getGroups()

setGroups

public void setGroups(Map<String,Map<String,GroupValue>> groups)

getNextBatch

public String getNextBatch()

setNextBatch

public void setNextBatch(String nextBatch)