---
source_url: https://www.pubnub.com/docs/chat/swift-chat-sdk/build/features/messages/unread
title: Unread messages
updated_at: 2026-06-12T11:23:14.648Z
---

> Documentation Index
> For a curated overview of PubNub documentation, see: https://www.pubnub.com/docs/llms.txt
> For the full list of all documentation pages, see: https://www.pubnub.com/docs/llms-full.txt


# Unread messages

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

`lastReadMessageTimetoken` on the [Membership](https://www.pubnub.com/docs/chat/swift-chat-sdk/learn/chat-entities/membership) object stores when a user last read messages on a channel. This is set automatically on [join()](https://www.pubnub.com/docs/chat/swift-chat-sdk/build/features/channels/join) or [invite()](https://www.pubnub.com/docs/chat/swift-chat-sdk/build/features/channels/invite#invite-one-user). Update it based on user actions (scrolling, app focus, etc.) using [mark as read](#mark-messages-as-read-one-channel) methods.

:::note Requires App Context and Message Persistence
Enable [App Context](https://youtu.be/9UEoSlngpYI) and [Message Persistence](https://youtu.be/qLMtbINWGig) in the [Admin Portal](https://admin.pubnub.com/).
:::

## 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

:::tip Sample code
The code samples in Swift Chat SDK focus on asynchronous code execution.
You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.
:::

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

```swift
// Assumes a "ChatImpl" reference named "chat"
Task {
  if let user = try await chat.getUser(userId: "support_agent_15") {
    if let membership = try await user.getMemberships(filter: "channel.id == 'support'").memberships.first {
      debugPrint("Last read message timetoken: \(String(describing: membership.lastReadMessageTimetoken))")
    } else {
      debugPrint("No memberships found for the \"support\" channel")
    }
  } else {
    debugPrint("User not found")
  }
}
```

## 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:

```swift
membership.getUnreadMessagesCount() async throws -> UInt64?
```

#### Input

This method doesn't take any parameters.

#### Output

| Parameter | Description |
| --- | --- |
| `UInt64` | 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](https://www.pubnub.com/docs/chat/swift-chat-sdk/build/features/messages/unread#mark-messages-as-read-one-channel) set on the [MessageImpl object](https://www.pubnub.com/docs/chat/swift-chat-sdk/learn/chat-entities/message). |

### Sample code

:::tip Sample code
The code samples in Swift Chat SDK focus on asynchronous code execution.
You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.
:::

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

```swift
// Assumes a "ChatImpl" reference named "chat"
Task {
  if let user = try await chat.getUser(userId: "support_agent_15") {
    if let membership = try await user.getMemberships(filter: "channel.id == 'support'").memberships.first {
      if let noOfUnreadMessages = try await membership.getUnreadMessagesCount() {
        print("Unread messages count: \(noOfUnreadMessages)")
      } else {
        print("No unread messages count available")
      }
    } else {
      debugPrint("No memberships found for the \"support\" channel")
    }
  } else {
    debugPrint("User not found")
  }
}
```

## 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.

##### Under the hood

`fetchUnreadMessagesCounts()` calls the Message Persistence API and the Swift SDK [messageCounts()](https://www.pubnub.com/docs/sdks/swift/api-reference/storage-and-playback#message-counts) method.

:::note Unread counts and filtering
Filters support `channel.*` fields plus `status`, `type`, `custom` (not `uuid.*`). Unread counts include your own messages. See [Memberships filters](https://www.pubnub.com/docs/general/metadata/filtering#memberships-filters).
:::

### Method signature

This method has the following signature:

```swift
chat.fetchUnreadMessagesCounts(
    limit: Int? = nil,
    page: PubNubHashedPage? = nil,
    filter: String? = nil,
    sort: [PubNub.MembershipSortField] = [],
    completion: ((Swift.Result<(countsByChannel: [GetUnreadMessagesCount<ChannelImpl, MembershipImpl>], page: PubNubHashedPage?), Error>) -> Void)? = nil
)
```

#### Input

| Parameter | Description |
| --- | --- |
| `limit`Type: `Int`Default: `nil` | Number of objects to return in response. The default (and maximum) value is `100`. |
| `page`Type: `PubNubHashedPage`Default: `nil` | Object used for pagination to define which previous or next result page you want to fetch. |
| `filter`Type: `String` (Memberships filter)Default: `nil` | Filter expression evaluated against [channel memberships](https://www.pubnub.com/docs/general/metadata/filtering#memberships-filters) only. Allowed targets: `channel.*` plus common fields (`status`, `type`, `custom`). `uuid.*` fields aren't supported. |
| `sort`Type: `[PubNub.MembershipSortField]`Default: `[]` | Array of sorting criteria 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 `nil` to take the default sorting direction (ascending). By default, the items are sorted by the last updated date. |
| `completion`Type: `((Swift.Result<(countsByChannel: [GetUnreadMessagesCount<ChannelImpl, MembershipImpl>], page: PubNubHashedPage?), Error>) -> Void)?`Default: `nil` | Completion closure called with the result of the operation. |

#### Output

| Parameter | Description |
| --- | --- |
| `Swift.Result<>`Type: `object` | Result object containing either success data or an error. |
| `> countsByChannel`Type: `[GetUnreadMessagesCount<ChannelImpl, MembershipImpl>]` | Array of objects containing channel, membership, and count information. |
| `>> channel`Type: `ChannelImpl` | Channel with unread messages. |
| `>> membership`Type: `MembershipImpl` | Returned [Membership object](https://www.pubnub.com/docs/chat/chat-sdk/learn/chat-entities/membership) showing the user-channel data. |
| `>> count`Type: `UInt64` | Total number of messages unread by the current user on a given channel. |
| `> page`Type: `PubNubHashedPage?` | Object containing pagination information. |
| `>> start`Type: `string?` | Token for fetching the next page of results. |
| `>> end`Type: `string?` | Token for fetching the previous page of results. |

### Sample code

:::tip Sample code
The code samples in Swift Chat SDK focus on asynchronous code execution.
You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.
:::

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

```swift
// Assumes a "ChatImpl" reference named "chat"
chat.fetchUnreadMessagesCounts { result in
  switch result {
  case let .success(response):
    let countsByChannel = response.countsByChannel
      
    countsByChannel.forEach { unreadCount in
      print("Channel: \(unreadCount.channel.id)")
      print("Unread messages count: \(unreadCount.count)")
    }
      
    let page = response.page
      
  case let .failure(error):
    print("Error fetching unread message counts: \(error)")
  }
}
```

To avoid counting your own recently sent messages as unread, ensure your app updates the [last read timetoken](#mark-messages-as-read-one-channel).

## 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](https://www.pubnub.com/docs/chat/swift-chat-sdk/build/features/messages/read-receipts) feature and monitor which channel member read which message.

### Method signature

These methods take the following parameters:

* setLastReadMessage() 1membership.setLastReadMessage(2 message: MessageImpl3) async throws -> MembershipImpl
* setLastReadMessageTimetoken() 1membership.setLastReadMessageTimetoken(2 _ timetoken: Timetoken 3) async throws -> MembershipImpl

#### Input

| Parameter | Required by `setLastReadMessage()` | Required by `setLastReadMessageTimetoken()` | Description |
| --- | --- | --- | --- |
| `message`Type: `MessageImpl`Default: n/a | Yes | No | Last read message on a given channel with the timestamp that gets added to the [user-channel membership](https://www.pubnub.com/docs/chat/swift-chat-sdk/build/features/channels/membership#update) as the `lastReadMessageTimetoken` property. |
| `timetoken`Type: `Timetoken`Default: n/a | No | Yes | Timetoken of the last read message on a given channel that gets added to the [user-channel membership](https://www.pubnub.com/docs/chat/swift-chat-sdk/build/features/channels/membership#update) as the `lastReadMessageTimetoken` property. |

#### Output

| Parameter | Description |
| --- | --- |
| `MembershipImpl` | Returned `MembershipImpl` object updated with the `lastReadMessageTimetoken` parameter. |

### Sample code

:::tip Sample code
The code samples in Swift Chat SDK focus on asynchronous code execution.
You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.
:::

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

* setLastReadMessage() // Assumes a "ChatImpl" reference named "chat" Task { if let user = try await chat.getUser(userId: "support_agent_15") { if let membership = try await user.getMemberships(filter: "channel.id == 'support'").memberships.first { if let message = try await membership.channel.getMessage(timetoken: 16200000000000001) { let updatedMembership = try await membership.setLastReadMessage(message: message) debugPrint("Successfully set the last read message") debugPrint("Updated membership object: \(updatedMembership)") } else { debugPrint("Message not found") } } } else { debugPrint("User not found") } }
* setLastReadMessageTimetoken() // Assumes a "ChatImpl" reference named "chat" Task { if let user = try await chat.getUser(userId: "support_agent_15") { if let membership = try await user.getMemberships(filter: "channel.id == 'support'").memberships.first { let updatedMembership = try await membership.setLastReadMessageTimetoken(16200000000000001) debugPrint("Successfully set the last read message timetoken") debugPrint("Updated membership object: \(updatedMembership)") } } else { debugPrint("User not found") } }

## 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:

```swift
chat.markAllMessagesAsRead(
    limit: Int? = nil,
    page: PubNubHashedPage? = nil,
    filter: String? = nil,
    sort: [PubNub.MembershipSortField] = []
  ) async throws -> (memberships: [MembershipImpl], page: PubNubHashedPage?)
```

#### Input

| Parameter | Description |
| --- | --- |
| `limit`Type: `Int`Default: `100` | Number of objects to return in response. The default (and maximum) value is `100`. |
| `page`Type: `PubNubHashedPage`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](https://www.pubnub.com/docs/general/metadata/filtering). |
| `sort`Type: `[PubNub.MembershipSortField]`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 |
| --- | --- |
| `(memberships: [MembershipImpl], page: PubNubHashedPage?)` | Returned object with a list of memberships and a `page` object with these fields: `next`, `prev`, `total`, and `status`. |

### Sample code

:::tip Sample code
The code samples in Swift Chat SDK focus on asynchronous code execution.
You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.
:::

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.

```swift
// Assumes a "ChatImpl" reference named "chat"
let nextPageString = "your_next_page_string"
  
Task {
  let response = try await chat.markAllMessagesAsRead(
    limit: 50,
    page: PubNubHashedPageBase(start: nextPageString)
  )
  response.memberships.forEach { membership in
    debugPrint("Channel: \(membership.channel.id) marked as read.")
  }
  debugPrint(String(describing: response.page))
}
```

## Get unread messages count (all channels) (deprecated)

:::warning Deprecated
Use [fetchUnreadMessagesCounts()](#get-unread-messages-count-all-channels) instead.
:::

`getUnreadMessagesCounts()` returns unread counts for all joined channels.

### Method signature

This method has the following signature:

```swift
chat.getUnreadMessagesCount(
    limit: Int? = nil,
    page: PubNubHashedPage? = nil,
    filter: String? = nil,
    sort: [PubNub.MembershipSortField] = []
) async throws -> [GetUnreadMessagesCount<ChannelImpl, MembershipImpl>]
```

#### Input

| Parameter | Description |
| --- | --- |
| `limit`Type: `Int`Default: `100` | Number of objects to return in response. The default (and maximum) value is `100`. |
| `page`Type: `PubNubHashedPage`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](https://www.pubnub.com/docs/general/metadata/filtering). |
| `sort`Type: `[PubNub.MembershipSortField]`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 |
| --- | --- |
| `[GetUnreadMessagesCount<ChannelImpl, MembershipImpl>]` | An array of `GetUnreadMessagesCount` representing unread messages for the current user in a given channel. It returns these details: `channel`, `membership`, `count`. |

### Sample code

:::tip Sample code
The code samples in Swift Chat SDK focus on asynchronous code execution.
You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.
:::

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

```swift
// Assumes a "ChatImpl" reference named "chat"
Task {
  // Returns info on all messages you didn't read on all joined channels
  let unreadMessagesResult = try await chat.getUnreadMessagesCount()
  // Iterate over an array of `GetUnreadMessagesCount`, printing details about each channel
  // and its number of unread messages
  unreadMessagesResult.forEach { unreadCount in
    debugPrint("Channel: \(unreadCount.channel.id)")
    debugPrint("Unread messages count: \(unreadCount.count)")
  }
}
```