Unread messages

Track unread message counts for users who reconnect after being offline.

lastReadMessageTimetoken on the Membership object stores when a user last read messages on a channel. This is set automatically on join() or invite(). Update it based on user actions (scrolling, app focus, etc.) using mark as read methods.

Requires App Context and Message Persistence

Enable App Context and Message Persistence in the Admin Portal.

Get last read message

lastReadMessageTimetoken returns the timetoken marking the user's last read position on a channel. This timetoken doesn't always correspond to an actual message. Use it to display unread markers in your UI.

Sample code

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

1chat.getUser("support_agent_15").async { result ->
2    result.onSuccess { user ->
3        user?.getMemberships(filter = "channel.id == 'support'")?.async { membershipsResult ->
4            membershipsResult.onSuccess { membershipsResponse ->
5                val membership = membershipsResponse.memberships.firstOrNull()
6                println("Last read message timetoken: ${membership?.lastReadMessageTimetoken}")
7            }.onFailure {
8                // handle failure
9            }
10        }
11    }.onFailure {
12        // handle failure
13    }
14}

Get unread messages count (one channel)

getUnreadMessagesCount() returns the number of unread messages on a channel. This counts all messages after the last read timetoken, including your own messages.

Method signature

This method has the following signature:

1membership.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.

Sample code

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

1// get the details of the "support_agent_15" user
2chat.getUser("support_agent_15").async { userResult ->
3    userResult.onSuccess { user ->
4        user?.getMemberships(filter = "channel.id == 'support'")?.async { membershipsResult ->
5            membershipsResult.onSuccess { membershipsResponse ->
6                val membership = membershipsResponse.memberships.firstOrNull()
7                membership?.getUnreadMessagesCount()?.async { unreadCountResult ->
8                    unreadCountResult.onSuccess { unreadCount ->
9                        if (unreadCount != null) {
10                            println("Unread messages count: $unreadCount")
11                        } else {
12                            println("No unread messages count available.")
13                        }
14                    }.onFailure {
15                        // handle failure
16                    }
17                }
18            }.onFailure {
19                // handle failure
20            }
21        }
22    }.onFailure {
23        // handle failure
24    }
25}

show all 25 lines

Get unread messages count (all channels)

fetchUnreadMessagesCounts() returns unread counts for all joined channels with unread messages (channels with zero unread are excluded). Counts include all messages after the last read timetoken, including your own.

fetchUnreadMessagesCounts() calls the Message Persistence API and the Kotlin SDK messageCounts() method.

Under the hood

Unread counts and filtering

fetchUnreadMessagesCounts uses the Memberships API. Filters here may target channel.* fields only (plus common fields: status, type, custom). You can't use uuid.* fields.

Unread counts always include all messages published after your last read timetoken including messages you sent yourself. You can't filter unread counts by sender but you can query Message Persistence from the last read timetoken and filter client-side.

See filterable fields: • Memberships filters • Members filters

Method signature

This method has the following signature:

1chat.fetchUnreadMessagesCounts(
2    limit: Int? = null,
3    page: PNPage? = null,
4    filter: String? = null,
5    sort: Collection<PNSortKey<PNMembershipKey>> = listOf()
6): PNFuture<UnreadMessagesCounts>

Input

* required

Parameter	Description
limit Type: Int Default: null	Number of objects to return in response. The default (and maximum) value is 100.
page Type: PNPage Default: null	Object used for pagination to define which previous or next result page you want to fetch.
filter Type: String (Memberships filter) Default: null	Filter expression evaluated against channel memberships only. Allowed targets: channel.* plus common fields (status, type, custom). uuid.* fields aren't supported.
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

Parameter	Description
PNFuture<UnreadMessagesCounts> Type: object	Returned object containing these fields: countsByChannel and page.
→ countsByChannel Type: Array<object>	Array of objects containing channel, membership, and count information.
→ channel Type: Channel	Channel with unread messages.
→ membership Type: Membership	Returned Membership object showing the user-channel data.
→ count Type: number	Total number of messages unread by the current user on a given channel.
→ page Type: object	Object containing pagination information.
→ next Type: string | undefined	Token for fetching the next page of results.
→ prev Type: string | undefined	Token for fetching the previous page of results.

Sample code

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

1// reference the "support_agent_15" user
2chat.getUser("support_agent_15").async { result ->
3    result.onSuccess { user ->
4        user?.let {
5            // get all messages unread by that user
6            chat.fetchUnreadMessagesCounts().async { unreadResult ->
7                unreadResult.onSuccess { unreadMessagesCounts ->
8                    // access the counts for each channel
9                    val countsByChannel = unreadMessagesCounts.countsByChannel
10                    
11                    // access pagination tokens if needed
12                    val next = unreadMessagesCounts.page.next
13                    val prev = unreadMessagesCounts.page.prev
14                }.onFailure {
15                    // handle failure
16                }
17            }
18        }
19    }.onFailure {
20        // handle failure
21    }
22}

show all 22 lines

To avoid counting your own recently sent messages as unread, ensure your app updates the last read timetoken.

Mark messages as read (one channel)

setLastReadMessage() and setLastReadMessageTimetoken() set the last read timetoken for counting unread messages. Bind these to user actions in your app.

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()

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

• setLastReadMessageTimetoken()

  1membership.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.

Sample code

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

• setLastReadMessage()

  1// retrieve the "support_agent_15" user
  2chat.getUser("support_agent_15").async { userResult ->
  3    userResult.onSuccess { user ->
  4        // retrieve membership details for the "support" channel
  5        user?.getMemberships(filter = "channel.id == 'support'")?.async { membershipsResult ->
  6            membershipsResult.onSuccess { membershipsResponse ->
  7                val membership = membershipsResponse.memberships.firstOrNull()
  8                // retrieve the specific message with the given timetoken
  9                chat.getChannel("support").getMessage(16200000000000001).async { messageResult ->
  10                    messageResult.onSuccess { message ->
  11                        // Set the last read message
  12                        membership?.setLastReadMessage(message)?.async { setResult ->
  13                            setResult.onSuccess {
  14                                // handle success
  15                            }.onFailure {
  16                                // handle failure
  17                            }
  18                        }
  19                    }.onFailure {
  20                        // handle failure
  21                    }
  22                }
  23            }.onFailure {
  24                // handle failure
  25            }
  26        }
  27    }.onFailure {
  28        // handle failure
  29    }
  30}

  show all 30 lines

• setLastReadMessageTimetoken()

  1// retrieve the "support_agent_15" user
  2chat.getUser("support_agent_15").async { userResult ->
  3    userResult.onSuccess { user ->
  4        // retrieve membership details for the "support" channel
  5        user?.getMemberships(filter = "channel.id == 'support'")?.async { membershipsResult ->
  6            membershipsResult.onSuccess { membershipsResponse ->
  7                val membership = membershipsResponse.memberships.firstOrNull()
  8                // set the last read message timetoken
  9                membership?.setLastReadMessageTimetoken(16200000000000001)?.async { setResult ->
  10                    setResult.onSuccess {
  11                        // handle success
  12                    }.onFailure {
  13                        // handle failure
  14                    }
  15                }
  16            }.onFailure {
  17                // handle failure
  18            }
  19        }
  20    }.onFailure {
  21        // handle failure
  22    }
  23}

  show all 23 lines

Mark messages as read (all channels)

markAllMessagesAsRead() marks all unread messages as read on all joined channels.

Method signature

This method has the following signature:

1chat.markAllMessagesAsRead(
2    limit: Int?,
3    page: PNPage?,
4    filter: String?,
5    sort: Collection<PNSortKey<PNMembershipKey>> = listOf()
6): 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.

Sample code

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.

1val nextPageString: String = "your_next_page_string"
2

3chat.markAllMessagesAsRead(
4    limit = 50,
5    page = PNPage(nextPageString, null)
6).async { result ->
7    result.onSuccess {
8        // handle success
9    }.onFailure {
10        // handle failure
11    }
12}

Get unread messages count (all channels) (deprecated)

Deprecated

The getUnreadMessagesCounts() method is deprecated. Use fetchUnreadMessagesCounts() instead.

getUnreadMessagesCounts() returns info on all messages you didn't read on joined channels that have unread messages.

This method only returns channels with unread message counts greater than 0 - channels with zero unread messages are filtered out. For each returned channel, this includes all messages published after your last read timetoken, including messages sent by yourself and all other channel members. The method cannot filter messages by sender - it counts all unread messages regardless of who published them. You can display this number on UI in the channel list of your chat app.

Method signature

This method has the following signature:

1chat.getUnreadMessagesCounts(
2    limit: Int?,
3    page: PNPage?,
4    filter: String?,
5    sort: Collection<PNSortKey<PNMembershipKey>> = listOf()
6): 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 which channel memberships to include in the results. Returns unread message counts only for channels whose membership 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.

Sample code

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

1// reference the "chat" object and invoke the "getUser()" method
2chat.getUser("support_agent_15").async { result ->
3    result.onSuccess { user ->
4        user?.let {
5            chat.getUnreadMessagesCounts(
6                filter = "user.id == 'support_agent_15'"
7            ).async { unreadMessagesResult ->
8                unreadMessagesResult.onSuccess { unreadMessagesCounts ->
9                    // handle success
10                    unreadMessagesCounts.forEach { unreadCount ->
11                        println("Channel: ${unreadCount.channelId}, Unread messages count: ${unreadCount.count}")
12                    }
13                }.onFailure {
14                    // handle failure
15                }
16            }
17        }
18    }.onFailure {
19        // handle failure
20    }
21}

show all 21 lines