chrome.printingMetrics
- Description
Use the
chrome.printingMetricsAPI to fetch data about printing usage. - Permissions
printingMetrics - AvailabilityChrome 79+
Summary
- Types
- Methods
- Events
Types
ColorMode
Type
"BLACK_AND_WHITE" "COLOR"
DuplexMode
Type
"ONE_SIDED" "TWO_SIDED_LONG_EDGE" "TWO_SIDED_SHORT_EDGE"
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.
Printer
Properties
- name
string
Displayed name of the printer.
- source
The source of the printer.
- uri
string
The full path for the printer. Contains protocol, hostname, port, and queue.
PrinterSource
The source of the printer.
Type
"USER" "POLICY"
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.
- printer_statusChrome 85+
The status of the printer.
- settings
The settings of the print job.
- source
Source showing who initiated the print job.
- sourceId
string optional
ID of source. Null if source is PRINT_PREVIEW or ANDROID_APP.
- status
The final status of the job.
- title
string
The title of the document which was printed.
PrintJobSource
The source of the print job.
Type
"PRINT_PREVIEW" "ANDROID_APP" "EXTENSION"
PrintJobStatus
The final status of the print job.
Type
"FAILED" "CANCELED" "PRINTED"
PrintSettings
Properties
- color
The requested color mode.
- copies
number
The requested number of copies.
- duplex
The requested duplex mode.
- mediaSize
The requested media size.
Methods
getPrintJobs
chrome.printingMetrics.getPrintJobs(
callback?: function,
)Returns the list of the finished print jobs.
Parameters
- callback
function optional
The
callbackparameter looks like:(jobs: PrintJobInfo[]) => void- jobs
Returns
Promise<PrintJobInfo[]>
PendingThis only returns a
Promisewhen thecallbackparameter is not specified, and with MV3+. The type inside thePromiseis the same as the 1st argument tocallback.
Events
onPrintJobFinished
chrome.printingMetrics.onPrintJobFinished.addListener(
callback: function,
)Event fired when the print job is finished. This includes any of termination statuses: FAILED, CANCELED and PRINTED.
Parameters
- callback
function
The
callbackparameter looks like:(jobInfo: PrintJobInfo) => void- jobInfo