UniPRT SDK v1.0.0.0
 
載入中...
搜尋中...
無符合項目
PrinterMonitor 類別 參考文件

模塊用於方便監聽/檢索打印機的非請求消息或檢索打印機狀態/信息。 更多...

#include <PrinterMonitor.h>

類別PrinterMonitor的繼承圖:

公開型態

typedef void(^ EngineStatusCallback) (NSString *newEngineState)
 引擎狀態更改的回調類型。
 
typedef void(^ DisplayStatusCallback) (NSArray< NSString * > *panelText)
 顯示狀態更改的回調類型。
 
typedef void(^ AlertStatusCallback) (NSArray< NSString * > *alertText)
 警報狀態更改的回調類型。
 

實體方法

(instancetype) - initWithTcpComm:
 使用給定的 TCP 通信對象初始化一個新實例。
 
(instancetype) - initWithJsonComm:
 使用給定的 JSON 通信對象初始化一個新實例。
 
(instancetype) - initWithCommDescriptor:
 創建由 SDK 管理的連接時調用的構造函數。
 
(PrinterInfo *) - getPrinterInfo
 獲取打印機信息。
 
(NSString *) - getEngineStatus
 查詢打印機的引擎狀態。
 
(NSArray< NSString * > *) - getFaultStatus
 查詢打印機的故障狀態。
 
(void) - SetEngineStatusListening:
 設置是否啟用引擎狀態監聽。
 
(void) - SetDisplayStatusListening:
 設置是否啟用顯示狀態監聽。
 
(void) - SetAlertStatusListening:
 設置是否啟用警報狀態監聽。
 

屬性(properties)

BOOL engineStatusListening
 啟用/禁用監聽/解析打印機發送的非請求引擎狀態。
 
BOOL displayStatusListening
 啟用/禁用監聽/解析打印機發送的非請求前面板顯示文本。
 
BOOL alertStatusListening
 啟用/禁用監聽/解析打印機發送的非請求故障狀態警報。
 
EngineStatusCallback engineStatusCallback
 當從打印機接收到引擎狀態時調用的函數。函數必須符合 EngineStatusNotice 的簽名。
 
DisplayStatusCallback displayStatusCallback
 當從打印機接收到顯示文本消息時調用的函數。函數必須符合 DisplayStatusNotice 的簽名。
 
AlertStatusCallback alertStatusCallback
 當從打印機接收到故障/警報消息時調用的函數。函數必須符合 AlertStatusNotice 的簽名。
 

詳細描述

模塊用於方便監聽/檢索打印機的非請求消息或檢索打印機狀態/信息。

如果在打印機上啟用了非請求消息,則可以隨時發送。該模塊需要與打印機的管理端口保持恆定的連接,以便監聽打印機發送的任何消息。

型態定義成員說明文件

◆ AlertStatusCallback

- AlertStatusCallback

警報狀態更改的回調類型。

參數
alertText新的警報文本。

◆ DisplayStatusCallback

- DisplayStatusCallback

顯示狀態更改的回調類型。

參數
panelText新的面板文本。

◆ EngineStatusCallback

- EngineStatusCallback

引擎狀態更改的回調類型。

參數
newEngineState新的引擎狀態。

方法文件

◆ getEngineStatus

- (NSString *) getEngineStatus

查詢打印機的引擎狀態。

引擎狀態用於檢查打印機在發送打印作業之前是否處於可打印狀態。

返回的字符串可以是 "fault", "idle", "offline", "pause", "printing", "present"(標籤存在)中的任何一個。

實現在 PrinterMonitor 中。

傳回值
表示引擎狀態的字符串。

◆ getFaultStatus

- (NSArray< NSString * > *) getFaultStatus

查詢打印機的故障狀態。

故障狀態用於檢查打印機是否處於需要注意的故障狀態,或者可能會阻止處理任何打印作業。

返回的警報字符串數組表示打印機在 alert[0] 處發送的警報編號以及 alert[1] 處的簡短描述。

例如,"2418" 表示一個 "Print Head Open" 警報。alert[0] = "2418"; alert[1] = "Print Head Open";

實現在 PrinterMonitor 中。

傳回值
表示故障狀態的字符串數組。

◆ getPrinterInfo

- (PrinterInfo *) getPrinterInfo

獲取打印機信息。

適用於需要檢查型號、固件版本、安裝選項和其他硬件特定詳細信息的情況。

實現在 PrinterMonitor 中。

傳回值
包含打印機信息的 PrinterInfo 對象。

◆ initWithCommDescriptor:

- (instancetype) initWithCommDescriptor: (NSString *) commDescriptor

創建由 SDK 管理的連接時調用的構造函數。

commDescriptor 是用於連接打印機的通信描述符。

TCP 描述符格式:"ip" 或 "ip:port"

例如 "127.0.0.1" 或 "127.0.0.1:3007"

如果未提供端口,則使用默認值。

參數
commDescriptor通信描述符。
傳回值
一個初始化的 PrinterMonitor 實例,如果無法創建對象,則返回 nil。

◆ initWithJsonComm:

- (instancetype) initWithJsonComm: (JsonComm *) mgmtComm

使用給定的 JSON 通信對象初始化一個新實例。

參數
mgmtCommJSON 通信對象。
傳回值
一個初始化的 PrinterMonitor 實例,如果無法創建對象,則返回 nil。

◆ initWithTcpComm:

- (instancetype) initWithTcpComm: (TcpComm *) connection

使用給定的 TCP 通信對象初始化一個新實例。

參數
connectionTCP 通信對象。
傳回值
一個初始化的 PrinterMonitor 實例,如果無法創建對象,則返回 nil。

◆ SetAlertStatusListening:

- (void) SetAlertStatusListening: (BOOL) value

設置是否啟用警報狀態監聽。

參數
valueYES 表示啟用監聽,NO 表示禁用。

◆ SetDisplayStatusListening:

- (void) SetDisplayStatusListening: (BOOL) value

設置是否啟用顯示狀態監聽。

參數
valueYES 表示啟用監聽,NO 表示禁用。

◆ SetEngineStatusListening:

- (void) SetEngineStatusListening: (BOOL) value

設置是否啟用引擎狀態監聽。

參數
valueYES 表示啟用監聽,NO 表示禁用。

屬性(property)說明文件

◆ alertStatusCallback

- (AlertStatusCallback) alertStatusCallback
readwritenonatomiccopy

當從打印機接收到故障/警報消息時調用的函數。函數必須符合 AlertStatusNotice 的簽名。

◆ alertStatusListening

- (BOOL) alertStatusListening
readwritenonatomicassign

啟用/禁用監聽/解析打印機發送的非請求故障狀態警報。

請注意,必須啟用此功能才能接收來自打印機的任何通知(AlertStatusCallback)。

◆ displayStatusCallback

- (DisplayStatusCallback) displayStatusCallback
readwritenonatomiccopy

當從打印機接收到顯示文本消息時調用的函數。函數必須符合 DisplayStatusNotice 的簽名。

◆ displayStatusListening

- (BOOL) displayStatusListening
readwritenonatomicassign

啟用/禁用監聽/解析打印機發送的非請求前面板顯示文本。

請注意,必須啟用此功能才能接收來自打印機的任何通知(DisplayStatusCallback)。

◆ engineStatusCallback

- (EngineStatusCallback) engineStatusCallback
readwritenonatomiccopy

當從打印機接收到引擎狀態時調用的函數。函數必須符合 EngineStatusNotice 的簽名。

◆ engineStatusListening

- (BOOL) engineStatusListening
readwritenonatomicassign

啟用/禁用監聽/解析打印機發送的非請求引擎狀態。

請注意,必須啟用此功能才能接收來自打印機的任何通知(EngineStatusCallback)。


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