MutatePriority
-
Cmn
enum MutatePriority : Enum
Priorities for performing mutation on state.
MutatePriority values follow the natural ordering of enum class values; a value that compares as > to another has a higher priority. A mutation of equal or greater priority will interrupt the current mutation in progress.
Summary
Enum Values |
|
|---|---|
Default |
The default priority for mutations. |
PreventUserInput |
A high-priority mutation that can only be interrupted by other |
UserInput |
An elevated priority for mutations meant for implementing direct user interactions. |
Public functions |
||
|---|---|---|
MutatePriority |
Returns the enum constant of this type with the specified name. |
Cmn
|
Array<MutatePriority> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Cmn
|
Public properties |
||
|---|---|---|
EnumEntries<MutatePriority> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
Cmn
|
Enum Values
Default
val MutatePriority.Default: MutatePriority
The default priority for mutations. Can be interrupted by other Default, UserInput or PreventUserInput priority operations. Default priority should be used for programmatic animations or changes that should not interrupt user input.
PreventUserInput
val MutatePriority.PreventUserInput: MutatePriority
A high-priority mutation that can only be interrupted by other PreventUserInput priority operations. PreventUserInput priority should be used for operations that user input should not be able to interrupt.
UserInput
val MutatePriority.UserInput: MutatePriority
An elevated priority for mutations meant for implementing direct user interactions. Can be interrupted by other UserInput or PreventUserInput priority operations.
Public functions
valueOf
fun valueOf(value: String): MutatePriority
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.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<MutatePriority>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Public properties
entries
val entries: EnumEntries<MutatePriority>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.