Upgrade / Migration Guide¶ ↑
Version 1.1.8 to 1.2.0¶ ↑
Notable Changes¶ ↑
This release is all about channel options. Here is the full changelog
-
Channel options were extracted into a seperate model ChannelOptions. However it's still backward campatible with
Hash
and you don't need to do make any adjustments to your code -
The
ChannelOptions
class now supports:params
,:modes
and:cipher
as options. Previously only:cipher
was available -
The client
:idempotent_rest_publishing
option istrue
by default. Previously:idempotent_rest_publishing
wasfalse
by default.
Breaking Changes¶ ↑
-
Changing channel options with
Channels#get
is now deprecated in favor of explicit options change -
If channel state is attached or attaching an exception will be raised
-
Otherwise the library will emit a warning
For example, the following code
client.channels.get(channel_name, new_channel_options)
Should be changed to:
channel = client.channels.get(channel_name) channel.options = new_channel_options