chrome.printerProvider

説明

chrome.printerProvider API は、印刷マネージャーが使用するイベントを公開して、拡張機能で制御されるプリンタへのクエリ、拡張機能の機能の照会、これらのプリンタへの印刷ジョブの送信を行います。

権限

printerProvider

対象

Chrome 44 以降

型

PrinterInfo

プロパティ

  • description

    文字列（省略可）

    人が読める形式のプリンタの説明。

  • id

    文字列

    固有のプリンタ ID。

  • name

    文字列

    人間が読める形式のプリンタ名。

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

      • 機能

        オブジェクト

        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

    • デバイス

      usb.Device

    • resultCallback

      関数

      resultCallback パラメータは次のようになります。 

      (printerInfo?: PrinterInfo) => void

onPrintRequested

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

プリント マネージャーが印刷をリクエストしたときに発生するイベント。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

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

    • printJob

      PrintJob

    • resultCallback

      関数

      resultCallback パラメータは次のようになります。 

      (result: PrintError) => void