Skip to content

Commit 1bfb257

Browse files
committed
docs: Update ChannelService docs about read events
1 parent 576c80f commit 1bfb257

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

projects/stream-chat-angular/src/lib/channel.service.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ export class ChannelService<
7676
* :::important
7777
* If you want to subscribe to channel events, you need to manually reenter Angular's change detection zone, our [Change detection guide](../concepts/change-detection.mdx) explains this in detail.
7878
* :::
79+
*
80+
* The active channel will always be marked as read when a new message is received
7981
*/
8082
activeChannel$: Observable<Channel<T> | undefined>;
8183
/**
@@ -344,7 +346,7 @@ export class ChannelService<
344346
}
345347

346348
/**
347-
* Sets the given `channel` as active.
349+
* Sets the given `channel` as active and marks it as read.
348350
* @param channel
349351
*/
350352
setAsActiveChannel(channel: Channel<T>) {
@@ -443,7 +445,7 @@ export class ChannelService<
443445
}
444446

445447
/**
446-
* Queries the channels with the given filters, sorts and options. More info about [channel querying](https://getstream.io/chat/docs/javascript/query_channels/?language=javascript) can be found in the platform documentation.
448+
* Queries the channels with the given filters, sorts and options. More info about [channel querying](https://getstream.io/chat/docs/javascript/query_channels/?language=javascript) can be found in the platform documentation. By default the first channel in the list will be set as active channel and will be marked as read.
447449
* @param filters
448450
* @param sort
449451
* @param options

0 commit comments

Comments
 (0)