Namespace StarMicronics.CloudPrnt.CpMessage

Classes

BarcodeReaderInfo

Information about a Barcode Reader device that is connected to a CloudPRNT client.

ClientActionRequest objects represent a special request from the server to a particular client that is outside of the typical ClOUDPRNT printing/peripheral control flow. Example requests include setting a client side ID, getting the Client type or version. ClientActions are client device specific and optional, not all requests will be supported by all devices, please check the official CloudPRNT specification for your device.

To issue a ClientAction request to a device, first wait for the device to issue a PollRequest to your server via http POST. When preparing the PollResponse response to the device any required ClientActionRequest objects can be added in a list to the PollResponse.clientAction property.

A Client will provide a response/acknowledgement of the ClientActionRequests by including a list of ClientActionResult objects in the PollRequest.clientAction property of a subsequent poll message.

ClientActionResult

Describes the client side result of any ClientActionRequest requests that have been seen to the client device. Note that ClientActionResult values may be provided by the client using any valin JSON type, although typically this is a string. Therefore, two ways are provided to read a ClientActionRequest result:

string Result - A property which returns the result as a string value, if it is available.
Object GetResultObject() - a method which returns the result as a request type specific object (such as PageInfo).

Applications are responsible for determining the correct Object return type of GetResultObject() by checking either the Type or Request properties, snd casting to the correct Object accordingly.

DisplayInfo

Information about a display device that is connected to a CloudPRNT client.

DisplayStatus

Describes the status of a display.

DisplayUpdate

Represents a message to be passed to a display that is conencted to a CloudPRNT client.

KeyboardInfo

Information about a keyboard device that is connected to a CloudPRNT client.

KeyboardStatus

Describes the status of a keyboard.

PageInfo

Represents the result of a "PageInfo" ClientAction request, which askes the client printer device to report details of the installed paper size, printable area and print resolution.

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.

PollResponse

Describes the fields that may be sent to a CloudPRNT compatible device in response to a received PollRequest. This object is intended to be serialised as JSON data, and passed back to CloudPRNT devices via http, in response to receiving a request poll.

Enums

ClientActions

An enumeration of supportec ClientAction request types. These will be converted to/from the corresponding CloudPRNT specification string name as needed. Note that independent CloudPRNT clinets may support additional ClientAction request types that are not available through this enumeration. For example some may offer device specific requests. In this case, please use the ClientActions.Other value, and supply the requires request type as a string.