chrome.printerProvider

refresh date: 2026-09-25 robots: noindex

說明

chrome.printerProvider API 會公開列印管理工具使用的事件,以便查詢擴充功能控管的印表機、查詢印表機功能,以及將列印工作提交至這些印表機。

權限

printerProvider

可用性

Chrome 44 以上版本

類型

PrinterInfo

屬性

  • 說明

    字串 選填

    印表機的人類可讀說明。

  • id

    字串

    印表機的專屬 ID。

  • 名稱

    字串

    印表機的人類可讀名稱。

PrintError

回應 onPrintRequested 事件時傳回的錯誤代碼。

列舉

「OK」
指定作業已順利完成。

「FAILED」
表示發生一般錯誤。

「INVALID_TICKET」
指定紙本票券無效。例如,票證與某些功能不一致,或擴充功能無法處理票證中的所有設定。

「INVALID_DATA」
指出文件無效。舉例來說,資料可能已毀損,或格式與擴充功能不相容。

PrintJob

屬性

  • contentType

    字串

    文件內容類型。支援的格式為 "application/pdf" 和 "image/pwg-raster"。

  • 文件

    Blob

    包含要列印文件資料的 Blob。格式必須與 contentType 相符。

  • printerId

    字串

    應處理工作的印表機 ID。

  • 支援單

    物件

    以 CJT 格式列印車票。

    CJT 參考資料已標示為已淘汰。這項功能僅適用於 Google 雲端列印,不適用於 ChromeOS 列印。

  • title

    字串

    列印工作名稱。

事件

onGetCapabilityRequested

chrome.printerProvider.onGetCapabilityRequested.addListener(
  callback: function,
)

列印管理員要求印表機功能時觸發的事件。

參數

  • callback

    函式

    callback 參數如下:

    (printerId: string, resultCallback: function) => void

    • printerId

      字串

    • resultCallback

      函式

      resultCallback 參數如下:

      (capabilities: object) => void

      • capabilities

        物件

        CDD 格式的裝置功能。

onGetPrintersRequested

chrome.printerProvider.onGetPrintersRequested.addListener(
  callback: function,
)

當列印管理員要求擴充功能提供的印表機時,會觸發這個事件。

參數

  • callback

    函式

    callback 參數如下:

    (resultCallback: function) => void

    • resultCallback

      函式

      resultCallback 參數如下:

      (printerInfo: PrinterInfo[]) => void

onGetUsbPrinterInfoRequested

Chrome 45 以上版本
chrome.printerProvider.onGetUsbPrinterInfoRequested.addListener(
  callback: function,
)

當列印管理員要求可能為印表機的 USB 裝置相關資訊時,系統會觸發此事件。

注意:應用程式不應依賴這個事件在每部裝置上觸發多次。如果支援已連線的裝置,則應在 onGetPrintersRequested 事件中傳回。

參數

  • callback

    函式

    callback 參數如下:

    (device: usb.Device, resultCallback: function) => void

onPrintRequested

chrome.printerProvider.onPrintRequested.addListener(
  callback: function,
)

列印管理員要求列印時觸發的事件。

參數

  • callback

    函式

    callback 參數如下:

    (printJob: PrintJob, resultCallback: function) => void