UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.Json.JsonStringBuilder 類別 參考文件

支援建立發送到打印機的 JSON 訊息 更多...

靜態公開方法(Static Public Methods)

static String CreateMsgFrame_Json (String fromId, String trackId, String command, String content, String toId, boolean usingDataPort)
 Create JSON object message that can be sent to printer. 更多...
 
static String CreateMsgFrame_Json (String fromId, String trackId, String command, String content, String toId)
 
static String CreateMsgFrame_Json (String fromId, String trackId, String command, String content)
 
static String CreateMsgFrame_Json (String fromId, String trackId, String command)
 
static String CreateMsgFrame (String fromId, String trackId, String command, String content, String toId)
 Create JSON object message that can be sent to printer. 更多...
 
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. 更多...
 
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". 更多...
 

靜態公開屬性

static final String DataPortPrefix = "!PTR_SETUP\nUPMC\n"
 
static final String DataPortSuffix = "PTR_END\n"
 
static final int MIN_RAND_MSG_ID = 1
 呼叫 GetRandomId() 時會隨機生成的最小 ID,可用於發送請求讯息的 ID。 更多...
 
static final int MAX_RAND_MSG_ID = 4_000_000
 呼叫 GetRandomId() 時會隨機生成的最大 ID,可用於發送請求讯息的 ID。 更多...
 
static final int MIN_RAND_OBJ_ID = 4_000_001
 呼叫 GetRandomObjectId() 時會隨機生成的最小 ID。
適用於想要用「物件 ID」來發送請求讯息的類別/物件。 更多...
 
static final int MAX_RAND_OBJ_ID = 6_000_000
 呼叫 GetRandomObjectId() 時會隨機生成的最大 ID。
適用於想要用「物件 ID」來發送請求讯息的類別/物件。 更多...
 

靜態私有屬性

static final Random rand = new Random()
 

詳細描述

支援建立發送到打印機的 JSON 訊息

函式成員說明文件

◆ CreateMsgFrame()

static String com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame ( String  fromId,
String  trackId,
String  command,
String  content,
String  toId 
)
static

Create JSON object message that can be sent to printer.

fromId:必填,發送者的標識符。請注意,這是用來路由回應的,應該對每個發送訊息的類別/物件唯一。
trackId:必填,可用來跟蹤訊息的標識符。
command:必填,命令值。
content:選填,內容值。可以是 JSON 物件。請注意,沒有檢查是否為正確的 JSON 格式。
請注意,由於 content 可以是 JSON 物件或字串,發送字串時由呼叫者負責添加引號。 toId:選填,區分目標接收者的標識符。

被參考於 com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), 及 com.UniPRT.Sdk.Mgmt.MgmtMsg.toString().

◆ CreateMsgFrame_Json() [1/4]

static String com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json ( String  fromId,
String  trackId,
String  command 
)
static

◆ CreateMsgFrame_Json() [2/4]

static String com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json ( String  fromId,
String  trackId,
String  command,
String  content 
)
static

◆ CreateMsgFrame_Json() [3/4]

static String com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json ( String  fromId,
String  trackId,
String  command,
String  content,
String  toId 
)
static

◆ CreateMsgFrame_Json() [4/4]

static String com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json ( String  fromId,
String  trackId,
String  command,
String  content,
String  toId,
boolean  usingDataPort 
)
static

Create JSON object message that can be sent to printer.

fromId:必填,發送者的標識符。請注意,這是用來路由回應的,應該對每個發送訊息的類別/物件唯一。
trackId:必填,可用來跟蹤訊息的標識符。
command:必填,命令值。
content:選填,內容值。可以是 JSON 物件。請注意,沒有檢查是否為正確的 JSON 格式。
請注意,由於 content 可以是 JSON 物件或字串,發送字串時由呼叫者負責添加引號。 toId:選填,區分目標接收者的標識符。

參考 com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame(), com.UniPRT.Sdk.Json.JsonStringBuilder.DataPortPrefix, 及 com.UniPRT.Sdk.Json.JsonStringBuilder.DataPortSuffix.

被參考於 com.UniPRT.Sdk.Json.JsonStringBuilder.CreateMsgFrame_Json(), com.UniPRT.Sdk.Json.SettingsReadWrite.GetAllProperties(), com.UniPRT.Sdk.Json.SettingsReadWrite.GetAllValues(), com.UniPRT.Sdk.Settings.Configs.GetConfig(), com.UniPRT.Sdk.Json.PrinterMonitor.GetEngineStatus(), com.UniPRT.Sdk.Json.PrinterMonitor.GetFaultStatus(), com.UniPRT.Sdk.Json.PrinterMonitor.GetPrinterInfo(), com.UniPRT.Sdk.Json.SettingsReadWrite.GetProperties(), com.UniPRT.Sdk.Json.SettingsReadWrite.GetValue(), com.UniPRT.Sdk.Json.SettingsReadWrite.GetValues(), com.UniPRT.Sdk.Mgmt.Messenger.SendMsg(), com.UniPRT.Sdk.Json.PrinterMonitor.SetAlertStatusListening(), com.UniPRT.Sdk.Settings.Configs.SetConfig(), com.UniPRT.Sdk.Json.PrinterMonitor.SetDisplayStatusListening(), com.UniPRT.Sdk.Json.PrinterMonitor.SetEngineStatusListening(), com.UniPRT.Sdk.Json.OdvMonitor.SetOdvReportListening(), com.UniPRT.Sdk.Json.RfidMonitor.SetRfidReportListening(), com.UniPRT.Sdk.Json.SettingsReadWrite.SetValue(), 及 com.UniPRT.Sdk.Json.SettingsReadWrite.SetValues().

◆ GetRandomId_Json()

◆ GetRandomObjectId_Json()

static String com.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".

隨機值在 MIN_RAND_OBJ_ID 和 MAX_RAND_OBJ_ID 之間返回。
如果希望為物件分配訊息 ID 以發送/接收訊息時,使用此選項。例如:物件向/從打印機發送/接收 ODV 或 RFID 訊息。

參考 com.UniPRT.Sdk.Json.JsonStringBuilder.MAX_RAND_OBJ_ID, com.UniPRT.Sdk.Json.JsonStringBuilder.MIN_RAND_OBJ_ID, 及 com.UniPRT.Sdk.Json.JsonStringBuilder.rand.

被參考於 com.UniPRT.Sdk.Mgmt.Messenger.Messenger(), com.UniPRT.Sdk.Json.OdvMonitor.OdvMonitor(), com.UniPRT.Sdk.Json.PrinterMonitor.PrinterMonitor(), 及 com.UniPRT.Sdk.Json.RfidMonitor.RfidMonitor().

資料成員說明文件

◆ DataPortPrefix

final String com.UniPRT.Sdk.Json.JsonStringBuilder.DataPortPrefix = "!PTR_SETUP\nUPMC\n"
static

◆ DataPortSuffix

final String com.UniPRT.Sdk.Json.JsonStringBuilder.DataPortSuffix = "PTR_END\n"
static

◆ MAX_RAND_MSG_ID

final int com.UniPRT.Sdk.Json.JsonStringBuilder.MAX_RAND_MSG_ID = 4_000_000
static

呼叫 GetRandomId() 時會隨機生成的最大 ID,可用於發送請求讯息的 ID。

被參考於 com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomId_Json().

◆ MAX_RAND_OBJ_ID

final int com.UniPRT.Sdk.Json.JsonStringBuilder.MAX_RAND_OBJ_ID = 6_000_000
static

呼叫 GetRandomObjectId() 時會隨機生成的最大 ID。
適用於想要用「物件 ID」來發送請求讯息的類別/物件。

被參考於 com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json().

◆ MIN_RAND_MSG_ID

final int com.UniPRT.Sdk.Json.JsonStringBuilder.MIN_RAND_MSG_ID = 1
static

呼叫 GetRandomId() 時會隨機生成的最小 ID,可用於發送請求讯息的 ID。

被參考於 com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomId_Json().

◆ MIN_RAND_OBJ_ID

final int com.UniPRT.Sdk.Json.JsonStringBuilder.MIN_RAND_OBJ_ID = 4_000_001
static

呼叫 GetRandomObjectId() 時會隨機生成的最小 ID。
適用於想要用「物件 ID」來發送請求讯息的類別/物件。

被參考於 com.UniPRT.Sdk.Json.JsonStringBuilder.GetRandomObjectId_Json().

◆ rand

final Random com.UniPRT.Sdk.Json.JsonStringBuilder.rand = new Random()
staticprivate

此類別(class) 文件是由下列檔案中產生: