All Implemented Interfaces:: io.getstream.chat.android.client.api.models.ChannelRequest


public final class QueryChannelsRequest
 implements ChannelRequest<QueryChannelsRequest>

Request body class for querying channels.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`state`
`private Boolean`	`watch`
`private Boolean`	`presence`
`private final List<Map<String, Object>>`	`sort`
`private final Boolean`	`isFirstPage`
`private final FilterObject`	`filter`
`private Integer`	`offset`
`private Integer`	`limit`
`private final QuerySorter<Channel>`	`querySort`
`private Integer`	`messageLimit`
`private Integer`	`memberLimit`

Constructor Summary

Constructors
Constructor	Description
`QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Boolean`	`getState()`
`Unit`	`setState(Boolean state)`
`Boolean`	`getWatch()`
`Unit`	`setWatch(Boolean watch)`
`Boolean`	`getPresence()`
`Unit`	`setPresence(Boolean presence)`
`final List<Map<String, Object>>`	`getSort()`	List of sort specifications.
`final Boolean`	`isFirstPage()`
`final FilterObject`	`getFilter()`	FilterObject conditions used by backend to filter queries response.
`final Integer`	`getOffset()`	Pagination offset.
`final Unit`	`setOffset(Integer offset)`	Pagination offset.
`final Integer`	`getLimit()`	Number of channels to be returned by this query channels request.
`final Unit`	`setLimit(Integer limit)`	Number of channels to be returned by this query channels request.
`final QuerySorter<Channel>`	`getQuerySort()`	QuerySorter Sort specification for api queries.
`final Integer`	`getMessageLimit()`	Number of messages in the response.
`final Unit`	`setMessageLimit(Integer messageLimit)`	Number of messages in the response.
`final Integer`	`getMemberLimit()`	Number of members in the response.
`final Unit`	`setMemberLimit(Integer memberLimit)`	Number of members in the response.
`final QueryChannelsRequest`	`withMessages(Integer limit)`	Sets the limit of number of messages to be returned by this backend.
`final QueryChannelsRequest`	`withLimit(Integer limit)`	Sets the number of channels to be returned by this backend.
`final QueryChannelsRequest`	`withOffset(Integer offset)`	Sets the offset to this request.

Methods inherited from class io.getstream.chat.android.client.api.models.ChannelRequest
noPresence, noState, noWatch, withPresence, withState, withWatch
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit)
```
- Method Detail
  - getState
```
 Boolean getState()
```
  - setState
```
 Unit setState(Boolean state)
```
  - getWatch
```
 Boolean getWatch()
```
  - setWatch
```
 Unit setWatch(Boolean watch)
```
  - getPresence
```
 Boolean getPresence()
```
  - setPresence
```
 Unit setPresence(Boolean presence)
```
  - getSort
```
 final List<Map<String, Object>> getSort()
```
    List of sort specifications.
  - isFirstPage
```
 final Boolean isFirstPage()
```
  - getFilter
```
 final FilterObject getFilter()
```
    FilterObject conditions used by backend to filter queries response.
  - getOffset
```
 final Integer getOffset()
```
    Pagination offset.
  - setOffset
```
 final Unit setOffset(Integer offset)
```
    Pagination offset.
  - getLimit
```
 final Integer getLimit()
```
    Number of channels to be returned by this query channels request.
  - setLimit
```
 final Unit setLimit(Integer limit)
```
    Number of channels to be returned by this query channels request.
  - getQuerySort
```
 final QuerySorter<Channel> getQuerySort()
```
    QuerySorter Sort specification for api queries.
  - getMessageLimit
```
 final Integer getMessageLimit()
```
    Number of messages in the response.
  - setMessageLimit
```
 final Unit setMessageLimit(Integer messageLimit)
```
    Number of messages in the response.
  - getMemberLimit
```
 final Integer getMemberLimit()
```
    Number of members in the response.
  - setMemberLimit
```
 final Unit setMemberLimit(Integer memberLimit)
```
    Number of members in the response.
  - withMessages
```
 final QueryChannelsRequest withMessages(Integer limit)
```
    Sets the limit of number of messages to be returned by this backend.
    
    Parameters:
    
    limit - Number of messages to limit.
    
    Returns:
    
    QueryChannelsRequest with updated limit.
  - withLimit
```
 final QueryChannelsRequest withLimit(Integer limit)
```
    Sets the number of channels to be returned by this backend.
    
    Parameters:
    
    limit - Number of channels to limit.
    
    Returns:
    
    QueryChannelsRequest with updated limit.
  - withOffset
```
 final QueryChannelsRequest withOffset(Integer offset)
```
    Sets the offset to this request.
    
    Parameters:
    
    offset - The offset value to set.
    
    Returns:
    
    QueryChannelsRequest with updated offset.

Class QueryChannelsRequest

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class io.getstream.chat.android.client.api.models.ChannelRequest

Methods inherited from class java.lang.Object

Constructor Detail

QueryChannelsRequest

Method Detail

getState

setState

getWatch

setWatch

getPresence

setPresence

getSort

isFirstPage

getFilter

getOffset

setOffset

getLimit

setLimit

getQuerySort

getMessageLimit

setMessageLimit

getMemberLimit

setMemberLimit

withMessages

withLimit

withOffset