Yesod.Comments.Core

Documentation

class YesodAuth m => YesodComments m where

Methods

commentStorage :: CommentStorage s m

How to store and load comments from persistent storage.

userDetails :: AuthId m -> GHandler s m (Maybe UserDetails)

If Nothing is returned, the user cannot add a comment. This can be used to blacklist users. Note that comments left by them will still appear until manually deleted.

threadRoute :: ThreadId -> Route m

A thread's route. Currently, only used for linking back from the admin subsite.

editRoute :: Maybe (ThreadId -> CommentId -> Route m)

A route to the admin subsite's EditCommentR action. If Nothing, the Edit link will not be shown.

deleteRoute :: Maybe (ThreadId -> CommentId -> Route m)

A route to the admin subsite's DeleteCommentR action. If Nothing, the Delete link will not be shown.

type CommentId = Int

type ThreadId = Text

data Comment

The core data type, a Comment

Constructors

Comment

Fields

commentId :: CommentId

cThreadId :: ThreadId

cTimeStamp :: UTCTime

cIpAddress :: Text

cUserName :: Text

cUserEmail :: Text

cContent :: Markdown

cIsAuth :: Bool

compatability field, always true

Instances

Eq Comment

data UserDetails

Information about the User needed to store comments.

Constructors

UserDetails

Fields

textUserId :: Text

Text version of a user id, toPathPiece userId is recommended. Comments are stored using this value so users can freely change names without losing comments.

friendlyName :: Text

The name that's actually displayed

emailAddress :: Text

Not shown but stored

Instances

Eq UserDetails

data CommentStorage s m

How to save and restore comments from persistent storage. All necessary actions are accomplished through these 5 functions. Currently, only persistStorage is available.

Constructors

CommentStorage

Fields

csGet :: ThreadId -> CommentId -> GHandler s m (Maybe Comment)

csStore :: Comment -> GHandler s m ()

csUpdate :: Comment -> Comment -> GHandler s m ()

csDelete :: Comment -> GHandler s m ()

csLoad :: Maybe ThreadId -> GHandler s m [Comment]

Pass Nothing to get all comments site-wide.