UniPRT SDK  v1.0.0.0
UniPRT.Sdk.Json.JsonStringBuilder Class Reference

Support for building JSON messages sent to printer. More...

Static Public Member Functions

static string CreateMsgFrame (string fromId, string trackId, string command, string content="", string toId="")
 Create JSON object message frame without checking for required fields.
 
static string CreateMsgFrame_Json (string fromId, string trackId, string command, string content="", string toId="", bool usingDataPort=false)
 Create JSON object message that can be sent to printer. More...
 
static string GetRandomId_Json ()
 Returns random integer simply used to make sure each msg has unique ID. Use this to identify any msgs that will be sent infrequent. More...
 
static string GetRandomObjectId_Json ()
 Returns random integer in case want to use a dedicated object ID that can also be used to send/receive json messages with that ID as "TrackNo". More...
 

Static Public Attributes

static string DataPortPrefix = "!PTR_SETUP" + Environment.NewLine + "UPMC" + Environment.NewLine
 
static string DataPortSuffix = "PTR_END" + Environment.NewLine
 
const int MAX_RAND_MSG_ID = 4_000_000
 Max. ID that will be randomly generated when calling GetRandomId() that can be used for IDs sent on solicited msgs.
 
const int MAX_RAND_OBJ_ID = 6_000_000
 Max. ID that will be randomly generated when calling GetRandomObjectId().
Useful for classes/objects that want to use an "object id" for their solicited msgs.
 
const int MIN_RAND_MSG_ID = 1
 Min. ID that will be randomly generated when calling GetRandomId() that can be used for IDs sent on solicited msgs.
 
const int MIN_RAND_OBJ_ID = 4_000_001
 Min. ID that will be randomly generated when calling GetRandomObjectId().
Useful for classes/objects that want to use an "object id" for their solicited msgs.
 

Detailed Description

Support for building JSON messages sent to printer.

Member Function Documentation

◆ CreateMsgFrame_Json()

static string UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json ( string  fromId,
string  trackId,
string  command,
string  content = "",
string  toId = "",
bool  usingDataPort = false 
)
static

Create JSON object message that can be sent to printer.

fromId: required identifier of sender. Note this is used to route responses. This should be unique to each class/Object sending messages.
trackId: required identifier that can be used to track messages within the class/object sending the message. command: required command value content: optional content value. This could be a JSON object. Note that no check is made to ensure proper JSON format. \r
Note that since content could be a JSON object or a string, caller responsible for adding quotes if sending a JSON string value toId: optional identifier to differentiate intended recipient.

◆ GetRandomId_Json()

static string UniPRT.Sdk.Json.JsonStringBuilder.GetRandomId_Json ( )
static

Returns random integer simply used to make sure each msg has unique ID. Use this to identify any msgs that will be sent infrequent.

Random values returned between range MIN_RAND_MSG_ID and MAX_RAND_MSG_ID

◆ GetRandomObjectId_Json()

static string UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json ( )
static

Returns random integer in case want to use a dedicated object ID that can also be used to send/receive json messages with that ID as "TrackNo".

Random values returned between range MIN_RAND_OBJ_ID and MAX_RAND_OBJ_ID
Use this if intent is to assign a msg id to an object for sending/receiving msgs. e.g. Object to send/receive ODV or RFID only msgs to/from printer