Sendbird Chat SDK for Flutter

Platform Language

Table of contents

  1. Introduction
  2. Requirements
  3. Getting started
  4. Sending your first message
  5. Getting help
  6. Hiring

đź”’ Security tip

When a new Sendbird application is created in the dashboard the default security settings are set permissive to simplify running samples and implementing your first code.

Before launching make sure to review the security tab under ⚙️ Settings -> Security, and set Access token permission to Read Only or Disabled so that unauthenticated users can not login as someone else. And review the Access Control lists. Most apps will want to disable "Allow retrieving user list" as that could expose usage numbers and other information.

Introduction

Through Chat SDK for flutter, you can efficiently integrate real-time chat into your client app. On the client-side implementation, you can initialize, configure and build the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for your chat within the app. This readme provides essential information on the Chat SDK’s structure, supplementary features, and the installation steps.

How it works

  1. A user logs in
  2. User sees a list of channels
  3. Select or create an open channel or a group channel
  4. Through the use of the channel event handler, sends and receives messages to other users in that channel.

Requirements

The minimum requirements for Chat SDK for Flutter are:

  • Xcode or Android studio
  • Dart 2.10.4 or above
  • Flutter 1.22.0 or higher

Getting started

This section gives you information you need to get started with Sendbird Chat SDK for Flutter. Follow the simple steps below to build the Chat SDK into your client app.

Try the sample app

The fastest way to test Sendbird Chat SDK for Flutter is to build your chat app on top of our sample app. To create a project for the sample app, download the app from our GitHub repository. The link is down below.

Step 1: Create a Sendbird application from your dashboard

A Sendbird application comprises everything required in a chat service including users, message, and channels. To create an application:

  1. Go to the Sendbird Dashboard and enter your email and password, and create a new account. You can also sign up with a Google account.
  2. When prompted by the setup wizard, enter your organization information to manage Sendbird applications.
  3. Lastly, when your dashboard home appears after completing setup, click Create + at the top-right corner.

Only one Sendbird application can be integrated per app for your service regardless of the platform. All users within your Sendbird application can communicate with each other across all platforms. This means that your iOS, Android, and web client app users can all send and receive messages with one another without any further setup.

Note: All data is limited to the scope of a single application, and users in different Sendbird applications can't chat with one other.

Step 2: Install packages

Installing the Chat SDK is a simple process if you’re familiar with using external packages or SDK’s in your projects. Follow the steps below via pub.

  • Add following dependency in pubspec.yaml.
dependencies:
  sendbird_sdk: ^3.0.11
  • Run flutter pub get command in your project directory.

Step 3: Use the Chat SDK in Flutter

You can use all classes and methods just with the one import statement as shown below.

import 'package:sendbird_sdk/sendbird_sdk.dart'

Sending your first message

Follow the step-by-step instructions below to authenticate and send your first message.

Authentication

In order to use the features of Sendbird Chat SDK for Flutter, you should initiate the Sendbirdsdk instance through user authentication with Sendbird server. This instance communicates and interacts with the server based on an authenticated user account, allowing the client app to use the Chat SDK's features.

Here are the steps to sending your first message using the Chat SDK:

Step 1: Initialize the Chat SDK

Initializing the Chat SDK allows it to respond to the connection and state changes in your client app. Pass the APP_ID of your Sendbird application as an argument to the appId parameter in the constructor of SendbirdSdk. The constructor of SendbirdSdk creates an instance, thus should be called a single time across your client app. It is recommended that the code for initialization be implemented in the user login view.

final sendbird = SendbirdSdk(appId: APP_ID);

Step 2: Connect to Sendbird server

A user can log in and connect a user to Sendbird server by using a unique user ID or with a user ID and an access token.

A. Using a unique user ID

To connect to Sendbird server, a user is required to log in with a unique ID. A new user can authenticate with any untaken user ID, which gets automatically registered to the Sendbird system. An existing ID can log in directly. The ID must be unique within a Sendbird application to be distinguished from others, such as a hashed email address or phone number in your service.

try {
  final user = await sendbird.connect(userId: USER_ID);
} catch (e) {
  // error
}

B. Using a unique user ID and an access token

By using Chat Platform API, you can create a user and issue a unique access token to each user, or issue an access token for an existing user. Once an access token is issued, a user is required to provide the access token to log in to your Sendbird application.

  1. Using the Chat Platform API, create a Sendbird user account with the information submitted when a user signs up or signs in to your service.
  2. Save the user ID along with the issued access token to your securely managed persistent storage.
  3. When a user attempts to log in to the application, load the user ID and access token from the storage, and then pass them to connect() method.
  4. Periodically replacing the user's access token is recommended for account security.
try {
  final user = await sendbird.connect(userId: USER_ID, accessToken: ACCESS_TOKEN);
} catch (e) {
  // error
}

- Tips for secure user login

To manage user access to your Sendbird application, go to Settings > Application > Security > Access token permission setting on your Sendbird dashboard. You can change settings to prevent the users without an access token from logging in to your application or restrict their access to read and write messages.

For security reasons, you can also use a session token when a user logs in to Sendbird server instead of an access token. Learn more about Access token vs. Session token from the Chat Platform API guide.

Step 3: Create a new open channel

Create an open channel. Once created, all users in your Sendbird application can easily participate in the channel.

try {
  final channel = await OpenChannel.createChannel();
} catch (e) {
  // error
}

You can also create a group channel by inviting users as new members to the channel.

Note: The majority of the methods used in the following steps are all asynchronous. This means, with asynchronous methods, your client app must receive a result via await or then() callbacks from Sendbird server through completion handlers before moving on to the next step.

Step 4: Enter the channel

Enter the channel to send and receive messages.

try {
  final channel = await OpenChannel.getChannel(CHANNEL_URL);
  await channel.enter();
} catch (e) {
  // error
}

Step 5: Send a message to the channel

Finally, send a message to the channel. There are three types of messages: a user message in a plain text, a file message in a binary file, such as an image or PDF, and an admin message in a plain text sent through the dashboard or Chat Platform API.

try {
  final params = UserMessageParams()
    ..message = MESSAGE
    ..data = DATA
    ..customType = CUSTOM_TYPE;

  final preMessage = openChannel.sendUserMessage(params, onCompleted:(message, error){
      if (error != null) {
        // error
      } else {
        // message is sent successfully
      }
  });
  // use preMessage to populate your chat messages early
} catch (e) {
  // error
}

Getting Help

Check out the Official Sendbird Flutter docs and Sendbird's Developer Portal for tutorials and videos. If you need any help in resolving any issues or have questions, visit our community forums.


We are Hiring!

Sendbird is made up of a diverse group of humble, friendly, and hardworking individuals united by a shared purpose to build the next generation of mobile & social technologies. Join our team remotely or at one of our locations in San Mateo, Seoul, New York, London, and Singapore. More information on a careers page.

Libraries

admin_message
api_client
api_request
app_info
apple_critical_alert_options
application_user_list_request
async_operation
async_queue
authenticate_event_handler
banned_user_list_query
banned_user_list_request
base_channel
base_event
base_message
base_message_fetch_params
base_message_internal
base_message_params
base_query
blocked_user_list_query
blocked_user_list_request
cache_service
cache_utils
cached_data
cached_data_map
channel_event
channel_event_handler
channel_invitation_preference_request
channel_my_mute_info_get_request
channel_reaction_add_request
channel_reaction_remove_request
channel_report_request
channel_user_ban_request
channel_user_mute_request
channel_user_unban_request
channel_user_unmute_request
command
command_manager
command_type
connection_event_handler
connection_manager
contants
create_request
create_request
create_request
delete_request
delete_request
delete_request
delivery_status
do_not_disturb_request
emoji
emoji_category_request
emoji_container_request
emoji_request
enums
error
error_code
event_manager
extensions
file_info
file_message
file_message_params
file_message_resend_request
file_message_send_request
file_message_update_request
file_upload_request
get_request
get_request
group_channel
group_channel_accept_request
group_channel_change_log_request
group_channel_change_logs_params
group_channel_count_preference_request
group_channel_count_request
group_channel_create_request
group_channel_decline_request
group_channel_delete_request
group_channel_delivery_request
group_channel_filters
group_channel_freeze_request
group_channel_hide_request
group_channel_internal
group_channel_invite_request
group_channel_join_request
group_channel_leave_request
group_channel_list_query
group_channel_list_request
group_channel_member_list_query
group_channel_params
group_channel_push_trigger_option_request
group_channel_read_request
group_channel_refresh_request
group_channel_reset_history_request
group_channel_screen_shot_request
group_channel_total_unread_channel_count_params
group_channel_total_unread_message_count_params
group_channel_typing_request
group_channel_update_request
http_client
info_update_request
isolate_bridge_def
isolate_bridge_master
isolate_bridge_slave
json_from_parser
logger
login_event
mack_request
mcnt_event
member
member_list_request
memory_cache_service
message_change_log_get_request
message_change_logs_params
message_copy_request
message_delete_request
message_event
message_get_request
message_list_params
message_meta_array_request
message_report_request
message_retrieval_params
message_search_query
message_search_request
message_translate_request
messages_get_request
meta_array
muted_user_list_query
muted_user_list_request
og_image
og_interfaces
og_meta_data
open_channel
open_channel_create_request
open_channel_delete_request
open_channel_enter_request
open_channel_exit_request
open_channel_list_query
open_channel_list_request
open_channel_params
open_channel_refresh_request
open_channel_update_request
operator_add_request
operator_list_query
operator_list_request
operator_remove_request
options
parsers
participant_list_query
participant_list_request
pin_create_request
pin_delete_request
policy
poll
poll_changelogs_get_request
poll_changelogs_params
poll_close_request
poll_create_request
poll_data
poll_delete_request
poll_get_request
poll_handler
poll_list_get_request
poll_list_query
poll_list_query_params
poll_option
poll_option_add_request
poll_option_delete_request
poll_option_get_list_voters_request
poll_option_get_request
poll_option_handler
poll_option_retrieval_params
poll_option_update_request
poll_params
poll_retrieval_params
poll_update_event
poll_update_params
poll_update_request
poll_vote_event
poll_vote_request
poll_voter_list_query
poll_voter_list_query_params
previous_message_list_query
public_group_channel_list_query
public_group_channel_list_request
push_register_request
push_sound_request
push_template_request
push_trigger_option_request
push_unregister_request
reaction
reaction_event
read_status
reconnect_configuration
reconnect_task
responses
restricted_user
scheduled_file_message
scheduled_file_message_params
scheduled_file_message_request
scheduled_file_message_send_request
scheduled_file_message_update_params
scheduled_file_message_update_request
scheduled_info
scheduled_message_cancel_request
scheduled_message_get_list_request
scheduled_message_get_request
scheduled_message_list_params
scheduled_message_list_query
scheduled_message_retrieval_params
scheduled_message_send_now_request
scheduled_message_total_count_params
scheduled_message_total_count_request
scheduled_user_message
scheduled_user_message_params
scheduled_user_message_request
scheduled_user_message_send_request
scheduled_user_message_update_params
scheduled_user_message_update_request
sendbird_sdk
Sendbird SDK for flutter
sendbird_sdk_accessor
sendbird_sdk_api
sendbird_sdk_internal
sendbird_sdk_streams
sender
session_event
session_event_handler
session_key_update_request
session_manager
session_token_issue_request
session_token_revoke_request
snooze_request
state
string_utils
thread_info
thread_info_update_event
threaded_message_list_params
types
typing_status
unread_channel_count_request
unread_count_info
unread_item_count
unread_item_count_request
unread_message_count_request
update_request
update_request
update_request
user
user_block_request
user_event
user_event_handler
user_list_query
user_list_query
user_message
user_message_params
user_message_resend_request
user_message_send_request
user_message_update_request
user_report_request
user_unblock_request
websocket_client
ws_event
ws_request