MicroblinkApi | microblink

HTTP layer with Microblink API

Hierarchy

MicroblinkApi

Implements

IMicroblinkApi

Index

Constructors

constructor

Properties

Accessors

isAuthorizationHeaderValid

Methods

Constructors

constructor

new MicroblinkApi(): MicroblinkApi

- Defined in microblinkApi.service.ts:17
Returns MicroblinkApi

Properties

Private activeRequests

activeRequests: XMLHttpRequest[] = []

Private authorizationHeader

authorizationHeader: string = ""

Private endpoint

endpoint: string

Private isDataPersistingEnabled

isDataPersistingEnabled: boolean = true

Private isExportImagesEnabled

isExportImagesEnabled: boolean = false

Private userId

userId: string = ""

Accessors

Private isAuthorizationHeaderValid

isAuthorizationHeaderValid:

Authorization header offline validator, just check for Authorization header format before sending it to the API

Methods

Recognize

Recognize(recognizers: string | string[], imageBase64: string, uploadProgress?: EventListener): Observable<any>

Implementation of IMicroblinkApi.Recognize
- Defined in microblinkApi.service.ts:81
Execute remote recognition

Parameters
- recognizers: string | string[]
  
  is string or array of strings on which image will be processed
- imageBase64: string
  
  is Base64 encoded image which should contain document for processing
- Optional uploadProgress: EventListener
  
  (optional) is XHR event listener for image upload to show upload progress bar on UI
Returns Observable<any>

SetAuthorization

SetAuthorization(authorizationHeader: string): void

Implementation of IMicroblinkApi.SetAuthorization
- Defined in microblinkApi.service.ts:37
Change authorization header value

Parameters
- authorizationHeader: string
Returns void

SetEndpoint

SetEndpoint(endpoint: string): void

Implementation of IMicroblinkApi.SetEndpoint
- Defined in microblinkApi.service.ts:53
Change API endpoint

Parameters
- endpoint: string
  
  is API endpoint where Microblink API or Microblink API proxy is available
Returns void

SetExportImages

SetExportImages(isExportImagesEnabled: boolean): void

Implementation of IMicroblinkApi.SetExportImages
- Defined in microblinkApi.service.ts:45
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

Implementation of IMicroblinkApi.SetIsDataPersistingEnabled
- Defined in microblinkApi.service.ts:71
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

SetUserId

SetUserId(userId: string): void

Implementation of IMicroblinkApi.SetUserId
- Defined in microblinkApi.service.ts:61
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

TerminateAll

TerminateAll(): void

Implementation of IMicroblinkApi.TerminateAll
- Defined in microblinkApi.service.ts:26
Terminate request session with aborting all pending responses

Returns void

Generated using TypeDoc