APA POS SDK/com.abrantix.apa.sdk/TerminalState

TerminalState

enum TerminalState : Enum<TerminalState>

Local connection/shift lifecycle state, as tracked by Terminal.getState and reported to Terminal.Builder.onStateChanged.

DISCONNECTED -> CONNECTING
CONNECTING   -> DEACTIVATED | ACTIVATED | DISCONNECTED
DEACTIVATED  -> ACTIVATED | DISCONNECTED
ACTIVATED    -> DEACTIVATED | DISCONNECTED

Entries

DISCONNECTED

Initial state, and the state after Terminal.disconnect.

CONNECTING

Terminal.connect is verifying the access token and terminal reachability.

DEACTIVATED

Connected, but the shift is closed - the terminal reports Deactivated.

ACTIVATED

Connected and the shift is open - the terminal reports Activated/InProgress.

Properties

entries

val entries: EnumEntries<TerminalState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): TerminalState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TerminalState>

Returns an array containing the constants of this enum type, in the order they're declared.