chrome.printing

ब्यौरा

अनुमतियां

उपलब्धता

मेनिफ़ेस्ट

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

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

उदाहरण

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

रद्द करें जॉब()

इस उदाहरण में, 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()

इन फ़ंक्शन के लिए एक उदाहरण का इस्तेमाल किया गया है, क्योंकि प्रिंटर की जानकारी पाने के लिए प्रिंटर आईडी ज़रूरी है, जिसे 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() वाले तरीके के लिए तीन चीज़ों की ज़रूरत होती है.

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

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

यह प्रिंटिंग के उदाहरण का आसान वर्शन है. ध्यान दें कि ticket, SubmitJobRequest स्ट्रक्चर (लाइन 8) से जुड़ा होता है और प्रिंट किए जाने वाले डेटा को ब्लॉब (लाइन 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,
)