-
- All Implemented Interfaces:
-
io.getstream.chat.android.client.models.CustomObject
public final class Channel implements CustomObject
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.
-
-
Field Summary
Fields Modifier and Type Field Description private final DatelastUpdatedprivate final BooleanhasUnreadprivate Stringcidprivate Stringidprivate Stringtypeprivate Stringnameprivate Stringimageprivate IntegerwatcherCountprivate Booleanfrozenprivate DatelastMessageAtprivate DatecreatedAtprivate DatedeletedAtprivate DateupdatedAtprivate SyncStatussyncStatusprivate IntegermemberCountprivate List<Message>messagesprivate List<Member>membersprivate List<User>watchersprivate List<ChannelUserRead>readprivate Configconfigprivate UsercreatedByprivate IntegerunreadCountprivate final Stringteamprivate Booleanhiddenprivate DatehiddenMessagesBeforeprivate final Integercooldownprivate List<Message>pinnedMessagesprivate Set<String>ownCapabilitiesprivate Membermembershipprivate Map<String, Object>extraData
-
Constructor Summary
Constructors Constructor Description Channel(String cid, 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, Map<String, Object> extraData)
-
Method Summary
-
-
Constructor Detail
-
Channel
Channel(String cid, 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, Map<String, Object> extraData)
- Parameters:
cid- The channel id in the format messaging:123.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.extraData- A map of custom fields for the channel.
-
-
Method Detail
-
getLastUpdated
final Date getLastUpdated()
-
getHasUnread
final Boolean getHasUnread()
-
getWatcherCount
final Integer getWatcherCount()
-
setWatcherCount
final Unit setWatcherCount(Integer watcherCount)
- Parameters:
watcherCount- Number of channel watchers.
-
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.
-
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.
-
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.
-
getExtraData
Map<String, Object> getExtraData()
-
setExtraData
Unit setExtraData(Map<String, Object> extraData)
- Parameters:
extraData- A map of custom fields for the channel.
-
-
-
-