RequestOutputItem Class
Click or drag to resize
RequestOutputItem Class

» Asprise Scan Home · Developer's Guide

Specifies an output target in a scan request.
Inheritance Hierarchy
SystemObject
  asprise_imaging_apiRequestOutputItem

Namespace: asprise_imaging_api
Assembly: asprise-imaging-scan.net-api (in asprise-imaging-scan.net-api.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class RequestOutputItem : ICloneable

The RequestOutputItem type exposes the following members.

Constructors
  NameDescription
Public methodRequestOutputItem
Initializes a new instance of the RequestOutputItem class
Public methodRequestOutputItem(String, String)
Constructor.
Top
Methods
  NameDescription
Public methodAddExifTag
Exif tags, key should be any of AspriseImaging#EXIF_NAME_DocumentName
Public methodClone
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodStatic memberFromJsonMap
Deserialize from JSON.
Public methodGetExifTags
Exif tags, key should be any of AspriseImaging#EXIF_NAME_DocumentName
Public methodGetFormat
Image format, any of AspriseImaging#FORMAT_JPG
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetJpegQuality
Only for JPG format; default value: 80
Public methodGetOutputType
Output type, any of AspriseImaging#OUTPUT_SAVE ...
Public methodGetPdfOwnerPassword
PDF owner password
Public methodGetPdfTextLine
Optionally prints a line of text at the bottom of the first page.
Public methodGetPdfUserPassword
PDF user password
Public methodGetSavePath
Target output file path, may contain variable for expansion, e.g., C:\\tmp\\${TMS}${EXT}.
Public methodGetThumbnailHeight
Only for thumbnail output types; default value: 200.
Public methodGetTiffCompression
Any of AspriseImaging#TIFF_COMPRESSION_CCITT_G4 ... Only for TIF format; default value: (null)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUploadSetting
must be set when type is AspriseImaging#OUTPUT_UPLOAD or AspriseImaging#OUTPUT_UPLOAD_THUMB.
Public methodIsPdfaCompliant
Set to true to output PDF/A compliant PDF.
Public methodIsPdfForceBlackWhite
Force to output black/white PDF to save space.
Public methodIsTiffForceSinglePage
Force to save images into individual single-image tiff files.
Public methodIsUploadAfterAllDone
Perform upload after all scans. Default is true.
Public methodIsUploadOneByOne
Set to true to upload one image per HTTP request; otherwise upload all images in one HTTP request. Default: false.
Public methodSetFormat
Image format, any of AspriseImaging#FORMAT_JPG*/
Public methodSetJpegQuality
Only for JPG format; default value: 80
Public methodSetPdfaCompliant
Set to true to output PDF/A compliant PDF.
Public methodSetPdfForceBlackWhite
Force to output black/white PDF to save space.
Public methodSetPdfOwnerPassword
PDF owner password
Public methodSetPdfTextLine
Optionally prints a line of text at the bottom of the first page.
Public methodSetPdfUserPassword
PDF user password
Public methodSetSavePath
Target output file path, may contain variable for expansion, e.g., C:\\tmp\\${TMS}${EXT}.
Public methodSetThumbnailHeight
Only for thumbnail output types; default value: 200.
Public methodSetTiffCompression
Any of AspriseImaging#TIFF_COMPRESSION_CCITT_G4 ... Only for TIF format; default value: (null)
Public methodsetTiffForceSinglePage
Force to save images into individual single-image tiff files.
Public methodSetType
Output type, any of AspriseImaging#OUTPUT_SAVE ...
Public methodSetUploadAfterAllDone
Perform upload after all scans. Default is true.
Public methodSetUploadOneByOne
Set to true to upload one image per HTTP request; otherwise upload all images in one HTTP request. Default: false.
Public methodSetUploadSetting
must be set when type is AspriseImaging#OUTPUT_UPLOAD AspriseImaging#OUTPUT_UPLOAD_THUMB.
Public methodToJsonObject
Serialize to JSON.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberDEFAULT_JPEG_QUALITY
Default JPEG quality.
Public fieldStatic memberDEFAULT_THUMBNAIL_HEIGHT
Default thumbnail height
Top
See Also