Skip to main content

ARDK for Android/com.nianticlabs.ardk/ScanSaveState

ScanSaveState

[androidJvm]
enum ScanSaveState : Enum<ScanSaveState>

Enumeration of possible scan recording save states.

This enum represents the current state of a scan recording operation, indicating whether the scan data has been successfully saved, discarded, or failed.

Entries​

NOT_AVAILABLE[androidJvm]
NOT_AVAILABLE
Save state is not available
DISCARDED[androidJvm]
DISCARDED
Recording was discarded
SAVED[androidJvm]
SAVED
Recording was saved successfully
FAILED_TO_SAVE[androidJvm]
FAILED_TO_SAVE
Recording failed to save

Types​

NameSummary
Companion[androidJvm]
object Companion

Properties​

NameSummary
entries[androidJvm]
val entries: EnumEntries<ScanSaveState>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
name[androidJvm]
val name: String
ordinal[androidJvm]
val ordinal: Int
value[androidJvm]
val value: Int

Functions​

NameSummary
valueOf[androidJvm]
fun valueOf(value: String): ScanSaveState
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[androidJvm]
fun values(): Array<ScanSaveState>
Returns an array containing the constants of this enum type, in the order they're declared.