Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Microblink

Implements

Index

Constructors

constructor

Properties

Private API

Private authorizationHeader

authorizationHeader: string = ""

Private listeners

listeners: ScanListener[] = []

Private recognizers

recognizers: string | string[] = []

Private scanFrameQueue

scanFrameQueue: ScanInputFrameWithQuality[] = []

Static Private fromHowManyFramesQualityCalculateBestFrame

fromHowManyFramesQualityCalculateBestFrame: number = 5

Methods

CreateScanExchanger

  • CreateScanExchanger(data: ScanExchanger, onChange: function): Promise<any>
  • Create object for exchange data for scan between devices

    Parameters

    Returns Promise<any>

GetAuthorization

  • GetAuthorization(): string

GetRecognizers

  • GetRecognizers(): string | string[]

IsDesktopToMobileAvailable

  • IsDesktopToMobileAvailable(): Promise<boolean>

RegisterListener

ScanFile

  • Scan file and get result from subscribed observable

    Parameters

    • scanInputFile: ScanInputFile
    • Optional uploadProgress: EventListener | undefined

    Returns Observable<ScanOutput>

SendFile

  • SendFile(scanInputFile: ScanInputFile, uploadProgress?: EventListener): void

SendFrame

SetAuthorization

  • SetAuthorization(authorizationHeader: string): void

SetEndpoint

  • SetEndpoint(endpoint: string): void

SetExportImages

  • SetExportImages(isExportImagesEnabled: boolean): void
  • Change export images flag for next request

    Parameters

    • isExportImagesEnabled: boolean

      is flag which describes does API should return extracted images in next response

    Returns void

SetIsDataPersistingEnabled

  • SetIsDataPersistingEnabled(isEnabled: boolean): void
  • When Authorization is not set it is available to disable persiting of uploaded data, by default it is enabled this should be disabled for every page where GDPR is not implemented and this is ability to disable data persisting on some demo pages

    Parameters

    • isEnabled: boolean

      is flag which describes should or should not API persist uploaded data, be default it is enabled

    Returns void

SetRecognizers

  • SetRecognizers(recognizers: string | string[]): void

SetUserId

  • SetUserId(userId: string): void
  • Set user identificator which will be stored with uploaded image

    Parameters

    • userId: string

      is any string which unique identifies user who use SDK and upload any image to API

    Returns void

TerminateActiveRequests

  • TerminateActiveRequests(): void

Private isDesktopToMobileAvailable

  • isDesktopToMobileAvailable(): Promise<boolean>

Private notifyOnErrorListeners

  • notifyOnErrorListeners(err: any): void
  • Notify all global listeners when error happens, HTTP response status code is not equal to 200 or base64 encode failed

    Parameters

    • err: any

    Returns void

Private notifyOnSuccessListeners

  • notifyOnSuccessListeners(scanOutput: ScanOutput, isFileScan: boolean): void
  • Notify all global listeners when success scan is complete

    Parameters

    Returns void

Private scan

  • scan(blob: Blob, isFileScan: boolean, uploadProgress?: EventListener): Observable<ScanOutput>
  • Execute scan on Microblink API service

    Parameters

    • blob: Blob
    • isFileScan: boolean
    • Optional uploadProgress: EventListener

    Returns Observable<ScanOutput>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc