Unread messages

The Unread Message Count feature shows users how many messages they missed while offline. Once they reconnect or log into the app again, they can get the number of messages published in a given channel while they were gone.

Chat SDK stores info about the timetoken of the last message the current user read on a given channel on the lastReadMessageTimetoken property. lastReadMessageTimetoken is available on the Membership object.

This property is automatically set for a user when they first join (join()) a given channel or are invited to it (invite() and inviteMultiple()). For all further updates of this property, you must decide what user actions will trigger methods that mark messages as read in your chat app - whether that's some user interaction on UI, like scrolling, your app going offline, or any other behavior.

Requires App Context and Message Persistence

To store message timetokens on the user-channel membership relationship at PubNub, you must enable App Context and Message Persistence for your app's keyset in the Admin Portal.

Get last read message

You can access the lastReadMessageTimetoken property of the Membership object to check what is the timetoken of the last message a user read on a given channel. lastReadMessageTimetoken returns the last read message timetoken stored in the membership data between the channel and the current user. Use it to display markers on the message list denoting which messages haven't been read by the user yet.

Basic usage

Get the timetoken of the last message read by the support_agent_15 user on the support channel.

chat.getUser("support_agent_15").async { result ->
    result.onSuccess { user ->
        user?.getMemberships(filter = "channel.id == 'support'")?.async { membershipsResult ->
            membershipsResult.onSuccess { membershipsResponse ->
                val membership = membershipsResponse.memberships.firstOrNull()
                println("Last read message timetoken: ${membership?.lastReadMessageTimetoken}")
            }.onFailure {
                // handle failure
            }
        }
    }.onFailure {
        // handle failure
    }
}

Get unread messages count (one channel)

getUnreadMessagesCount() returns the number of messages you didn't read on a given channel. You can display this number on UI in the channel list of your chat app.

Method signature

This method has the following signature:

membership.getUnreadMessagesCount(): PNFuture<Long?>

Input

This method doesn't take any parameters.

Output

Type	Description
`PNFuture<Long?>`	Retrieves from Message Persistence the number (count) of all messages unread by a given user on a given channel from the last read message. The method returns `null` when there is no last read message timetoken set on the `Message` object.

Basic usage

Get the number of all messages unread by the support_agent_15 user on the support channel.

// get the details of the "support_agent_15" user
chat.getUser("support_agent_15").async { userResult ->
    userResult.onSuccess { user ->
        user?.getMemberships(filter = "channel.id == 'support'")?.async { membershipsResult ->
            membershipsResult.onSuccess { membershipsResponse ->
                val membership = membershipsResponse.memberships.firstOrNull()
                membership?.getUnreadMessagesCount()?.async { unreadCountResult ->
                    unreadCountResult.onSuccess { unreadCount ->
                        if (unreadCount != null) {
                            println("Unread messages count: $unreadCount")
                        } else {
                            println("No unread messages count available.")
                        }
                    }.onFailure {
                        // handle failure
show all 25 lines

Get unread messages count (all channels)

getUnreadMessagesCounts() returns info on all messages you didn't read on all joined channels. You can display this number on UI in the channel list of your chat app.

Method signature

This method has the following signature:

chat.getUnreadMessagesCounts(
    limit: Int?,
    page: PNPage?,
    filter: String?,
    sort: Collection<PNSortKey<PNMembershipKey>> = listOf()
): PNFuture<Set<GetUnreadMessagesCounts>>

Input

* required

Parameter	Description
`limit` Type: `Int` Default: `100`	Number of objects to return in response. The default (and maximum) value is `100`.
`page` Type: `PNPage` Default: n/a	Object used for pagination to define which previous or next result page you want to fetch.
`filter` Type: `String` Default: n/a	Expression used to filter the results. Returns only these unread messages whose properties satisfy the given expression. The filter language is defined here.
`sort` Type: `Collection<PNSortKey<PNMembershipKey>>` Default: `listOf()`	Key-value pair of a property to sort by, and a sort direction. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify the sorting direction, or specify `null` to take the default sorting direction (ascending). For example: `{name: "asc"}`. By default, the items are sorted by the last updated date.

Output

Type	Description
`PNFuture<Set<GetUnreadMessagesCounts>>`	`PNFuture` containing the number (count) of all messages unread by a given user on all joined channels after the last read message. It returns these details: `channel`, `membership`, `count`.

Basic usage

Get the number of all messages unread by the support_agent_15 user on all joined channels.

// reference the "chat" object and invoke the "getUser()" method
chat.getUser("support_agent_15").async { result ->
    result.onSuccess { user ->
        user?.let {
            chat.getUnreadMessagesCounts(
                filter = "user.id == 'support_agent_15'"
            ).async { unreadMessagesResult ->
                unreadMessagesResult.onSuccess { unreadMessagesCounts ->
                    // handle success
                    unreadMessagesCounts.forEach { unreadCount ->
                        println("Channel: ${unreadCount.channelId}, Unread messages count: ${unreadCount.count}")
                    }
                }.onFailure {
                    // handle failure
                }
show all 21 lines

Mark messages as read (one channel)

setLastReadMessage() and setLastReadMessageTimetoken() let you set the timetoken of the last read message on a given channel to set a timeline from which you can count unread messages. You choose on your own which user action it is bound to.

Setting the last read message for users lets you implement the Read Receipts feature and monitor which channel member read which message.

Method signature

These methods take the following parameters:

setLastReadMessage()

membership.setLastReadMessage(message: Message): PNFuture<Membership>

setLastReadMessageTimetoken()

membership.setLastReadMessageTimetoken(timetoken: Long): PNFuture<Membership>

Input

Parameter	Required by `setLastReadMessage()`	Required by `setLastReadMessageTimetoken()`	Description
`message` Type: `Message` Default: n/a	Yes	No	Last read message on a given channel with the timestamp that gets added to the user-channel membership as the `lastReadMessageTimetoken` property.
`timetoken` Type: `Long` Default: n/a	No	Yes	Timetoken of the last read message on a given channel that gets added to the user-channel membership as the `lastReadMessageTimetoken` property.

Output

Type	Description
`PNFuture<Membership>`	Returned `Membership` object updated with the `lastReadMessageTimetoken` parameter.

Basic usage

Set the message with the 16200000000000001 timetoken as the last read message for the support_agent_15 user on the support channel.

setLastReadMessage()

// retrieve the "support_agent_15" user
chat.getUser("support_agent_15").async { userResult ->
    userResult.onSuccess { user ->
        // retrieve membership details for the "support" channel
        user?.getMemberships(filter = "channel.id == 'support'")?.async { membershipsResult ->
            membershipsResult.onSuccess { membershipsResponse ->
                val membership = membershipsResponse.memberships.firstOrNull()
                // retrieve the specific message with the given timetoken
                chat.getChannel("support").getMessage(16200000000000001).async { messageResult ->
                    messageResult.onSuccess { message ->
                        // Set the last read message
                        membership?.setLastReadMessage(message)?.async { setResult ->
                            setResult.onSuccess {
                                // handle success
                            }.onFailure {
show all 30 lines

setLastReadMessageTimetoken()

// retrieve the "support_agent_15" user
chat.getUser("support_agent_15").async { userResult ->
    userResult.onSuccess { user ->
        // retrieve membership details for the "support" channel
        user?.getMemberships(filter = "channel.id == 'support'")?.async { membershipsResult ->
            membershipsResult.onSuccess { membershipsResponse ->
                val membership = membershipsResponse.memberships.firstOrNull()
                // set the last read message timetoken
                membership?.setLastReadMessageTimetoken(16200000000000001)?.async { setResult ->
                    setResult.onSuccess {
                        // handle success
                    }.onFailure {
                        // handle failure
                    }
                }
show all 23 lines

Mark messages as read (all channels)

markAllMessagesAsRead() lets you mark as read all messages you didn't read on all joined channels.

Method signature

This method has the following signature:

chat.markAllMessagesAsRead(
    limit: Int?,
    page: PNPage?,
    filter: String?,
    sort: Collection<PNSortKey<PNMembershipKey>> = listOf()
): PNFuture<MarkAllMessageAsReadResponse>

Input

* required

Parameter	Description
`limit` Type: `Int` Default: `100`	Number of objects to return in response. The default (and maximum) value is `100`.
`page` Type: `PNPage` Default: n/a	Object used for pagination to define which previous or next result page you want to fetch.
`filter` Type: `String` Default: n/a	Expression used to filter the results. Returns only these messages whose properties satisfy the given expression. The filter language is defined here.
`sort` Type: `Collection<PNSortKey<PNMembershipKey>>` Default: `listOf()`	Key-value pair of a property to sort by, and a sort direction. Available options are `id`, `name`, and `updated`. Use `asc` or `desc` to specify the sorting direction, or specify `null` to take the default sorting direction (ascending). For example: `{name: "asc"}`. By default, the items are sorted by the last updated date.

Output

Type	Description
`PNFuture<MarkAllMessageAsReadResponse>`	Returned object with a list of memberships and these fields: `next`, `prev`, `total`, and `status`.

Basic usage

Mark the total number of 50 messages as read and specify you want to fetch the results from the next page using a string that was previously returned from the PubNub server.

val nextPageString: String = "your_next_page_string"

chat.markAllMessagesAsRead(
    limit = 50,
    page = PNPage(nextPageString, null)
).async { result ->
    result.onSuccess {
        // handle success
    }.onFailure {
        // handle failure
    }
}

Requires App Context and Message Persistence

Get last read message​

Basic usage​

Get unread messages count (one channel)​

Method signature​

Input​

Output​

Basic usage​

Get unread messages count (all channels)​

Method signature​

Input​

Output​

Basic usage​

Mark messages as read (one channel)​

Method signature​

Input​

Output​

Basic usage​

Mark messages as read (all channels)​

Method signature​

Input​

Output​

Basic usage​

Get last read message

Basic usage

Get unread messages count (one channel)

Method signature

Input

Output

Basic usage

Get unread messages count (all channels)

Method signature

Input

Output

Basic usage

Mark messages as read (one channel)

Method signature

Input

Output

Basic usage

Mark messages as read (all channels)

Method signature

Input

Output

Basic usage