FPO.Dto.DocumentDto.DocumentHistory

newtype DocumentHistory

Document history response from /docs/{documentID}/history endpoint Matches swagger DocumentHistory schema

Constructors

• DH { document :: DocumentID, history :: Array DocumentHistoryItem }

Instances

• Eq DocumentHistory
• DecodeJson DocumentHistory

data DocumentHistoryItem

A document history item can be either a tree revision (structure change) or a text revision (content change in a specific text element). Matches swagger DocumentHistoryItem oneOf schema

Constructors

• TreeHistoryItem TreeRevisionHeader
• TextHistoryItem { header :: TreeRevisionHeader, textElementID :: Int }

Instances

• Eq DocumentHistoryItem
• DecodeJson DocumentHistoryItem

newtype TreeRevisionHeader

Header for tree revisions (document structure changes) Matches swagger TreeRevisionHeader schema

Constructors

• TRH { author :: User, identifier :: Int, timestamp :: DocDate }

Instances

• Eq TreeRevisionHeader
• DecodeJson TreeRevisionHeader

newtype TreeRevisionHistory

Tree revision history response from /docs/{documentID}/tree/history endpoint Contains only tree revisions (document structure changes) Matches swagger TreeRevisionHistory schema

Constructors

• TRHist { document :: DocumentID, history :: Array TreeRevisionHeader }

Instances

• Eq TreeRevisionHistory
• DecodeJson TreeRevisionHistory

getDocumentID :: DocumentHistory -> DocumentID

Get the document ID from the history response

getHistoryItems :: DocumentHistory -> Array DocumentHistoryItem

Get all history items from the history response

isTreeItem :: DocumentHistoryItem -> Boolean

Check if an item is a tree revision

isTextItem :: DocumentHistoryItem -> Boolean

Check if an item is a text revision

getItemHeader :: DocumentHistoryItem -> TreeRevisionHeader

Get the header from any history item

getTextElementID :: DocumentHistoryItem -> Maybe Int

Get the text element ID from a text history item (returns Nothing for tree items)

getTreeRevisionIdentifier :: TreeRevisionHeader -> Int

getTreeRevisionTimestamp :: TreeRevisionHeader -> DocDate

getTreeRevisionAuthor :: TreeRevisionHeader -> User

getTreeHistoryDocumentID :: TreeRevisionHistory -> DocumentID

Get the document ID from the tree history response

getTreeHistoryItems :: TreeRevisionHistory -> Array TreeRevisionHeader

Get all tree revision headers from the tree history response