Rate this page:

Read Horizon and Read Status Overview

The Read Horizon feature helps to indicate how far along a particular Chat (SDK) Participant is in the Conversation.

Set a Chat Participant’s Read Horizon

The Read Horizon feature is not automatically set. You’ll need to set it within your application.

You can mark all of a Conversation’s Messages as read by calling the specific method on the Conversation object. For most implementations, marking all messages as read when a user views a particular Conversation in your application is sufficient.

You can also call a different method to set all messages in the Conversation to unread.

To set a Chat Participant’s Read Horizon to a specific message, you’ll need to retrieve the index property of the Message you want to set the horizon to and then call the appropriate method.

Message indices are sequential (later messages will have a greater index than previous messages), but are not necessarily consecutive (indices between two messages may increment by more than 1).

You can also use an alternate method to advance the index of the last read message in a conversation to a specific index. This method only changes the Read Horizon if the index you provided is greater than the index that the Read Horizon is currently set to.

This action doesn't change the order of messages in the conversation. It only influences which messages are considered as having been viewed by a participant and which messages are still considered "unread."

Loading Code Sample...

        Set Read Horizon

        Display a Participant’s Read Horizon

        The Conversation SDK will report the Participant’s read status and share it with other Participants in the Conversation.

        To display how far a specific Participant has read in a Conversation, you will need to get the "last read message" value for that Participant within a Conversation. Once you have this value, you can render this however you want in your UI. For 1:1 messages, some type of checkmark or other visual indicator works well. For group conversations, you’ll need to decide how to represent different read positions in the Conversation for each Participant.

        From a Conversations list, you can get a specific content (Message) that another Participant has read, by referencing their last read message index.

        You can count the number of unread Messages in a Conversation for a specific Participant. This is useful for displaying unread message counters in a list of Conversations.

        Loading Code Sample...
              Get Read Horizon messages and get unread messages count.

              Retrieve Read Horizon

              Get Read Horizon messages and get unread messages count.

              What's Next?

              You have finished reading the Read Horizon Overview guide. Let’s continue learning more about Conversations:

              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

              Loading Code Sample...

                    Thank you for your feedback!

                    Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!