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

    Class CreditCardScannerUiResult

    Configuration of the credit card scanner RTU UI result.

    Index

    Constructors

    constructor

    Properties

    creditCard recognitionStatus

    Methods

    encodeImages release serialize

    Constructors

    Properties

    creditCard: GenericDocument | null

    Generic document containing credit card data. Not present, if status is FAIL.

    recognitionStatus: CreditCardScanningStatus

    The status of the credit card recognition step.

    Methods

    • Returns Promise<void>

    • Returns void

    • Parameters

      Returns Promise<
          {
              creditCard?: | {
                  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;
              encodeImages?: () => Promise<void>;
              recognitionStatus?: CreditCardScanningStatus;
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => Promise<{ readonly recognitionStatus?: CreditCardScanningStatus | undefined; readonly creditCard?: ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((con...;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods