ChromeDocumentScan class

Properties

hashCode → int
The hash code for this object.
no setterinherited
isAvailable → bool
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancelScan(String job) → Future<CancelScanResponse>
Cancels a started scan and returns a Promise that resolves with a CancelScanResponse object. If a callback is used, the object is passed to it instead. |job| : The handle of an active scan job previously returned from a call to startScan. |Returns| : Returns a Promise which resolves with the result.
closeScanner(String scannerHandle) → Future<CloseScannerResponse>
Closes the scanner with the passed in handle and returns a Promise that resolves with a CloseScannerResponse object. If a callback is used, the object is passed to it instead. Even if the response is not a success, the supplied handle becomes invalid and should not be used for further operations. |scannerHandle| : Specifies the handle of an open scanner that was previously returned from a call to openScanner. |Returns| : Returns a Promise which resolves with the result.
getOptionGroups(String scannerHandle) → Future<GetOptionGroupsResponse>
Gets the group names and member options from a scanner previously opened by openScanner. This method returns a Promise that resolves with a GetOptionGroupsResponse object. If a callback is passed to this function, returned data is passed to it instead. |scannerHandle| : The handle of an open scanner returned from a call to openScanner. |Returns| : Returns a Promise which resolves with the result.
getScannerList(DeviceFilter filter) → Future<GetScannerListResponse>
Gets the list of available scanners and returns a Promise that resolves with a GetScannerListResponse object. If a callback is passed to this function, returned data is passed to it instead. |filter| : A DeviceFilter indicating which types of scanners should be returned. |Returns| : Returns a Promise which resolves with the result and list of scanners.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
openScanner(String scannerId) → Future<OpenScannerResponse>
Opens a scanner for exclusive access and returns a Promise that resolves with an OpenScannerResponse object. If a callback is passed to this function, returned data is passed to it instead. |scannerId| : The ID of a scanner to be opened. This value is one returned from a previous call to getScannerList. |Returns| : Returns a Promise which resolves with the result.
readScanData(String job) → Future<ReadScanDataResponse>
Reads the next chunk of available image data from an active job handle, and returns a Promise that resolves with a ReadScanDataResponse object. If a callback is used, the object is passed to it instead.
scan(ScanOptions options) → Future<ScanResults>
Performs a document scan and returns a Promise that resolves with a ScanResults object. If a callback is passed to this function, the returned data is passed to it instead. |options| : An object containing scan parameters. |Returns| : Returns a Promise which resolves with the scan results.
setOptions(String scannerHandle, List<OptionSetting> options) → Future<SetOptionsResponse>
Sets options on the specified scanner and returns a Promise that resolves with a SetOptionsResponse object containing the result of trying to set every value in the order of the passed-in OptionSetting object. If a callback is used, the object is passed to it instead. |scannerHandle| : The handle of the scanner to set options on. This should be a value previously returned from a call to openScanner. |options| : A list of OptionSetting objects to be applied to the scanner. |Returns| : Returns a Promise which resolves with the result.
startScan(String scannerHandle, StartScanOptions options) → Future<StartScanResponse>
Starts a scan on the specified scanner and returns a Promise that resolves with a StartScanResponse. If a callback is used, the object is passed to it instead. If the call was successful, the response includes a job handle that can be used in subsequent calls to read scan data or cancel a scan. |scannerHandle| : The handle of an open scanner. This should be a value previously returned from a call to openScanner. |options| : A StartScanOptions object indicating the options to be used for the scan. The StartScanOptions.format property must match one of the entries returned in the scanner's ScannerInfo. |Returns| : Returns a Promise which resolves with the result.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited