Message reactions help you build a more engaging chat experience that goes beyond text messages. They are a quick and easy way for users to respond to a message. Users can express their acknowledgement of or feelings about a message without written text by simply adding reactions. They can also view and delete their reactions to the message.
Note: Message reactions are currently available only in group channels.
final emojiKey = 'smile'
// The BASE_MESSAGE argument below indicates an BaseMessage object to add a reaction to.
try {
final event = await groupChannel.addReaction(BASE_MESSAGE, key: emojiKey);
} catch (e) {
// Handle error.
}
// The BASE_MESSAGE argument below indicates an BaseMessage object to remove a reaction from.
try {
final event = await groupChannel.deleteReaction(BASE_MESSAGE, key: emojiKey);
} catch (e) {
// Handle error.
}
// To add or remove an emoji that matches the emojiKey under a message in the current user's chat view, the apply() method should be called in the channel event handler's updatedReaction() method.
You can decide how to display reactions that were added to messages in the current user’s chat view.
try {
final currentUserId = sendbird.currentUser().userId;
final params = MessageListParams()
..includeReactions = true
..previousResultSize = 20;
final messages = await groupChannel.getMessagesByTimestamp(TIMESTAMP, params);
messages.forEach((m) {
m.reactions.forEach((reaction) {
// Check if this emoji has been used when the current user reacted to the message.
if (reaction.userIds.firstWhere((u) => currentUserId == u.userId) != null) {
final key = reaction.key
final updatedAt = reaction.updatedAt
// Show the emoji however you want in the current user's chat view.
}
})
});
} catch (e) {
// Handle error.
}
When one of the channel members reacts to a message, the onReactionUpdated() method in the channel event handler is invoked on all channel members’ devices including the one that belongs to the current user. The applyReactionEvent() method reflects the reaction change to the message in real time.
class MyClass with ChannelEventHandler {
// Add this class through sdk.addChannelEventHandler(UNIQUE_HANDLER_ID, this).
// Or remove it through sdk.removeChannelEventHandler(UNIQUE_HANDLER_ID) when it is no longer needed.
@override
void onReactionUpdated(BaseChannel channel, ReactionEvent event) {
// If there is a message with the reactionEvent.messageId, you can apply the reaction change to the message by calling the message.apply(reactionEvent) method.
// Add or remove an emoji that appears below the message on the current user's chat view.
}
}