workflow/com.miteksystems.misnap.workflow.fragment/NfcReaderFragment/Companion

Companion

Functions

fun buildFragmentArguments(@DrawableRes scanInstructionsSearchingDrawableId: Int? = null, @DrawableRes scanInstructionsReadingDrawableId: Int? = null, @DrawableRes scanInstructionsSuccessDrawableId: Int? = null, @DrawableRes scanInstructionsFailureDrawableId: Int? = null, @StringRes scanInstructionsTextId: Int? = null, shouldShowFailoverPopup: Boolean? = null, skipVisibilityTimeout: Int? = null, handleOrientation: Boolean? = null): Bundle

Formats an arguments object for this fragment to use with Fragment.setArguments.

buildWorkflowSettings

@JvmStatic

@JvmOverloads

fun buildWorkflowSettings(@DrawableRes scanInstructionsSearchingDrawableId: Int? = null, @DrawableRes scanInstructionsReadingDrawableId: Int? = null, @DrawableRes scanInstructionsSuccessDrawableId: Int? = null, @DrawableRes scanInstructionsFailureDrawableId: Int? = null, @StringRes scanInstructionsTextId: Int? = null, shouldShowFailoverPopup: Boolean? = null, skipVisibilityTimeout: Int? = null, handleOrientation: Boolean? = null): String

Formats an encoded workflow settings JSON string for this fragment to use with MiSnapSettings.Workflow.add.

getDefaultWorkflowSettings

@JvmStatic

@JvmOverloads

fun getDefaultWorkflowSettings(settings: MiSnapSettings? = null, context: Context? = null): NfcReaderFragment.WorkflowSettings

Gets the default values used as workflow params on this fragment.

Properties

HANDLE_ORIENTATION

const val HANDLE_ORIENTATION: String

Boolean attribute for toggling the orientation handling on this fragment. When turned on the fragment will do its best to adjust the parent activity to the configured orientation while it's being used and revert it back to the original orientation once its gone.

SCAN_INSTRUCTIONS_FAILURE_DRAWABLE_ID

const val SCAN_INSTRUCTIONS_FAILURE_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the nfc failure step.

SCAN_INSTRUCTIONS_READING_DRAWABLE_ID

const val SCAN_INSTRUCTIONS_READING_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the nfc reading step.

SCAN_INSTRUCTIONS_SEARCHING_DRAWABLE_ID

const val SCAN_INSTRUCTIONS_SEARCHING_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the nfc searching step.

SCAN_INSTRUCTIONS_SUCCESS_DRAWABLE_ID

const val SCAN_INSTRUCTIONS_SUCCESS_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the nfc success step.

SCAN_INSTRUCTIONS_TEXT_ID

const val SCAN_INSTRUCTIONS_TEXT_ID: String

Integer attribute for providing the string resource id for the nfc instructions text.

SHOULD_SHOW_FAILOVER_POPUP

const val SHOULD_SHOW_FAILOVER_POPUP: String

Boolean attribute for providing the whether or not the failover pop up should be displayed when there's an error.

SKIP_VISIBILITY_TIMEOUT

const val SKIP_VISIBILITY_TIMEOUT: String

Integer attribute for providing the duration of the reading session until showing the skip button in milliseconds.