TaskDocument - ABBYY Documentation

What it does

The TaskDocument data type stores information about a document contained in a task.

Fields

Name	Type	Description
`BatchId`	`int`	The ID of the batch that contains the document.
`Comment`	`string`	Comment on the document.
`DocumentId`	`int`	The ID of the document.
`ExternalId`	`string`	The external ID of the document.
`Flags`	`int`	A set of flags that describe the status of the document. The value combines the flags listed after this table.
`HasAssemblingErrors`	`bool`	Document assembly errors. `True` if there are assembly errors in the document, `False` if there are none.
`HasErrors`	`bool`	Document errors. `True` if there are errors in the document, `False` if there are none.
`HasWarnings`	`bool`	Document warnings. `True` if there are warnings in the document, `False` if there are none.
`Pages`	TaskPage[]	The set of pages in the document.
`PagesCount`	`int`	The number of pages in the document.
`Priority`	`int`	The priority of the document. For possible values, see Priority.
`ProcessingStageType`	`int`	The processing stage of the document. For possible values, see ProcessingStageType.
`TemplateName`	`int`	The name of the matched Document Definition.
`TotalSymbols`	`int`	The total number of characters in the document.
`UncertainSymbols`	`int`	The number of unreliably recognized characters in the document.
`VerificationSymbols`	`int`	The number of characters to verify in the document.

Flags field values

The Flags value is a combination of the following flags. Only the flags useful when working with tasks and the Web Services API methods are listed.

Flag	Value	Meaning
`BIF_IsAnalyzed`	`0x100`	The document has been analyzed.
`BIF_IsRecognized`	`0x200`	The document has been recognized.
`BIF_IsVerified`	`0x400`	The document has been verified.
`BIF_IsExported`	`0x800`	The document has been exported.
`BIF_HasRuleErrors`	`0x10000`	The document contains validation rule errors.
`BIF_HasRuleWarnings`	`0x20000`	The document contains validation rule warnings.

⌘I