Error Handling / Debugging

This article explains how errors are returned using the HYPR SDK for Android.

HyprStatusResult is similar to a linked list. Each node represents a level where the error could have occurred. That level is specified by the StatusType.

FIDO_SERVER -> HYPR_SERVER_RP -> HYPR_UI_ADAPTER -> HYPR_USER_AGENT -> FIDO_CLIENT -> FIDO_ASM -> FIDO_AUTHENTICATOR_TLV

HyprStatusResult

Errors are returned back to an activity via the onActivityResult override method inside of HyprStatusResult.
First check to see if the Extra exists in the Intent data returned back to the calling activity from the HYPR Activity launched via a HyprApiActionAdatper method call, then cast to the HyprStatusResult object.
Once you have this object, then you can get the Display Code, Display Text, and other various attributes such as displaying the class toString() which will give an integrating developer the full Error Trace that is required to debug issues.

@Override
protected void onActivityResult(int requestCode,
                                int resultCode,
                                Intent data) {
    if (data != null && data.hasExtra(INTENT_KEY_HYPR_STATUS_RESULT)) {
        HyprStatusResult statusResult = (HyprStatusResult) data.getSerializableExtra(INTENT_KEY_HYPR_STATUS_RESULT);
        if (statusResult != null) {
            // Display Error and Display Text can be shown to the end user
            int displayErrorCode = statusResult.getLowestLevelDisplayCode();
            String displayErrorText = statusResult.getLowestLevelDisplayText();
            // Display the lowest level developer error string
            String developerDebugText = statusResult.getLowestLevelExtraInfo();
            // Display the complete debug log for this Error.
            // This is what developers should use to fully debug issues.
            String developerFullDebugLog = statusResult.toString();
        }
    }
}

Display Codes

The display codes that is returned in HyprStatusResult are listed in the table below.

Display Error Text

The display error text that is returned in HyprStatusResult are listed in the table below.

Android Errors

📘

DEVELOPER ERROR

This error type represents errors which may occur during the SDK integration. They should not be visible to the end user.

Below is a full list of all possible errors returned by HYPR SDK for Android. The table is listed by error code, error string, and display information provided in the SDK.

ADB Logging

ADB Logging can be enabled with an entry in the overrides.xml file located in the following directory in the application project:

<project>/app/src/main/res/values/overrides.xml

<string name="hypr_show_release_log_filter" translatable="false">1</string>

<string name="hypr_show_release_log_filter" translatable="false">131072</string>

<string name="hypr_show_release_log_filter" translatable="false">1048576</string>

To properly diagnose integration issues, it is recommended to set this filter when debugging issues. This will give the full HyprStatusResult error trace logs.

<string name="hypr_show_release_log_filter" translatable="false">4294967295</string>