Channels

When you retrieve a channel from the API (e.g. using query channels), the read state for all members is included in the response. This allows you to display which messages are read by each user. For each member, we include the last time he or she marked the channel as read.

// Get channel val queryChannelRequest = QueryChannelRequest().withState()  client.queryChannel(  channelType = "channel-type",  channelId = "channel-id",  request = queryChannelRequest, ).enqueue { result ->  if (result.isSuccess) {  // readState is the list of read states for each user on the channel  val readState: List<ChannelUserRead> = result.data().read  } else {  // Handle result.error()  } }

const channel = client.channel("messaging", "test"); await channel.watch();  console.log(channel.state.read);  //{ '2fe6019c-872f-482a-989e-ecf4f786501b': // { user: // { // id: '2fe6019c-872f-482a-989e-ecf4f786501b', // role: 'user', // created_at: '2019-04-24T13:09:19.664378Z', // updated_at: '2019-04-24T13:09:23.784642Z', // last_active: '2019-04-24T13:09:23.781641Z', // online: true // }, // last_read: '2019-04-24T13:09:21.623Z', // } //}

final response = await channel.watch();  // readState is the list of read states for each user on the channel List<Read> readState = response.read;

let channelController = client.channelController(for: .init(type: .messaging, id: "general"))  channelController.synchronize() { error in  if error == nil {  channelController.channel?.reads  } }

const FChannelProperties Properties{TEXT("channel-type"), TEXT("channel-id")}; Client->WatchChannel(  Properties,  [](UChatChannel* Channel)  {  // ReadState is the list of read states for each user on the channel  const TArray<FRead>& ReadState = Channel->State.Read;  });

// Get channel QueryChannelRequest queryChannelRequest = new QueryChannelRequest().withState();  client.queryChannel("channel-type", "channel-id", queryChannelRequest).enqueue((result) -> {  if (result.isSuccess()) {  // readState is the list of read states for each user on the channel  List<ChannelUserRead> readState = result.data().getRead();  } else {  // Handle result.error()  } });

// Every channel maintains a full list of read state for each channel member foreach (var read in channel.Read) {  Debug.Log(read.User); // User  Debug.Log(read.UnreadMessages); // How many unread messages  Debug.Log(read.LastRead); // Last read date }

Unread Messages Per Channel

You can retrieve the count of unread messages for the current user on a channel like this:

// Get channel val queryChannelRequest = QueryChannelRequest().withState()  client.queryChannel(  channelType = "channel-type",  channelId = "channel-id",  request = queryChannelRequest, ).enqueue { result ->  if (result.isSuccess) {  // Unread count for current user  val unreadCount = result.data().unreadCount  } else {  // Handle result.error()  } }

channel.countUnread();

channel.unreadCount();

let channelController = client.channelController(for: .init(type: .messaging, id: "general"))  class ChannelDelegate: ChatChannelControllerDelegate {  func channelController(_ channelController: ChatChannelController,  didUpdateChannel channel: EntityChange<ChatChannel>) {  channelController.channel?.unreadCount  } }  channelController.delegate = ChannelDelegate()  channelController.synchronize()

Channel->State.UnreadCount();

// Get channel QueryChannelRequest queryChannelRequest = new QueryChannelRequest().withState();  client.queryChannel("channel-type", "channel-id", queryChannelRequest).enqueue((result) -> {  if (result.isSuccess()) {  // Unread count for current user  Integer unreadCount = result.data().getUnreadCount();  } else {  // Handle result.error()  } });

// Every channel maintains a full list of read state for each channel member foreach (var read in channel.Read) {  Debug.Log(read.User); // User  Debug.Log(read.UnreadMessages); // How many unread messages  Debug.Log(read.LastRead); // Last read date }

Unread Mentions Per Channel

You can retrieve the count of unread messages mentioning the current user on a channel like this:

// Get channel val queryChannelRequest = QueryChannelRequest().withState() val currentUser = client.getCurrentUser() if (currentUser == null) {  // Handle user not connected state  return }  client.queryChannel(  channelType = "channel-type",  channelId = "channel-id",  request = queryChannelRequest, ).enqueue { result ->  if (result.isSuccess) {  // Unread mentions  val channel = result.data()  val unreadCount = channel.countUnreadMentionsForUser(currentUser)  } else {  // Handle result.error()  } }

channel.countUnreadMentions();

let channelController = client.channelController(for: .init(type: .messaging, id: "general"))  class ChannelDelegate: ChatChannelControllerDelegate {  func channelController(_ channelController: ChatChannelController,  didUpdateChannel channel: EntityChange<ChatChannel>) {  channelController.channel?.unreadCount.mentionedMessages  } }  channelController.delegate = ChannelDelegate()  channelController.synchronize()

// Get channel QueryChannelRequest queryChannelRequest = new QueryChannelRequest().withState(); User currentUser = client.getCurrentUser(); if (currentUser == null) {  // Handle user not connected state  return; }  client.queryChannel("channel-type", "channel-id", queryChannelRequest).enqueue((result) -> {  if (result.isSuccess()) {  // Unread mentions  Channel channel = result.data();  Integer unreadCount = ChannelExtensionKt.countUnreadMentionsForUser(channel, currentUser);  } else {  // Handle result.error()  } });

// Will be implemented soon, raise a GitHub issue if you need this feature https://github.com/GetStream/stream-chat-unity/issues/

Mark All As Read

You can mark all channels as read for a user like this:

client.markAllRead().enqueue { result ->  if (result.isSuccess) {  //Handle success  } else {  //Handle failure  } }

// client-side await client.markAllRead();  // mark all as read for one user server-side await serverSideClient.markAllRead({ user: { id: "myid" } });

// mark all messages on all channels as read for one user, server-side $client->markAllRead('user-id');

await client.markRead();

let channelListController = client.channelListController(query: .init(filter: .containMembers(userIds: ["joe"]))) channelListController.markAllRead()

Client->MarkAllRead();

client.markAllRead().enqueue((result) -> {  if (result.isSuccess()) {  //Handle success  } else {  //Handle failure  } });

// Mark this message as last read await message.MarkMessageAsLastReadAsync();  // Mark whole channel as read await channel.MarkChannelReadAsync();

Unread

Typing Indicators