ChromeDocumentScan class

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isAvailable → bool

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancelScan(String job) → Future<CancelScanResponse>

Cancels a scan that was previously started using startScan. The response is sent to the callback. |job| : An active scan job previously returned from startScan. |callback| : Called with the result.

closeScanner(String scannerHandle) → Future<CloseScannerResponse>

Closes a previously opened scanner handle. A response indicating the outcome will be sent to the callback. Even if the response is not a success, the supplied handle will become invalid and should not be used for further operations. |scannerHandle| : Open scanner handle previously returned from openScanner. |callback| : Called with the result.

getOptionGroups(String scannerHandle) → Future<GetOptionGroupsResponse>

Gets the group names and member options from a scanner handle previously opened by openScanner. |scannerHandle| : Open scanner handle previously returned from openScanner. |callback| : Called with the result.

getScannerList(DeviceFilter filter) → Future<GetScannerListResponse>

Gets the list of available scanners. On success, the list will be sent to the callback. |filter| : DeviceFilter indicating which types of scanners should be returned. |callback| : Called 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. On success, the response containing a scanner handle and configuration will be sent to the callback. |scannerId| : Scanner id previously returned from getScannerList indicating which scanner should be opened. |callback| : Called with the result.

readScanData(String job) → Future<ReadScanDataResponse>

Reads the next chunk of available image data from an active job handle. A response indicating the outcome will be sent to the callback.

scan(ScanOptions options) → Future<ScanResults>

Performs a document scan. On success, the PNG data will be sent to the callback. |options| : Object containing scan parameters. |callback| : Called with the result and data from the scan.

setOptions(String scannerHandle, List<OptionSetting> options) → Future<SetOptionsResponse>

Sends the list of new option values in options as a bundle to be set on scannerHandle. Each option will be set by the backend the order specified. Returns a backend response indicating the result of each option setting and a new set of final option values after all options have been updated. |scannerHandle| : Open scanner handle previously returned from openScanner. |options| : A list of OptionSettings that will be applied to scannerHandle. |callback| : Called with the result.

startScan(String scannerHandle, StartScanOptions options) → Future<StartScanResponse>

Starts a scan using a previously opened scanner handle. A response indicating the outcome will be sent to the callback. If successful, the response will include a job handle that can be used in subsequent calls to read scan data or cancel a scan. |scannerHandle| : Open scanner handle previously returned from openScanner. |options| : StartScanOptions indicating what options are to be used for the scan. StartScanOptions.format must match one of the entries returned in the scanner's ScannerInfo. |callback| : Called with the result.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited