SettingsReadWrite 類別 參考文件

支持讀取和寫入打印機設置。 更多...

#include <SettingsReadWrite.h>

類別SettingsReadWrite的繼承圖:

實體方法
(instancetype)	- initWithTcpComm:usingDataPort:
	使用已打開的 TcpComm 連接初始化 SettingsReadWrite 實例。
(instancetype)	- initWithBtComm:usingDataPort:
	使用 BtComm 連接初始化 SettingsReadWrite 實例。
(instancetype)	- initWithBleComm:usingDataPort:
	使用 BleComm 連接初始化 SettingsReadWrite 實例。
(instancetype)	- initWithJsonComm:
	使用給定的 JSON 通信對象初始化一個新實例。
(instancetype)	- initWithCommDescriptor:
	創建由 SDK 管理的連接時調用的構造函數。
(NSDictionary< NSString *, NSString * > *)	- getAllValuesWithTimeout:
	讀取所有設置的鍵/值對。
(NSString *)	- getValueForKey:timeout:
	讀取與給定鍵關聯的設置。
(NSDictionary< NSString *, NSString * > *)	- getValuesForKeys:timeout:
	讀取與給定鍵列表關聯的多個設置。
(BOOL)	- setValue:forKey:timeout:
	寫入與給定鍵關聯的設置值。
(BOOL)	- setValues:timeout:
	寫入與給定鍵關聯的多個設置。
(Setting *)	- getPropertiesForKey:timeout:
	讀取與給定鍵關聯的屬性。
(NSDictionary< NSString *, Setting * > *)	- getPropertiesForKeys:timeout:
	讀取與多個鍵關聯的屬性。
(NSDictionary< NSString *, Setting * > *)	- getAllPropertiesWithTimeout:
	讀取所有設置為 Setting 對象。

詳細描述

支持讀取和寫入打印機設置。

有關有效鍵和值的列表，請參閱：Settings Key/Value Items。

方法文件

getAllPropertiesWithTimeout:

- (NSDictionary< NSString *, Setting * > *) getAllPropertiesWithTimeout:

(int)

timeout

讀取所有設置為 Setting 對象。

在 SettingsReadWrite 中實現。

參數

timeout

等待的最長時間（毫秒）。

傳回值

包含所有鍵及其相應屬性的字典。

getAllValuesWithTimeout:

- (NSDictionary< NSString *, NSString * > *) getAllValuesWithTimeout:

(int)

timeout

讀取所有設置的鍵/值對。

在 SettingsReadWrite 中實現。

參數

timeout

等待的最長時間（毫秒）。

傳回值

包含所有設置鍵及其相應值的字典。

getPropertiesForKey:timeout:

- (Setting *) getPropertiesForKey:		(NSString *)	key
timeout:		(int)	timeout

讀取與給定鍵關聯的屬性。

在 SettingsReadWrite 中實現。

參數

key	要獲取屬性的鍵。
timeout	等待的最長時間（毫秒）。

傳回值

包含指定鍵屬性的 Setting 對象。

getPropertiesForKeys:timeout:

- (NSDictionary< NSString *, Setting * > *) getPropertiesForKeys:		(NSArray< NSString * > *)	keys
timeout:		(int)	timeout

讀取與多個鍵關聯的屬性。

在 SettingsReadWrite 中實現。

參數

keys	要獲取屬性的鍵數組。
timeout	等待的最長時間（毫秒）。

傳回值

包含指定鍵及其相應屬性的字典。

getValueForKey:timeout:

- (NSString *) getValueForKey:		(NSString *)	key
timeout:		(int)	timeout

讀取與給定鍵關聯的設置。

在 SettingsReadWrite 中實現。

參數

key	要獲取值的鍵。
timeout	等待的最長時間（毫秒）。

傳回值

與指定鍵關聯的值。

getValuesForKeys:timeout:

- (NSDictionary< NSString *, NSString * > *) getValuesForKeys:		(NSArray< NSString * > *)	keys
timeout:		(int)	timeout

讀取與給定鍵列表關聯的多個設置。

在 SettingsReadWrite 中實現。

參數

keys	要獲取值的鍵數組。
timeout	等待的最長時間（毫秒）。

傳回值

包含指定鍵及其相應值的字典。

initWithBleComm:usingDataPort:

- (instancetype) initWithBleComm:		(BleComm *)	connection
usingDataPort:		(BOOL)	usingDataPort

使用 BleComm 連接初始化 SettingsReadWrite 實例。

參數

connection	BLE（低功耗藍牙）通信對象。
usingDataPort	是否使用資料埠進行通訊。

傳回值

一個初始化的 SettingsReadWrite 實例，如果無法創建對象，則返回 nil。

initWithBtComm:usingDataPort:

- (instancetype) initWithBtComm:		(BtComm *)	connection
usingDataPort:		(BOOL)	usingDataPort

使用 BtComm 連接初始化 SettingsReadWrite 實例。

參數

connection	藍牙通信對象。
usingDataPort	是否使用資料埠進行通訊。

傳回值

一個初始化的 SettingsReadWrite 實例，如果無法創建對象，則返回 nil。

initWithCommDescriptor:

- (instancetype) initWithCommDescriptor:

(NSString *)

commDescriptor

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

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

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

例如 "127.0.0.1" 或 "127.0.0.1:3007"

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

參數

commDescriptor

通信描述符。

傳回值

一個初始化的 SettingsReadWrite 實例，如果無法創建對象，則返回 nil。

initWithJsonComm:

- (instancetype) initWithJsonComm:

(JsonComm *)

mgmtComm

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

參數

mgmtComm

JSON 通信對象。

傳回值

一個初始化的 SettingsReadWrite 實例，如果無法創建對象，則返回 nil。

initWithTcpComm:usingDataPort:

- (instancetype) initWithTcpComm:		(TcpComm *)	connection
usingDataPort:		(BOOL)	usingDataPort

使用已打開的 TcpComm 連接初始化 SettingsReadWrite 實例。

如果監聽來自打印機的非請求消息，該連接必須保持打開狀態。 發送/接收打印機狀態消息需要連接。

參數

connection	TCP 通信對象。
usingDataPort	是否使用資料埠進行通訊。

傳回值

一個初始化的 SettingsReadWrite 實例，如果無法創建對象，則返回 nil。

setValue:forKey:timeout:

- (BOOL) setValue:		(NSString *)	value
forKey:		(NSString *)	key
timeout:		(int)	timeout

寫入與給定鍵關聯的設置值。

如果寫入成功，則返回 YES。

注意：要作為字串處理的值應加引號。 例如，value = SomeString 和 value = "SomeString" 將按接收到的內容發送，但印表機可能會以不同方式處理。

在 SettingsReadWrite 中實現。

參數

value	要設置的值。
key	要設置值的鍵。
timeout	等待的最長時間（毫秒）。

傳回值

如果值已成功設置，則返回 YES；否則返回 NO。

setValues:timeout:

- (BOOL) setValues:		(NSDictionary< NSString *, NSString * > *)	keysToSet
timeout:		(int)	timeout

寫入與給定鍵關聯的多個設置。

如果寫入成功，則返回 YES。

注意：要作為字串處理的值應加引號。 例如，value = SomeString 和 value = "SomeString" 將按接收到的內容發送，但印表機可能會以不同方式處理。

在 SettingsReadWrite 中實現。

參數

keysToSet	包含要設置的鍵和值的字典。
timeout	等待的最長時間（毫秒）。

傳回值

如果值已成功設置，則返回 YES；否則返回 NO。

---

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

• /Users/bob_huang/Documents/Project/sdk_json_Objective-C_IOS/sdk_json_Objective-C_IOS/Json/SettingsReadWrite.h