API: Check Enabled Printers

Check with printer is enabled in Kiosk Pro's settings. This API is useful if your kiosk deployment uses multiple types of printers and you want to be able to print to any of them without creating duplicate pieces of content.

Requirements

Kiosk Pro Enterprise

  • Integration of our JavaScript API into your webpage
    • Sample code to run within the app and download for integration into your own project is available here.
    • Best practices for working with the JavaScript API are available here.
  • App Settings
    • Content > JavaScript API > Access JavaScript API > By Import
    • Printing > only one printer toggle enabled


Triggers via API Functions

Check Enabled Printer

This function checks to see which printer is enabled in the app settings. Note: this function will only return one printer type. This cannot be used if more than one printer is enabled.

Format
kp_CommonPrintingAPI_requestEnabledPrinterType(callback);
		
Parameters callback - [string] the name of the callback to be triggered after the function has been executed
Callback format
callback(type);
		
Callback return values
  • type - [array] contains the following values:
    • printerType - [integer] represents the printer type that is enabled. Possible values are:
      • 1 - Airprint Printer
      • 2 - Star Micronics Printer
      • 3 - Bixolon Printer
    • printerTypeDescription - [string] the name of the printer type that is enabled


Sample Code

  • This sample code relies on the JavaScript APIs built into Kiosk Pro and will not run successfully in other browsers or within our in-app help interface.
  • To run sample code, set the app's homepage to https://kioskgroup.com/printer-type-api
  • To download a .zip of sample code, click here.

Change Log

  • Added in version 10.0.

Still stuck? How can we help? How can we help?