Used for storing inter-fragment state and data during a session, this view model is designed to work within the scope of an activity and the fragments that pertain to a single session, hence if working directly with this class it is necessary to acquire it through the activity's androidx.lifecycle.ViewModelProvider.

NavigationAction

sealed class NavigationAction

The navigation action that was unable to be performed.

NavigationError

data class NavigationError @JvmOverloads constructor(val action: NavigationAction, val navigationErrorInfo: NavigationErrorInfo? = null)

Returned if there was an unsuccessful attempt to navigate to a destination.

NavigationErrorInfo

data class NavigationErrorInfo(val exception: Exception, val fragmentClass: Class<Fragment>, val hashCode: Int)

Metadata about the fragment that encountered a NavigationError.

NfcMrz1LineManualEntryFragment

class NfcMrz1LineManualEntryFragment : Fragment

A prebuilt screen for manually entering a 1 Line MRZ.

NfcMrzDataManualEntryFragment

class NfcMrzDataManualEntryFragment : Fragment

A prebuilt screen for manually entering a 3 Line MRZ.

NfcReaderFragment

class NfcReaderFragment : Fragment

A prebuilt screen for starting a NFC session.

NfcSelectionFragment

class NfcSelectionFragment : Fragment

A prebuilt screen for selecting which type of document to begin a NFC session. If MiSnapSettings.Nfc.mrz is set then the session will automatically begin, otherwise the user will be prompted to select which type of document they have and to manually enter its MRZ.

ReviewFragment

class ReviewFragment : Fragment

A prebuilt screen for reviewing the image returned from a session.

VoicePhraseSelectionFragment

class VoicePhraseSelectionFragment : Fragment

A pre-built screen for selecting a password phrase for the MiSnapSettings.Voice.Flow.ENROLLMENT flow from the default list of password phrases. If MiSnapSettings.Voice.phrase is set the voice session will automatically start.

VoiceProcessorFragment

class VoiceProcessorFragment : Fragment

A pre-built screen for starting voice recording and analysis.