Skip to main content

Result Screen UI Guide

The Entrupy Android SDK's Result Screen provides immediate feedback to users after they complete the Capture Flow. This optional screen displays the initial status of their authentication submission and can be configured to show or hide based on your application's needs.

Overview​

The Result Screen is a full-screen activity that appears immediately after a successful capture submission. It serves as a bridge between the capture process and the final authentication result, providing users with:

  • Immediate Confirmation: Visual confirmation that their submission was received.
  • Status Information: Current processing status and estimated completion time.
  • Next Steps: Clear guidance on what to expect and how to access results.

Configuring Result Screen Display​

You can control whether the Result Screen appears after capture completion through SDK configuration or method parameters.

Method 1: SDK Configuration​

Set the Result Screen display preference globally for your application:

// Kotlin
import com.entrupy.sdk.EntrupySDK

// Configure the SDK to show/hide the Result Screen after capture
EntrupySDK.getInstance().setShowResultScreenAfterCapture(true) // or false to hide

Method 2: Per-Capture Configuration​

Override the global setting for specific capture sessions:

// Kotlin
// When starting a capture, specify whether to show the Result Screen
val captureOptions = EntrupyCaptureOptions.Builder()
    .setShowResultScreen(true) // or false
    .build()

EntrupySDK.getInstance().startCapture(this, itemMetadata, captureOptions)

Result Screen Content​

The Result Screen displays several key pieces of information:

1. Submission Confirmation​

  • Success Message: Clear indication that the item was successfully submitted.
  • Entrupy ID: The unique identifier for the authentication (may be displayed or accessible).
  • Submission Time: When the item was submitted for processing.

2. Processing Status​

  • Current Status: Real-time status updates (e.g., "Processing", "Analyzing Images").
  • Estimated Time: ETA for completion (e.g., "Estimated completion: 10 minutes").
  • Progress Indicators: Visual progress indicators when available.

3. Next Steps​

  • Access Results: Information on how to view the final authentication result.
  • Detail View: Direct access to the Detail View for the submitted item.
  • Support Information: Contact details or support options if needed.

Customizing the Result Screen​

While the Result Screen provides a standard interface, you can customize certain aspects:

1. Branding and Theming​

The Result Screen respects the same theming configuration as other SDK components. See UI Theme Customization for details on customizing colors, fonts, and other visual elements.

2. Content Customization​

Some content elements can be customized through SDK configuration:

// Kotlin
// Customize Result Screen content
val resultScreenConfig = EntrupyResultScreenConfig.Builder()
    .setCustomSuccessMessage("Your item has been successfully submitted for authentication!")
    .setShowEntrupyId(true) // or false
    .setShowEstimatedTime(true) // or false
    .build()

EntrupySDK.getInstance().setResultScreenConfig(resultScreenConfig)

Result Screen Callbacks​

The Result Screen provides callback methods to handle user interactions:

// Kotlin
class YourActivity : AppCompatActivity(), EntrupyResultScreenCallback {

    // Called when the user taps to view the Detail View for the submitted item
    override fun onViewDetailRequested(entrupyId: String) {
        println("User requested to view details for item: $entrupyId")
        // Launch the Detail View or navigate to your custom detail screen
        EntrupySDK.getInstance().showDetailView(this, entrupyId)
    }

    // Called when the user dismisses the Result Screen
    override fun onResultScreenDismissed(entrupyId: String) {
        println("Result Screen dismissed for item: $entrupyId")
        // Handle dismissal, e.g., return to your app's main flow
        finish() // or navigate to another screen
    }

    // Called when the user requests support for the submitted item
    override fun onSupportRequested(entrupyId: String) {
        println("User requested support for item: $entrupyId")
        // Handle support request, e.g., open support chat or contact form
    }
}

Integration with Detail View​

The Result Screen is designed to seamlessly transition to the Detail View, which provides comprehensive information about the authentication result once processing is complete.

Automatic Transition​

When the authentication result becomes available, the Result Screen can automatically transition to the Detail View:

// Kotlin
// Configure automatic transition to Detail View when results are ready
val resultScreenConfig = EntrupyResultScreenConfig.Builder()
    .setAutoTransitionToDetailView(true) // Automatically show Detail View when results are ready
    .setTransitionDelay(2000L) // Wait 2 seconds before transitioning
    .build()

EntrupySDK.getInstance().setResultScreenConfig(resultScreenConfig)

Manual Transition​

Users can also manually navigate to the Detail View from the Result Screen:

// Kotlin
// Handle manual navigation to Detail View
override fun onViewDetailRequested(entrupyId: String) {
    // Show Detail View for the specific item
    EntrupySDK.getInstance().showDetailView(this, entrupyId)
}

Best Practices​

1. User Experience​

  • Clear Communication: Ensure users understand what happens after submission.
  • Consistent Flow: Maintain a consistent user experience across your app.
  • Accessibility: Follow Android accessibility guidelines for the Result Screen.

2. Performance​

  • Efficient Loading: The Result Screen should load quickly after capture completion.
  • Background Updates: Status updates should occur in the background without blocking the UI.

3. Error Handling​

  • Graceful Degradation: Handle cases where the Result Screen cannot be displayed.
  • Fallback Options: Provide alternative ways to access submission status.

Next Steps​