browser.printing

ब्यौरा

अनुमतियां

उपलब्धता

सभी browser.printing तरीकों और इवेंट के लिए, आपको एक्सटेंशन मेनिफ़ेस्ट में "printing" अनुमति का एलान करना होगा. उदाहरण के लिए:

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

उदाहरण

नीचे दिए गए उदाहरणों में, प्रिंटिंग नेमस्पेस में हर तरीके का इस्तेमाल करने का तरीका दिखाया गया है. यह कोड, extensions-samples Github repo में मौजूद api-samples/printing से कॉपी किया गया है या इस पर आधारित है.

cancelJob()

इस उदाहरण में, onJobStatusChanged हैंडलर का इस्तेमाल किया गया है. इससे, jobStatus के PENDING या IN_PROGRESS न होने पर, 'रद्द करें' बटन को छिपाया जाता है. ध्यान दें कि कुछ नेटवर्क पर या जब Chromebook को सीधे प्रिंटर से कनेक्ट किया जाता है, तो ये स्थितियां इतनी तेज़ी से बदल सकती हैं कि 'रद्द करें' बटन को दिखने में इतना समय न मिले कि उसे कॉल किया जा सके. यह प्रिंटिंग का एक आसान उदाहरण है.

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

getPrinters() and getPrinterInfo()

इन फ़ंक्शन के लिए, एक ही उदाहरण का इस्तेमाल किया गया है. ऐसा इसलिए, क्योंकि प्रिंटर की जानकारी पाने के लिए प्रिंटर आईडी की ज़रूरत होती है. यह आईडी, getPrinters() को कॉल करके वापस पाया जाता है. इस उदाहरण में, डिफ़ॉल्ट प्रिंटर का नाम और ब्यौरा कंसोल में लॉग किया गया है. यह प्रिंटिंग के उदाहरण का आसान वर्शन है.

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

submitJob()

submitJob() तरीके के लिए तीन चीज़ें ज़रूरी हैं.

• यह एक ticket स्ट्रक्चर है. इससे यह तय किया जाता है कि प्रिंटर की किन सुविधाओं का इस्तेमाल किया जाना है. अगर उपयोगकर्ता को उपलब्ध सुविधाओं में से किसी एक को चुनना है, तो getPrinterInfo() का इस्तेमाल करके किसी प्रिंटर के लिए सुविधाएं वापस पाई जा सकती हैं.
• SubmitJobRequest स्ट्रक्चर, जिसमें प्रिंटर के इस्तेमाल और प्रिंट की जाने वाली फ़ाइल या डेटा के बारे में बताया जाता है. इस स्ट्रक्चर में, ticket स्ट्रक्चर का रेफ़रंस शामिल है.
• प्रिंट करने के लिए फ़ाइल या डेटा का एक बड़ा हिस्सा.

submitJob() को कॉल करने पर, एक डायलॉग बॉक्स ट्रिगर होता है. इसमें उपयोगकर्ता से प्रिंट करने की पुष्टि करने के लिए कहा जाता है. पुष्टि की प्रोसेस को बायपास करने के लिए, PrintingAPIExtensionsAllowlist का इस्तेमाल करें.

यह प्रिंटिंग के उदाहरण का आसान वर्शन है. ध्यान दें कि ticket को SubmitJobRequest स्ट्रक्चर (लाइन 8) से जोड़ा गया है. साथ ही, प्रिंट किए जाने वाले डेटा को एक ब्लोब (लाइन 10) में बदल दिया गया है. प्रिंटर का आईडी (पहली लाइन) पाना, सैंपल में यहां दिखाए गए तरीके से ज़्यादा मुश्किल है.

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'
    });
  }
};

browser.printing.submitJob(submitJobRequest, (response) => {
  if (response !== undefined) {
    console.log(response.status);
  }
  if (browser.runtime.lastError !== undefined) {
    console.log(browser.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() पर कॉल करें और "finishings/11" का "display_name" देखें.

"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
  },
  ...
  ]
}

chrome.printing.cancelJob(
  jobId: string,
): Promise<void>

chrome.printing.getJobStatus(
  jobId: string,
): Promise<JobStatus>

chrome.printing.getPrinterInfo(
  printerId: string,
): Promise<GetPrinterInfoResponse>

chrome.printing.getPrinters(): Promise<Printer[]>

chrome.printing.submitJob(
  request: SubmitJobRequest,
): Promise<SubmitJobResponse>

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