Release notes
The Agora Signaling SDK provides a streamlined and stable messaging mechanism for you to quickly implement real-time messaging for various scenarios. See product overview for more information.
This page contains information on the following releases:
v2.1.7
v2.1.7 was released on November 17, 2023.
v2.1.6
v2.1.6 was released on September 18, 2023.
Compatibility changes
If you use the features mentioned in this section, ensure that you modify the implementation of the relevant features after upgrading the SDK.
-
Multiple connection region settings
To support setting multiple connection regions simultaneously, this release changes the parameter type of
areaCode
fromRtmAreaCode
toEnumSet<RtmAreaCode>
. Refer to the following sample code to update your implementation: -
RTMConfig
Constructor optimizationThis release changes the constructor pattern of
RTMConfig
to the builder pattern. Refer to the following sample code to update your implementation: -
Callback name changes
This release changes the name of the
onConnectionStateChange
callback toonConnectionStateChanged
.
New features
-
Multiple ways to add event listeners
This release adds the
addEventListener
andremoveEventListener
methods. In addition to adding or removing an event listener object during initialization, you can also call the new methods to add or remove one or more event listener objects at any time during the app's lifecycle.Furthermore, to enhance the experience of setting event listeners, this release no longer requires implementing all events of the
RtmEventListener
. You only need to implement the events that you need. See the following sample code: -
New struct constructors
This release adds the constructor for the following structs:
JoinChannelOptions
JoinTopicOptions
MetadataItem
MetadataOptions
GetOnlineUsersOptions
RtmEncryptionConfig
RtmLogConfig
RtmProxyConfig
StateItem
SubscribeOptions
TopicOptions
You can continue using the previous implementation, or refer to the following sample code to update your implementation:
Improvements
This release improves the performance of setting the presence event notification in JoinChannelOptions
.
Fixed issues
This release fixed the following issues:
- Occasional inability to log out of the RTM system when the network status changed.
- Occasional inability to log in to the RTM system after logging out when the network status changed.
- When the network was disconnected, users occasionally did not receive the
SNAPSHOT
event notification due to that the app did not clear data. - When a user joined a channel and switched the app to the background and then back to the foreground, the SDK occasionally triggered the
REMOTE_JOIN
event notification multiple times.