Error Handling

When you make an API call to access an HMS SDK, the SDK may return error codes. ErrorCodes are returned when a problem that cannot be recovered without app intervention has occurred.

These are returned as HMSException in the onError callback of the HMSUpdateListner.

Errors that need to be handled

While the number of possible errors is large, the handling is very concise.

The errors for general sdk features are self-explanatory, here we will list only the core handling needed for the join and preview methods. You don't need to handle specific errors, just categories of isTerminal or not.

Here's a typical example of a join method with only the error handling methods:

hmsSDK.join(hmsConfig, object : HMSUpdateListener {

            override fun onError(error: HMSException) {
                // Show a different dialog if error is terminal else a dismissible dialog
                if (error.isTerminal) {
                    // The meeting cannot continue, display the error and return to your previous screen.
                    
                    // 1. Hide the progress bar that you were showing for a join call.
                    // 2. You may choose to give a retry button that will attempt the join again.
                } else {
                    // The meeting can continue, there may be temporary issues.
                    // The SDK will recover from these automatically.
                    // Only inform the user that it's happening.
                    
                    // 1. `error.message` may be shown to the user.
                }
            }

            // Show UI for temporary disconnections and if the sdk could reconnect.
            // If there was a permanent failure, it will be sent in `onError`.
            override fun onReconnecting() {}
            override fun onReconnected() {}
}

Preview

The same handling can be applied for the onError method of the HMSPreviewListener.

Others

Permissions handling has also been simplified and you may look at how to handle those here.

Index

Following are the different error codes that are returned by the SDK . Before returning any error code, SDK retries the errors(whichever is possible).