Migration guide

Sendbird Chat SDK v4 for Flutter has introduced enhancements and revisions from v3, including major breaking changes to streamline the code structure and enhance its scalability.

This page explains the breaking changes and provides a step-by-step guide to assist in transitioning from v3 to v4.

The minimum requirements for v4 are the following.

• Flutter 3.7.0 or later
• Dart 2.19.0 or later

The following breaking changes have been made to the Chat SDK v4 for Flutter.

1. Renamed the core SDK class from SendbirdSdk to SendbirdChat.

2. Renamed Options to SendbirdChatOptions.

3. Renamed loadNext to next.

4. Refactored the following params classes.

5. Renamed the following params classes.

6. Removed Event suffix from handler class names as shown below.

7. Added the following exception classes in v4.

8. Added the following new collection classes in v4.

9. Renamed the following enums.

10. Removed the following enums from v3.

11. Added the following enums in v4.

The following guide covers the changes and key steps required during the migration from the Chat SDK v3 to v4.

Sendbird Chat SDK v4 will likely prevent your app from compiling until all migration tasks are complete and all errors are fixed. After fixing all the blocking errors, further work may be needed to remove warnings and align the SDK with your app again. We recommend you allow a generous timeline for the task.

Update all of import 'package:sendbird_sdk/sendbird_sdk.dart'; to import 'package:sendbird_chat_sdk/sendbird_chat_sdk.dart';.

Replace all of SendbirdSdk with SendbirdChat.

Change Options to SendbirdChatOptions.

Adjust all param classes according to the mapping table.

// Change UserMessageParams() to UserMessageCreateParams().

// v3
UserMessageParams(message: 'MESSAGE')

// v4
UserMessageCreateParams(message: 'MESSAGE')


// Change GroupChannelParams() to GroupChannelCreateParams().                    

// v3
GroupChannelParams()

// v4
GroupChannelCreateParams()

Update all handler class names by removing the 'Event' suffix. You can find the full list in number 6 of breaking changes.

// Change addChannelEventHandler() to addChannelHandler().

// v3
SendbirdSdk().addChannelEventHandler('UNIQUE_CHANNEL_EVENT_HANDLER', MyChannelEventHandler());

// v4
SendbirdChat.addChannelHandler('UNIQUE_CHANNEL_HANDLER', MyChannelHandler());

Switch all of loadNext to next.

// Change list query function loadNext() to next().

// v3
GroupChannelListQuery().loadNext();

// v4
GroupChannelListQuery().next();

Update enum values that were renamed, removed, or added as listed in numbers 9, 10, and 11 of breaking changes.

Update the variable and method names as shown in the table below. Changes are organized by v4 class names.

Function parameter name when sending user message and file message has changed from onCompleted to handler.

// Change onCompleted to handler when sending user and file message.

// v3
channel.sendUserMessage(
  UserMessageParams(message: 'MESSAGE'),
  onCompleted: (message, error) {},
);

// v4
channel.sendUserMessage(
  UserMessageParams(message: 'MESSAGE'),
  handler: (message, e) {},
);

The migration process is now complete. We highly recommend a thorough review and testing of all app features to ensure seamless operation with the Sendbird Chat SDK v4.