API: Print to AirPrint Printer

Allows you to trigger print requests to an AirPrint-enabled printer.

Requirements

• 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
  • AirPrint > Enable AirPrint = On
• Physical Hardware
  • AirPrint-enabled printer. iOS/iPadOS device must be on the same WiFi network as the printer. For more information about Airprint-enabled printers currently available and how to set up AirPrint, click here.

Triggers via API Functions

Check if AirPrint is Enabled

Supported in:

This function determines whether printing to AirPrint printers is enabled in Kiosk Pro's settings.

kp_AirPrinter_requestStateOfSupporting();
		

Check the Status of the Selected Printer

Supported in:

This function determines the connection status of the AirPrint printer Kiosk Pro is connected to in Automatic Kiosk Print Mode.

kp_AirPrinter_checkStatusOfSelectedPrinter(callback);
		

callback(statusCode)
		

Print Current Page

Supported in:

This function initiates printing of the current webpage or document.

kp_AirPrinter_print();
		

Print PDF

Supported in:

This function initiates printing of the referenced PDF file.

kp_AirPrinter_printPdf(filename);
		

Print HTML String

Supported in:

This function initiates printing of an HTML string.

kp_AirPrinter_printHTMLString(string);
		

Notifications via API Callbacks

When Print Job Completes

Supported in:

This callback is triggered when a print job is sent to a connected AirPrinter and no error is returned.

kp_AirPrinter_printDidFinish();
		

Note

This callback may be triggered without actually printing if a job is accepted and stored in the printer's print queue without returning an error to the app. For example, the Brother AirPrint printer we use for internal testing will accept print jobs even if it is out of paper and save them until new paper is added, at which point it will move ahead with printing automatically. As this may vary depending on the printer manufacturer, testing may be required with your specific printer set-up to determine how these types of errors are handled.

When Print Job Fails

Supported in:

This callback is triggered when visitor cancels printing or an error has occurred.

kp_AirPrinter_printDidFailWithErrorEx(error);
		

Note

If the printer cannot print, but still accepts the print job successfully, no error is returned. For example, the Brother Airprint printer we use for internal testing will accept print jobs even if it is out of paper and save them until new paper is added, at which point it will move ahead with printing automatically; in this case, no error is returned by the printer and so we are unable to trigger this callback. As this may vary depending on the printer manufacturer, testing may be required with your specific printer set-up to determine when an error callback can be returned.

When PDF To Be Printed Cannot Be Opened

Supported in:

This callback is triggered when the PDF file named in kp_AirPrinter_printPdf cannot be successfully opened.

kp_AirPrinter_openPdfDidFailWithError(errDescription, errDomain, errCode);
		

Errors are returned directly from Apple's Foundation framework. For more information on specific error codes that can be returned, click here.

When Enable State Changes

Supported in:

This callback is triggered when your code calls kp_AirPrinter_requestStateOfSupporting and each time the app is launched or an administrative user changes Kiosk Pro's settings.

kp_AirPrinter_stateOfSupportingDidChange(supported);