All Implemented Interfaces:

java.io.Serializable , live.hms.video.events.IAnalyticsPropertiesProvider
```
public final class HMSException
extends Exception implements IAnalyticsPropertiesProvider
                    
```
This class contains the error codes and messages that may arise when calling any API of HMS SDK

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`description`
`private final Integer`	`code`
`private final String`	`name`
`private final String`	`action`
`private final String`	`message`
`private Boolean`	`isTerminal`
`private final Throwable`	`cause`

Constructor Summary

Constructors
Constructor	Description
`HMSException(Integer code, String name, String action, String message, String description, Throwable cause, Boolean isTerminal, HashMap<String, Object> params)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getDescription()`
`final Integer`	`getCode()`	The error code by which this error can be identified with
`final String`	`getName()`	The error name by which can be shown to user in UI
`final String`	`getAction()`	Action denotes the category which resulted in this error (Not so useful for UI)
`String`	`getMessage()`	The error message describing the error which can be shown on the UI
`final Boolean`	`isTerminal()`	This denotes if the SDK has cleaned up the connection due to this error or not.
`final Unit`	`setTerminal(Boolean isTerminal)`	This denotes if the SDK has cleaned up the connection due to this error or not.
`HashMap<String, Object>`	`toAnalyticsProperties()`
`String`	`toString()`

Methods inherited from class kotlin.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HMSException
```
HMSException(Integer code, String name, String action, String message, String description, Throwable cause, Boolean isTerminal, HashMap<String, Object> params)
```
- Method Detail
  - getDescription
```
 final String getDescription()
```
  - getCode
```
 final Integer getCode()
```
    The error code by which this error can be identified with
  - getName
```
 final String getName()
```
    The error name by which can be shown to user in UI
  - getAction
```
 final String getAction()
```
    Action denotes the category which resulted in this error (Not so useful for UI)
  - getMessage
```
 String getMessage()
```
    The error message describing the error which can be shown on the UI
  - isTerminal
```
 final Boolean isTerminal()
```
    This denotes if the SDK has cleaned up the connection due to this error or not. UI show show a notification or dialog according to this. If this is true it denotes that this error has removed user from the room else it denotes that user is still in the room even with this error
  - setTerminal
```
 final Unit setTerminal(Boolean isTerminal)
```
    This denotes if the SDK has cleaned up the connection due to this error or not. UI show show a notification or dialog according to this. If this is true it denotes that this error has removed user from the room else it denotes that user is still in the room even with this error
  - toAnalyticsProperties
```
 HashMap<String, Object> toAnalyticsProperties()
```
  - toString
```
 String toString()
```

Class HMSException

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class kotlin.Throwable

Methods inherited from class java.lang.Object

Constructor Detail

HMSException

Method Detail

getDescription

getCode

getName

getAction

getMessage

isTerminal

setTerminal

toAnalyticsProperties

toString