PublicRoomsResponse (server-server-api 0.9.0 API)

java.lang.Object
- io.github.ma1uta.matrix.server.model.federation.PublicRoomsResponse

public class PublicRoomsResponse
extends Object

Public rooms response.

Field Summary

Fields
Modifier and Type	Field	Description
`private List<PublicRoomsChunk>`	`chunk`	Required.
`private String`	`nextBatch`	A pagination token for the response.
`private String`	`prevBatch`	A pagination token that allows fetching previous results.
`private Long`	`totalRoomCountEstimate`	An estimate on the total number of public rooms, if the server has an estimate.

Constructor Summary

Constructors
Constructor Description

PublicRoomsResponse()

Method Summary

Modifier and Type	Method	Description
`List<PublicRoomsChunk>`	`getChunk()`
`String`	`getNextBatch()`
`String`	`getPrevBatch()`
`Long`	`getTotalRoomCountEstimate()`
`void`	`setChunk(List<PublicRoomsChunk> chunk)`
`void`	`setNextBatch(String nextBatch)`
`void`	`setPrevBatch(String prevBatch)`
`void`	`setTotalRoomCountEstimate(Long totalRoomCountEstimate)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - chunk
```
private List<PublicRoomsChunk> chunk
```
    Required. A paginated chunk of public rooms.
  - nextBatch
```
private String nextBatch
```
    A pagination token for the response. The absence of this token means there are no more results to fetch and the client should stop paginating.
  - prevBatch
```
private String prevBatch
```
    A pagination token that allows fetching previous results. The absence of this token means there are no results before this batch, i.e. this is the first batch.
  - totalRoomCountEstimate
```
private Long totalRoomCountEstimate
```
    An estimate on the total number of public rooms, if the server has an estimate.
- Constructor Detail
  - PublicRoomsResponse
```
public PublicRoomsResponse()
```
- Method Detail
  - getChunk
```
public List<PublicRoomsChunk> getChunk()
```
  - setChunk
```
public void setChunk(List<PublicRoomsChunk> chunk)
```
  - getNextBatch
```
public String getNextBatch()
```
  - setNextBatch
```
public void setNextBatch(String nextBatch)
```
  - getPrevBatch
```
public String getPrevBatch()
```
  - setPrevBatch
```
public void setPrevBatch(String prevBatch)
```
  - getTotalRoomCountEstimate
```
public Long getTotalRoomCountEstimate()
```
  - setTotalRoomCountEstimate
```
public void setTotalRoomCountEstimate(Long totalRoomCountEstimate)
```