DocumentRules class

Represents the custom document rules.

This setting allows users to narrow down our internal rules on mandatory fields. All undefined fields will become optional. It is not possible to mark fields as mandatory if they cannot theoretically appear on the document. The more detailed document filter will have priority over the other.

Document fields are validated using internal rules that define mandatory fields for the scanned document class.

Annotations
  • @JsonSerializable()

Constructors

DocumentRules.new(List<DetailedFieldType> fields, [DocumentFilter? documentFilter])
Represents the custom document rules.
DocumentRules.fromJson(Map<String, dynamic> json)
factory

Properties

documentFilter DocumentFilter?
Specified fields will overrule our document class field rules if filter conditions are met.
getter/setter pair
fields List<DetailedFieldType>
Fields to overrule our class field rules.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
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