Chat server connection¶
The Hive SDK chat feature uses WebSocket communication with the Hive chat socket server. Therefore, to use the Hive SDK chat feature, you must first refer to the guide below to connect to the Hive chat socket server.
Connection request¶
To connect to the chat, call the connect
method of the Chat
class.
Here is an example code that requests a chat connection.
Warning
Hive SDK chat feature can only be used by users (including guest accounts) who have logged in using the Hive SDK authentication feature and have been issued a PlayerID
.
Reconnection request¶
Note
In the case of a temporary network disconnection or (iOS only) during the transition between background and foreground, the SDK will automatically attempt to reconnect to the network once.
If the chat socket server connection is disconnected due to network conditions, you can request a chat reconnection. If you request a reconnection within 10 minutes after the chat socket server disconnection, it will attempt to automatically join the channel you were previously participating in. The result of the reconnection request will return a list of channels that were successfully joined and a list of channels that failed to join.
When requesting a chat reconnection, call the reconnect
method of the Chat
class. Here is an example code for requesting a chat reconnection.
Disconnection request¶
To disconnect the chat, call the Chat class's disconnect()
method. Below is an example code for disconnecting the chat connection.
Note
The chat disconnection request is automatically executed when the app user account logs out.
Check connection status¶
Checks if the app user is currently connected to the chat. Calls the Chat class isConnected
method.
Here is an example code to check the chat connection status.
Connection event management¶
The Hive chat socket server detects the connection status and continuously delivers status change events to the app. For detailed event handling methods, please refer to the Event Management > Connection Events document.