/ SDKs / iOS
SDKs
Chat SDKs iOS v4
Chat SDKs iOS
Chat SDKs
iOS
Version 4

Mark messages as read

Copy link

To keep the most up-to-date and accurate read status of messages for all group channel members, the markAsRead(completionHandler:) method should be called every time a member reads messages by entering the channel from a channel list or switching the chat view from the background to the foreground.

When a member sends a message to the channel, the Sendbird server immediately updates the sender's read receipt to the time when the message was sent. The read receipts of other channel members are updated when the markAsRead(completionHandler:) method is called.

If a member opens a channel and the markAsReadAll(completionHandler:) is called, the Sendbird server updates both the unread message count of the individual channel and the total unread message count of all the group channels joined by the member. The server then triggers the channelDidUpdateReadStatus(_:) method of the channel event delegate to notify the change of read status to all other channel members' devices.

If a new member joins the channel, the method works differently based on the value of the display_past_message property of your Sendbird application. If the property is set to true, the new member's read receipt is updated to the sent time of the last message in the channel. If set to false, the property's value is 0.

// Call the markAsRead method when the current user views
// unread messages in a group channel.
channel.markAsRead { error in
    guard error == nil else {
        // Handle error.
        return
    }
}


// To listen to an update from other channel members' client apps,
// implement the `channelDidUpdateReadStatus(_:)` with actions to perform when notified.
class GroupChannelChattingViewController: UIViewController, GroupChannelDelegate {
    func initViewController() {
        SendbirdChat.add(self as GroupChannelDelegate, identifier: UNIQUE_DELEGATE_ID)
    }

    func channelDidUpdateReadStatus(_ channel: GroupChannel) {
        if currentGroupChannel.channelURL == channel.channelURL {
            // You can implement codes to redraw a channel view here.
        }
    }
}

Note: The display_past_message property determines whether to display past messages to newly joined members when they enter the channel. This property is also linked to the Chat history option, which can be managed on Sendbird Dashboard under Settings > Chat > Channels > Group channels.