ClassFilter class

ClassFilter represents the document filter used to determine which documents will be processed. Document information (Country, Region, Type) is evaluated with the content set in the filter, and their inclusion or exclusion depends on the defined rules. To set the document information, use DocumentFilter. The recognition results of the excluded documents will not be returned. If using the standard BlinkID UX, an alert will be displayed that the document will not be scanned.

By default, the ClassFilter is turned off, and all documents will be included.

Annotations
  • @JsonSerializable.new()

Constructors

ClassFilter()
ClassFilter represents the document filter used to determine which documents will be processed. Document information (Country, Region, Type) is evaluated with the content set in the filter, and their inclusion or exclusion depends on the defined rules. To set the document information, use DocumentFilter. The recognition results of the excluded documents will not be returned. If using the standard BlinkID UX, an alert will be displayed that the document will not be scanned.
ClassFilter.fromJson(Map<String, dynamic> json)
factory
ClassFilter.withExcludedDocumentClasses(List<DocumentFilter>? excludeDocuments)
Constructor for only adding the document clasess that will be excluded for the scanning process.
ClassFilter.withIncludedDocumentClasses(List<DocumentFilter>? includeDocuments)
Constructor for only adding the document clasess that will be included for the scanning process.

Properties

excludeDocuments ↔ List<DocumentFilter>?
Document classes that will be explicitly rejected by this filter. Documents belonging to the specified classes will not be processed. Other documents, not included with excludeDocuments will be accepted.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
includeDocuments ↔ List<DocumentFilter>?
Document classes that will be explicitly accepted by this filter. Only documents belonging to the specified classes will be processed. All other documents will be rejected.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited