Client.Hook

This module defines types for hooking into the operation of the client.

Documentation

• Message hook results

data MessageResult

The possible results of a MessageHook action. A hook can decline to handle a message (PassMessage), filter out a message (OmitMessage), or change a message into an arbitrary other message (RemapMessage).

Constructors

PassMessage

OmitMessage

RemapMessage IrcMsg

Instances

Semigroup MessageResult

Methods

(<>) :: MessageResult -> MessageResult -> MessageResult

sconcat :: NonEmpty MessageResult -> MessageResult

stimes :: Integral b => b -> MessageResult -> MessageResult

Monoid MessageResult

Methods

mempty :: MessageResult

mappend :: MessageResult -> MessageResult -> MessageResult

mconcat :: [MessageResult] -> MessageResult

• Message hooks

data MessageHook

Constructors

MessageHook

Fields

• _messageHookName :: Text

  Identifying name for the hook

• _messageHookStateful :: Bool

  Whether the remapping should affect client state

• _messageHookAction :: IrcMsg -> MessageResult

  (Partial) message remapping action

messageHookName :: Lens' MessageHook Text

messageHookStateful :: Lens' MessageHook Bool

messageHookAction :: Lens' MessageHook (IrcMsg -> MessageResult)

applyMessageHooks :: [MessageHook] -> IrcMsg -> Maybe IrcMsg

Apply the given message hooks to an IrcMsg. The hooks are tried in order until one handles the message. A Nothing result means the message was filtered out by a hook. A Just result contains the actual IrcMsg to be processed.