ID Capture Settings

Defined under the namespace Scandit.Datacapture.Id

IdCaptureSettings

class IdCaptureSettings

Added in version 6.6.0

Settings to configure an IdCapture instance.

constructor()

constructor()

Added in version 6.6.0

Creates a new default settings.

getShouldPassImageTypeToResult(type)

getShouldPassImageTypeToResult(type: IdImageType): boolean

Added in version 6.6.0

Gets whether an IdCapture created with these settings should extract an image (specified by the given type) from recognized documents and return it as part of CapturedId. Note that the image may still not be returned, for example, if it’s not present in a document or if it’s not recognized. Default is false.

setShouldPassImageTypeToResult(type, shouldPass)

setShouldPassImageTypeToResult(type: IdImageType,
        shouldPass: boolean): void

Added in version 6.6.0

Sets whether an IdCapture created with these settings should extract an image (specified by the given type) from recognized documents and return it as part of CapturedId. Note that the image may still not be returned, for example, if it’s not present in a document or if it’s not recognized. Default is false.

supportedDocuments

supportedDocuments: IdDocumentType[]

Added in version 6.6.0

The types of personal identification documents that IdCapture configured with these settings is able to scan.

setProperty(name, value)

setProperty(name: string,
        value: any): void

Added in version 6.6.0

Sets a property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may change in a future release.

getProperty(name)

getProperty(name: string): any

Added in version 6.6.0

Retrieves the value of a previously set property. In case the property does not exist, null is returned. Use this method to get properties that are not yet part of a stable API. These properties may change in a future release.

supportedSides

supportedSides: SupportedSides

Added in version 6.6.0

The sides of personal identification documents that IdCapture configured with these settings is able to scan. This setting is relevant only for supportedDocuments of type IdDocumentType.DLVIZ and IdDocumentType.IdCardVIZ, otherwise it is ignored. The default is SupportedSides.FrontOnly.