Interface DocumentContentInterface

A Document content.

The document content is retrieved from an id-card request, please refer to IdCardGetterInterface and InstanceMetadataInterface.

Data Retrievers

See

interface DocumentContentInterface {
    getDocumentContent(): tDocContent;
    getDocumentId(): string;
    getDocumentSecurityTags(): string[];
    getDocumentType(): MetadataDocumentType;
    getNonIndexedContent(): string[];
}

Index

Methods

getDocumentContent getDocumentId getDocumentSecurityTags getDocumentType getNonIndexedContent

Methods

getDocumentContent

getDocumentContent(): tDocContent
Gets the actual content of the document.

Returns tDocContent
The actual content of the document.

See
tDocContent

getDocumentId

getDocumentId(): string
Gets the id of the document.

Returns string
The id of the document.

getDocumentSecurityTags

getDocumentSecurityTags(): string[]
Gets the security tags of the document.

Please refer to DataSessionInterface for an explanation of the tag system.

Returns string[]
The security tags of the document.

getDocumentType

getDocumentType(): MetadataDocumentType
Gets the type of the document.

Returns MetadataDocumentType
The type of the document.

getNonIndexedContent

getNonIndexedContent(): string[]
Gets the non-indexed content of the document.

Tells the fields of the instance metadata document that are either:
- missing from the AttributesDictionaryInterface.
- null
- not of the expected type.
The name of the attribute is the path (concatenated with .) and optionally a number (if the type is an array), or gt, gte, lt, lte for range values.

Such metadata cannot be used in filters.
Returns string[]
The name of metadata than cannot be used in filters.