opticonnect sdk/com.opticon.opticonnect.sdk.api.scanner_settings.interfaces/Formatting

Formatting

Interface defining methods for formatting options such as preambles, prefixes, suffixes, and postambles. These methods allow setting, clearing, and configuring formatting using direct input keys or strings.

Functions

clearAllPrefixes

abstract suspend fun clearAllPrefixes(deviceId: String): CommandResponse

Clears the prefix formatting on the device.

abstract fun clearAllPrefixes(deviceId: String, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of clearAllPrefixes for Java interoperability.

clearAllSuffixes

abstract suspend fun clearAllSuffixes(deviceId: String): CommandResponse

Clears the suffix formatting on the device.

abstract fun clearAllSuffixes(deviceId: String, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of clearAllSuffixes for Java interoperability.

clearPostamble

abstract suspend fun clearPostamble(deviceId: String): CommandResponse

Clears the postamble formatting on the device.

abstract fun clearPostamble(deviceId: String, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of clearPostamble for Java interoperability.

clearPreamble

abstract suspend fun clearPreamble(deviceId: String): CommandResponse

Clears the preamble formatting on the device.

abstract fun clearPreamble(deviceId: String, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of clearPreamble for Java interoperability.

setPostambleFromKeys

abstract suspend fun setPostambleFromKeys(deviceId: String, keys: List<DirectInputKey>): CommandResponse

Sets the postamble formatting using a list of DirectInputKey.

abstract fun setPostambleFromKeys(deviceId: String, keys: List<DirectInputKey>, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of setPostambleFromKeys for Java interoperability.

setPostambleFromString

abstract suspend fun setPostambleFromString(deviceId: String, postamble: String): CommandResponse

Sets the postamble formatting using a string.

abstract fun setPostambleFromString(deviceId: String, postamble: String, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of setPostambleFromString for Java interoperability.

setPreambleFromKeys

abstract suspend fun setPreambleFromKeys(deviceId: String, keys: List<DirectInputKey>): CommandResponse

Sets the preamble formatting using a list of DirectInputKey.

abstract fun setPreambleFromKeys(deviceId: String, keys: List<DirectInputKey>, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of setPreambleFromKeys for Java interoperability.

setPreambleFromString

abstract suspend fun setPreambleFromString(deviceId: String, preamble: String): CommandResponse

Sets the preamble formatting using a string.

abstract fun setPreambleFromString(deviceId: String, preamble: String, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of setPreambleFromString for Java interoperability.

setPrefixFromKeys

abstract suspend fun setPrefixFromKeys(deviceId: String, keys: List<DirectInputKey>, symbology: FormattableSymbology = FormattableSymbology.ALL_CODES): CommandResponse

Sets the prefix formatting using a list of DirectInputKey.

abstract fun setPrefixFromKeys(deviceId: String, keys: List<DirectInputKey>, symbology: FormattableSymbology, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of setPrefixFromKeys for Java interoperability.

setPrefixFromString

abstract suspend fun setPrefixFromString(deviceId: String, prefix: String, symbology: FormattableSymbology = FormattableSymbology.ALL_CODES): CommandResponse

Sets the prefix formatting using a string.

abstract fun setPrefixFromString(deviceId: String, prefix: String, symbology: FormattableSymbology, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of setPrefixFromString for Java interoperability.

setSuffixFromKeys

abstract suspend fun setSuffixFromKeys(deviceId: String, keys: List<DirectInputKey>, symbology: FormattableSymbology = FormattableSymbology.ALL_CODES): CommandResponse

Sets the suffix formatting using a list of DirectInputKey.

abstract fun setSuffixFromKeys(deviceId: String, keys: List<DirectInputKey>, symbology: FormattableSymbology, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of setSuffixFromKeys for Java interoperability.

setSuffixFromString

abstract suspend fun setSuffixFromString(deviceId: String, suffix: String, symbology: FormattableSymbology = FormattableSymbology.ALL_CODES): CommandResponse

Sets the suffix formatting using a string.

abstract fun setSuffixFromString(deviceId: String, suffix: String, symbology: FormattableSymbology, callback: (Result<CommandResponse>) -> Unit)

Callback-based version of setSuffixFromString for Java interoperability.