Welcome Getting started API Reference Samples
Welcome Getting started API Reference Samples

chrome.printingMetrics

Important: This API works only on Chrome OS
  • Description

    Use the chrome.printingMetrics API to fetch data about printing usage.

  • Permissions
    printingMetrics

Summary

Types

MediaSize

Properties

  • height
    number

    Height (in micrometers) of the media used for printing.

  • vendorId
    string

    Vendor-provided ID, e.g. "iso_a3_297x420mm" or "na_index-3x5_3x5in". Possible values are values of "media" IPP attribute and can be found on IANA page .

  • width
    number

    Width (in micrometers) of the media used for printing.

PrintJobInfo

Properties

  • completionTime
    number

    The job completion time (in milliseconds past the Unix epoch).

  • creationTime
    number

    The job creation time (in milliseconds past the Unix epoch).

  • id
    string

    The ID of the job.

  • numberOfPages
    number

    The number of pages in the document.

  • printer

    The info about the printer which printed the document.

  • The status of the printer.

  • The settings of the print job.

  • Source showing who initiated the print job.

  • sourceId
    string optional

    ID of source. Null if source is PRINT_PREVIEW or ANDROID_APP.

  • The final status of the job.

  • title
    string

    The title of the document which was printed.

PrintSettings

Properties

  • The requested color mode.

  • copies
    number

    The requested number of copies.

  • The requested duplex mode.

  • mediaSize

    The requested media size.

Printer

Properties

  • name
    string

    Displayed name of the printer.

  • The source of the printer.

  • uri
    string

    The full path for the printer. Contains protocol, hostname, port, and queue.

ColorMode

Enum

"BLACK_AND_WHITE", or "COLOR"

DuplexMode

Enum

"ONE_SIDED", "TWO_SIDED_LONG_EDGE", or "TWO_SIDED_SHORT_EDGE"

PrintJobSource

The source of the print job.

Enum

"PRINT_PREVIEW", "ANDROID_APP", or "EXTENSION"

PrintJobStatus

The final status of the print job.

Enum

"FAILED", "CANCELED", or "PRINTED"

PrinterSource

The source of the printer.

Enum

"USER", or "POLICY"

Methods

getPrintJobs

chrome.printingMetrics.getPrintJobs(callback: function)

Returns the list of the finished print jobs.

Parameters

  • callback
    function

    The callback parameter should be a function that looks like this:

    (jobs: PrintJobInfo[]) => {...}

Events

onPrintJobFinished

chrome.printingMetrics.onPrintJobFinished.addListener(listener: function)

Event fired when the print job is finished. This includes any of termination statuses: FAILED, CANCELED and PRINTED.

Event

  • listener
    function

    The listener parameter should be a function that looks like this:

    (jobInfo: PrintJobInfo) => {...}
We serve cookies on this site to analyze traffic, remember your preferences, and optimize your experience.