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


public final class QueryChannelsRequest
 implements ChannelRequest<QueryChannelsRequest>

Request body class for querying channels.

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`
`private final String`	`predefinedFilter`
`private final Map<String, Object>`	`filterValues`
`private final Map<String, Object>`	`sortValues`

Constructor Summary

Constructors
Constructor	Description
`QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues, Map<String, Object> sortValues, Integer offset, Integer messageLimit, Integer memberLimit)`	Constructs a QueryChannelsRequest for a server-side predefined filter.
`QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues, Map<String, Object> sortValues, Integer offset, Integer messageLimit)`	Constructs a QueryChannelsRequest for a server-side predefined filter.
`QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues, Map<String, Object> sortValues, Integer offset)`	Constructs a QueryChannelsRequest for a server-side predefined filter.
`QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues, Map<String, Object> sortValues)`	Constructs a QueryChannelsRequest for a server-side predefined filter.
`QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues)`	Constructs a QueryChannelsRequest for a server-side predefined filter.
`QueryChannelsRequest(String predefinedFilter, Integer limit)`	Constructs a QueryChannelsRequest for a server-side predefined filter.
`QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit, String predefinedFilter, Map<String, Object> filterValues, Map<String, Object> sortValues)`
`QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit, String predefinedFilter, Map<String, Object> filterValues)`
`QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit, String predefinedFilter)`
`QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit)`
`QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit)`
`QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort)`
`QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit)`
`QueryChannelsRequest(FilterObject filter, Integer limit)`

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`	`getIsFirstPage()`
`final FilterObject`	`getFilter()`
`final Integer`	`getOffset()`
`final Unit`	`setOffset(Integer offset)`
`final Integer`	`getLimit()`
`final Unit`	`setLimit(Integer limit)`
`final QuerySorter<Channel>`	`getQuerySort()`
`final Integer`	`getMessageLimit()`
`final Unit`	`setMessageLimit(Integer messageLimit)`
`final Integer`	`getMemberLimit()`
`final Unit`	`setMemberLimit(Integer memberLimit)`
`final String`	`getPredefinedFilter()`
`final Map<String, Object>`	`getFilterValues()`
`final Map<String, Object>`	`getSortValues()`
`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.QueryChannelsRequest
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(String predefinedFilter, Integer limit, Map<String, Object> filterValues, Map<String, Object> sortValues, Integer offset, Integer messageLimit, Integer memberLimit)
```
    Constructs a QueryChannelsRequest for a server-side predefined filter.
    
    Parameters:
    
    predefinedFilter - ID of a server-side predefined filter to use.
    
    limit - Number of channels to be returned by this query channels request.
    
    filterValues - Values to interpolate into the predefined filter template.
    
    sortValues - Values to interpolate into the predefined sort template.
    
    offset - Pagination offset.
    
    messageLimit - Number of messages in the response.
    
    memberLimit - Number of members in the response.
  - QueryChannelsRequest
```
QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues, Map<String, Object> sortValues, Integer offset, Integer messageLimit)
```
    Constructs a QueryChannelsRequest for a server-side predefined filter.
    
    Parameters:
    
    predefinedFilter - ID of a server-side predefined filter to use.
    
    limit - Number of channels to be returned by this query channels request.
    
    filterValues - Values to interpolate into the predefined filter template.
    
    sortValues - Values to interpolate into the predefined sort template.
    
    offset - Pagination offset.
    
    messageLimit - Number of messages in the response.
  - QueryChannelsRequest
```
QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues, Map<String, Object> sortValues, Integer offset)
```
    Constructs a QueryChannelsRequest for a server-side predefined filter.
    
    Parameters:
    
    predefinedFilter - ID of a server-side predefined filter to use.
    
    limit - Number of channels to be returned by this query channels request.
    
    filterValues - Values to interpolate into the predefined filter template.
    
    sortValues - Values to interpolate into the predefined sort template.
    
    offset - Pagination offset.
  - QueryChannelsRequest
```
QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues, Map<String, Object> sortValues)
```
    Constructs a QueryChannelsRequest for a server-side predefined filter.
    
    Parameters:
    
    predefinedFilter - ID of a server-side predefined filter to use.
    
    limit - Number of channels to be returned by this query channels request.
    
    filterValues - Values to interpolate into the predefined filter template.
    
    sortValues - Values to interpolate into the predefined sort template.
  - QueryChannelsRequest
```
QueryChannelsRequest(String predefinedFilter, Integer limit, Map<String, Object> filterValues)
```
    Constructs a QueryChannelsRequest for a server-side predefined filter.
    
    Parameters:
    
    predefinedFilter - ID of a server-side predefined filter to use.
    
    limit - Number of channels to be returned by this query channels request.
    
    filterValues - Values to interpolate into the predefined filter template.
  - QueryChannelsRequest
```
QueryChannelsRequest(String predefinedFilter, Integer limit)
```
    Constructs a QueryChannelsRequest for a server-side predefined filter.
    
    Parameters:
    
    predefinedFilter - ID of a server-side predefined filter to use.
    
    limit - Number of channels to be returned by this query channels request.
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit, String predefinedFilter, Map<String, Object> filterValues, Map<String, Object> sortValues)
```
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit, String predefinedFilter, Map<String, Object> filterValues)
```
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit, String predefinedFilter)
```
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit, Integer memberLimit)
```
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort, Integer messageLimit)
```
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit, QuerySorter<Channel> querySort)
```
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer offset, Integer limit)
```
  - QueryChannelsRequest
```
QueryChannelsRequest(FilterObject filter, Integer limit)
```
- 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.
  - getIsFirstPage
```
 final Boolean getIsFirstPage()
```
  - getFilter
```
 final FilterObject getFilter()
```
  - getOffset
```
 final Integer getOffset()
```
  - setOffset
```
 final Unit setOffset(Integer offset)
```
  - getLimit
```
 final Integer getLimit()
```
  - setLimit
```
 final Unit setLimit(Integer limit)
```
  - getQuerySort
```
 final QuerySorter<Channel> getQuerySort()
```
  - getMessageLimit
```
 final Integer getMessageLimit()
```
  - setMessageLimit
```
 final Unit setMessageLimit(Integer messageLimit)
```
  - getMemberLimit
```
 final Integer getMemberLimit()
```
  - setMemberLimit
```
 final Unit setMemberLimit(Integer memberLimit)
```
  - getPredefinedFilter
```
 final String getPredefinedFilter()
```
  - getFilterValues
```
 final Map<String, Object> getFilterValues()
```
  - getSortValues
```
 final Map<String, Object> getSortValues()
```
  - 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.
  - withLimit
```
 final QueryChannelsRequest withLimit(Integer limit)
```
    Sets the number of channels to be returned by this backend.
    
    Parameters:
    
    limit - Number of channels to limit.
  - withOffset
```
 final QueryChannelsRequest withOffset(Integer offset)
```
    Sets the offset to this request.
    
    Parameters:
    
    offset - The offset value to set.

Class QueryChannelsRequest

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

QueryChannelsRequest

Method Detail

getState

setState

getWatch

setWatch

getPresence

setPresence

getSort

getIsFirstPage

getFilter

getOffset

setOffset

getLimit

setLimit

getQuerySort

getMessageLimit

setMessageLimit

getMemberLimit

setMemberLimit

getPredefinedFilter

getFilterValues

getSortValues

withMessages

withLimit

withOffset