Interface CheckOptions

Check options describe how the server should handle the checked document.

interface CheckOptions {
    externalContent?: ExternalContent;
    inputFormat?: string;
    requestDescription?: {
        documentReference?: string;
    };
    selection?: DocumentSelection;
}

Index

Properties

externalContent? inputFormat? requestDescription? selection?

Properties

`Optional`externalContent

externalContent?: ExternalContent

Only supported with Acrolinx Platform 2019.10 (Sidebar version 14.16) and newer.

`Optional`inputFormat

inputFormat?: string

Valid formats are: XML, HTML, TEXT, WORD_XML

`Optional`requestDescription

requestDescription?: {
documentReference?: string;
}

Type declaration

OptionaldocumentReference?: string
Usually the path and file name. In a CMS it could be the id, which can be used to lookup the document.

`Optional`selection

selection?: DocumentSelection

Experimental