chrome.printing

ब्यौरा

अनुमतियां

उपलब्धता

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

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

उदाहरण

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

cancelJob()

यह उदाहरण 'cancel' को छिपाने के लिए 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() and 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() तरीके के लिए तीन चीज़ों की ज़रूरत होती है.

• 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 बटन का इस्तेमाल करें. (अलग-अलग प्रिंटर के लिए, डिफ़ॉल्ट सेटिंग अलग-अलग होती है.) वैल्यू बदलने के लिए, एक सदस्य वाला कलेक्शन उपलब्ध कराएं: वह ऑब्जेक्ट जिसका 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,
  callback?: function,
)

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

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

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

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