stream-chat-android-client/io.getstream.chat.android.client.models/Channel

Channel

data class Channel( var cid: String = "", var id: String = "", var type: String = "", var name: String = "", var image: String = "", var watcherCount: Int = 0, var frozen: Boolean = false, var lastMessageAt: Date? = null, var createdAt: Date? = null, var deletedAt: Date? = null, var updatedAt: Date? = null, var syncStatus: SyncStatus = SyncStatus.COMPLETED, var memberCount: Int = 0, var messages: List<Message> = mutableListOf(), var members: List<Member> = mutableListOf(), var watchers: List<User> = mutableListOf(), var read: List<ChannelUserRead> = mutableListOf(), var config: Config = Config(), var createdBy: User = User(), var unreadCount: Int? = null, val team: String = "", var hidden: Boolean? = null, var hiddenMessagesBefore: Date? = null, val cooldown: Int = 0, var pinnedMessages: List<Message> = mutableListOf(), var ownCapabilities: Set<String> = setOf(), var membership: Member? = null, var extraData: MutableMap<String, Any> = mutableMapOf()) : 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.

Parameters

cid

The channel id in the format messaging:123.

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. Note that the field is not provided in the events.

membership

Represents relationship of the current user to this channel.

extraData

A map of custom fields for the channel.

Constructors

Channel

fun Channel( cid: String = "", id: String = "", type: String = "", name: String = "", image: String = "", watcherCount: Int = 0, frozen: Boolean = false, lastMessageAt: Date? = null, createdAt: Date? = null, deletedAt: Date? = null, updatedAt: Date? = null, syncStatus: SyncStatus = SyncStatus.COMPLETED, memberCount: Int = 0, messages: List<Message> = mutableListOf(), members: List<Member> = mutableListOf(), watchers: List<User> = mutableListOf(), read: List<ChannelUserRead> = mutableListOf(), config: Config = Config(), createdBy: User = User(), unreadCount: Int? = null, team: String = "", hidden: Boolean? = null, hiddenMessagesBefore: Date? = null, cooldown: Int = 0, pinnedMessages: List<Message> = mutableListOf(), ownCapabilities: Set<String> = setOf(), membership: Member? = null, extraData: MutableMap<String, Any> = mutableMapOf())

Properties

cid

var cid: String

config

var config: Config

cooldown

val cooldown: Int = 0

createdAt

var createdAt: Date? = null

createdBy

var createdBy: User

deletedAt

var deletedAt: Date? = null

extraData

open override var extraData: MutableMap<String, Any>

frozen

var frozen: Boolean = false

hasUnread

val hasUnread: Boolean

Whether a channel contains unread messages or not.

hidden

var hidden: Boolean? = null

hiddenMessagesBefore

var hiddenMessagesBefore: Date? = null

var id: String

image

var image: String

lastMessageAt

var lastMessageAt: Date? = null

lastUpdated

val lastUpdated: Date?

Determines the last updated date/time. Returns either lastMessageAt or createdAt.

memberCount

var memberCount: Int = 0

members

var members: List<Member>

membership

var membership: Member? = null

messages

var messages: List<Message>

name

var name: String

ownCapabilities

var ownCapabilities: Set<String>

pinnedMessages

var pinnedMessages: List<Message>

read

var read: List<ChannelUserRead>

syncStatus

var syncStatus: SyncStatus

team

val team: String

type

var type: String

unreadCount

var unreadCount: Int? = null

updatedAt

var updatedAt: Date? = null

watcherCount

var watcherCount: Int = 0

watchers

var watchers: List<User>

Functions

getComparableField

open override fun getComparableField(fieldName: String): Comparable<*>?

Gets a comparable fields from a name.

Inherited functions

getExtraValue

open fun <T> getExtraValue(key: String, default: T): T

putExtraValue

open fun putExtraValue(key: String, value: Any)

Extensions

addMember

fun Channel.addMember(member: Member?): Channel

Adds member to the Channel.members and aligns Channel.memberCount.

addMembership

fun Channel.addMembership(currentUserId: String?, member: Member?): Channel

Sets Channel.membership to member if currentUserId equals to member.user.id.

countUnreadMentionsForUser

fun Channel.countUnreadMentionsForUser(user: User): Int

Counts messages in which user is mentioned. The method relies on the Channel.messages list and doesn't do any API call. Therefore, the count might be not reliable as it relies on the local data.

getUnreadMessagesCount