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

chrome.printerProvider

  • Description

    The chrome.printerProvider API exposes events used by print manager to query printers controlled by extensions, to query their capabilities and to submit print jobs to these printers.

  • Permissions
    printerProvider

Summary

Types

PrintJob

Properties

  • contentType
    string

    The document content type. Supported formats are "application/pdf" and "image/pwg-raster".

  • document
    Blob

    Blob containing the document data to print. Format must match |contentType|.

  • printerId
    string

    ID of the printer which should handle the job.

  • ticket
    object

    Print ticket in CJT format.

  • title
    string

    The print job title.

PrinterInfo

Properties

  • description
    string optional

    Printer's human readable description.

  • id
    string

    Unique printer ID.

  • name
    string

    Printer's human readable name.

PrintError

Error codes returned in response to onPrintRequested event.

Enum

"OK", "FAILED", "INVALID_TICKET", or "INVALID_DATA"

Events

onGetCapabilityRequested

chrome.printerProvider.onGetCapabilityRequested.addListener(listener: function)

Event fired when print manager requests printer capabilities.

Event

  • listener
    function

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

    (printerId: string, resultCallback: function) => {...}
    • printerId
      string

      Unique ID of the printer whose capabilities are requested.

    • resultCallback
      function

      The resultCallback function looks like this:

      resultCallback(capabilities: object) => {...}
      • capabilities
        object

onGetPrintersRequested

chrome.printerProvider.onGetPrintersRequested.addListener(listener: function)

Event fired when print manager requests printers provided by extensions.

Event

  • listener
    function

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

    (resultCallback: function) => {...}
    • resultCallback
      function

      The resultCallback function looks like this:

      resultCallback(printerInfo: PrinterInfo[]) => {...}

onGetUsbPrinterInfoRequested

chrome.printerProvider.onGetUsbPrinterInfoRequested.addListener(listener: function)

Event fired when print manager requests information about a USB device that may be a printer.

Note: An application should not rely on this event being fired more than once per device. If a connected device is supported it should be returned in the onGetPrintersRequested event.

Event

  • listener
    function

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

    (device: usb.Device, resultCallback: function) => {...}
    • The USB device.

    • resultCallback
      function

      The resultCallback function looks like this:

      resultCallback(printerInfo: PrinterInfo) => {...}

onPrintRequested

chrome.printerProvider.onPrintRequested.addListener(listener: function)

Event fired when print manager requests printing.

Event

  • listener
    function

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

    (printJob: PrintJob, resultCallback: function) => {...}
    • printJob

      The printing request parameters.

    • resultCallback
      function

      The resultCallback function looks like this:

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