chrome.printing

คำอธิบาย

ใช้ chrome.printing API เพื่อส่งงานพิมพ์ไปยังเครื่องพิมพ์ที่ติดตั้งใน Chromebook

สิทธิ์

printing

ความพร้อมใช้งาน

Chrome 81 ขึ้นไป ChromeOS เท่านั้น

ไฟล์ Manifest

คุณต้องประกาศสิทธิ์ "printing" ในไฟล์ Manifest ของส่วนขยายสำหรับเมธอดและเหตุการณ์ chrome.printing ทั้งหมด เช่น

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

ตัวอย่าง

ตัวอย่างด้านล่างแสดงให้เห็นการใช้แต่ละวิธีในเนมสเปซของการพิมพ์ โค้ดนี้คัดลอกมาจากหรืออิงตาม api-samples/printing ในที่เก็บ GitHub ของ extensions-samples

cancelJob()

ตัวอย่างนี้ใช้ตัวแฮนเดิล onJobStatusChanged เพื่อซ่อนปุ่ม "ยกเลิก" เมื่อ jobStatus ไม่ใช่ PENDING หรือ IN_PROGRESS โปรดทราบว่าในบางเครือข่ายหรือเมื่อ 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() และ getPrinterInfo()

ฟังก์ชันเหล่านี้ใช้ตัวอย่างเพียงรายการเดียว เนื่องจากการรับข้อมูลเครื่องพิมพ์ต้องใช้รหัสเครื่องพิมพ์ ซึ่งดึงข้อมูลได้โดยเรียกใช้ 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() ต้องใช้ 3 สิ่ง

  • โครงสร้าง ticket ที่ระบุความสามารถของเครื่องพิมพ์ หากผู้ใช้ต้องเลือกจากความสามารถที่มี คุณก็สามารถเรียกข้อมูลความสามารถสำหรับเครื่องพิมพ์ที่ต้องการได้โดยใช้ getPrinterInfo()
  • โครงสร้าง SubmitJobRequest ซึ่งระบุเครื่องพิมพ์ที่จะใช้ และไฟล์หรือวันที่ที่จะพิมพ์ โครงสร้างนี้มีการอ้างอิงโครงสร้าง ticket
  • Blob ของไฟล์หรือข้อมูลที่จะพิมพ์

การเรียกใช้ submitJob() จะเป็นการทริกเกอร์กล่องโต้ตอบที่ขอให้ผู้ใช้ยืนยันการพิมพ์ ใช้ PrintingAPIExtensionsAllowlist เพื่อข้ามการยืนยัน

นี่เป็นตัวอย่างการพิมพ์แบบง่าย โปรดสังเกตว่า ticket แนบอยู่กับโครงสร้าง SubmitJobRequest (บรรทัดที่ 8) และข้อมูลที่จะพิมพ์ได้แปลงเป็น BLOB (บรรทัดที่ 10) แล้ว การรับรหัสของเครื่องพิมพ์ (บรรทัดที่ 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 (ค่าเริ่มต้นจะแตกต่างกันไปในแต่ละเครื่องพิมพ์) หากรวมไว้ คีย์นี้ต้องเป็นอาร์เรย์ที่มีสมาชิก 1 คน: ออบเจ็กต์ที่มี 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" เป็น "จริง" ใช้ค่าความสูงและความกว้างสำหรับตั๋ว

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

ประเภท

GetPrinterInfoResponse

พร็อพเพอร์ตี้

  • ความสามารถ

    ออบเจ็กต์ ไม่บังคับ

    ความสามารถของเครื่องพิมพ์ในรูปแบบ CDD พร็อพเพอร์ตี้อาจหายไป

  • สถานะ

    PrinterStatus

    สถานะของเครื่องพิมพ์

JobStatus

สถานะงานพิมพ์

ค่าแจกแจง

"รอดำเนินการ"
ระบบได้รับงานพิมพ์ฝั่ง Chrome แล้ว แต่ยังไม่ได้ประมวลผล

"IN_PROGRESS"
ส่งงานพิมพ์เพื่อพิมพ์แล้ว

"FAILED"
งานพิมพ์ถูกขัดจังหวะเนื่องจากมีข้อผิดพลาดบางอย่าง

"ยกเลิก"
ผู้ใช้ยกเลิกงานพิมพ์หรือผ่าน API

"printED"
พิมพ์งานพิมพ์โดยไม่มีข้อผิดพลาดใดๆ

Printer

พร็อพเพอร์ตี้

  • คำอธิบาย

    สตริง

    คำอธิบายเครื่องพิมพ์ที่มนุษย์อ่านได้

  • id

    สตริง

    ตัวระบุของเครื่องพิมพ์ ซึ่งรับประกันว่าไม่ซ้ำกันกับเครื่องพิมพ์อื่นๆ ในอุปกรณ์

  • isDefault

    boolean

    ธงซึ่งจะแสดงว่าเครื่องพิมพ์เป็นไปตามกฎ DefaultPrinterSelection หรือไม่ โปรดทราบว่าเครื่องพิมพ์หลายเครื่องอาจถูกแจ้งว่าไม่เหมาะสม

  • ชื่อ

    สตริง

    ชื่อเครื่องพิมพ์

  • recentlyUsedRank

    หมายเลข ไม่บังคับ

    ค่าที่แสดงว่าเครื่องพิมพ์มีการใช้งานเมื่อใดล่าสุดสำหรับการพิมพ์จาก Chrome ยิ่งค่าต่ำลง แสดงว่าเครื่องพิมพ์มีการใช้งานล่าสุด ค่าต่ำสุดคือ 0 ค่าที่ขาดหายไปบ่งบอกว่าไม่มีการใช้งานเครื่องพิมพ์เมื่อเร็วๆ นี้ ค่านี้รับประกันว่าจะไม่ซ้ำกันสำหรับเครื่องพิมพ์ทุกเครื่อง

  • source

    PrinterSource

    แหล่งที่มาของเครื่องพิมพ์ (ผู้ใช้หรือนโยบายที่กําหนดค่าไว้)

  • URI

    สตริง

    URI ของเครื่องพิมพ์ ส่วนขยายสามารถใช้ข้อมูลนี้เพื่อเลือกเครื่องพิมพ์ให้กับผู้ใช้

PrinterSource

แหล่งที่มาของเครื่องพิมพ์

ค่าแจกแจง

"USER"
ผู้ใช้เพิ่มเครื่องพิมพ์

"POLICY"
มีการเพิ่มเครื่องพิมพ์ผ่านนโยบาย

PrinterStatus

สถานะของเครื่องพิมพ์

ค่าแจกแจง

"DOOR_OPEN"
ฝาเครื่องพิมพ์เปิดอยู่ เครื่องพิมพ์ยังคงยอมรับงานพิมพ์

"TRAY_MISSING"
ถาดของเครื่องพิมพ์หายไป เครื่องพิมพ์ยังคงยอมรับงานพิมพ์

"OUT_OF_INK"
เครื่องพิมพ์ไม่มีหมึก เครื่องพิมพ์ยังคงรับงานพิมพ์

"OUT_OF_PAPER"
เครื่องพิมพ์ไม่มีกระดาษ เครื่องพิมพ์ยังคงยอมรับงานพิมพ์

"OUTPUT_FULL"
พื้นที่สำหรับกระดาษออกของเครื่องพิมพ์ (เช่น ถาด) เต็มแล้ว เครื่องพิมพ์ยังคงยอมรับงานพิมพ์

"PAPER_JAM"
กระดาษติดอยู่ในเครื่องพิมพ์ เครื่องพิมพ์ยังคงยอมรับงานพิมพ์

"GENERIC_ISSUE"
ปัญหาทั่วไปบางอย่าง เครื่องพิมพ์ยังคงยอมรับงานพิมพ์

"หยุดแล้ว"
เครื่องพิมพ์หยุดทำงานและไม่ได้พิมพ์ แต่ยังคงรับงานพิมพ์

"UNREACHABLE"
เข้าถึงเครื่องพิมพ์ไม่ได้และไม่ยอมรับงานพิมพ์

"EXPIRED_CERTIFICATE"
ใบรับรอง SSL หมดอายุแล้ว เครื่องพิมพ์ยอมรับงานแต่ทำไม่สำเร็จ

"พร้อมใช้งาน"
เครื่องพิมพ์พร้อมใช้งาน

SubmitJobRequest

พร็อพเพอร์ตี้

  • งาน

    PrintJob

    งานพิมพ์ที่จะส่ง เนื้อหาที่รองรับเพียงประเภทเดียวคือ "application/pdf" และ Cloud Ticket ไม่ควรมีฟิลด์ FitToPageTicketItem, PageRangeTicketItem, ReverseOrderTicketItem และ VendorTicketItem เนื่องจากไม่เกี่ยวข้องกับการพิมพ์แบบดั้งเดิม แต่ต้องกรอกข้อมูลในช่องอื่นๆ ทั้งหมด

SubmitJobResponse

พร็อพเพอร์ตี้

  • jobId

    สตริง ไม่บังคับ

    รหัสของงานพิมพ์ที่สร้าง ซึ่งเป็นตัวระบุที่ไม่ซ้ำกันสำหรับงานพิมพ์ทั้งหมดในอุปกรณ์ หากสถานะไม่ใช่ OK รหัสงานจะเป็นค่าว่าง

  • สถานะ

    SubmitJobStatus

    สถานะของคําขอ

SubmitJobStatus

สถานะของคำขอ submitJob

ค่าแจกแจง

"ตกลง"
คำของานพิมพ์ที่ส่งมาได้รับการยอมรับ

"USER_REJECTED"
ผู้ใช้ปฏิเสธคำของานพิมพ์ที่ส่ง

พร็อพเพอร์ตี้

MAX_GET_PRINTER_INFO_CALLS_PER_MINUTE

จำนวนครั้งสูงสุดที่เรียก getPrinterInfo ต่อนาที

ค่า

20

MAX_SUBMIT_JOB_CALLS_PER_MINUTE

จำนวนครั้งสูงสุดที่เรียก submitJob ต่อนาที

ค่า

40

เมธอด

cancelJob()

สัญญา 
chrome.printing.cancelJob(
  jobId: string,
  callback?: function,
)

ยกเลิกงานที่ส่งก่อนหน้านี้

พารามิเตอร์

  • jobId

    สตริง

    รหัสงานพิมพ์ที่จะยกเลิก ซึ่งควรเป็นรหัสเดียวกับที่ได้รับใน SubmitJobResponse

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • คำสัญญา<โมฆะ>

    Chrome 100 ขึ้นไป

    ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getPrinterInfo()

สัญญา 
chrome.printing.getPrinterInfo(
  printerId: string,
  callback?: function,
)

แสดงสถานะและความสามารถของเครื่องพิมพ์ในรูปแบบ CDD การเรียกใช้นี้จะล้มเหลวพร้อมกับข้อผิดพลาดแบบรันไทม์ หากไม่มีการติดตั้งเครื่องพิมพ์ที่มีรหัสที่ระบุ

พารามิเตอร์

  • printerId

    สตริง

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (response: GetPrinterInfoResponse) => void

การคืนสินค้า

  • Chrome 100 ขึ้นไป

    ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getPrinters()

สัญญา 
chrome.printing.getPrinters(
  callback?: function,
)

แสดงรายการเครื่องพิมพ์ที่ใช้ได้บนอุปกรณ์ ซึ่งรวมถึงเครื่องพิมพ์ที่เพิ่มด้วยตัวเอง เครื่องพิมพ์ขององค์กร และเครื่องพิมพ์ที่ค้นพบ

พารามิเตอร์

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (printers: Printer[]) => void

การคืนสินค้า

  • Promise<Printer[]>

    Chrome 100 ขึ้นไป

    ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

submitJob()

สัญญา 
chrome.printing.submitJob(
  request: SubmitJobRequest,
  callback?: function,
)

ส่งงานเข้าพิมพ์ หากส่วนขยายไม่อยู่ในนโยบาย PrintingAPIExtensionsAllowlist ระบบจะแจ้งให้ผู้ใช้ยอมรับงานพิมพ์ ก่อนที่จะมี Chrome 120 ฟังก์ชันนี้ไม่ได้ให้คำมั่นสัญญาไว้

พารามิเตอร์

  • ส่งคำขอ

    SubmitJobRequest

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (response: SubmitJobResponse) => void

การคืนสินค้า

  • Chrome 100 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onJobStatusChanged

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

เหตุการณ์เริ่มทำงานเมื่อสถานะของงานมีการเปลี่ยนแปลง ซึ่งจะทริกเกอร์สําหรับงานที่สร้างขึ้นโดยส่วนขยายนี้เท่านั้น

พารามิเตอร์

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

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

    • jobId

      สตริง

    • สถานะ

      JobStatus