chrome.printing

Description
Use the chrome.printing API to send print jobs to printers installed on Chromebook.
Permissions
printing
Availability
Chrome 81+

Summary

Types
GetPrinterInfoResponse
JobStatus
Printer
PrinterSource
PrinterStatus
SubmitJobRequest
SubmitJobResponse
SubmitJobStatus
Properties
MAX_GET_PRINTER_INFO_CALLS_PER_MINUTE
MAX_SUBMIT_JOB_CALLS_PER_MINUTE
Methods
cancelJob
getPrinterInfo
getPrinters
submitJob
Events
onJobStatusChanged

Types

GetPrinterInfoResponse

Properties

capabilities
object optional
Printer capabilities in CDD format. The property may be missing.
status
PrinterStatus
The status of the printer.

JobStatus

Status of the print job.

Type

"PENDING"

"IN_PROGRESS"

"FAILED"

"CANCELED"

, or

"PRINTED"

Printer

Properties

description
string
The human-readable description of the printer.
id
string
The printer's identifier; guaranteed to be unique among printers on the device.
isDefault
boolean
The flag which shows whether the printer fits DefaultPrinterSelection rules. Note that several printers could be flagged.
name
string
The name of the printer.
recentlyUsedRank
number optional
The value showing how recent the printer was used for printing from Chrome. The lower the value is the more recent the printer was used. The minimum value is 0. Missing value indicates that the printer wasn't used recently. This value is guaranteed to be unique amongst printers.
source
PrinterSource
The source of the printer (user or policy configured).
uri
string
The printer URI. This can be used by extensions to choose the printer for the user.

PrinterSource

The source of the printer.

Type

"USER"

, or

"POLICY"

PrinterStatus

The status of the printer.

Type

"DOOR_OPEN"

"TRAY_MISSING"

"OUT_OF_INK"

"OUT_OF_PAPER"

"OUTPUT_FULL"

"PAPER_JAM"

"GENERIC_ISSUE"

"STOPPED"

"UNREACHABLE"

, or

"AVAILABLE"

SubmitJobRequest

Properties

job
PrintJob
The print job to be submitted. The only supported content type is "application/pdf", and the CJT ticket shouldn't include FitToPageTicketItem, PageRangeTicketItem, ReverseOrderTicketItem and VendorTicketItem fields since they are irrelevant for native printing. All other fields must be present.

SubmitJobResponse

Properties

jobId
string optional
The id of created print job. This is a unique identifier among all print jobs on the device. If status is not OK, jobId will be null.
status
SubmitJobStatus
The status of the request.

SubmitJobStatus

The status of submitJob request.

Type

"OK"

, or

"USER_REJECTED"

Properties

MAX_GET_PRINTER_INFO_CALLS_PER_MINUTE

The maximum number of times that getPrinterInfo can be called per minute.

Value

MAX_SUBMIT_JOB_CALLS_PER_MINUTE

The maximum number of times that submitJob can be called per minute.

Value

Methods

cancelJob

chrome.printing.cancelJob(
  jobId: string,
  callback?: function,
)

Promise

Cancels previously submitted job.

Parameters

jobId
string
The id of the print job to cancel. This should be the same id received in a SubmitJobResponse.
callback
function optional
The callback parameter looks like: () => void

Returns

Promise<void>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getPrinterInfo

chrome.printing.getPrinterInfo(
  printerId: string,
  callback?: function,
)

Promise

Returns the status and capabilities of the printer in CDD format. This call will fail with a runtime error if no printers with given id are installed.

Parameters

printerId
string
callback
function optional
The callback parameter looks like: (response: GetPrinterInfoResponse) => void
- response
  GetPrinterInfoResponse

Returns

Promise<GetPrinterInfoResponse>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getPrinters

chrome.printing.getPrinters(
  callback?: function,
)

Promise

Returns the list of available printers on the device. This includes manually added, enterprise and discovered printers.

Parameters

callback
function optional
The callback parameter looks like: (printers: Printer[]) => void
- printers
  Printer[]

Returns

Promise<Printer[]>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

submitJob

chrome.printing.submitJob(
  request: SubmitJobRequest,
  callback?: function,
)

Promise

Submits the job for print. If the extension is not listed in PrintingAPIExtensionsAllowlist policy, the user will be prompted to accept the print job.

Parameters

request
SubmitJobRequest
callback
function optional
The callback parameter looks like: (response: SubmitJobResponse) => void
- response
  SubmitJobResponse

Returns

Promise<SubmitJobResponse>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Events

onJobStatusChanged

chrome.printing.onJobStatusChanged.addListener(
  callback: function,
)

Event fired when the status of the job is changed. This is only fired for the jobs created by this extension.

Parameters

callback
function
The callback parameter looks like: (jobId: string, status: JobStatus) => void
- jobId
  string
- status
  JobStatus