Matterhorn.State.Channels

Documentation

updateViewed :: Bool -> MH ()

refreshChannel :: SidebarUpdate -> Channel -> ChannelMember -> MH ()

Refresh information about a specific channel. The channel metadata is refreshed, and if this is a loaded channel, the scrollback is updated as well.

The sidebar update argument indicates whether this refresh should also update the sidebar. Ordinarily you want this, so pass SidebarUpdateImmediate unless you are very sure you know what you are doing, i.e., you are very sure that a call to refreshChannel will be followed immediately by a call to updateSidebar. We provide this control so that channel refreshes can be batched and then a single updateSidebar call can be used instead of the default behavior of calling it once per refreshChannel call, which is the behavior if the immediate setting is passed here.

refreshChannelsAndUsers :: MH ()

Refresh information about all channels and users. This is usually triggered when a reconnect event for the WebSocket to the server occurs.

setFocus :: TeamId -> ChannelId -> MH ()

refreshChannelById :: ChannelId -> MH ()

applyPreferenceChange :: Preference -> MH ()

leaveChannel :: ChannelId -> MH ()

leaveCurrentChannel :: TeamId -> MH ()

getNextUnreadChannel :: ChatState -> TeamId -> Zipper a ChannelListEntry -> Zipper a ChannelListEntry

getNextUnreadUserOrChannel :: ChatState -> TeamId -> Zipper a ChannelListEntry -> Zipper a ChannelListEntry

nextUnreadChannel :: TeamId -> MH ()

nextUnreadUserOrChannel :: TeamId -> MH ()

createOrFocusDMChannel :: TeamId -> UserInfo -> Maybe (ChannelId -> MH ()) -> MH ()

prevChannel :: TeamId -> MH ()

nextChannel :: TeamId -> MH ()

recentChannel :: TeamId -> MH ()

setReturnChannel :: TeamId -> MH ()

resetReturnChannel :: TeamId -> MH ()

hideDMChannel :: ChannelId -> MH ()

If the current channel is a DM channel with a single user or a group of users, hide it from the sidebar and adjust the server-side preference to hide it persistently. Note that this does not actually hide the channel in our UI; we hide it in response to the preference change websocket event triggered by this function's API interaction with the server.

If the current channel is any other kind of channel, complain with a usage error.

createGroupChannel :: TeamId -> Text -> MH ()

showGroupChannelPref :: ChannelId -> UserId -> Preference

inputHistoryForward :: Lens' ChatState (MessageInterface n i) -> MH ()

inputHistoryBackward :: Lens' ChatState (MessageInterface n i) -> MH ()

handleNewChannel :: Bool -> SidebarUpdate -> Channel -> ChannelMember -> MH ()

createOrdinaryChannel :: TeamId -> Bool -> Text -> MH ()

handleChannelInvite :: ChannelId -> MH ()

When we are added to a channel not locally known about, we need to fetch the channel info for that channel.

addUserByNameToCurrentChannel :: TeamId -> Text -> MH ()

addUserToCurrentChannel :: TeamId -> UserInfo -> MH ()

removeUserFromCurrentChannel :: TeamId -> Text -> MH ()

removeChannelFromState :: ChannelId -> MH ()

isRecentChannel :: ChatState -> TeamId -> ChannelId -> Bool

isReturnChannel :: ChatState -> TeamId -> ChannelId -> Bool

isCurrentChannel :: ChatState -> TeamId -> ChannelId -> Bool

deleteCurrentChannel :: TeamId -> MH ()

startLeaveCurrentChannel :: TeamId -> MH ()

joinChannel :: TeamId -> ChannelId -> MH ()

If the user is not a member of the specified channel, submit a request to join it. Otherwise switch to the channel.

joinChannel' :: TeamId -> ChannelId -> Maybe (MH ()) -> MH ()

joinChannelByName :: TeamId -> Text -> MH ()

changeChannelByName :: TeamId -> Text -> MH ()

This switches to the named channel or creates it if it is a missing but valid user channel.

setChannelTopic :: TeamId -> Text -> MH ()

getCurrentChannelTopic :: TeamId -> MH (Maybe Text)

beginCurrentChannelDeleteConfirm :: TeamId -> MH ()

toggleExpandedChannelTopics :: MH ()

updateChannelNotifyProps :: ChannelId -> ChannelNotifyProps -> MH ()

renameChannelUrl :: TeamId -> Text -> MH ()

This renames the current channel's url name. It makes a request to the server to change the name, but does not actually change the name in Matterhorn yet; that is handled by a websocket event handled asynchronously.

toggleChannelFavoriteStatus :: TeamId -> MH ()

toggleChannelListGroupVisibility :: ChannelListGroupLabel -> MH ()

toggleCurrentChannelChannelListGroup :: TeamId -> MH ()

toggleCurrentChannelChannelListGroupByName :: Text -> TeamId -> MH ()

cycleChannelListSortingMode :: TeamId -> MH ()