All Implemented Interfaces:

io.getstream.chat.android.models.CustomObject , io.getstream.chat.android.models.querysort.ComparableFieldProvider
```
public final class Channel
 implements CustomObject, ComparableFieldProvider
                    
```
Channel is where conversations take place between two or more chat users. It contains a list of messages and have a list of the member users that are participating in the conversation.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`cid`
`private final Date`	`lastUpdated`
`private final Boolean`	`hasUnread`
`private String`	`id`
`private String`	`type`
`private String`	`name`
`private String`	`image`
`private Integer`	`watcherCount`
`private Boolean`	`frozen`
`private Date`	`lastMessageAt`
`private Date`	`createdAt`
`private Date`	`deletedAt`
`private Date`	`updatedAt`
`private SyncStatus`	`syncStatus`
`private Integer`	`memberCount`
`private List<Message>`	`messages`
`private List<Member>`	`members`
`private List<User>`	`watchers`
`private List<ChannelUserRead>`	`read`
`private Config`	`config`
`private User`	`createdBy`
`private Integer`	`unreadCount`
`private final String`	`team`
`private Boolean`	`hidden`
`private Date`	`hiddenMessagesBefore`
`private final Integer`	`cooldown`
`private List<Message>`	`pinnedMessages`
`private Set<String>`	`ownCapabilities`
`private Member`	`membership`
`private List<Message>`	`cachedLatestMessages`
`private Boolean`	`isInsideSearch`
`private Map<String, Object>`	`extraData`

Constructor Summary

Constructors
Constructor	Description
Channel(String id, String type, String name, String image, Integer watcherCount, Boolean frozen, Date lastMessageAt, Date createdAt, Date deletedAt, Date updatedAt, SyncStatus syncStatus, Integer memberCount, List<Message> messages, List<Member> members, List<User> watchers, List<ChannelUserRead> read, Config config, User createdBy, Integer unreadCount, String team, Boolean hidden, Date hiddenMessagesBefore, Integer cooldown, List<Message> pinnedMessages, Set<String> ownCapabilities, Member membership, List<Message> cachedLatestMessages, Boolean isInsideSearch, Map<String, Object> extraData)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getCid()`
`final Date`	`getLastUpdated()`
`final Boolean`	`getHasUnread()`
`final String`	`getId()`
`final Unit`	`setId(String id)`
`final String`	`getType()`
`final Unit`	`setType(String type)`
`final String`	`getName()`
`final Unit`	`setName(String name)`
`final String`	`getImage()`
`final Unit`	`setImage(String image)`
`final Integer`	`getWatcherCount()`
`final Unit`	`setWatcherCount(Integer watcherCount)`
`final Boolean`	`getFrozen()`
`final Unit`	`setFrozen(Boolean frozen)`
`final Date`	`getLastMessageAt()`
`final Unit`	`setLastMessageAt(Date lastMessageAt)`
`final Date`	`getCreatedAt()`
`final Unit`	`setCreatedAt(Date createdAt)`
`final Date`	`getDeletedAt()`
`final Unit`	`setDeletedAt(Date deletedAt)`
`final Date`	`getUpdatedAt()`
`final Unit`	`setUpdatedAt(Date updatedAt)`
`final SyncStatus`	`getSyncStatus()`
`final Unit`	`setSyncStatus(SyncStatus syncStatus)`
`final Integer`	`getMemberCount()`
`final Unit`	`setMemberCount(Integer memberCount)`
`final List<Message>`	`getMessages()`
`final Unit`	`setMessages(List<Message> messages)`
`final List<Member>`	`getMembers()`
`final Unit`	`setMembers(List<Member> members)`
`final List<User>`	`getWatchers()`
`final Unit`	`setWatchers(List<User> watchers)`
`final List<ChannelUserRead>`	`getRead()`
`final Unit`	`setRead(List<ChannelUserRead> read)`
`final Config`	`getConfig()`
`final Unit`	`setConfig(Config config)`
`final User`	`getCreatedBy()`
`final Unit`	`setCreatedBy(User createdBy)`
`final Integer`	`getUnreadCount()`
`final Unit`	`setUnreadCount(Integer unreadCount)`
`final String`	`getTeam()`
`final Boolean`	`getHidden()`
`final Unit`	`setHidden(Boolean hidden)`
`final Date`	`getHiddenMessagesBefore()`
`final Unit`	`setHiddenMessagesBefore(Date hiddenMessagesBefore)`
`final Integer`	`getCooldown()`
`final List<Message>`	`getPinnedMessages()`
`final Unit`	`setPinnedMessages(List<Message> pinnedMessages)`
`final Set<String>`	`getOwnCapabilities()`
`final Unit`	`setOwnCapabilities(Set<String> ownCapabilities)`
`final Member`	`getMembership()`
`final Unit`	`setMembership(Member membership)`
`final List<Message>`	`getCachedLatestMessages()`
`final Unit`	`setCachedLatestMessages(List<Message> cachedLatestMessages)`
`final Boolean`	`isInsideSearch()`
`final Unit`	`setInsideSearch(Boolean isInsideSearch)`
`Map<String, Object>`	`getExtraData()`
`Unit`	`setExtraData(Map<String, Object> extraData)`
`Comparable<?>`	`getComparableField(String fieldName)`	Gets a comparable fields from a name.

Methods inherited from class io.getstream.chat.android.models.CustomObject
getExtraValue, putExtraValue
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Channel
```
Channel(String id, String type, String name, String image, Integer watcherCount, Boolean frozen, Date lastMessageAt, Date createdAt, Date deletedAt, Date updatedAt, SyncStatus syncStatus, Integer memberCount, List<Message> messages, List<Member> members, List<User> watchers, List<ChannelUserRead> read, Config config, User createdBy, Integer unreadCount, String team, Boolean hidden, Date hiddenMessagesBefore, Integer cooldown, List<Message> pinnedMessages, Set<String> ownCapabilities, Member membership, List<Message> cachedLatestMessages, Boolean isInsideSearch, Map<String, Object> extraData)
```
    Parameters:
    
    id - Channel's unique ID.
    
    type - Type of the channel.
    
    name - Channel's name.
    
    image - Channel's image.
    
    watcherCount - Number of channel watchers.
    
    frozen - Whether channel is frozen or not.
    
    lastMessageAt - Date of the last message sent.
    
    createdAt - Date/time of creation.
    
    deletedAt - Date/time of deletion.
    
    updatedAt - Date/time of the last update.
    
    syncStatus - Local field used to store channel's sync status and retry requests if needed.
    
    memberCount - Number of members in the channel.
    
    messages - The list of channel's messages.
    
    members - The list of channel's members.
    
    watchers - The list of channel's watchers.
    
    read - The list of read states.
    
    config - Channel's configuration.
    
    createdBy - Creator of the channel.
    
    unreadCount - The number of unread messages for the current user.
    
    team - Team the channel belongs to (multi-tenant only).
    
    hidden - Whether this channel is hidden by current user or not.
    
    hiddenMessagesBefore - Messages before this date are hidden from the user.
    
    cooldown - Cooldown period after sending each message in seconds.
    
    pinnedMessages - The list of pinned messages in the channel.
    
    ownCapabilities - Channel's capabilities available for the current user.
    
    membership - Represents relationship of the current user to this channel.
    
    cachedLatestMessages - The list of cached messages if the regular list does not contain the newest messages.
    
    isInsideSearch - When the channel is inside search, eg.
    
    extraData - A map of custom fields for the channel.
- Method Detail
  - getCid
```
 final String getCid()
```
  - getLastUpdated
```
 final Date getLastUpdated()
```
  - getHasUnread
```
 final Boolean getHasUnread()
```
  - getId
```
 final String getId()
```
  - setId
```
 final Unit setId(String id)
```
    Parameters:
    
    id - Channel's unique ID.
  - getType
```
 final String getType()
```
  - setType
```
 final Unit setType(String type)
```
    Parameters:
    
    type - Type of the channel.
  - getName
```
 final String getName()
```
  - setName
```
 final Unit setName(String name)
```
    Parameters:
    
    name - Channel's name.
  - getImage
```
 final String getImage()
```
  - setImage
```
 final Unit setImage(String image)
```
    Parameters:
    
    image - Channel's image.
  - getWatcherCount
```
 final Integer getWatcherCount()
```
  - setWatcherCount
```
 final Unit setWatcherCount(Integer watcherCount)
```
    Parameters:
    
    watcherCount - Number of channel watchers.
  - getFrozen
```
 final Boolean getFrozen()
```
  - setFrozen
```
 final Unit setFrozen(Boolean frozen)
```
    Parameters:
    
    frozen - Whether channel is frozen or not.
  - getLastMessageAt
```
 final Date getLastMessageAt()
```
  - setLastMessageAt
```
 final Unit setLastMessageAt(Date lastMessageAt)
```
    Parameters:
    
    lastMessageAt - Date of the last message sent.
  - getCreatedAt
```
 final Date getCreatedAt()
```
  - setCreatedAt
```
 final Unit setCreatedAt(Date createdAt)
```
    Parameters:
    
    createdAt - Date/time of creation.
  - getDeletedAt
```
 final Date getDeletedAt()
```
  - setDeletedAt
```
 final Unit setDeletedAt(Date deletedAt)
```
    Parameters:
    
    deletedAt - Date/time of deletion.
  - getUpdatedAt
```
 final Date getUpdatedAt()
```
  - setUpdatedAt
```
 final Unit setUpdatedAt(Date updatedAt)
```
    Parameters:
    
    updatedAt - Date/time of the last update.
  - getSyncStatus
```
 final SyncStatus getSyncStatus()
```
  - setSyncStatus
```
 final Unit setSyncStatus(SyncStatus syncStatus)
```
    Parameters:
    
    syncStatus - Local field used to store channel's sync status and retry requests if needed.
  - getMemberCount
```
 final Integer getMemberCount()
```
  - setMemberCount
```
 final Unit setMemberCount(Integer memberCount)
```
    Parameters:
    
    memberCount - Number of members in the channel.
  - getMessages
```
 final List<Message> getMessages()
```
  - setMessages
```
 final Unit setMessages(List<Message> messages)
```
    Parameters:
    
    messages - The list of channel's messages.
  - getMembers
```
 final List<Member> getMembers()
```
  - setMembers
```
 final Unit setMembers(List<Member> members)
```
    Parameters:
    
    members - The list of channel's members.
  - getWatchers
```
 final List<User> getWatchers()
```
  - setWatchers
```
 final Unit setWatchers(List<User> watchers)
```
    Parameters:
    
    watchers - The list of channel's watchers.
  - getRead
```
 final List<ChannelUserRead> getRead()
```
  - setRead
```
 final Unit setRead(List<ChannelUserRead> read)
```
    Parameters:
    
    read - The list of read states.
  - getConfig
```
 final Config getConfig()
```
  - setConfig
```
 final Unit setConfig(Config config)
```
    Parameters:
    
    config - Channel's configuration.
  - getCreatedBy
```
 final User getCreatedBy()
```
  - setCreatedBy
```
 final Unit setCreatedBy(User createdBy)
```
    Parameters:
    
    createdBy - Creator of the channel.
  - getUnreadCount
```
 final Integer getUnreadCount()
```
  - setUnreadCount
```
 final Unit setUnreadCount(Integer unreadCount)
```
    Parameters:
    
    unreadCount - The number of unread messages for the current user.
  - getTeam
```
 final String getTeam()
```
  - getHidden
```
 final Boolean getHidden()
```
  - setHidden
```
 final Unit setHidden(Boolean hidden)
```
    Parameters:
    
    hidden - Whether this channel is hidden by current user or not.
  - getHiddenMessagesBefore
```
 final Date getHiddenMessagesBefore()
```
  - setHiddenMessagesBefore
```
 final Unit setHiddenMessagesBefore(Date hiddenMessagesBefore)
```
    Parameters:
    
    hiddenMessagesBefore - Messages before this date are hidden from the user.
  - getCooldown
```
 final Integer getCooldown()
```
  - getPinnedMessages
```
 final List<Message> getPinnedMessages()
```
  - setPinnedMessages
```
 final Unit setPinnedMessages(List<Message> pinnedMessages)
```
    Parameters:
    
    pinnedMessages - The list of pinned messages in the channel.
  - getOwnCapabilities
```
 final Set<String> getOwnCapabilities()
```
  - setOwnCapabilities
```
 final Unit setOwnCapabilities(Set<String> ownCapabilities)
```
    Parameters:
    
    ownCapabilities - Channel's capabilities available for the current user.
  - getMembership
```
 final Member getMembership()
```
  - setMembership
```
 final Unit setMembership(Member membership)
```
    Parameters:
    
    membership - Represents relationship of the current user to this channel.
  - getCachedLatestMessages
```
 final List<Message> getCachedLatestMessages()
```
  - setCachedLatestMessages
```
 final Unit setCachedLatestMessages(List<Message> cachedLatestMessages)
```
    Parameters:
    
    cachedLatestMessages - The list of cached messages if the regular list does not contain the newest messages.
  - isInsideSearch
```
 final Boolean isInsideSearch()
```
  - setInsideSearch
```
 final Unit setInsideSearch(Boolean isInsideSearch)
```
    Parameters:
    
    isInsideSearch - When the channel is inside search, eg.
  - getExtraData
```
 Map<String, Object> getExtraData()
```
  - setExtraData
```
 Unit setExtraData(Map<String, Object> extraData)
```
    Parameters:
    
    extraData - A map of custom fields for the channel.
  - getComparableField
```
 Comparable<?> getComparableField(String fieldName)
```
    Gets a comparable fields from a name.
    
    Parameters:
    
    fieldName - The name of the field.

Class Channel

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class io.getstream.chat.android.models.CustomObject

Methods inherited from class java.lang.Object

Constructor Detail

Channel

Method Detail

getCid

getLastUpdated

getHasUnread

getId

setId

getType

setType

getName

setName

getImage

setImage

getWatcherCount

setWatcherCount

getFrozen

setFrozen

getLastMessageAt

setLastMessageAt

getCreatedAt

setCreatedAt

getDeletedAt

setDeletedAt

getUpdatedAt

setUpdatedAt

getSyncStatus

setSyncStatus

getMemberCount

setMemberCount

getMessages

setMessages

getMembers

setMembers

getWatchers

setWatchers

getRead

setRead

getConfig

setConfig

getCreatedBy

setCreatedBy

getUnreadCount

setUnreadCount

getTeam

getHidden

setHidden

getHiddenMessagesBefore

setHiddenMessagesBefore

getCooldown

getPinnedMessages

setPinnedMessages

getOwnCapabilities

setOwnCapabilities

getMembership

setMembership

getCachedLatestMessages

setCachedLatestMessages

isInsideSearch

setInsideSearch

getExtraData

setExtraData

getComparableField