Interface CheckResult

After a check, the sidebar will tell the plug-in which parts of the document had been checked.

interface CheckResult {
    checkedPart: CheckedDocumentPart;
    embedCheckInformation?: CheckInformationKeyValuePair[];
    inputFormat?: string;
}

Properties

checkedPart embedCheckInformation? inputFormat?

Properties

checkedPart

checkedPart: CheckedDocumentPart

The part of the document which was checked by the server. If the server recognizes that parts of the document are missing, only valid parts will be checked.

OptionalembedCheckInformation

embedCheckInformation?: CheckInformationKeyValuePair[]

The integration can embed this information into the document or into a separate storage.

OptionalinputFormat

inputFormat?: string

Input Format of the document

Settings

Member Visibility

On This Page

Properties