Class States

Methods for dealing with State.

Hierarchy

SdkModule
- States

Index

Methods

getAll getAllWithoutDefault getById getTopState hasNonDefaultStates

Methods

getAll

getAll(): State[]
Returns State[]
an array of all the states in the WME data model

getAllWithoutDefault

getAllWithoutDefault(): State[]
Returns State[]
an array of all the states apart from default in the WME data model

getById

getById(args: { stateId: number }): null | State
Parameters
- args: { stateId: number }
  - stateId: number
    The id of the state to look for.
Returns null | State
state with id, or null if not found in the WME data model

getTopState

getTopState(): null | State
Returns null | State
the State set to be the top state in the WME data model, or null if none set

hasNonDefaultStates

hasNonDefaultStates(): boolean
Returns boolean
true if there are any states apart from the default state in the WME data model.