UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.Json.ISettingsReadWrite Interface Reference
Inheritance diagram for com.UniPRT.Sdk.Json.ISettingsReadWrite:
com.UniPRT.Sdk.Json.SettingsReadWrite

Public Member Functions

Map< String, SettingGetAllProperties ()
 Read all settings. More...
 
Map< String, String > GetAllValues ()
 Read all settings key/value pairs. More...
 
Map< String, SettingGetProperties (List< String > keys)
 Read setting associated with given key. More...
 
Setting GetProperties (String key)
 Read multiple settings associated with the given list of keys. More...
 
String GetValue (String key)
 Read setting associated with the given key. More...
 
Map< String, String > GetValues (List< String > keys)
 Read multiple settings associated with the given list of keys. More...
 
boolean SetValue (String keyToSet, String valueToSet)
 Write a setting value associated with the given key. More...
 
boolean SetValues (Map< String, String > keysToSet)
 Write multiple settings associated with given keys. More...
 

Member Function Documentation

◆ GetAllProperties()

Map<String, Setting> com.UniPRT.Sdk.Json.ISettingsReadWrite.GetAllProperties ( )

Read all settings.

Implemented in com.UniPRT.Sdk.Json.SettingsReadWrite.

◆ GetAllValues()

Map<String, String> com.UniPRT.Sdk.Json.ISettingsReadWrite.GetAllValues ( )

Read all settings key/value pairs.

Implemented in com.UniPRT.Sdk.Json.SettingsReadWrite.

◆ GetProperties() [1/2]

Map<String, Setting> com.UniPRT.Sdk.Json.ISettingsReadWrite.GetProperties ( List< String >  keys)

Read setting associated with given key.

Implemented in com.UniPRT.Sdk.Json.SettingsReadWrite.

◆ GetProperties() [2/2]

Setting com.UniPRT.Sdk.Json.ISettingsReadWrite.GetProperties ( String  key)

Read multiple settings associated with the given list of keys.

Implemented in com.UniPRT.Sdk.Json.SettingsReadWrite.

◆ GetValue()

String com.UniPRT.Sdk.Json.ISettingsReadWrite.GetValue ( String  key)

Read setting associated with the given key.

Implemented in com.UniPRT.Sdk.Json.SettingsReadWrite.

◆ GetValues()

Map<String, String> com.UniPRT.Sdk.Json.ISettingsReadWrite.GetValues ( List< String >  keys)

Read multiple settings associated with the given list of keys.

Implemented in com.UniPRT.Sdk.Json.SettingsReadWrite.

◆ SetValue()

boolean com.UniPRT.Sdk.Json.ISettingsReadWrite.SetValue ( String  keyToSet,
String  valueToSet 
)

Write a setting value associated with the given key.

Returns true if write is successful. Note: A value intended to be processed as strings should be quoted. e.g., value = SomeString and value = "SomeString" will be sent exactly as received but may be handled differently by the printer.

Implemented in com.UniPRT.Sdk.Json.SettingsReadWrite.

◆ SetValues()

boolean com.UniPRT.Sdk.Json.ISettingsReadWrite.SetValues ( Map< String, String >  keysToSet)

Write multiple settings associated with given keys.

Returns true if write is successful. Note: Values intended to be processed as strings should be quoted. e.g., value = SomeString and value = "SomeString" will be sent exactly as received but may be handled differently by the printer.

Implemented in com.UniPRT.Sdk.Json.SettingsReadWrite.


The documentation for this interface was generated from the following file: