ID Capture Settings

Defined in package com.scandit.datacapture.id.capture

IdCaptureSettings

class IdCaptureSettings

Added in version 6.2.0

Settings to configure an IdCapture instance.

IdCaptureSettings()

IdCaptureSettings()

Added in version 6.2.0

Creates a new default settings.

getShouldPassImageTypeToResult(type)

boolean getShouldPassImageTypeToResult(IdImageType type)

Added in version 6.2.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, value)

void setShouldPassImageTypeToResult(IdImageType type,
        boolean value)

Added in version 6.2.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.

setSupportedDocuments(documents)

void setSupportedDocuments(Iterable<IdDocumentType> documents)

Added in version 6.5.0

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

supportedDocuments

@NonNull EnumSet<IdDocumentType> getSupportedDocuments()

Added in version 6.5.0

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

setProperty(key, value)

void setProperty(@NonNull String key,
        @NonNull Object value)

Added in version 6.2.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(key)

@NonNull Object getProperty(@NonNull String key)

Added in version 6.2.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 getSupportedSides()
void setSupportedSides(SupportedSides value)

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.DL_VIZ and IdDocumentType.ID_CARD_VIZ, otherwise it is ignored. The default is SupportedSides.FRONT_ONLY.

anonymizationMode

IdAnonymizationMode getAnonymizationMode()
void setAnonymizationMode(IdAnonymizationMode value)

Added in version 6.17.0

This setting allows to remove protected data from images and result fields of certain document types. Enabling anonymization helps to remain compliant with local legal requirements which restrict the collection of some data. Examples of affected fields are the document number on German IDs or the personal ID number on Dutch driver’s licenses. By default set to IdAnonymizationMode.FIELDS_ONLY.

equals(other)

boolean equals(@Nullable Object other)

Added in version 6.6.0

Indicates whether some other object is equal to this one.

hashCode()

int hashCode()

Added in version 6.6.0

Returns a hash code value for the object.