chrome-types 0.1.273 → 0.1.274

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Wed Mar 13 2024 22:28:57 GMT+0000 (Coordinated Universal Time)
-// Built at 234817aae8fbd917079408c00e70cfc8d9416b6d
+// Generated on Tue Mar 19 2024 21:58:29 GMT+0000 (Coordinated Universal Time)
+// Built at a732d94bc71ad98bdfb0441c5cc2a4b7ef180ac0
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -10291,7 +10291,7 @@ declare namespace chrome {
   }
 
   /**
-   * Use the `chrome.documentScan` API to discover and retrieve images from attached paper document scanners.
+   * Use the `chrome.documentScan` API to discover and retrieve images from attached document scanners.
    *
    * @since Chrome 44
    * @chrome-permission documentScan
@@ -10308,7 +10308,7 @@ declare namespace chrome {
       mimeTypes?: string[];
 
       /**
-       * The number of scanned images allowed (defaults to 1).
+       * The number of scanned images allowed. The default is 1.
        */
       maxImages?: number;
     }
@@ -10316,21 +10316,485 @@ declare namespace chrome {
     export interface ScanResults {
 
       /**
-       * The data image URLs in a form that can be passed as the "src" value to an image tag.
+       * An array of data image URLs in a form that can be passed as the "src" value to an image tag.
        */
       dataUrls: string[];
 
       /**
-       * The MIME type of `dataUrls`.
+       * The MIME type of the `dataUrls`.
        */
       mimeType: string;
     }
 
     /**
-     * Performs a document scan. On success, the PNG data will be sent to the callback.
+     * An enum that indicates the result of each operation.
+     *
+     * @chrome-enum "UNKNOWN" An unknown or generic failure occurred.
+     * @chrome-enum "SUCCESS" The operation succeeded.
+     * @chrome-enum "UNSUPPORTED" The operation is not supported.
+     * @chrome-enum "CANCELLED" The operation was cancelled.
+     * @chrome-enum "DEVICE\_BUSY" The device is busy.
+     * @chrome-enum "INVALID" Either the data or an argument passed to the method is not valid.
+     * @chrome-enum "WRONG\_TYPE" The supplied value is the wrong data type for the underlying option.
+     * @chrome-enum "EOF" No more data is available.
+     * @chrome-enum "ADF\_JAMMED" The document feeder is jammed.
+     * @chrome-enum "ADF\_EMPTY" The document feeder is empty.
+     * @chrome-enum "COVER\_OPEN" The flatbed cover is open.
+     * @chrome-enum "IO\_ERROR" An error occurred while communicating with the device.
+     * @chrome-enum "ACCESS\_DENIED" The device requires authentication.
+     * @chrome-enum "NO\_MEMORY" Not enough memory is available on the Chromebook to complete the operation.
+     * @chrome-enum "UNREACHABLE" The device is not reachable.
+     * @chrome-enum "MISSING" The device is disconnected.
+     * @chrome-enum "INTERNAL\_ERROR" An error has occurred somewhere other than the calling application.
+     * @since Pending
+     */
+    export type OperationResult = "UNKNOWN" | "SUCCESS" | "UNSUPPORTED" | "CANCELLED" | "DEVICE_BUSY" | "INVALID" | "WRONG_TYPE" | "EOF" | "ADF_JAMMED" | "ADF_EMPTY" | "COVER_OPEN" | "IO_ERROR" | "ACCESS_DENIED" | "NO_MEMORY" | "UNREACHABLE" | "MISSING" | "INTERNAL_ERROR";
+
+    /**
+     * Indicates how the scanner is connected to the computer.
+     *
+     * @since Pending
+     */
+    export type ConnectionType = "UNSPECIFIED" | "USB" | "NETWORK";
+
+    /**
+     * @since Pending
+     */
+    export interface ScannerInfo {
+
+      /**
+       * The ID of a specific scanner.
+       */
+      scannerId: string;
+
+      /**
+       * A human-readable name for the scanner to display in the UI.
+       */
+      name: string;
+
+      /**
+       * The scanner manufacturer.
+       */
+      manufacturer: string;
+
+      /**
+       * The scanner model if it is available, or a generic description.
+       */
+      model: string;
+
+      /**
+       * For matching against other `ScannerInfo` entries that point to the same physical device.
+       */
+      deviceUuid: string;
+
+      /**
+       * Indicates how the scanner is connected to the computer.
+       */
+      connectionType: ConnectionType;
+
+      /**
+       * If true, the scanner connection's transport cannot be intercepted by a passive listener, such as TLS or USB.
+       */
+      secure: boolean;
+
+      /**
+       * An array of MIME types that can be requested for returned scans.
+       */
+      imageFormats: string[];
+
+      /**
+       * A human-readable description of the protocol or driver used to access the scanner, such as Mopria, WSD, or epsonds. This is primarily useful for allowing a user to choose between protocols if a device supports multiple protocols.
+       */
+      protocolType: string;
+    }
+
+    /**
+     * The data type of an option.
+     *
+     * @chrome-enum "UNKNOWN" The option's data type is unknown. The `value` property will be unset.
+     * @chrome-enum "BOOL" The `value` property will be one of `true`false.
+     * @chrome-enum "INT" A signed 32-bit integer. The `value` property will be long or long\[\], depending on whether the option takes more than one value.
+     * @chrome-enum "FIXED" A double in the range -32768-32767.9999 with a resolution of 1/65535. The `value` property will be double or double\[\] depending on whether the option takes more than one value. Double values that can't be exactly represented will be rounded to the available range and precision.
+     * @chrome-enum "STRING" A sequence of any bytes except NUL ('\\0'). The `value` property will be a DOMString.
+     * @chrome-enum "BUTTON" An option of this type has no value. Instead, setting an option of this type causes an option-specific side effect in the scanner driver. For example, a button-typed option could be used by a scanner driver to provide a means to select default values or to tell an automatic document feeder to advance to the next sheet of paper.
+     * @chrome-enum "GROUP" Grouping option. No value. This is included for compatibility, but will not normally be returned in `ScannerOption` values. Use `getOptionGroups()` to retrieve the list of groups with their member options.
+     * @since Pending
+     */
+    export type OptionType = "UNKNOWN" | "BOOL" | "INT" | "FIXED" | "STRING" | "BUTTON" | "GROUP";
+
+    /**
+     * Indicates the data type for {@link ScannerOption.unit}.
+     *
+     * @chrome-enum "UNITLESS" The value is a unitless number. For example, it can be a threshold.
+     * @chrome-enum "PIXEL" The value is a number of pixels, for example, scan dimensions.
+     * @chrome-enum "BIT" The value is the number of bits, for example, color depth.
+     * @chrome-enum "MM" The value is measured in millimeters, for example, scan dimensions.
+     * @chrome-enum "DPI" The value is measured in dots per inch, for example, resolution.
+     * @chrome-enum "PERCENT" The value is a percent, for example, brightness.
+     * @chrome-enum "MICROSECOND" The value is measured in microseconds, for example, exposure time.
+     * @since Pending
+     */
+    export type OptionUnit = "UNITLESS" | "PIXEL" | "BIT" | "MM" | "DPI" | "PERCENT" | "MICROSECOND";
+
+    /**
+     * The data type of constraint represented by an {@link OptionConstraint}.
+     *
+     * @chrome-enum "INT\_RANGE" The constraint on a range of `OptionType.INT` values. The `min`, `max`, and `quant` properties of `OptionConstraint` will be `long`, and its `list` propety will be unset.
+     * @chrome-enum "FIXED\_RANGE" The constraint on a range of `OptionType.FIXED` values. The `min`, `max`, and `quant` properties of `OptionConstraint` will be `double`, and its `list` property will be unset.
+     * @chrome-enum "INT\_LIST" The constraint on a specific list of `OptionType.INT` values. The `OptionConstraint.list` property will contain `long` values, and the other properties will be unset.
+     * @chrome-enum "FIXED\_LIST" The constraint on a specific list of `OptionType.FIXED` values. The `OptionConstraint.list` property will contain `double` values, and the other properties will be unset.
+     * @chrome-enum "STRING\_LIST" The constraint on a specific list of `OptionType.STRING` values. The `OptionConstraint.list` property will contain `DOMString` values, and the other properties will be unset.
+     * @since Pending
+     */
+    export type ConstraintType = "INT_RANGE" | "FIXED_RANGE" | "INT_LIST" | "FIXED_LIST" | "STRING_LIST";
+
+    /**
+     * @since Pending
+     */
+    export interface OptionConstraint {
+
+      type: ConstraintType;
+
+      min?: number | number;
+
+      max?: number | number;
+
+      quant?: number | number;
+
+      list?: number[] | number[] | string[];
+    }
+
+    /**
+     * How an option can be changed.
+     *
+     * @chrome-enum "NOT\_CONFIGURABLE" The option is read-only.
+     * @chrome-enum "SOFTWARE\_CONFIGURABLE" The option can be set in software.
+     * @chrome-enum "HARDWARE\_CONFIGURABLE" The option can be set by the user toggling or pushing a button on the scanner.
+     * @since Pending
+     */
+    export type Configurability = "NOT_CONFIGURABLE" | "SOFTWARE_CONFIGURABLE" | "HARDWARE_CONFIGURABLE";
+
+    /**
+     * @since Pending
+     */
+    export interface ScannerOption {
+
+      /**
+       * The option name using lowercase ASCII letters, numbers, and dashes. Diacritics are not allowed.
+       */
+      name: string;
+
+      /**
+       * A printable one-line title.
+       */
+      title: string;
+
+      /**
+       * A longer description of the option.
+       */
+      description: string;
+
+      /**
+       * The data type contained in the `value` property, which is needed for setting this option.
+       */
+      type: OptionType;
+
+      /**
+       * The unit of measurement for this option.
+       */
+      unit: OptionUnit;
+
+      /**
+       * The current value of the option, if relevant. Note that the data type of this property must match the data type specified in `type`.
+       */
+      value?: boolean | number | number[] | number | number[] | string;
+
+      /**
+       * Defines {@link OptionConstraint} on the current scanner option.
+       */
+      constraint?: OptionConstraint;
+
+      /**
+       * Indicates that this option can be detected from software.
+       */
+      isDetectable: boolean;
+
+      /**
+       * Indicates whether and how the option can be changed.
+       */
+      configurability: Configurability;
+
+      /**
+       * Can be automatically set by the scanner driver.
+       */
+      isAutoSettable: boolean;
+
+      /**
+       * Emulated by the scanner driver if true.
+       */
+      isEmulated: boolean;
+
+      /**
+       * Indicates the option is active and can be set or retrieved. If false, the `value` property will not be set.
+       */
+      isActive: boolean;
+
+      /**
+       * Indicates that the UI should not display this option by default.
+       */
+      isAdvanced: boolean;
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface DeviceFilter {
+
+      /**
+       * Only return scanners that are directly attached to the computer.
+       */
+      local?: boolean;
+
+      /**
+       * Only return scanners that use a secure transport, such as USB or TLS.
+       */
+      secure?: boolean;
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface OptionGroup {
+
+      /**
+       * Provides a printable title, for example "Geometry options".
+       */
+      title: string;
+
+      /**
+       * An array of option names in driver-provided order.
+       */
+      members: string[];
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface GetScannerListResponse {
+
+      /**
+       * The enumeration result. Note that partial results could be returned even if this indicates an error.
+       */
+      result: OperationResult;
+
+      /**
+       * A possibly-empty list of scanners that match the provided {@link DeviceFilter}.
+       */
+      scanners: ScannerInfo[];
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface OpenScannerResponse {
+
+      /**
+       * The scanner ID passed to `openScanner()`.
+       */
+      scannerId: string;
+
+      /**
+       * The result of opening the scanner. If the value of this is `SUCCESS`, the `scannerHandle` and `options` properties will be populated.
+       */
+      result: OperationResult;
+
+      /**
+       * If `result` is `SUCCESS`, a handle to the scanner that can be used for further operations.
+       */
+      scannerHandle?: string;
+
+      /**
+       * If `result` is `SUCCESS`, provides a key-value mapping where the key is a device-specific option and the value is an instance of {@link ScannerOption}.
+       */
+      options?: {[name: string]: any};
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface GetOptionGroupsResponse {
+
+      /**
+       * The same scanner handle as was passed to {@link getOptionGroups}.
+       */
+      scannerHandle: string;
+
+      /**
+       * The result of getting the option groups. If the value of this is `SUCCESS`, the `groups` property will be populated.
+       */
+      result: OperationResult;
+
+      /**
+       * If `result` is `SUCCESS`, provides a list of option groups in the order supplied by the scanner driver.
+       */
+      groups?: OptionGroup[];
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface CloseScannerResponse {
+
+      /**
+       * The same scanner handle as was passed to {@link closeScanner}.
+       */
+      scannerHandle: string;
+
+      /**
+       * The result of closing the scanner. Even if this value is not `SUCCESS`, the handle will be invalid and should not be used for any further operations.
+       */
+      result: OperationResult;
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface OptionSetting {
+
+      /**
+       * Indicates the name of the option to set.
+       */
+      name: string;
+
+      /**
+       * Indicates the data type of the option. The requested data type must match the real data type of the underlying option.
+       */
+      type: OptionType;
+
+      /**
+       * Indicates the value to set. Leave unset to request automatic setting for options that have `autoSettable` enabled. The data type supplied for `value` must match `type`.
+       */
+      value?: boolean | number | number[] | number | number[] | string;
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface SetOptionResult {
+
+      /**
+       * Indicates the name of the option that was set.
+       */
+      name: string;
+
+      /**
+       * Indicates the result of setting the option.
+       */
+      result: OperationResult;
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface SetOptionsResponse {
+
+      /**
+       * Provides the scanner handle passed to `setOptions()`.
+       */
+      scannerHandle: string;
+
+      /**
+       * An array of results, one each for every passed-in `OptionSetting`.
+       */
+      results: SetOptionResult[];
+
+      /**
+       * An updated key-value mapping from option names to {@link ScannerOption} values containing the new configuration after attempting to set all supplied options. This has the same structure as the `options` property in {@link OpenScannerResponse}.
+       *
+       * This property will be set even if some options were not set successfully, but will be unset if retrieving the updated configuration fails (for example, if the scanner is disconnected in the middle of scanning).
+       */
+      options?: {[name: string]: any};
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface StartScanOptions {
+
+      /**
+       * Specifies the MIME type to return scanned data in.
+       */
+      format: string;
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface StartScanResponse {
+
+      /**
+       * Provides the same scanner handle that was passed to `startScan()`.
+       */
+      scannerHandle: string;
+
+      /**
+       * The result of starting a scan. If the value of this is `SUCCESS`, the `job` property will be populated.
+       */
+      result: OperationResult;
+
+      /**
+       * If `result` is `SUCCESS`, provides a handle that can be used to read scan data or cancel the job.
+       */
+      job?: string;
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface CancelScanResponse {
+
+      /**
+       * Provides the same job handle that was passed to `cancelScan()`.
+       */
+      job: string;
+
+      /**
+       * The backend's cancel scan result. If the result is `OperationResult.SUCCESS` or `OperationResult.CANCELLED`, the scan has been cancelled and the scanner is ready to start a new scan. If the result is `OperationResult.DEVICE_BUSY` , the scanner is still processing the requested cancellation; the caller should wait a short time and try the request again. Other result values indicate a permanent error that should not be retried.
+       */
+      result: OperationResult;
+    }
+
+    /**
+     * @since Pending
+     */
+    export interface ReadScanDataResponse {
+
+      /**
+       * Provides the job handle passed to `readScanData()`.
+       */
+      job: string;
+
+      /**
+       * The result of reading data. If its value is `SUCCESS`, then `data` contains the _next_ (possibly zero-length) chunk of image data that is ready for reading. If its value is `EOF`, the `data` contains the _last_ chunk of image data.
+       */
+      result: OperationResult;
+
+      /**
+       * If `result` is `SUCCESS`, contains the _next_ chunk of scanned image data. If `result` is `EOF`, contains the _last_ chunk of scanned image data.
+       */
+      data?: ArrayBuffer;
+
+      /**
+       * If `result` is `SUCCESS`, an estimate of how much of the total scan data has been delivered so far, in the range 0 to 100.
+       */
+      estimatedCompletion?: number;
+    }
+
+    /**
+     * Performs a document scan and returns a Promise that resolves with a {@link ScanResults} object. If a callback is passed to this function, the returned data is passed to it instead.
      *
      * @chrome-returns-extra since Chrome 96
-     * @param options Object containing scan parameters.
+     * @param options An object containing scan parameters.
      */
     export function scan(
 
@@ -10338,9 +10802,9 @@ declare namespace chrome {
     ): Promise<ScanResults>;
 
     /**
-     * Performs a document scan. On success, the PNG data will be sent to the callback.
+     * Performs a document scan and returns a Promise that resolves with a {@link ScanResults} object. If a callback is passed to this function, the returned data is passed to it instead.
      *
-     * @param options Object containing scan parameters.
+     * @param options An object containing scan parameters.
      * @param callback Called with the result and data from the scan.
      */
     export function scan(
@@ -10351,6 +10815,242 @@ declare namespace chrome {
         result: ScanResults,
       ) => void,
     ): void;
+
+    /**
+     * Gets the list of available scanners and returns a Promise that resolves with a {@link GetScannerListResponse} object. If a callback is passed to this function, returned data is passed to it instead.
+     *
+     * @param filter A {@link DeviceFilter} indicating which types of scanners should be returned.
+     * @since Pending
+     */
+    export function getScannerList(
+
+      filter: DeviceFilter,
+    ): Promise<GetScannerListResponse>;
+
+    /**
+     * Gets the list of available scanners and returns a Promise that resolves with a {@link GetScannerListResponse} object. If a callback is passed to this function, returned data is passed to it instead.
+     *
+     * @param filter A {@link DeviceFilter} indicating which types of scanners should be returned.
+     * @param callback Called with the result and list of scanners.
+     * @since Pending
+     */
+    export function getScannerList(
+
+      filter: DeviceFilter,
+
+      callback?: (
+        response: GetScannerListResponse,
+      ) => void,
+    ): void;
+
+    /**
+     * Opens a scanner for exclusive access and returns a Promise that resolves with an {@link OpenScannerResponse} object. If a callback is passed to this function, returned data is passed to it instead.
+     *
+     * @param scannerId The ID of a scanner to be opened. This value is one returned from a previous call to {@link getScannerList}.
+     * @since Pending
+     */
+    export function openScanner(
+
+      scannerId: string,
+    ): Promise<OpenScannerResponse>;
+
+    /**
+     * Opens a scanner for exclusive access and returns a Promise that resolves with an {@link OpenScannerResponse} object. If a callback is passed to this function, returned data is passed to it instead.
+     *
+     * @param scannerId The ID of a scanner to be opened. This value is one returned from a previous call to {@link getScannerList}.
+     * @param callback Called with the result.
+     * @since Pending
+     */
+    export function openScanner(
+
+      scannerId: string,
+
+      callback?: (
+        response: OpenScannerResponse,
+      ) => void,
+    ): void;
+
+    /**
+     * Gets the group names and member options from a scanner previously opened by {@link openScanner}. This method returns a Promise that resolves with a {@link GetOptionGroupsResponse} object. If a callback is passed to this function, returned data is passed to it instead.
+     *
+     * @param scannerHandle The handle of an open scanner returned from a call to {@link openScanner}.
+     * @since Pending
+     */
+    export function getOptionGroups(
+
+      scannerHandle: string,
+    ): Promise<GetOptionGroupsResponse>;
+
+    /**
+     * Gets the group names and member options from a scanner previously opened by {@link openScanner}. This method returns a Promise that resolves with a {@link GetOptionGroupsResponse} object. If a callback is passed to this function, returned data is passed to it instead.
+     *
+     * @param scannerHandle The handle of an open scanner returned from a call to {@link openScanner}.
+     * @param callback Called with the result.
+     * @since Pending
+     */
+    export function getOptionGroups(
+
+      scannerHandle: string,
+
+      callback?: (
+        response: GetOptionGroupsResponse,
+      ) => void,
+    ): void;
+
+    /**
+     * Closes the scanner with the passed in handle and returns a Promise that resolves with a {@link 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.
+     *
+     * @param scannerHandle Specifies the handle of an open scanner that was previously returned from a call to {@link openScanner}.
+     * @since Pending
+     */
+    export function closeScanner(
+
+      scannerHandle: string,
+    ): Promise<CloseScannerResponse>;
+
+    /**
+     * Closes the scanner with the passed in handle and returns a Promise that resolves with a {@link 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.
+     *
+     * @param scannerHandle Specifies the handle of an open scanner that was previously returned from a call to {@link openScanner}.
+     * @param callback Called with the result.
+     * @since Pending
+     */
+    export function closeScanner(
+
+      scannerHandle: string,
+
+      callback?: (
+        response: CloseScannerResponse,
+      ) => void,
+    ): void;
+
+    /**
+     * Sets options on the specified scanner and returns a Promise that resolves with a {@link SetOptionsResponse} object containing the result of trying to set every value in the order of the passed-in {@link OptionSetting} object. If a callback is used, the object is passed to it instead.
+     *
+     * @param scannerHandle The handle of the scanner to set options on. This should be a value previously returned from a call to {@link openScanner}.
+     * @param options A list of `OptionSetting` objects to be applied to the scanner.
+     * @since Pending
+     */
+    export function setOptions(
+
+      scannerHandle: string,
+
+      options: OptionSetting[],
+    ): Promise<SetOptionsResponse>;
+
+    /**
+     * Sets options on the specified scanner and returns a Promise that resolves with a {@link SetOptionsResponse} object containing the result of trying to set every value in the order of the passed-in {@link OptionSetting} object. If a callback is used, the object is passed to it instead.
+     *
+     * @param scannerHandle The handle of the scanner to set options on. This should be a value previously returned from a call to {@link openScanner}.
+     * @param options A list of `OptionSetting` objects to be applied to the scanner.
+     * @param callback Called with the result.
+     * @since Pending
+     */
+    export function setOptions(
+
+      scannerHandle: string,
+
+      options: OptionSetting[],
+
+      callback?: (
+        response: SetOptionsResponse,
+      ) => void,
+    ): void;
+
+    /**
+     * Starts a scan on the specified scanner and returns a Promise that resolves with a {@link 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.
+     *
+     * @param scannerHandle The handle of an open scanner. This should be a value previously returned from a call to {@link openScanner}.
+     * @param options A {@link 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`.
+     * @since Pending
+     */
+    export function startScan(
+
+      scannerHandle: string,
+
+      options: StartScanOptions,
+    ): Promise<StartScanResponse>;
+
+    /**
+     * Starts a scan on the specified scanner and returns a Promise that resolves with a {@link 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.
+     *
+     * @param scannerHandle The handle of an open scanner. This should be a value previously returned from a call to {@link openScanner}.
+     * @param options A {@link 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`.
+     * @param callback Called with the result.
+     * @since Pending
+     */
+    export function startScan(
+
+      scannerHandle: string,
+
+      options: StartScanOptions,
+
+      callback?: (
+        response: StartScanResponse,
+      ) => void,
+    ): void;
+
+    /**
+     * Cancels a started scan and returns a Promise that resolves with a {@link CancelScanResponse} object. If a callback is used, the object is passed to it instead.
+     *
+     * @param job The handle of an active scan job previously returned from a call to {@link startScan}.
+     * @since Pending
+     */
+    export function cancelScan(
+
+      job: string,
+    ): Promise<CancelScanResponse>;
+
+    /**
+     * Cancels a started scan and returns a Promise that resolves with a {@link CancelScanResponse} object. If a callback is used, the object is passed to it instead.
+     *
+     * @param job The handle of an active scan job previously returned from a call to {@link startScan}.
+     * @param callback Called with the result.
+     * @since Pending
+     */
+    export function cancelScan(
+
+      job: string,
+
+      callback?: (
+        response: CancelScanResponse,
+      ) => void,
+    ): void;
+
+    /**
+     * Reads the next chunk of available image data from an active job handle, and returns a Promise that resolves with a {@link ReadScanDataResponse} object. If a callback is used, the object is passed to it instead.
+     *
+     * **Note:**It is valid for a response result to be `SUCCESS` with a zero-length `data` member. This means the scanner is still working but does not yet have additional data ready. The caller should wait a short time and try again.
+     *
+     * When the scan job completes, the response will have the result value of `EOF`. This response may contain a final non-zero `data` member.
+     *
+     * @param job Active job handle previously returned from {@link startScan}.
+     * @since Pending
+     */
+    export function readScanData(
+
+      job: string,
+    ): Promise<ReadScanDataResponse>;
+
+    /**
+     * Reads the next chunk of available image data from an active job handle, and returns a Promise that resolves with a {@link ReadScanDataResponse} object. If a callback is used, the object is passed to it instead.
+     *
+     * **Note:**It is valid for a response result to be `SUCCESS` with a zero-length `data` member. This means the scanner is still working but does not yet have additional data ready. The caller should wait a short time and try again.
+     *
+     * When the scan job completes, the response will have the result value of `EOF`. This response may contain a final non-zero `data` member.
+     *
+     * @param job Active job handle previously returned from {@link startScan}.
+     * @param callback Called with the result.
+     * @since Pending
+     */
+    export function readScanData(
+
+      job: string,
+
+      callback?: (
+        response: ReadScanDataResponse,
+      ) => void,
+    ): void;
   }
 
   /**