Matterhorn.Types.Channels

Documentation

data ClientChannel

A ClientChannel contains both the message listing and the metadata about a channel

Constructors

ClientChannel

Fields

• _ccInfo :: ChannelInfo

  The ChannelInfo for the channel

• _ccMessageInterface :: MessageInterface Name ()

  The channel's message interface

data ChannelInfo

The ChannelInfo record represents metadata about a channel

Constructors

ChannelInfo

Fields

• _cdChannelId :: ChannelId

  The channel's ID

• _cdTeamId :: Maybe TeamId

  The channel's team ID

• _cdViewed :: Maybe ServerTime

  The last time we looked at a channel

• _cdNewMessageIndicator :: NewMessageIndicator

  The state of the channel's new message indicator.

• _cdEditedMessageThreshold :: Maybe ServerTime

  The channel's edited message threshold.

• _cdMentionCount :: Int

  The current number of unread mentions

• _cdUpdated :: ServerTime

  The last time a message showed up in the channel

• _cdName :: Text

  The name of the channel

• _cdDisplayName :: Text

  The display name of the channel

• _cdHeader :: Text

  The header text of a channel

• _cdPurpose :: Text

  The stated purpose of the channel

• _cdType :: Type

  The type of a channel: public, private, or DM

• _cdNotifyProps :: ChannelNotifyProps

  The user's notification settings for this channel

• _cdDMUserId :: Maybe UserId

  The user associated with this channel, if it is a DM channel

• _cdSidebarShowOverride :: Maybe UTCTime

  If set, show this channel in the sidebar regardless of other considerations as long as the specified timestamp meets a cutoff. Otherwise fall back to other application policy to determine whether to show the channel.

• _cdFetchPending :: Bool

  Whether a fetch in this channel is pending

data ClientChannels

Instances

Semigroup ClientChannels

Defined in Matterhorn.Types.Channels

Methods

(<>) :: ClientChannels -> ClientChannels -> ClientChannels

sconcat :: NonEmpty ClientChannels -> ClientChannels

stimes :: Integral b => b -> ClientChannels -> ClientChannels

Monoid ClientChannels

Defined in Matterhorn.Types.Channels

Methods

mempty :: ClientChannels

mappend :: ClientChannels -> ClientChannels -> ClientChannels

mconcat :: [ClientChannels] -> ClientChannels

chanMap :: Lens' ClientChannels (HashMap ChannelId ClientChannel)

data NewMessageIndicator

Constructors

Hide

NewPostsAfterServerTime ServerTime

NewPostsStartingAt ServerTime

Instances

Eq NewMessageIndicator

Defined in Matterhorn.Types.Channels

Methods

(==) :: NewMessageIndicator -> NewMessageIndicator -> Bool

(/=) :: NewMessageIndicator -> NewMessageIndicator -> Bool

Show NewMessageIndicator

Defined in Matterhorn.Types.Channels

Methods

showsPrec :: Int -> NewMessageIndicator -> ShowS

show :: NewMessageIndicator -> String

showList :: [NewMessageIndicator] -> ShowS

Lenses created for accessing ClientChannel fields

ccInfo :: Lens' ClientChannel ChannelInfo

ccMessageInterface :: Lens' ClientChannel (MessageInterface Name ())

Lenses created for accessing ChannelInfo fields

cdViewed :: Lens' ChannelInfo (Maybe ServerTime)

cdNewMessageIndicator :: Lens' ChannelInfo NewMessageIndicator

cdEditedMessageThreshold :: Lens' ChannelInfo (Maybe ServerTime)

cdUpdated :: Lens' ChannelInfo ServerTime

cdName :: Lens' ChannelInfo Text

cdDisplayName :: Lens' ChannelInfo Text

cdHeader :: Lens' ChannelInfo Text

cdPurpose :: Lens' ChannelInfo Text

cdType :: Lens' ChannelInfo Type

cdMentionCount :: Lens' ChannelInfo Int

cdDMUserId :: Lens' ChannelInfo (Maybe UserId)

cdChannelId :: Lens' ChannelInfo ChannelId

cdSidebarShowOverride :: Lens' ChannelInfo (Maybe UTCTime)

cdNotifyProps :: Lens' ChannelInfo ChannelNotifyProps

cdTeamId :: Lens' ChannelInfo (Maybe TeamId)

cdFetchPending :: Lens' ChannelInfo Bool

Managing ClientChannel collections

noChannels :: ClientChannels

Initial collection of Channels with no members

addChannel :: ChannelId -> ClientChannel -> ClientChannels -> ClientChannels

Add a channel to the existing collection.

removeChannel :: ChannelId -> ClientChannels -> ClientChannels

Remove a channel from the collection.

findChannelById :: ChannelId -> ClientChannels -> Maybe ClientChannel

Get the ChannelInfo information given the ChannelId

modifyChannelById :: ChannelId -> (ClientChannel -> ClientChannel) -> ClientChannels -> ClientChannels

Transform the specified channel in place with provided function.

channelByIdL :: ChannelId -> Traversal' ClientChannels ClientChannel

A Traversal that will give us the ClientChannel in a ClientChannels structure if it exists

maybeChannelByIdL :: ChannelId -> Lens' ClientChannels (Maybe ClientChannel)

A Lens that will give us the ClientChannel in a ClientChannels wrapped in a Maybe

allTeamIds :: ClientChannels -> [TeamId]

Get all the team IDs in the channel collection.

filteredChannelIds :: (ClientChannel -> Bool) -> ClientChannels -> [ChannelId]

Apply a filter to each ClientChannel and return a list of the ChannelId values for which the filter matched.

filteredChannels :: ((ChannelId, ClientChannel) -> Bool) -> ClientChannels -> [(ChannelId, ClientChannel)]

Filter the ClientChannel collection, keeping only those for which the provided filter test function returns True.

Creating ChannelInfo objects

channelInfoFromChannelWithData :: Channel -> ChannelMember -> ChannelInfo -> ChannelInfo

Channel State management

clearNewMessageIndicator :: ClientChannel -> ClientChannel

Clear the new message indicator for the specified channel

clearEditedThreshold :: ClientChannel -> ClientChannel

Clear the edit threshold for the specified channel

adjustUpdated :: Post -> ClientChannel -> ClientChannel

Adjust updated time based on a message, ensuring that the updated time does not move backward.

adjustEditedThreshold :: Post -> ClientChannel -> ClientChannel

updateNewMessageIndicator :: Post -> ClientChannel -> ClientChannel

Notification settings

notifyPreference :: User -> ClientChannel -> NotifyOption

isMuted :: ClientChannel -> Bool

channelNotifyPropsMarkUnreadL :: Lens' ChannelNotifyProps (WithDefault NotifyOption)

channelNotifyPropsIgnoreChannelMentionsL :: Lens' ChannelNotifyProps (WithDefault Bool)

channelNotifyPropsDesktopL :: Lens' ChannelNotifyProps (WithDefault NotifyOption)

channelNotifyPropsPushL :: Lens' ChannelNotifyProps (WithDefault NotifyOption)

Miscellaneous channel-related operations

canLeaveChannel :: ChannelInfo -> Bool

preferredChannelName :: Channel -> Text

isTownSquare :: Channel -> Bool

Town Square is special in that its non-display name cannot be changed and is a hard-coded constant server-side according to the developers (as of 8217). So this is a reliable way to check for whether a channel is in fact that channel, even if the user has changed its display name.

channelDeleted :: Channel -> Bool

getDmChannelFor :: UserId -> ClientChannels -> Maybe ChannelId

allDmChannelMappings :: ClientChannels -> [(UserId, ChannelId)]

getChannelNameSet :: TeamId -> ClientChannels -> Set Text

emptyChannelMessages :: MonadIO m => m Messages

An initial empty channel message list. This also contains an UnknownGapBefore, which is a signal that causes actual content fetching. The initial Gap's timestamp is the local client time, but subsequent fetches will synchronize with the server (and eventually eliminate this Gap as well).