You are here:
This section describes the APIs that are used for the print series.
Required Editions
| Available in Lightning Experience in Professional, Unlimited, and Enterprise Editions that have Consumer Goods Cloud enabled |
- printerClearQueue()
Use this function to remove all items and database entries from the queue. This function can move items from a failed to a new state. - printerEnablePrinterQueue()
Use this function to enable or disable the queuing mechanism in the printer engine. You can set or reset this function by passing either true or false in the parameter. - printerGetPrintStatus()
Use this function to retrieve the status of the last Print command. - printerGetQueueStatus()
Use this function to fetch the current status of queuing by specifying whether it’s enabled or disabled. - printerPrint(Name,reportData,numCopies)
Use this function to print all the items in the queue if the queuing mechanism is enabled. If the mechanism is disabled, this function requires the same parameters asprintToPrint()and prints any report that is passed. It goes through the database table and retrieves one report at a time for queuing. - printerReprint()
Use this function to reprint all the items or just failed items in the queue based on thereprintAllparameter. - printerUpdateQueue(Name,reportData,numCopies)
Use this function to either add a new report to the queue, remove any report from the queue, or modify the number of copies of any existing report. This function creates a database table if the table does not exist and adds, modifies, or deletes an entry for each report in the database.
Did this article solve your issue?
Let us know so we can improve!

