Copyright	(c) Dan Doel 2016
License	ISC
Maintainer	dan.doel@gmail.com
Safe Haskell	None
Language	Haskell2010

Client.Hook

Description

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

Synopsis

data MessageResult
- = PassMessage
- | OmitMessage
- | RemapMessage IrcMsg
data MessageHook = MessageHook {
- _messageHookName :: Text
- _messageHookStateful :: Bool
- _messageHookAction :: IrcMsg -> MessageResult
}
messageHookName :: Lens' MessageHook Text
messageHookStateful :: Lens' MessageHook Bool
messageHookAction :: Lens' MessageHook (IrcMsg -> MessageResult)
applyMessageHooks :: [MessageHook] -> IrcMsg -> Maybe IrcMsg

Documentation

Message hook results

data MessageResult Source #

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	continue processing
OmitMessage	stop processing and drop message
RemapMessage IrcMsg	stop processing and return new message

Instances

Semigroup MessageResult Source #
Instance details Defined in Client.Hook Methods (<>) :: MessageResult -> MessageResult -> MessageResult # sconcat :: NonEmpty MessageResult -> MessageResult # stimes :: Integral b => b -> MessageResult -> MessageResult #
Monoid MessageResult Source #
Instance details Defined in Client.Hook Methods mempty :: MessageResult # mappend :: MessageResult -> MessageResult -> MessageResult # mconcat :: [MessageResult] -> MessageResult #

Message hooks

data MessageHook Source #

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 Source #

messageHookStateful :: Lens' MessageHook Bool Source #

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

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

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.