Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientScanJob

Specifies information about the scan job to be processed at the client side.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_dither

_dither: Dither = Dither.Threshold

_enableDuplex

_enableDuplex: boolean = false

_enableFeeder

_enableFeeder: boolean = false

_feederCount

_feederCount: number = 1

_imageFormat

_imageFormat: ScannerImageFormatOutput = ScannerImageFormatOutput.JPG

_jpgCompressionQuality

_jpgCompressionQuality: number = 100

_pdfTitle

_pdfTitle: string = ""

_pixelMode

_pixelMode: PixelMode = PixelMode.Color

_resolution

_resolution: number = 200

_scannerName

_scannerName: string = ""

_threshold

_threshold: number = 128

_type

_type: string = 'scan_job'

Accessors

dither

  • Gets or sets the dither algorithm for black & white output image. Default is Dither.Threshold.

    Returns Dither

  • Gets or sets the dither algorithm for black & white output image. Default is Dither.Threshold.

    Parameters

    Returns void

enableDuplex

  • get enableDuplex(): boolean
  • set enableDuplex(val: boolean): void

  • Gets or sets whether to enable duplex scanning. Default is false.

    Returns boolean

  • Gets or sets whether to enable duplex scanning. Default is false.

    Parameters

    • val: boolean

    Returns void

enableFeeder

  • get enableFeeder(): boolean
  • set enableFeeder(val: boolean): void

  • Gets or sets whether to enable Auto Document Feeder (ADF). Default is false.

    Returns boolean

  • Gets or sets whether to enable Auto Document Feeder (ADF). Default is false.

    Parameters

    • val: boolean

    Returns void

feederCount

  • get feederCount(): number
  • set feederCount(val: number): void

  • Gets or sets the number of docs to be scanned. Default is 1.

    Returns number

  • Gets or sets the number of docs to be scanned. Default is 1.

    Parameters

    • val: number

    Returns void

imageFormat

  • Gets or sets the scan output image format. Default is ScannerImageFormatOutput.JPG.

    Returns ScannerImageFormatOutput

  • Gets or sets the scan output image format. Default is ScannerImageFormatOutput.JPG.

    Parameters

    Returns void

jpgCompressionQuality

  • get jpgCompressionQuality(): number
  • set jpgCompressionQuality(val: number): void

  • Gets or sets the compression quality for JPG output image. Allowed range is 1 (Very bad quality, smallest size) to 100 (Best quality, biggest size). Default is 100.

    Returns number

  • Gets or sets the compression quality for JPG output image. Allowed range is 1 (Very bad quality, smallest size) to 100 (Best quality, biggest size). Default is 100.

    Parameters

    • val: number

    Returns void

pdfTitle

  • get pdfTitle(): string
  • set pdfTitle(val: string): void

  • Gets or sets the PDF title of the output image. Default is an empty string.

    Returns string

  • Gets or sets the PDF title of the output image. Default is an empty string.

    Parameters

    • val: string

    Returns void

pixelMode

  • Gets or sets the scan pixel mode. Default is PixelMode.Color.

    Returns PixelMode

  • Gets or sets the scan pixel mode. Default is PixelMode.Color.

    Parameters

    Returns void

resolution

  • get resolution(): number
  • set resolution(val: number): void

  • Gets or sets the DPI or quality resolution of the output scan. Default is 200 dpi.

    Returns number

  • Gets or sets the DPI or quality resolution of the output scan. Default is 200 dpi.

    Parameters

    • val: number

    Returns void

scannerName

  • get scannerName(): string
  • set scannerName(val: string): void

  • Gets or sets the Scanner device name. Default is an empty string.

    Returns string

  • Gets or sets the Scanner device name. Default is an empty string.

    Parameters

    • val: string

    Returns void

threshold

  • get threshold(): number
  • set threshold(val: number): void

  • Gets or sets the threshold value for black & white output image. Allowed range is 0 to 255. Default is 128.

    Returns number

  • Gets or sets the threshold value for black & white output image. Allowed range is 0 to 255. Default is 128.

    Parameters

    • val: number

    Returns void

Methods

onError

  • onError(data: any, is_critical: any): void

  • Occurs when an error is thrown for the current scan job.

    Parameters

    • data: any

      The data object related to this event.

    • is_critical: any

      Whether the error is critial or not.

    Returns void

onFinished

  • onFinished(data: any): void

  • Occurs when the current scan job has finished.

    Parameters

    • data: any

      The data object related to this event.

    Returns void

onUpdate

  • onUpdate(data: any, last: any): void

  • Parameters

    • data: any
    • last: any

    Returns void

sendToClient

  • sendToClient(): Promise<unknown>