With Sendbird Chat SDK for Flutter, you can efficiently integrate real-time chat into a client app. On the client-side implementation, you can initialize and configure the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for your chat within the app.
This page demonstrates how to install the Chat SDK in your mobile and web apps so that you can send your first message in just a few simple steps. In addition, try building your app on top of our sample app to jumpstart your build.
Note: To learn about how to integrate Sendbird Chat SDK for Flutter with a third-party UI plugin, see our Flutter chat tutorial.
The minimum requirements for Chat SDK for Flutter are:
Xcode9 or later
Android studio4.4 or later
Dart 2.12.0or later
Flutter 2.0.0or later
Note: The Sendbird server supports Transport Layer Security (TLS) from versions 1.0 up to 1.3. For example, in the server regions where TLS 1.3 isn't available, lower versions from 1.0 to 1.2 will be sequentially supported for secure data transmission.
Before installing Sendbird Chat SDK, you need to create a Sendbird application on the Sendbird Dashboard, which comprises everything required in a chat service including users, messages, and channels. You will need the
App ID of your Sendbird application when initializing the Chat SDK.
Note: Each Sendbird application can be integrated with a single client app. Within the same application, users can communicate with each other across all platforms, whether they are on mobile devices or on the web.
Sendbird provides various access control options when using the Chat SDK. By default, the following attributes are turned on to avoid unexpected errors when creating sample apps and sending your first message:
- Allow retrieving user list
- Allow updating user metadata
- Allow creating open channels
- Allow creating group channels
However, this may grant access to unwanted data or operations, leading to potential security concerns. To manage your access control settings, you can turn on or off each option in Settings > Application > Security > Access control list on Sendbird Dashboard.
To send a message in a client app, you should install, build, and configure an in-app chat using Sendbird Chat SDK. Sendbird Chat SDK can be installed through
Create a dependency and add the following code to your package's
Install packages from the command line.
You can use all classes and methods just with the following one
Now, initialize Sendbird Chat SDK in the app to allow the Chat SDK to respond to changes in the connection status in Flutter client apps. Initialization requires the
App ID, which can be found in the Sendbird Dashboard.
Note: The constructor of a
SendbirdSdkinstance must be called across a client app at least once. We recommend that you initialize the Chat SDK in the
main.dartand use its variable across your application.
You will need a user in order to send a message to a channel. You can either create a user on our dashboard or use a unique ID that hasn't been taken by any of your Sendbird application users. In the latter case, a new user will be automatically created in your Sendbird application before being connected.
Note: To learn more about authenticating with an access token, go to Authentication.
Create an open channel using the following codes. Open channels are where all users in your Sendbird application can easily participate without an invitation. When creating an open channel, the
OpenChannelParams class needs to be passed as a parameter.
Note: You can also create a group channel to send a message. To learn more, see Create a channel in the Group channel page.
Enter the open channel to send and receive messages.
Finally, send a message to the channel. To learn about the message types you can send, refer to Message Overview in our Platform API Docs.