chrome.printerProvider

說明

chrome.printerProvider API 會公開列印管理員使用的事件，用於查詢擴充功能控制的印表機、查詢其功能，以及向這些印表機提交列印工作。

權限

printerProvider

可用性

Chrome 44 以上版本

類型

PrinterInfo

屬性

  • 說明

    string optional

    印表機的人類可讀說明。

  • 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 參數如下所示： 

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

    • printerId

      字串

    • resultCallback

      函式

      resultCallback 參數如下所示： 

      (capabilities: object) => void

      • capabilities

        物件

        採用 CDD 格式的裝置功能。

onGetPrintersRequested

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

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

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (resultCallback: function) => void

    • resultCallback

      函式

      resultCallback 參數如下所示： 

      (printerInfo: PrinterInfo[]) => void

onGetUsbPrinterInfoRequested

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

列印管理員要求 USB 裝置的相關資訊 (可能是印表機) 時，會觸發事件。

注意：應用程式不得仰賴在每部裝置上觸發此事件超過一次。如果支援已連結的裝置，應在 onGetPrintersRequested 事件中傳回。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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

onPrintRequested

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

當列印管理員要求列印時，會觸發事件。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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