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

Companion

object Companion

Functions

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun buildFragmentArguments(@LayoutRes autoLayoutId: Int? = null, @LayoutRes manualLayoutId: Int? = null, showSkipCheckBox: Boolean? = null, handleOrientation: Boolean? = null): Bundle

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

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun buildWorkflowSettings(@LayoutRes autoLayoutId: Int? = null, @LayoutRes manualLayoutId: Int? = null, showSkipCheckBox: Boolean? = null, handleOrientation: Boolean? = null): String

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

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun getDefaultWorkflowSettings(settings: MiSnapSettings? = null, context: Context? = null, behavior: MiSnapWorkflowStep.Behavior? = null): HelpFragment.WorkflowSettings

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

Properties

Link copied to clipboard
const val AUTO_LAYOUT_ID: String

Integer attribute for providing the tutorial/help layout id when in auto mode.

Link copied to clipboard
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.

Link copied to clipboard
const val MANUAL_LAYOUT_ID: String

Integer attribute for providing the tutorial/help layout id when in manual mode.

Link copied to clipboard
const val SHOW_SKIP_CHECKBOX: String

Boolean attribute for toggling whether the 'skip' checkbox is supported. If the checkbox is supported, it will be displayed and allow users to opt out of seeing the screen on subsequent sessions. If a user navigates to this screen after opting out, it will automatically navigate to its 'continue' destination. If the checkbox is not supported, the checkbox will not be displayed and users will always see the screen.