chrome.printerProvider

説明

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

権限

printerProvider

対象

Chrome 44 以降

型

PrinterInfo

プロパティ

  • description

    string（省略可）

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

  • id

    文字列

    一意のプリンタ ID。

  • name

    文字列

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

PrintError

onPrintRequested イベントに応答して返されるエラーコード。

Enum

"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 デバイスに関する情報をリクエストすると発生します。

注: アプリは、このイベントが 1 つのデバイスで複数回発生することに依存すべきではありません。接続されたデバイスがサポートされている場合は、onGetPrintersRequested イベントで返されます。

パラメータ

  • callback

    機能

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

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

    • 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