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

    Class BarcodeDocumentParserResult

    The result of barcode document parsing.

    Index

    Constructors

    constructor

    Properties

    parsedDocument success

    Methods

    encodeImages release serialize

    Constructors

    Properties

    parsedDocument: GenericDocument | null

    In case of success, the parsed document.

    success: boolean

    True if any document was parsed.

    Methods

    • Returns Promise<void>

    • Returns void

    • Parameters

      Returns Promise<
          {
              encodeImages?: () => Promise<void>;
              parsedDocument?:
                  | {
                      children?: {
                          children?: { readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImages?: (() ...;
                          confidence?: number;
                          confidenceWeight?: number;
                          crop?: | {
                              buffer?: ...;
                              clear?: ...;
                              encodeImage?: ...;
                              encodeInPlace?: ...;
                              hibernate?: ...;
                              info?: ...;
                              isRetained?: ...;
                              release?: ...;
                              retain?: ...;
                              saveImage?: ...;
                              serialize?: ...;
                              uniqueId?: ...;
                          } & {}
                          | null;
                          encodeImages?: () => Promise<(...)>;
                          fields?: {
                              confidenceWeight?: ...;
                              encodeImages?: ...;
                              image?: ...;
                              parsedData?: ...;
                              polygonInRoot?: ...;
                              release?: ...;
                              serialize?: ...;
                              type?: ...;
                              validationStatus?: ...;
                              value?: ...;
                          }[];
                          quad?: Point[];
                          quadInRoot?: Point[];
                          release?: () => void;
                          serialize?: (config?: (...) | (...)) => Promise<(...)>;
                          type?: {
                              fullName?: (...) | (...);
                              listIndex?: (...) | (...) | (...);
                              name?: (...) | (...);
                              normalizedName?: (...) | (...);
                              serialize?: (...) | (...);
                          };
                      }[];
                      confidence?: number;
                      confidenceWeight?: number;
                      crop?: | {
                          buffer?: string;
                          clear?: () => Promise<(...)>;
                          encodeImage?: (options?: (...) | (...)) => Promise<(...)>;
                          encodeInPlace?: () => Promise<(...)>;
                          hibernate?: () => Promise<(...)>;
                          info?: () => Promise<(...)>;
                          isRetained?: () => boolean;
                          release?: () => void;
                          retain?: () => void;
                          saveImage?: (path: string, options?: (...) | (...)) => Promise<(...)>;
                          serialize?: (
                              imageSerializationMode: ImageSerializationMode,
                          ) => Promise<(...)>;
                          uniqueId?: string;
                      } & {}
                      | null;
                      encodeImages?: () => Promise<void>;
                      fields?: {
                          confidenceWeight?: number;
                          encodeImages?: () => Promise<(...)>;
                          image?:
                              | {
                                  buffer?: ...;
                                  clear?: ...;
                                  encodeImage?: ...;
                                  encodeInPlace?: ...;
                                  hibernate?: ...;
                                  info?: ...;
                                  isRetained?: ...;
                                  release?: ...;
                                  retain?: ...;
                                  saveImage?: ...;
                                  serialize?: ...;
                                  uniqueId?: ...;
                              } & {}
                              | null;
                          parsedData?: { serialize?: ...; type?: ...; value?: ... }[];
                          polygonInRoot?: Point[];
                          release?: () => void;
                          serialize?: (config?: (...) | (...)) => Promise<(...)>;
                          type?: {
                              commonType?: (...) | (...) | (...);
                              fullName?: (...) | (...);
                              listIndex?: (...) | (...) | (...);
                              name?: (...) | (...);
                              normalizedName?: (...) | (...);
                              serialize?: (...) | (...);
                          };
                          validationStatus?: FieldValidationStatus;
                          value?: { confidence?: ...; serialize?: ...; text?: ... } & {}
                          | null;
                      }[];
                      quad?: Point[];
                      quadInRoot?: Point[];
                      release?: () => void;
                      serialize?: (
                          config?: ToJsonConfiguration,
                      ) => Promise<
                          {
                              children?: (...)[];
                              confidence?: number;
                              confidenceWeight?: number;
                              crop?: (...) & (...) | null;
                              encodeImages?: () => ...;
                              fields?: (...)[];
                              quad?: (...)[];
                              quadInRoot?: (...)[];
                              release?: () => ...;
                              serialize?: ((config?: ToJsonConfiguration | undefined) => Promise<{ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ......;
                              type?: {
                                  fullName?: ...;
                                  listIndex?: ...;
                                  name?: ...;
                                  normalizedName?: ...;
                                  serialize?: ...;
                              };
                          },
                      >;
                      type?: {
                          fullName?: string;
                          listIndex?: number
                          | null;
                          name?: string;
                          normalizedName?: string;
                          serialize?: (
                              config?: ToJsonConfiguration,
                          ) => { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                      };
                  } & {}
                  | null;
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => Promise<{ readonly success?: boolean | undefined; readonly parsedDocument?: ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfigurati...;
              success?: boolean;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods