ActiveAnno

Web-based responsive document annotation tool

View the Project on GitHub MaxMello/ActiveAnno

activeannoservice / project.export

Package project.export

Types

Name Summary
Export Export configuration for consuming the results of this servicedata class Export
ExportDocument data class ExportDocument
ExportFormat What aspects for the document and results to exportdata class ExportFormat
OnOverwrittenFinalizedAnnotationBehavior Define behavior what to do when a finalizedAnnotation was defined, but a new one was set afterwards. This would not happen normally, but cannot be prevented for cases where an annotation is found via search to correct an earlier mistake. For this case, we need to define if we want to trigger web hooks again or not.enum class OnOverwrittenFinalizedAnnotationBehavior
OnWebHookFailureBehavior What to do when calling the WebHook failedenum class OnWebHookFailureBehavior
RestAuthentication sealed class RestAuthentication
RestConfig What REST endpoints to activate and how to export themdata class RestConfig
WebHookConfig data class WebHookConfig

Functions

Name Summary
callWebHook suspend fun WebHookConfig.callWebHook(projectID: String, document: Document): Unit
checkWebHooks suspend fun Export.checkWebHooks(projectID: String, document: Document): Unit
convertDocument fun ExportFormat.convertDocument(projectID: String, document: Document, includeUsedProject: Boolean = false, includeDocumentData: Boolean = false, includeExportStatistics: Boolean = false): ExportDocument