/ SDKs / Flutter

SDKs

Overview
- Getting started
- Send first message
- Migration guide
- User
- Overview
- - Retrieving and updating user information
  - Retrieve the online status of a user
  - Update user profile
  - Retrieve the latest information on participants
- - Managing user metadata
  - Manage user metadata
- Channel
- Overview
- - Creating a channel
  - Create a channel
- - Managing operators
  - Register and remove operators
- - Joining and leaving a channel
  - Enter and exit an open channel
  - Join and leave a group channel
- - Retrieving channels
  - Retrieve a list of channels
  - Retrieve a channel by URL
- - Inviting users to a group channel
  - Invite users as members
  - Accept or decline an invitation
- - Categorizing channels
  - Categorize channels by custom type
- - Managing channels
  - Delete a channel
  - Hide or archive a group channel
  - Refresh all data related to a group channel
- - Moderating a channel
  - Freeze and unfreeze a channel
- - Managing channel metadata
  - Manage channel metadata
- - Managing channel metacounters
  - Manage channel metacounters
- Message
- Overview
- - Sending a message
  - Send a message
  - Send an admin message
  - Track file upload progress using a handler
  - Cancel an in-progress file upload
  - Share an encrypted file
  - Spam flood protection
  - Smart throttling
- - Using message collection
  - Message collection
- - Receiving messages through event handler
  - Receive messages in a channel
- - Using message threading
  - Create a message thread
  - List replies in a message thread
- - Retrieving a message
  - Retrieve a message
- - Searching messages in a group channel
  - Search messages by a keyword
- - Managing a message
  - Copy a message
  - Update a message
  - Delete a message
  - React to a message in a group channel
  - Clear the chat history in a group channel
  - Send typing indicators to other members
  - Display Open Graph tags in a message
  - Generate thumbnails of a file message
- - Managing scheduled messages in group channel
  - Create a scheduled message
  - Retrieve a scheduled message
  - Update a scheduled message
  - Cancel a scheduled message
  - Send a scheduled message immediately
  - List all scheduled messages
  - Retrieve the total number of scheduled messages
- - Managing pinned messages in group channels
  - Pin a message
  - Unpin a message
- - Loading messages
  - Load previous messages
  - Load messages by timestamp or message ID
- - Listing changelogs
  - List changelogs of messages
- - Marking messages as read in a group channel
  - Mark messages as read
- - Marking messages as delivered in a group channel
  - Mark messages as delivered
- - Mentioning other users in a message
  - Mention other users in a message
- - Managing polls
  - Create a poll
  - Retrieve a poll
  - Update a poll
  - Delete a poll
  - Close a poll
  - Add a poll option
  - Retrieve a poll option
  - Update a poll option
  - Delete a poll option
  - Cast or cancel a vote
  - Retrieve a list of polls
  - Retrieve a list of voters
  - List changelogs of polls
- - Retrieving unread count in a group channel
  - Unread messages in a channel
  - Unread messages in all channels
  - Unread channels
  - Members who haven't received a message
  - Members who haven't read a message
  - Unread items
- - Categorizing messages
  - Categorize messages by custom type
- - Adding extra data to a message
  - Add extra data to a message
- - Translating messages
  - Auto-translate messages
  - Translate messages on-demand
  - Translation engine
- Application
- Overview
- - Authenticating a user
  - Authentication
- - Understanding rate limits
  - Rate limits
- Event handler
- Overview
- - Managing channel event handlers
  - Add or remove a channel event handler
- - Managing connection event handlers
  - Add or remove a connection event handler
- - Managing user event handlers
  - Add or remove a user event handler
- Push notifications
- Overview
- - Managing push notifications
  - Set up push notifications
  - Configure push notification preferences
  - Push notification content templates
  - Push notification tester
  - Push notification translation
- Report
- Overview
- - Creating a report
  - Report a message, user, or channel
- Local caching
- Overview
- - Using group channel collection
  - Group channel collection
- - Using message collection
  - Message collection
Migrating to Sendbird
Deprecated
Error codes
Logger

Chat SDKs Flutter v4

Chat SDKs Flutter

Chat SDKs

Flutter

Version 4

/

/

/

/

Mark messages as delivered

Delivery receipt can be used to see whether a message has been successfully delivered to all the intended recipients by the Sendbird server. To mark a message as delivered when an offline group channel member receives a push notification for the message from Firebase Cloud Messaging, use the markAsDelivered() method.

Dart

// App is in the foreground.
FirebaseMessaging.onMessage.listen((RemoteMessage remoteMessage) {
  // ...
  SendbirdChat.markAsDelivered(remoteMessage.data);
});

// App is in the background.
FirebaseMessaging.onBackgroundMessage(_backgroundMessageHandler);

@pragma('vm:entry-point')
Future<void> _backgroundMessageHandler(RemoteMessage remoteMessage) async {
  // ...
  SendbirdChat.markAsDelivered(remoteMessage.data);
}

When a message is delivered to a group channel member who is online, the message is marked as delivered and other members who are online are notified of the delivery receipt through the onDeliveryStatusUpdated() method of the channel event handler.

Dart

class MyGroupChannelHandler extends GroupChannelHandler {
  @override
  void onDeliveryStatusUpdated(GroupChannel channel) {
    // Delivery status is updated.
  }
}

Sample app