capacitor-plugin-scanbot-sdk
    Preparing search index...

    Class CompositeFieldValueSemantics

    Report of a logical field value semantics verification. If some logical field, e.g. expiry date is present in multiple places in the document, it can occur that some entries are semantically correct and some are semantically incorrect. This report shows the overall status of the logical field value semantics verification and details for each field that was verified.

    Index

    Constructors

    Properties

    fieldDetails: FieldValueSemantics[]

    List of value semantics for each field corresponding to the same logical field.

    overallFieldValueSemantics: ValueSemantics

    Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.

    Methods

    • Parameters

      Returns {
          fieldDetails?: {
              fieldFullName?: string;
              invalidSemantics?: boolean;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[];
          overallFieldValueSemantics?: ValueSemantics;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...;
      }

      • Optional ReadonlyfieldDetails?: {
            fieldFullName?: string;
            invalidSemantics?: boolean;
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        }[]

        List of value semantics for each field corresponding to the same logical field.

      • Optional ReadonlyoverallFieldValueSemantics?: ValueSemantics

        Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.

      • Optionalserialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly overallFieldValueSemantics?: ValueSemantics | undefined; readonly fieldDetails?: { readonly fieldFullName?: string | undefined; readonly invalidSemantics?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined; serialize?: ((config?: ToJsonConfig...