Parameter/Return Class Information
This documentation provides information on classes provided as parameter values or returned as return values when using BACKND Chat.
ErrorInfo
These are classes that express error information.
| Value | Type | Description |
|---|---|---|
| Category | ErrorCode | ErrorCode category |
| Detail | ErrorCode | ErrorCode details |
| SocketErrorCode | SocketError | Error codes for Socket class |
| Reason | string | Reason for success/failure |
ErrorCode(enum)
| Value | Description |
|---|---|
| Success | Request successful |
| Exception | Error code on occurrence of an unknown internal exception |
| SocketOpertatonError | When the socket task fails |
| AuthenticationFailed | When authentication fails on the chat server |
| BrokenStream | When there is an issue in the transmission/reception stream related to the socket |
| NetworkTimeout | When failing to reconnect after being disconnected from the chat server due to abnormal reasons |
| DisconnectFromLocal | When the SDK disconnects from the chat server due to some reason |
| DisconnectFromRemote | When the chat server disconnects due to some reason |
| InvalidMessage | Invalid message sent or received |
| InvalidOperation | Occurs upon an invalid request |
| InvalidSession | Invalid session error due to an unidentifiable reason in the chat server |
| ChannelTimeOut | Occurs when no chat is entered for a certain period |
| BannedChat | When chat messages are sent N times within a certain period and when a non-admin user uses GlobalChat |
| DuplicateConnection | When a duplicate login occurs |
| NetworkOffline | When temporarily disconnected from the chat server due to abnormal reasons(includes the user and other users) |
| NetworkOnline | When the connection to the chat server is recovered after NetworkOffline(includes the user and other users) |
SessionInfo
These are the classes for the users within a channel.
| Value | Type | Description |
|---|---|---|
| NickName | string | Nickname of the session user |
| IsRemote | bool | remote status(false for my session, true for other user's session) |