All Implemented Interfaces:

io.getstream.chat.android.models.CustomObject , io.getstream.chat.android.models.querysort.ComparableFieldProvider
```
@Immutable() 
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
`public final class`	`Channel.Builder`

Field Summary

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

Constructor Summary

Constructors
Constructor	Description
Channel(String id, String type, String name, String image, Integer watcherCount, Boolean frozen, 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<PendingMessage> pendingMessages, List<Message> pinnedMessages, Set<String> ownCapabilities, Member membership, List<Message> cachedLatestMessages, Boolean isInsideSearch, DraftMessage draftMessage, List<Location> activeLiveLocations, Integer messageCount, PushPreference pushPreference, List<String> filterTags, Date lastMessageAt, Date truncatedAt, Boolean disabled, Boolean blocked, Map<String, Object> extraData)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getId()`
`final String`	`getType()`
`final String`	`getName()`
`final String`	`getImage()`
`final Integer`	`getWatcherCount()`
`final Boolean`	`getFrozen()`
`final Date`	`getCreatedAt()`
`final Date`	`getDeletedAt()`
`final Date`	`getUpdatedAt()`
`final SyncStatus`	`getSyncStatus()`
`final Integer`	`getMemberCount()`
`final List<Message>`	`getMessages()`
`final List<Member>`	`getMembers()`
`final List<User>`	`getWatchers()`
`final List<ChannelUserRead>`	`getRead()`
`final Config`	`getConfig()`
`final User`	`getCreatedBy()`
`final Integer`	`getUnreadCount()`
`final String`	`getTeam()`
`final Boolean`	`getHidden()`
`final Date`	`getHiddenMessagesBefore()`
`final Integer`	`getCooldown()`
`final List<PendingMessage>`	`getPendingMessages()`
`final List<Message>`	`getPinnedMessages()`
`final Set<String>`	`getOwnCapabilities()`
`final Member`	`getMembership()`
`final List<Message>`	`getCachedLatestMessages()`
`final Boolean`	`isInsideSearch()`
`final DraftMessage`	`getDraftMessage()`
`final List<Location>`	`getActiveLiveLocations()`
`final Integer`	`getMessageCount()`
`final PushPreference`	`getPushPreference()`
`final List<String>`	`getFilterTags()`
`final Date`	`getLastMessageAt()`
`final Date`	`getTruncatedAt()`
`final Boolean`	`getDisabled()`
`final Boolean`	`getBlocked()`
`Map<String, Object>`	`getExtraData()`
`final String`	`getCid()`	The channel id in the format messaging:123.
`final Date`	`getLastUpdated()`	Determines the last updated date/time.
`final Boolean`	`getHasUnread()`	Whether a channel contains unread messages or not.
`Comparable<?>`	`getComparableField(String fieldName)`	Gets a comparable fields from a name.
`final Channel.Builder`	`newBuilder()`

Methods inherited from class io.getstream.chat.android.models.CustomObject
getExtraValue
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 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<PendingMessage> pendingMessages, List<Message> pinnedMessages, Set<String> ownCapabilities, Member membership, List<Message> cachedLatestMessages, Boolean isInsideSearch, DraftMessage draftMessage, List<Location> activeLiveLocations, Integer messageCount, PushPreference pushPreference, List<String> filterTags, Date lastMessageAt, Date truncatedAt, Boolean disabled, Boolean blocked, 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.
    
    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.
    
    pendingMessages - The list of pending messages in the channel for the current user (if the feature enabled).
    
    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 newest messages if the regular list does not contain the newest messages.
    
    isInsideSearch - When the channel is inside search, eg.
    
    draftMessage - The draft message for the channel.
    
    activeLiveLocations - The list of active live locations in the channel.
    
    messageCount - The total number of messages in the channel.
    
    pushPreference - Channel-specific push preferences (if set).
    
    filterTags - The list of filter tags applied to the channel.
    
    lastMessageAt - Date/time of the last message sent.
    
    truncatedAt - Date/time of the last truncation, if the channel was ever truncated.
    
    disabled - Whether the channel is disabled or not.
    
    blocked - Whether the channel is blocked or not.
    
    extraData - A map of custom fields for the channel.
- Method Detail
  - getId
```
 final String getId()
```
  - getType
```
 final String getType()
```
  - getName
```
 final String getName()
```
  - getImage
```
 final String getImage()
```
  - getWatcherCount
```
 final Integer getWatcherCount()
```
  - getFrozen
```
 final Boolean getFrozen()
```
  - getCreatedAt
```
 final Date getCreatedAt()
```
  - getDeletedAt
```
 final Date getDeletedAt()
```
  - getUpdatedAt
```
 final Date getUpdatedAt()
```
  - getSyncStatus
```
 final SyncStatus getSyncStatus()
```
  - getMemberCount
```
 final Integer getMemberCount()
```
  - getMessages
```
 final List<Message> getMessages()
```
  - getMembers
```
 final List<Member> getMembers()
```
  - getWatchers
```
 final List<User> getWatchers()
```
  - getRead
```
 final List<ChannelUserRead> getRead()
```
  - getConfig
```
 final Config getConfig()
```
  - getCreatedBy
```
 final User getCreatedBy()
```
  - getUnreadCount
```
 final Integer getUnreadCount()
```
  - getTeam
```
 final String getTeam()
```
  - getHidden
```
 final Boolean getHidden()
```
  - getHiddenMessagesBefore
```
 final Date getHiddenMessagesBefore()
```
  - getCooldown
```
 final Integer getCooldown()
```
  - getPendingMessages
```
 final List<PendingMessage> getPendingMessages()
```
  - getPinnedMessages
```
 final List<Message> getPinnedMessages()
```
  - getOwnCapabilities
```
 final Set<String> getOwnCapabilities()
```
  - getMembership
```
 final Member getMembership()
```
  - getCachedLatestMessages
```
 final List<Message> getCachedLatestMessages()
```
  - isInsideSearch
```
 final Boolean isInsideSearch()
```
  - getDraftMessage
```
 final DraftMessage getDraftMessage()
```
  - getActiveLiveLocations
```
 final List<Location> getActiveLiveLocations()
```
  - getMessageCount
```
 final Integer getMessageCount()
```
  - getPushPreference
```
 final PushPreference getPushPreference()
```
  - getFilterTags
```
 final List<String> getFilterTags()
```
  - getLastMessageAt
```
 final Date getLastMessageAt()
```
  - getTruncatedAt
```
 final Date getTruncatedAt()
```
  - getDisabled
```
 final Boolean getDisabled()
```
  - getBlocked
```
 final Boolean getBlocked()
```
  - getExtraData
```
 Map<String, Object> getExtraData()
```
  - getCid
```
 final String getCid()
```
    The channel id in the format messaging:123.
  - getLastUpdated
```
 final Date getLastUpdated()
```
    Determines the last updated date/time. Returns either lastMessageAt or createdAt.
  - getHasUnread
```
 final Boolean getHasUnread()
```
    Whether a channel contains unread messages or not.
  - getComparableField
```
 Comparable<?> getComparableField(String fieldName)
```
    Gets a comparable fields from a name.
  - newBuilder
```
@SinceKotlin(version = "99999.9") final Channel.Builder newBuilder()
```

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

getId

getType

getName

getImage

getWatcherCount

getFrozen

getCreatedAt

getDeletedAt

getUpdatedAt

getSyncStatus

getMemberCount

getMessages

getMembers

getWatchers

getRead

getConfig

getCreatedBy

getUnreadCount

getTeam

getHidden

getHiddenMessagesBefore

getCooldown

getPendingMessages

getPinnedMessages

getOwnCapabilities

getMembership

getCachedLatestMessages

isInsideSearch

getDraftMessage

getActiveLiveLocations

getMessageCount

getPushPreference

getFilterTags

getLastMessageAt

getTruncatedAt

getDisabled

getBlocked

getExtraData

getCid

getLastUpdated

getHasUnread

getComparableField

newBuilder