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

Companion

Functions

fun buildFragmentArguments(@DrawableRes guideViewDrawableId: Int? = null, guideViewAlignedScalePercentage: Float? = null, guideViewUnalignedScalePercentage: Float? = null, guideViewShowVignette: Boolean? = null, @DrawableRes manualButtonDrawableId: Int? = null, manualButtonVisible: Boolean? = null, timeoutDuration: Int? = null, @DrawableRes torchViewOnDrawableId: Int? = null, @DrawableRes torchViewOffDrawableId: Int? = null, hintDuration: Int? = null, @AnimRes hintAnimationId: Int? = null, hintViewShouldShowBackground: Boolean? = null, hintViewInitialHintDelay: Int? = null, @DrawableRes recordingIconDrawableId: Int? = null, @AnimRes recordingIconAnimationId: Int? = null, @DrawableRes helpButtonDrawableId: Int? = null, @DrawableRes successViewMessageDrawableId: Int? = null, @AnimRes successViewMessageAnimationId: Int? = null, @DrawableRes successViewBackgroundDrawableId: Int? = null, successViewShouldVibrate: Boolean? = null, successViewSoundUri: String? = null, misnapViewShouldShowBoundingBox: Boolean? = null, misnapViewShouldShowGlareBox: Boolean? = null, reviewCondition: DocumentAnalysisFragment.ReviewCondition? = null, handleOrientation: Boolean? = null, shouldShowDocumentLabel: Boolean? = null, @StringRes documentLabelStringId: Int? = null, shouldShowCancelButton: Boolean? = null, @DrawableRes cancelButtonDrawableId: Int? = null): Bundle

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

buildWorkflowSettings

@JvmStatic

@JvmOverloads

fun buildWorkflowSettings(@DrawableRes guideViewDrawableId: Int? = null, guideViewAlignedScalePercentage: Float? = null, guideViewUnalignedScalePercentage: Float? = null, guideViewShowVignette: Boolean? = null, @DrawableRes manualButtonDrawableId: Int? = null, manualButtonVisible: Boolean? = null, timeoutDuration: Int? = null, @DrawableRes torchViewOnDrawableId: Int? = null, @DrawableRes torchViewOffDrawableId: Int? = null, hintDuration: Int? = null, @AnimRes hintAnimationId: Int? = null, hintViewShouldShowBackground: Boolean? = null, hintViewInitialHintDelay: Int? = null, @DrawableRes recordingIconDrawableId: Int? = null, @AnimRes recordingIconAnimationId: Int? = null, @DrawableRes helpButtonDrawableId: Int? = null, @DrawableRes successViewMessageDrawableId: Int? = null, @AnimRes successViewMessageAnimationId: Int? = null, @DrawableRes successViewBackgroundDrawableId: Int? = null, successViewShouldVibrate: Boolean? = null, successViewSoundUri: String? = null, misnapViewShouldShowBoundingBox: Boolean? = null, misnapViewShouldShowGlareBox: Boolean? = null, reviewCondition: DocumentAnalysisFragment.ReviewCondition? = null, handleOrientation: Boolean? = null, shouldShowDocumentLabel: Boolean? = null, @StringRes documentLabelStringId: Int? = null, shouldShowCancelButton: Boolean? = null, @DrawableRes cancelButtonDrawableId: Int? = 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): DocumentAnalysisFragment.WorkflowSettings

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

Properties

CANCEL_BUTTON_DRAWABLE_ID

const val CANCEL_BUTTON_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the cancel button.

DOCUMENT_LABEL_STRING_ID

const val DOCUMENT_LABEL_STRING_ID: String

Integer attribute for providing the string resource id for the document label.

GUIDE_VIEW_ALIGNED_SCALE_PERCENTAGE

const val GUIDE_VIEW_ALIGNED_SCALE_PERCENTAGE: String

Float attribute for providing the percentage of the screen width that the guide view takes up. This value is for when the document and the device are aligned, use GUIDE_VIEW_UNALIGNED_SCALE_PERCENTAGE for specifying the width when they are opposite.

GUIDE_VIEW_DRAWABLE_ID

const val GUIDE_VIEW_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the guide view.

GUIDE_VIEW_SHOW_VIGNETTE

const val GUIDE_VIEW_SHOW_VIGNETTE: String

Boolean attribute for displaying a vignette around the guide view.

GUIDE_VIEW_UNALIGNED_SCALE_PERCENTAGE

const val GUIDE_VIEW_UNALIGNED_SCALE_PERCENTAGE: String

Float attribute for providing the percentage of the screen width that the guide view takes up. This value is for when the document and device are not aligned, use GUIDE_VIEW_ALIGNED_SCALE_PERCENTAGE for specifying the width when they are the same.

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.

HELP_BUTTON_DRAWABLE_ID

const val HELP_BUTTON_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the help button.

HINT_ANIMATION_ID

const val HINT_ANIMATION_ID: String

Integer attribute for providing the animation resource id for showing hint messages.

HINT_DURATION

const val HINT_DURATION: String

Integer attribute for providing the duration of each hint to the user in milliseconds.

HINT_VIEW_INITIAL_HINT_DELAY

const val HINT_VIEW_INITIAL_HINT_DELAY: String

Integer attribute for providing an initial hint delay time in milliseconds for the HintView, no hint messages are displayed while the delay is active.

HINT_VIEW_SHOW_BACKGROUND

const val HINT_VIEW_SHOW_BACKGROUND: String

Boolean attribute for showing a background color for hint messages

MANUAL_BUTTON_DRAWABLE_ID

const val MANUAL_BUTTON_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the manual button.

MANUAL_BUTTON_VISIBLE

const val MANUAL_BUTTON_VISIBLE: String

Boolean attribute for determining if the manual button will be shown.

MISNAP_VIEW_SHOW_BOUNDING_BOX

const val MISNAP_VIEW_SHOW_BOUNDING_BOX: String

Boolean attribute for if the camera should display on screen the detected bounding box of the document or not.

MISNAP_VIEW_SHOW_GLARE_BOX

const val MISNAP_VIEW_SHOW_GLARE_BOX: String

Boolean attribute for if the camera should display on screen the detected glare box of the document or not.

RECORDING_ICON_ANIMATION_ID

const val RECORDING_ICON_ANIMATION_ID: String

Integer attribute for providing the animation resource id for the recording icon.

RECORDING_ICON_DRAWABLE_ID

const val RECORDING_ICON_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the for the recording icon.

REVIEW_CONDITION

const val REVIEW_CONDITION: String

ReviewCondition attribute for controlling when to navigate to the review screen.

SHOW_CANCEL_BUTTON

const val SHOW_CANCEL_BUTTON: String

Boolean attribute for toggling the visibility of the cancel button. When turned on a cancel button will be displayed, pressing this button is equivalent to pressing the back button in the device.

SHOW_DOCUMENT_LABEL

const val SHOW_DOCUMENT_LABEL: String

Boolean attribute for toggling the visibility of the document label. When turned on a text view will be displayed on the screen to indicate the document type that is expected during the session, e.g. "Check front".

SUCCESS_VIEW_BACKGROUND_DRAWABLE_ID

const val SUCCESS_VIEW_BACKGROUND_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the success view's background. If not provided the success view will use the returned image as background.

SUCCESS_VIEW_MESSAGE_ANIMATION_ID

const val SUCCESS_VIEW_MESSAGE_ANIMATION_ID: String

Integer attribute for providing the animation resource id for the success view's message.

SUCCESS_VIEW_MESSAGE_DRAWABLE_ID

const val SUCCESS_VIEW_MESSAGE_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the success view's message.

SUCCESS_VIEW_SHOULD_VIBRATE

const val SUCCESS_VIEW_SHOULD_VIBRATE: String

Boolean attribute for if the device should vibrate when the success view starts.

SUCCESS_VIEW_SOUND_URI

const val SUCCESS_VIEW_SOUND_URI: String

String attribute for providing the URI path to a sound file that the success view will play when starting. Null will play the default camera shutter sound, while an empty string will play no sound.

TIMEOUT_DURATION

const val TIMEOUT_DURATION: String

Integer attribute for providing the duration of the session until timeout in milliseconds.

TORCH_VIEW_OFF_DRAWABLE_ID

const val TORCH_VIEW_OFF_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the for the torch view when its state is OFF.

TORCH_VIEW_ON_DRAWABLE_ID

const val TORCH_VIEW_ON_DRAWABLE_ID: String

Integer attribute for providing the drawable resource id for the torch view when its state is ON.