Package io.getstream.chat.android.models
Class ChannelData
-
- All Implemented Interfaces:
@Immutable() public final class ChannelDataA class that only stores the channel data and not the channel state that changes a lot (for example messages, watchers, etc.).
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringcidprivate final Stringidprivate final Stringtypeprivate final Stringnameprivate final Stringimageprivate final UsercreatedByprivate final Integercooldownprivate final Booleanfrozenprivate final DatecreatedAtprivate final DateupdatedAtprivate final DatedeletedAtprivate final IntegermemberCountprivate final Stringteamprivate final Map<String, Object>extraDataprivate final Set<String>ownCapabilitiesprivate final Membermembership
-
Constructor Summary
Constructors Constructor Description ChannelData(Channel channel, Set<String> currentOwnCapabilities)Creates a ChannelData entity from a Channel object. ChannelData(String id, String type, String name, String image, User createdBy, Integer cooldown, Boolean frozen, Date createdAt, Date updatedAt, Date deletedAt, Integer memberCount, String team, Map<String, Object> extraData, Set<String> ownCapabilities, Member membership)
-
Method Summary
Modifier and Type Method Description final StringgetCid()final StringgetId()final StringgetType()final StringgetName()final StringgetImage()final UsergetCreatedBy()final IntegergetCooldown()final BooleangetFrozen()final DategetCreatedAt()final DategetUpdatedAt()final DategetDeletedAt()final IntegergetMemberCount()final StringgetTeam()final Map<String, Object>getExtraData()final Set<String>getOwnCapabilities()final MembergetMembership()final ChanneltoChannel(List<Message> messages, List<Message> cachedLatestMessages, List<Member> members, List<ChannelUserRead> reads, List<User> watchers, Integer watcherCount, Boolean insideSearch, Date channelLastMessageAt)final ChanneltoChannel(List<Message> messages, List<Message> cachedLatestMessages, List<Member> members, List<ChannelUserRead> reads, List<User> watchers, Integer watcherCount, Boolean insideSearch)Converts a ChannelData entity to a Channel based on additional information. final BooleanisUserAbleTo(String channelCapability)Checks if the user has specific capabilities. -
-
Constructor Detail
-
ChannelData
ChannelData(Channel channel, Set<String> currentOwnCapabilities)
Creates a ChannelData entity from a Channel object.- Parameters:
channel- The Channel object to convert.currentOwnCapabilities- Set of existing own capabilities stored for the Channel.
-
ChannelData
ChannelData(String id, String type, String name, String image, User createdBy, Integer cooldown, Boolean frozen, Date createdAt, Date updatedAt, Date deletedAt, Integer memberCount, String team, Map<String, Object> extraData, Set<String> ownCapabilities, Member membership)
- Parameters:
id- Channel's unique ID.type- Type of the channel.name- Channel's name.image- Channel's image.createdBy- Creator of the channel.cooldown- Cooldown period after sending each message in seconds.frozen- Whether channel is frozen or not.createdAt- Date/time of creation.updatedAt- Date/time of the last update.deletedAt- Date/time of deletion.memberCount- Number of members in the channel.team- Team the channel belongs to (multi-tenant only).extraData- A map of custom fields for the channel.ownCapabilities- Channel's capabilities available for the current user.membership- Represents relationship of the current user to the channel.
-
-
Method Detail
-
getCreatedBy
final User getCreatedBy()
-
getCooldown
final Integer getCooldown()
-
getCreatedAt
final Date getCreatedAt()
-
getUpdatedAt
final Date getUpdatedAt()
-
getDeletedAt
final Date getDeletedAt()
-
getMemberCount
final Integer getMemberCount()
-
getExtraData
final Map<String, Object> getExtraData()
-
getOwnCapabilities
final Set<String> getOwnCapabilities()
-
getMembership
final Member getMembership()
-
toChannel
@Deprecated(message = "Use Channel.toChannelData instead", replaceWith = @ReplaceWith(imports = {}, expression = "Channel.toChannelData(messages, cachedLatestMessages, members, reads, watchers, watcherCount, insideSearch)")) final Channel toChannel(List<Message> messages, List<Message> cachedLatestMessages, List<Member> members, List<ChannelUserRead> reads, List<User> watchers, Integer watcherCount, Boolean insideSearch, Date channelLastMessageAt)
-
toChannel
final Channel toChannel(List<Message> messages, List<Message> cachedLatestMessages, List<Member> members, List<ChannelUserRead> reads, List<User> watchers, Integer watcherCount, Boolean insideSearch)
Converts a ChannelData entity to a Channel based on additional information.
- Parameters:
messages- The list of channel's messages.members- The list of channel's members.reads- The list of read states.watchers- The list of channel's watchers.watcherCount- Number of channel watchers.- Returns:
A Channel object.
-
isUserAbleTo
final Boolean isUserAbleTo(String channelCapability)
Checks if the user has specific capabilities.
You can find a list of capabilities in ChannelCapabilities.
- Parameters:
channelCapability- The specific ability we are checking against.
-
-
-
-