Matterhorn.Types.EditState

Documentation

data EditMode

The input state associated with the message editor.

Constructors

NewPost

The input is for a new post.

Editing Post MessageType

The input is ultimately to replace the body of an existing post of the specified type.

Replying Message Post

The input is to be used as a new post in reply to the specified post.

Instances

Show EditMode

Defined in Matterhorn.Types.EditState

Methods

showsPrec :: Int -> EditMode -> ShowS

show :: EditMode -> String

showList :: [EditMode] -> ShowS

Eq EditMode

Defined in Matterhorn.Types.EditState

Methods

(==) :: EditMode -> EditMode -> Bool

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

data AttachmentData

An attachment.

Constructors

AttachmentData

Fields

• attachmentDataFileInfo :: FileInfo
• attachmentDataBytes :: ByteString

Instances

Show AttachmentData

Defined in Matterhorn.Types.EditState

Methods

showsPrec :: Int -> AttachmentData -> ShowS

show :: AttachmentData -> String

showList :: [AttachmentData] -> ShowS

Eq AttachmentData

Defined in Matterhorn.Types.EditState

Methods

(==) :: AttachmentData -> AttachmentData -> Bool

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

data AutocompletionType

The type of data that the autocompletion logic supports. We use this to track the kind of completion underway in case the type of completion needs to change.

Constructors

ACUsers

ACChannels

ACCodeBlockLanguage

ACEmoji

ACCommands

Instances

Show AutocompletionType

Defined in Matterhorn.Types.EditState

Methods

showsPrec :: Int -> AutocompletionType -> ShowS

show :: AutocompletionType -> String

showList :: [AutocompletionType] -> ShowS

Eq AutocompletionType

Defined in Matterhorn.Types.EditState

Methods

(==) :: AutocompletionType -> AutocompletionType -> Bool

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

data CompletionSource

The source of an autocompletion alternative.

Constructors

Server

Client

Instances

Show CompletionSource

Defined in Matterhorn.Types.EditState

Methods

showsPrec :: Int -> CompletionSource -> ShowS

show :: CompletionSource -> String

showList :: [CompletionSource] -> ShowS

Eq CompletionSource

Defined in Matterhorn.Types.EditState

Methods

(==) :: CompletionSource -> CompletionSource -> Bool

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

data SpecialMention

A "special" mention that does not map to a specific user, but is an alias that the server uses to notify users.

Constructors

MentionAll

@all: notify everyone in the channel.

MentionChannel

@channel: notify everyone in the channel.

specialMentionName :: SpecialMention -> Text

isSpecialMention :: Text -> Bool

data EditState n

The EditState value contains the editor widget itself as well as history and metadata we need for editing-related operations.

Constructors

EditState

Fields

• _esEditor :: Editor Text n
• _esEditMode :: EditMode
• _esEphemeral :: EphemeralEditState
• _esMisspellings :: Set Text
• _esAutocomplete :: Maybe (AutocompleteState n)

  The autocomplete state. The autocompletion UI is showing only when this state is present.

• _esResetEditMode :: EditMode

  The editing mode to reset to after input is handled.

• _esAutocompletePending :: Maybe Text

  The search string associated with the latest in-flight autocompletion request. This is used to determine whether any (potentially late-arriving) API responses are for stale queries since the user can type more quickly than the server can get us the results, and we wouldn't want to show results associated with old editor states.

• _esAttachmentList :: List n AttachmentData

  The list of attachments to be uploaded with the post being edited.

• _esFileBrowser :: Maybe (FileBrowser n)

  The browser for selecting attachment files. This is a Maybe because the instantiation of the FileBrowser causes it to read and ingest the target directory, so this action is deferred until the browser is needed.

• _esJustCompleted :: Bool
• _esShowReplyPrompt :: Bool

  Whether to show the reply prompt when replying

• _esSpellCheckTimerReset :: Maybe (IO ())

  An action to reset the spell check timer for this editor, if a spell checker is running.

• _esChannelId :: ChannelId

  Channel ID associated with this edit state

• _esTeamId :: Maybe TeamId

  Team ID associated with this edit state (optional since not all channels are associated with teams)

• _esTarget :: EditorTarget

  Target for this editor

newEditState :: n -> n -> EditorTarget -> Maybe TeamId -> ChannelId -> EditMode -> Bool -> Maybe (IO ()) -> EditState n

unsafeEsFileBrowser :: Lens' (EditState n) (FileBrowser n)

esAttachmentList :: forall n. Lens' (EditState n) (List n AttachmentData)

esFileBrowser :: forall n. Lens' (EditState n) (Maybe (FileBrowser n))

esMisspellings :: forall n. Lens' (EditState n) (Set Text)

esEditMode :: forall n. Lens' (EditState n) EditMode

esEphemeral :: forall n. Lens' (EditState n) EphemeralEditState

esEditor :: forall n. Lens' (EditState n) (Editor Text n)

esAutocomplete :: forall n. Lens' (EditState n) (Maybe (AutocompleteState n))

esAutocompletePending :: forall n. Lens' (EditState n) (Maybe Text)

esResetEditMode :: forall n. Lens' (EditState n) EditMode

esJustCompleted :: forall n. Lens' (EditState n) Bool

esShowReplyPrompt :: forall n. Lens' (EditState n) Bool

esSpellCheckTimerReset :: forall n. Lens' (EditState n) (Maybe (IO ()))

esTeamId :: forall n. Lens' (EditState n) (Maybe TeamId)

esChannelId :: forall n. Lens' (EditState n) ChannelId

esTarget :: forall n. Lens' (EditState n) EditorTarget

data EditorTarget

Constructors

EditorForThread TeamId

EditorForChannel ChannelId

Instances

Show EditorTarget

Defined in Matterhorn.Types.EditState

Methods

showsPrec :: Int -> EditorTarget -> ShowS

show :: EditorTarget -> String

showList :: [EditorTarget] -> ShowS

Eq EditorTarget

Defined in Matterhorn.Types.EditState

Methods

(==) :: EditorTarget -> EditorTarget -> Bool

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

data EphemeralEditState

Constructors

EphemeralEditState

Fields

• _eesMultiline :: Bool

  Whether the editor is in multiline mode

• _eesInputHistoryPosition :: Maybe Int

  The input history position, if any

• _eesLastInput :: (Text, EditMode)

  The input entered into the text editor last time the user was focused on the channel associated with this state.

• _eesTypingUsers :: TypingUsers

defaultEphemeralEditState :: EphemeralEditState

eesMultiline :: Lens' EphemeralEditState Bool

eesInputHistoryPosition :: Lens' EphemeralEditState (Maybe Int)

eesLastInput :: Lens' EphemeralEditState (Text, EditMode)

eesTypingUsers :: Lens' EphemeralEditState TypingUsers

addEphemeralStateTypingUser :: UserId -> UTCTime -> EphemeralEditState -> EphemeralEditState

Add user to the list of users in this state who are currently typing.

data AutocompleteState n

Constructors

AutocompleteState

Fields

• _acPreviousSearchString :: Text

  The search string used for the currently-displayed autocomplete results, for use in deciding whether to issue another server query

• _acCompletionList :: List n AutocompleteAlternative

  The list of alternatives that the user selects from

• _acType :: AutocompletionType

  The type of data that we're completing

• _acCachedResponses :: HashMap Text [AutocompleteAlternative]

  A cache of alternative lists, keyed on search string, for use in avoiding server requests. The idea here is that users type quickly enough (and edit their input) that would normally lead to rapid consecutive requests, some for the same strings during editing, that we can avoid that by caching them here. Note that this cache gets destroyed whenever autocompletion is not on, so this cache does not live very long.

acPreviousSearchString :: forall n. Lens' (AutocompleteState n) Text

acCompletionList :: forall n n. Lens (AutocompleteState n) (AutocompleteState n) (List n AutocompleteAlternative) (List n AutocompleteAlternative)

acCachedResponses :: forall n. Lens' (AutocompleteState n) (HashMap Text [AutocompleteAlternative])

acType :: forall n. Lens' (AutocompleteState n) AutocompletionType

data AutocompleteAlternative

Constructors

UserCompletion User Bool Text

User, plus whether the user is in the channel that triggered the autocomplete and any prefix (e.g. the preceeding portion of a user list) that should be retained when subtituting this autocompletion.

SpecialMention SpecialMention

A special mention.

ChannelCompletion Bool Channel

Channel, plus whether the user is a member of the channel

SyntaxCompletion Text

Name of a skylighting syntax definition

CommandCompletion CompletionSource Text Text Text

Source, name of a slash command, argspec, and description

EmojiCompletion Text

The text of an emoji completion

autocompleteAlternativeReplacement :: AutocompleteAlternative -> Text

Returns the actual text that should replace the current autocompletion word.

autocompleteAlternativeText :: AutocompleteAlternative -> Text

This returns the potential auto-completion final portion that might be used to match and therefore complete the current entry. Note that this is just the final completion portion; it differs from autocompleteAlternativeReplacement in that it does not include any sigils or prefixes; this value is often used to filter text for the results that will match the auto-completion.