PollRequest
Represents a Star CloudPRNT polling request that will be sent by the CloudPRNT device to the server via an http POST.
This object should be created by deserialising a Json request from a CloudPRNT device.
NameSpace: StarMicronics.CloudPrnt.CpMessage
Syntax
public class PollRequest
Properties
barcodeReader
Reports the status of any barcode readers connected to the CloudPRNT device.
Declaration
public BarcodeReaderInfo[] barcodeReader { get; set; }
Property Value
Type |
Description |
|---|---|
clientAction
An array of the CloudPRNT devices replies to any ClientAction requests made in a previous POST response from the server to the device (using a PollResponse object).
Declaration
public ClientActionResult[] clientAction { get; set; }
Property Value
Type |
Description |
|---|---|
DecodedStatus
Returns a PrinterStatus object, decoded from the raw ASB ‘status’ value.
Declaration
public PrinterStatus DecodedStatus { get; }
Property Value
Type |
Description |
|---|---|
display
Reports the status of any displays connected to the CloudPRNT device.
Declaration
public DisplayInfo[] display { get; set; }
Property Value
Type |
Description |
|---|---|
DisplayInfo [] |
keyboard
Reports the status of any keyboards connected to the CloudPRNT device.
Declaration
public KeyboardInfo[] keyboard { get; set; }
Property Value
Type |
Description |
|---|---|
KeyboardInfo [] |
printerMAC
MAC address of the printer or device that submitted this request.
Declaration
public string printerMAC { get; set; }
Property Value
Type |
Description |
|---|---|
System.String |
printingInProgress
Printing in progress will report true if the device is currently handling a print job, and if the device supports version 2 or later of the CloudPRNT specification.
Older generation devices do not report this information.
Declaration
public bool printingInProgress { get; set; }
Property Value
Type |
Description |
|---|---|
System.Boolean |
status
Raw Star ASB format device status.
Declaration
public string status { get; set; }
Property Value
Type |
Description |
|---|---|
System.String |
statusCode
short status summary of the device.
For detailes status please check the ‘status’ or ‘DecodedStatus’ properties.
Declaration
public string statusCode { get; set; }
Property Value
Type |
Description |
|---|---|
System.String |
uniqueID
Server assigned ID of this device, or null if one has not been assigned.
Servers may use a client action request to set this ID.
Declaration
public string uniqueID { get; set; }
Property Value
Type |
Description |
|---|---|
System.String |
Methods
FromJson(String)
Deserizlise valid JSON string data into a PollRequest object.
An exception will be thrown in case of failure, with an inner exception containing the error of the underlying serialization engine (currently Newtonsoft.Json).
Declaration
public static PollRequest FromJson(string pollRequest)
Parameters
Type |
Name |
Description |
|---|---|---|
System.String |
pollRequest |
JSON input |
Returns
Type |
Description |
|---|---|
Deserialized PollRequest object |