UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.Json.IPrinterMonitor Interface Reference
Inheritance diagram for com.UniPRT.Sdk.Json.IPrinterMonitor:
com.UniPRT.Sdk.Json.PrinterMonitor

Public Member Functions

void SetAlertStatusCallback (AlertStatusNotice callback)
 Holds the function to call when fault/alert msgs received from printer. Function must match signature of AlertStatusNotice. More...
 
AlertStatusNotice GetAlertStatusCallback ()
 
void SetAlertStatusListening (boolean listening)
 Enable/disable listening/parsing unsolicited fault status alerts from printer. More...
 
boolean GetAlertStatusListening ()
 
void SetDisplayStatusCallback (DisplayStatusNotice callback)
 Holds the function to call when display text msgs received from printer. Function must match signature of DisplayStatusNotice. More...
 
DisplayStatusNotice GetDisplayStatusCallback ()
 
void SetDisplayStatusListening (boolean listening)
 Enable/disable listening/parsing unsolicited front panel display text from printer. More...
 
boolean GetDisplayStatusListening ()
 
void SetEngineStatusCallback (EngineStatusNotice callback)
 Holds the function to call when engine status received from printer. Function must match signature of EngineStatusNotice. More...
 
EngineStatusNotice GetEngineStatusCallback ()
 
void SetEngineStatusListening (boolean listening)
 Enable/disable listening/parsing unsolicited engine status from printer. More...
 
boolean GetEngineStatusListening ()
 
String GetEngineStatus ()
 Query the printer for the engine status. More...
 
String[] GetFaultStatus ()
 Query the printer for fault status. More...
 
PrinterInfo GetPrinterInfo ()
 Get printer information. More...
 

Member Function Documentation

◆ GetAlertStatusCallback()

AlertStatusNotice com.UniPRT.Sdk.Json.IPrinterMonitor.GetAlertStatusCallback ( )

◆ GetAlertStatusListening()

boolean com.UniPRT.Sdk.Json.IPrinterMonitor.GetAlertStatusListening ( )

◆ GetDisplayStatusCallback()

DisplayStatusNotice com.UniPRT.Sdk.Json.IPrinterMonitor.GetDisplayStatusCallback ( )

◆ GetDisplayStatusListening()

boolean com.UniPRT.Sdk.Json.IPrinterMonitor.GetDisplayStatusListening ( )

◆ GetEngineStatus()

String com.UniPRT.Sdk.Json.IPrinterMonitor.GetEngineStatus ( )

Query the printer for the engine status.

Engine status is useful to check if printer is in a state that can print before sending a print job. The string returned is any of the "fault", "idle", "offline", "pause", "printing", "present" (Label Present).

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.

◆ GetEngineStatusCallback()

EngineStatusNotice com.UniPRT.Sdk.Json.IPrinterMonitor.GetEngineStatusCallback ( )

◆ GetEngineStatusListening()

boolean com.UniPRT.Sdk.Json.IPrinterMonitor.GetEngineStatusListening ( )

◆ GetFaultStatus()

String [] com.UniPRT.Sdk.Json.IPrinterMonitor.GetFaultStatus ( )

Query the printer for fault status.

Fault status is used to check if printer is in a fault state that needs attention or may prevent processing of any print job. The alert string array returned represents the alert number sent by printer at alert[0] and brief description at alert[1]. e.g. "2418" represents a "Print Head Open" alert. alert[0] = "2418"; alert[1] = "Print Head Open";

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.

◆ GetPrinterInfo()

PrinterInfo com.UniPRT.Sdk.Json.IPrinterMonitor.GetPrinterInfo ( )

Get printer information.

Useful for cases where want to check model, firmware version, options installed and other hardware specific details.

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.

◆ SetAlertStatusCallback()

void com.UniPRT.Sdk.Json.IPrinterMonitor.SetAlertStatusCallback ( AlertStatusNotice  callback)

Holds the function to call when fault/alert msgs received from printer. Function must match signature of AlertStatusNotice.

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.

◆ SetAlertStatusListening()

void com.UniPRT.Sdk.Json.IPrinterMonitor.SetAlertStatusListening ( boolean  listening)

Enable/disable listening/parsing unsolicited fault status alerts from printer.

Note that this must be enabled in order to receive any notifications, AlertStatusCallback, from printer.

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.

◆ SetDisplayStatusCallback()

void com.UniPRT.Sdk.Json.IPrinterMonitor.SetDisplayStatusCallback ( DisplayStatusNotice  callback)

Holds the function to call when display text msgs received from printer. Function must match signature of DisplayStatusNotice.

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.

◆ SetDisplayStatusListening()

void com.UniPRT.Sdk.Json.IPrinterMonitor.SetDisplayStatusListening ( boolean  listening)

Enable/disable listening/parsing unsolicited front panel display text from printer.

Note that this must be enabled in order to receive any notifications, DisplayStatusCallback, from printer.

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.

◆ SetEngineStatusCallback()

void com.UniPRT.Sdk.Json.IPrinterMonitor.SetEngineStatusCallback ( EngineStatusNotice  callback)

Holds the function to call when engine status received from printer. Function must match signature of EngineStatusNotice.

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.

◆ SetEngineStatusListening()

void com.UniPRT.Sdk.Json.IPrinterMonitor.SetEngineStatusListening ( boolean  listening)

Enable/disable listening/parsing unsolicited engine status from printer.

Note that this must be enabled in order to receive any notifications, EngineStatusCallback, from printer.

Implemented in com.UniPRT.Sdk.Json.PrinterMonitor.


The documentation for this interface was generated from the following file: