-
- All Implemented Interfaces:
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 Stringidprivate Stringtypeprivate Stringnameprivate Stringimageprivate UsercreatedByprivate Integercooldownprivate Booleanfrozenprivate DatecreatedAtprivate DateupdatedAtprivate DatedeletedAtprivate IntegermemberCountprivate Stringteamprivate Map<String, Object>extraDataprivate Set<String>ownCapabilitiesprivate 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 UnitsetId(String id)final StringgetType()final UnitsetType(String type)final StringgetName()final UnitsetName(String name)final StringgetImage()final UnitsetImage(String image)final UsergetCreatedBy()final UnitsetCreatedBy(User createdBy)final IntegergetCooldown()final UnitsetCooldown(Integer cooldown)final BooleangetFrozen()final UnitsetFrozen(Boolean frozen)final DategetCreatedAt()final UnitsetCreatedAt(Date createdAt)final DategetUpdatedAt()final UnitsetUpdatedAt(Date updatedAt)final DategetDeletedAt()final UnitsetDeletedAt(Date deletedAt)final IntegergetMemberCount()final UnitsetMemberCount(Integer memberCount)final StringgetTeam()final UnitsetTeam(String team)final Map<String, Object>getExtraData()final UnitsetExtraData(Map<String, Object> extraData)final Set<String>getOwnCapabilities()final UnitsetOwnCapabilities(Set<String> ownCapabilities)final MembergetMembership()final UnitsetMembership(Member membership)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()
-
setCreatedBy
final Unit setCreatedBy(User createdBy)
- Parameters:
createdBy- Creator of the channel.
-
getCooldown
final Integer getCooldown()
-
setCooldown
final Unit setCooldown(Integer cooldown)
- Parameters:
cooldown- Cooldown period after sending each message in seconds.
-
setFrozen
final Unit setFrozen(Boolean frozen)
- Parameters:
frozen- Whether channel is frozen or not.
-
getCreatedAt
final Date getCreatedAt()
-
setCreatedAt
final Unit setCreatedAt(Date createdAt)
- Parameters:
createdAt- Date/time of creation.
-
getUpdatedAt
final Date getUpdatedAt()
-
setUpdatedAt
final Unit setUpdatedAt(Date updatedAt)
- Parameters:
updatedAt- Date/time of the last update.
-
getDeletedAt
final Date getDeletedAt()
-
setDeletedAt
final Unit setDeletedAt(Date deletedAt)
- Parameters:
deletedAt- Date/time of deletion.
-
getMemberCount
final Integer getMemberCount()
-
setMemberCount
final Unit setMemberCount(Integer memberCount)
- Parameters:
memberCount- Number of members in the channel.
-
setTeam
final Unit setTeam(String team)
- Parameters:
team- Team the channel belongs to (multi-tenant only).
-
getExtraData
final Map<String, Object> getExtraData()
-
setExtraData
final Unit setExtraData(Map<String, Object> extraData)
- Parameters:
extraData- A map of custom fields for 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 the channel.
-
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.
-
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.
-
-
-
-