Skip to content

Upgrade guide

This page provides guidance on all changes to the Hive chat API and items that are no longer supported.
Refer to this content to smoothly upgrade your Chat integration to the latest version.

SDK 26.4.0

Changes

  • Adds the new events onConnectStarted and onConnectCompleted. The onConnectStarted and onConnectCompleted events replace the existing Chat.reconnect events onReconnectStarted and onReconnected. When the chat connection is automatically retried, the onConnectStarted and onConnectCompleted events are now delivered.
    • The onConnectStarted event occurs when a chat connection attempt starts.
    • The onConnectCompleted event delivers the result of the chat connection. It returns the connection result as-is whether the chat connection succeeds or fails. Because the onConnectCompleted event replaces the onReconnected event, implement your logic so it performs the appropriate work for chat connection success or failure based on the onConnectCompleted event result.

Unsupported items

  • (Planned deprecation) The reconnect method of the Chat class is not supported.
    • Replace the existing manual reconnection request feature with the Chat.connect method.
  • (Planned deprecation) The onReconnectStarted and onReconnected events are not supported. The lists of channels successfully joined and channels that failed to join previously delivered by the onReconnected event are provided as empty arrays.
  • (Planned deprecation) The onConnected event is not supported. Instead, use the onConnectCompleted event and implement your logic so it handles work when the connection succeeds or fails.
Warning

Features scheduled for deprecation will have support fully removed starting from the next version. Therefore, they are not recommended for use and should be replaced with other features.

Hive SDK 25.8.0

Changes

  • Chat functionality is supported starting from SDK 25.8.0 for the Windows version.
    • Chat functionality is currently not supported on Steam Deck (support planned for the future).

Hive SDK 25.6.0

Changes

  • The channel message retrieval method has changed from fetching the latest messages to fetching messages within a range before and after a specific message ID.
    • A message ID, which uniquely identifies each message object, has been added.
    • The ChannelMessageListQueryParams class has been updated. To maintain previous behavior, set messageId to null and assign the same value to both size and prevSize.


Hive SDK 25.4.0

Changes

  • The following changes have been made to listener events registered via the addConnectionListener method of the Chat class:
    • Added a new onReconnectStarted event. This is triggered when the reconnect API of the Chat class is called or when the chat connection is automatically retried due to internal state changes.
    • The onReconnected event now includes a ResultAPI object containing result information.

Unsupported Items

  • The addDirectMessageListener and removeDirectMessageListener methods of the Chat class are no longer supported. The previous 1:1 message receiving functionality can now be handled using the addUserListener and removeUserListener methods of the Chat class.