chrome.printing

Importante: Questa API funziona solo su ChromeOS.

Descrizione

Utilizza l'API chrome.printing per inviare processi di stampa alle stampanti installate su Chromebook.

Autorizzazioni

printing

Disponibilità

Chrome 81 e versioni successive Solo ChromeOS

Tutti i metodi e gli eventi chrome.printing richiedono di dichiarare l'autorizzazione "printing" nel manifest dell'estensione. Ad esempio:

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

Esempi

Gli esempi riportati di seguito mostrano l'utilizzo di ciascuno dei metodi nello spazio dei nomi di stampa. Questo codice viene copiato o basato su api-samples/printing nel repository GitHub extensions-samples.

cancelJob()

In questo esempio viene utilizzato il gestore onJobStatusChanged per nascondere un "annullamento" quando jobStatus non è né PENDING né IN_PROGRESS. Tieni presente che su alcune reti o quando un Chromebook è collegato direttamente alla stampante, questi stati potrebbero passare troppo velocemente prima che il pulsante Annulla sia visibile per un tempo sufficiente a essere chiamato. Questo è un esempio di stampa molto semplificato.

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()

Per queste funzioni viene utilizzato un singolo esempio perché il recupero delle informazioni sulla stampante richiede un ID stampante, che viene recuperato chiamando getPrinters(). Questo esempio registra il nome e la descrizione della stampante predefinita nella console. Questa è una versione semplificata dell'esempio di stampa.

​​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()

Il metodo submitJob() richiede tre cose.

• Una struttura ticket che specifica le funzionalità della stampante da utilizzare. Se l'utente deve scegliere tra le funzionalità disponibili, puoi recuperarle per una stampante specifica utilizzando getPrinterInfo().
• Una struttura SubmitJobRequest, che specifica la stampante da utilizzare e il file o la data da stampare. Questa struttura contiene un riferimento alla struttura ticket.
• Un blob del file o dei dati da stampare.

La chiamata di submitJob() attiva una finestra di dialogo che chiede all'utente di confermare la stampa. Usa PrintingAPIExtensionsAllowlist per ignorare la conferma.

Questa è una versione semplificata dell'esempio di stampa. Nota che ticket è collegato alla struttura SubmitJobRequest (riga 8) e che i dati da stampare vengono convertiti in un blob (riga 10). Trovare l'ID della stampante (riga 1) è più complicato nell'esempio di quello mostrato qui.

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

Stampa in rotolo

Questo esempio mostra come creare un ticket per la stampa continua (o in rotolo), che viene spesso utilizzato con la stampa di ricevute. L'oggetto submitJobRequest per la stampa in rotolo è lo stesso mostrato per l'esempio submitJob().

Se devi modificare il valore predefinito per il taglio della carta, utilizza il tasto vendor_ticket_item. (l'impostazione predefinita varia a seconda della stampante). Per modificare il valore, fornisci un array con un membro: un oggetto il cui id è 'finishings'. Il valore può essere 'trim' per le stampanti che tagliano il rotolo al termine della stampa o 'none' per le stampanti che richiedono la rimozione del processo di stampa.

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

Alcune stampanti non supportano l'opzione "finishings". Per determinare se la tua stampante funziona, chiama getPrinterInfo() e cerca un "display_name" di "finishings/11".

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

Nota: a partire da Chrome 124, vendor_ticket_item consente tutti gli elementi dal file vendor_capabilities della stampante. Ad esempio, qualsiasi valore restituito da getPrinterInfo() è valido. In precedenza, era supportata solo la chiave finishings.

I valori nella chiave media_size di un ticket sono specifici per ciascuna stampante. Per selezionare un formato appropriato, chiama getPrinterInfo(). L'elemento GetPrinterResponse restituito contiene un array di dimensioni multimediali supportate in "media_size"."option". Scegli un'opzione il cui valore "is_continuous_feed" sia vero. Utilizza i relativi valori di altezza e larghezza per il ticket.

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

Tipi

GetPrinterInfoResponse

Proprietà

• capabilities

  oggetto facoltativo

  Funzionalità della stampante in formato CDD. La proprietà potrebbe mancare.

• stato

  PrinterStatus

  Lo stato della stampante.

JobStatus

Stato del processo di stampa.

Enum

"IN ATTESA"
Il processo di stampa è stato ricevuto su Chrome, ma non è stato ancora elaborato.

"IN_PROGRESS"
Il processo di stampa viene inviato per la stampa.

"FAILED"
Il processo di stampa è stato interrotto a causa di alcuni errori.

"ANNULLATO"
Il processo di stampa è stato annullato dall'utente o tramite API.

"STAMPATO"
Il processo di stampa è stato stampato senza errori.

Printer

Proprietà

• descrizione

  stringa

  La descrizione leggibile della stampante.

• id

  stringa

  l'identificatore della stampante; l'unicità delle stampanti presenti sul dispositivo.

• isDefault

  booleano

  Il flag che mostra se la stampante soddisfa le regole DefaultPrinterSelection. Tieni presente che potrebbero essere segnalate diverse stampanti.

• nome

  stringa

  Il nome della stampante.

• recentlyUsedRank

  numero facoltativo

  Il valore che mostra quanto di recente è stata utilizzata la stampante per la stampa da Chrome. Più basso è il valore, più recente è stata utilizzata la stampante. Il valore minimo è 0. Il valore mancante indica che la stampante non è stata utilizzata di recente. Garantiamo che questo valore sia univoco tra le stampanti.

• origine

  PrinterSource

  L'origine della stampante (utente o criterio configurato).

• URI

  stringa

  L'URI della stampante. Questa opzione può essere utilizzata dalle estensioni per scegliere la stampante per l'utente.

PrinterSource

L'origine della stampante.

Enum

"UTENTE"
La stampante è stata aggiunta dall'utente.

"POLICY"
La stampante è stata aggiunta tramite le norme.

PrinterStatus

Lo stato della stampante.

Enum

"DOOR_OPEN"
Lo sportello della stampante è aperto. La stampante accetta comunque processi di stampa.

"TRAY_MISSING"
Il vassoio della stampante è mancante. La stampante accetta comunque processi di stampa.

"OUT_OF_INK"
L'inchiostro della stampante è esaurito. La stampante accetta comunque processi di stampa.

"OUT_OF_PAPER"
La stampante ha esaurito la carta. La stampante accetta comunque processi di stampa.

"OUTPUT_FULL"
L'area di uscita della stampante (ad esempio il vassoio) è piena. La stampante accetta comunque processi di stampa.

"PAPER_JAM"
La stampante si è inceppata. La stampante accetta comunque processi di stampa.

"GENERIC_ISSUE"
Alcuni problemi generici. La stampante accetta comunque processi di stampa.

"INTERROMPI"
La stampante è stata arrestata e non riesce a stampare, ma accetta comunque processi di stampa.

"UNREACHABLE"
La stampante non è raggiungibile e non accetta processi di stampa.

"EXPIRED_CERTIFICATE"
Il certificato SSL è scaduto. La stampante accetta i processi, ma non vengono completati.

"AVAILABLE"
La stampante è disponibile.

SubmitJobRequest

Proprietà

• job

  PrintJob

  Il processo di stampa da inviare. L'unico tipo di contenuto supportato è "application/pdf" e Cloud Job Ticket non deve includere i campi FitToPageTicketItem, PageRangeTicketItem, ReverseOrderTicketItem e VendorTicketItem poiché non sono pertinenti per la stampa nativa. Devono essere presenti tutti gli altri campi.

SubmitJobResponse

Proprietà

• jobId

  stringa facoltativo

  L'ID del processo di stampa creato. Si tratta di un identificatore univoco tra tutti i processi di stampa sul dispositivo. Se lo stato non è OK, jobId sarà nullo.

• stato

  SubmitJobStatus

  Lo stato della richiesta.

SubmitJobStatus

Lo stato della richiesta submitJob.

Enum

"OK"
La richiesta di processo di stampa inviata è stata accettata.

"USER_REJECTED"
La richiesta di lavoro di stampa inviata è stata rifiutata dall'utente.

Proprietà

MAX_GET_PRINTER_INFO_CALLS_PER_MINUTE

Il numero massimo di chiamate al minuto in cui è possibile chiamare getPrinterInfo.

Valore

20

MAX_SUBMIT_JOB_CALLS_PER_MINUTE

Il numero massimo di chiamate al minuto in cui è possibile chiamare submitJob.

Valore

40

Metodi

cancelJob()

Promesso .

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

Annulla il job inviato in precedenza.

Parametri

• jobId

  stringa

  L'ID del processo di stampa da annullare. Deve essere lo stesso ID ricevuto in SubmitJobResponse.

• callback

  funzione facoltativa

  Il parametro callback ha il seguente aspetto:

  () => void

Resi

• Promesso<void>

  Chrome 100 e versioni successive .

  Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

getPrinterInfo()

Promesso .

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

Restituisce lo stato e le funzionalità della stampante in formato CDD. Se non sono installate stampanti con l'ID specificato, questa chiamata non riesce e restituisce un errore di runtime.

Parametri

• printerId

  stringa

• callback

  funzione facoltativa

  Il parametro callback ha il seguente aspetto:

  (response: GetPrinterInfoResponse) => void

  • risposta

    GetPrinterInfoResponse

Resi

• Promise&lt;GetPrinterInfoResponse&gt;

  Chrome 100 e versioni successive .

  Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

getPrinters()

Promesso .

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

Restituisce l'elenco delle stampanti disponibili sul dispositivo. Sono incluse le stampanti aggiunte manualmente, aziendali e rilevate.

Parametri

• callback

  funzione facoltativa

  Il parametro callback ha il seguente aspetto:

  (printers: Printer[]) => void

  • stampanti

    Stampante[]

Resi

• Prometti<Stampante[]>

  Chrome 100 e versioni successive .

  Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

submitJob()

Promesso .

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

Invia il lavoro per la stampa. Se l'estensione non è elencata nel criterio PrintingAPIExtensionsAllowlist, all'utente viene chiesto di accettare il processo di stampa. Prima di Chrome 120, questa funzione non restituiva una promessa.

Parametri

• richiesta

  SubmitJobRequest

• callback

  funzione facoltativa

  Il parametro callback ha il seguente aspetto:

  (response: SubmitJobResponse) => void

  • risposta

    SubmitJobResponse

Resi

• Promise&lt;SubmitJobResponse&gt;

  Chrome 100 e versioni successive .

  Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

Eventi

onJobStatusChanged

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

Evento generato quando viene modificato lo stato del job. Viene attivato solo per i job creati da questa estensione.

Parametri

• callback

  funzione

  Il parametro callback ha il seguente aspetto:

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

  • jobId

    stringa

  • stato

    JobStatus