chrome.printing

重要提示：此 API 仅适用于 ChromeOS。

说明

使用 chrome.printing API 可将打印任务发送到 Chromebook 上安装的打印机。

权限

printing

可用性

Chrome 81 及更高版本 仅限 ChromeOS

所有 chrome.printing 方法和事件都要求您在扩展程序清单中声明 "printing" 权限。例如：

{
  "name": "My extension",
  ...
  "permissions": [
    "printing"
  ],
  ...
}

示例

以下示例演示了如何在打印命名空间中使用每种方法。此代码从 extensions-samples GitHub 代码库中的 api-samples/printing 或基于该库复制。

cancelJob()

当 jobStatus 既不是 PENDING 也不是 IN_PROGRESS 时，此示例使用 onJobStatusChanged 处理程序隐藏“取消”按钮。请注意，在某些网络上或当 Chromebook 直接连接到打印机时，这些状态的传递速度过快，以致于取消按钮显示的时间不够长，无法立即调用。这大大简化了打印示例。

chrome.printing.onJobStatusChanged.addListener((jobId, status) => {
  const cancelButton = document.getElementById("cancelButton");
  cancelButton.addEventListener('click', () => {
    chrome.printing.cancelJob(jobId).then((response) => {
      if (response !== undefined) {
        console.log(response.status);
      }
      if (chrome.runtime.lastError !== undefined) {
        console.log(chrome.runtime.lastError.message);
      }
    });
  });
  if (status !== "PENDING" && status !== "IN_PROGRESS") {
    cancelButton.style.visibility = 'hidden';
  } else {
    cancelButton.style.visibility = 'visible';
  }
}

getPrinters() and getPrinterInfo()

由于获取打印机信息需要用到打印机 ID，该 ID 可通过调用 getPrinters() 检索，因此我们只使用了这些函数。此示例会将默认打印机的名称和说明记录到控制台中。这是打印示例的简化版本。

​​const printers = await chrome.printing.getPrinters();
const defaultPrinter = printers.find((printer) => {
  const printerInfo = await chrome.printing.getPrinterInfo(printer.id);
  return printerInfo.isDefault;
}
console.log(`Default printer: ${defaultPrinter.name}.\n\t${defaultPrinter.description}`);

submitJob()

submitJob() 方法需要做三项工作。

• ticket 结构，用于指定要使用打印机的哪些功能。如果用户需要从可用功能中进行选择，您可以使用 getPrinterInfo() 检索特定打印机的这些功能。
• SubmitJobRequest 结构，用于指定要使用的打印机以及要打印的文件或日期。此结构包含对 ticket 结构的引用。
• 要输出的文件或数据的 blob。

调用 submitJob() 会触发一个对话框，要求用户确认打印。使用 PrintingAPIExtensionsAllowlist 绕过确认。

这是打印示例的简化版本。请注意，ticket 附加到了 SubmitJobRequest 结构（第 8 行），并且要输出的数据会转换为 blob（第 10 行）。获取打印机 ID（第 1 行）示例中要比此处所示的复杂得多。

const defaultPrinter = getDefaultPrinter();
const ticket = getPrinterTicket(defaultPrinter);
const arrayBuffer = getPrintData();
const submitJobRequest = {
  job: {
    printerId: defaultPrinter,
    title: 'test job',
    ticket: ticket,
    contentType: 'application/pdf',
    document: new Blob([new Uint8Array(arrayBuffer)], {
      type: 'application/pdf'
    });
  }
};

chrome.printing.submitJob(submitJobRequest, (response) => {
  if (response !== undefined) {
    console.log(response.status);
  }
  if (chrome.runtime.lastError !== undefined) {
    console.log(chrome.runtime.lastError.message);
  }
});

卷印

此示例展示了如何为连续（或卷页）打印（通常用于收据打印）构建打印机工单。用于卷印的 submitJobRequest 对象与 submitJob() 示例中显示的对象相同。

如果您需要更改纸张切割的默认值，请使用 vendor_ticket_item 键。（默认值因打印机而异）。如果包含此键，则此键必须是包含一个成员（id 为 'finishings' 的对象）的数组。对于在打印结束时切割卷纸的打印机，该值可以是 'trim'；对于需要撕下打印任务的打印机，该值可以是 'none'。

const ticket = {
  version: '1.0',
  print: {
    vendor_ticket_item: [{id: 'finishings', value: 'trim'}],
    color: {type: 'STANDARD_MONOCHROME'},
    duplex: {type: 'NO_DUPLEX'},
    page_orientation: {type: 'PORTRAIT'},
    copies: {copies: 1},
    dpi: {horizontal_dpi: 300, vertical_dpi: 300},
    media_size: {
      width_microns: 72320,
      height_microns: 100000
    },
    collate: {collate: false}
  }
};

部分打印机不支持 "finishings" 选项。要确定您的打印机是否可用，请调用 getPrinterInfo()，并查找 "display_name" 是否为 "finishings/11"。

"vendor_capability": [
  {
    "display_name": "finishings/11",
    "id": "finishings/11",
    "type": "TYPED_VALUE",
    "typed_value_cap": {
      "value_type": "BOOLEAN"
    }
  },
  ...
]

工单的 media_size 键中的值特定于每台打印机。如需选择合适的尺寸，请调用 getPrinterInfo()。返回的 GetPrinterResponse 包含受支持的媒体尺寸数组，位于 "media_size"."option"。选择一个 "is_continuous_feed" 值为 true 的选项。在门票中使用其高度和宽度值。

"media_size": {
  "option": [
  {
    "custom_display_name": "",
    "is_continuous_feed": true,
    "max_height_microns": 2000000,
    "min_height_microns": 25400,
    "width_microns": 50800
  },
  ...
  ]
}

类型

GetPrinterInfoResponse

属性

• capabilities

  对象（可选）

  打印机功能（采用 CDD 格式）。该属性可能缺失。

• status

  PrinterStatus

  打印机的状态。

JobStatus

打印作业的状态。

枚举

"PENDING"
已在 Chrome 端收到打印任务，但尚未处理。

"IN_PROGRESS"
打印作业已发出进行打印。

"FAILED"
由于出现错误，打印作业中断。

"CANCELED"
打印任务已被用户或通过 API 取消。

"PRINTED"
打印作业已打印完毕，没有任何错误。

Printer

属性

• 说明

  string

  直观易懂的打印机说明。

• id

  string

  打印机的标识符；保证对于设备上的打印机来说是唯一的。

• isDefault

  boolean

  一个标记，显示打印机是否符合 DefaultPrinterSelection 规则。请注意，系统可能会标记多台打印机。

• name

  string

  打印机的名称。

• recentlyUsedRank

  数字可选

  显示通过 Chrome 使用打印机的新近程度的值。该值越小，表示使用打印机的时间越新。最小值为 0。如果缺少值，则表示该打印机最近未使用。此值保证在各打印机之间是唯一的。

• source

  PrinterSource

  打印机的来源（已配置的用户或政策）。

• uri

  string

  打印机 URI。扩展程序可以使用此设置来为用户选择打印机。

PrinterSource

打印机的来源。

枚举

"USER"
用户已添加打印机。

"POLICY"
已通过政策添加了打印机。

PrinterStatus

打印机的状态。

枚举

"DOOR_OPEN"
打印机的机盖是开着的。打印机仍会接受打印任务。

"TRAY_MISSING"
打印机缺少托盘。打印机仍会接受打印任务。

"OUT_OF_INK"
打印机的墨水已耗尽。打印机仍会接受打印任务。

"OUT_OF_PAPER"
打印机的纸张已用尽。打印机仍会接受打印任务。

"OUTPUT_FULL"
打印机的输出区域（例如纸盘）已满。打印机仍会接受打印任务。

"PAPER_JAM"
打印机卡纸了。打印机仍会接受打印任务。

"GENERIC_ISSUE"
一些一般性问题。打印机仍会接受打印任务。

"STOPPED"
打印机已停止运行，无法打印，但仍接受打印任务。

"UNREACHABLE"
无法连接到打印机，因此不接受打印任务。

"EXPIRED_CERTIFICATE"
SSL 证书已过期。打印机接受了作业，但作业失败。

"AVAILABLE"
打印机可以使用。

SubmitJobRequest

属性

• 作业

  PrintJob

  要提交的打印作业。唯一支持的内容类型是“application/pdf”，并且 Cloud Job Ticket 不应包含 FitToPageTicketItem、PageRangeTicketItem、ReverseOrderTicketItem 和 VendorTicketItem 字段，因为它们与本机打印无关。所有其他字段都必须填写。

SubmitJobResponse

属性

• jobId

  字符串（可选）

  已创建的打印作业的 ID。这是设备上所有打印作业中的唯一标识符。如果状态不正常，则 jobId 将为 null。

• status

  SubmitJobStatus

  请求的状态。

SubmitJobStatus

submitJob 请求的状态。

枚举

“确定”
已接受发送的打印任务请求。

"USER_REJECTED"
用户拒绝了发送的打印任务请求。

属性

MAX_GET_PRINTER_INFO_CALLS_PER_MINUTE

每分钟可以调用 getPrinterInfo 的次数上限。

值

20

MAX_SUBMIT_JOB_CALLS_PER_MINUTE

每分钟可以调用 submitJob 的次数上限。

值

40

方法

cancelJob()

Promise

chrome.printing.cancelJob(
  jobId: string,
  callback?: function,
)

取消之前提交的作业。

参数

• jobId

  string

  要取消的打印作业的 ID。此 ID 应与 SubmitJobResponse 中收到的 ID 相同。

• callback

  函数（可选）

  callback 参数如下所示：

  ()=>void

返回

• Promise<void>

  Chrome 100 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

getPrinterInfo()

Promise

chrome.printing.getPrinterInfo(
  printerId: string,
  callback?: function,
)

以 CDD 格式返回打印机的状态和功能。如果未安装具有指定 ID 的打印机，此调用将会失败并出现运行时错误。

参数

• printerId

  string

• callback

  函数（可选）

  callback 参数如下所示：

  (response: GetPrinterInfoResponse)=>void

  • 条回复

    GetPrinterInfoResponse

返回

• Promise<GetPrinterInfoResponse>

  Chrome 100 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

getPrinters()

Promise

chrome.printing.getPrinters(
  callback?: function,
)

返回设备上可用打印机的列表。包括手动添加的打印机、企业打印机和发现的打印机。

参数

• callback

  函数（可选）

  callback 参数如下所示：

  (printers: Printer[])=>void

  • 打印机

    打印机[]

返回

• Promise<Printer[]>

  Chrome 100 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

submitJob()

Promise

chrome.printing.submitJob(
  request: SubmitJobRequest,
  callback?: function,
)

提交作业进行打印。如果相应扩展程序未列在 PrintingAPIExtensionsAllowlist 政策中，系统会提示用户接受打印任务。 在 Chrome 120 之前，此函数不会返回 promise。

参数

• request

  SubmitJobRequest

• callback

  函数（可选）

  callback 参数如下所示：

  (response: SubmitJobResponse)=>void

  • 条回复

    SubmitJobResponse

返回

• Promise<SubmitJobResponse>

  Chrome 100 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

活动

onJobStatusChanged

chrome.printing.onJobStatusChanged.addListener(
  callback: function,
)

更改作业状态时触发的事件。仅对此扩展程序创建的作业触发此事件。

参数

• callback

  功能

  callback 参数如下所示：

  (jobId: string,status: JobStatus)=>void

  • jobId

    string

  • status

    JobStatus