ChannelService

The ChannelService provides data and interaction for the channel list and message list.

Type parameters

Properties

activeChannel$

activeChannel$: Observable<undefined | Channel<T>>

Emits the currently active channel.

:::important If you want to subscribe to channel events, you need to manually reenter Angular’s change detection zone, our Change detection guide explains this in detail. :::

The active channel will always be marked as read when a new message is received

Defined in

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

activeChannelLastReadMessageId

Optional activeChannelLastReadMessageId: string

The last read message id of the active channel, it’s used by the message list component to display unread UI, and jump to latest read message

This property isn’t always updated, please use channel.read to display up-to-date read information

Defined in

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

activeChannelMessages$

activeChannelMessages$: Observable<StreamMessage<T>[]>

Emits the list of currently loaded messages of the active channel.

Defined in

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

activeChannelPinnedMessages$

activeChannelPinnedMessages$: Observable<StreamMessage<T>[]>

Emits the list of pinned messages of the active channel.

Defined in

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

activeChannelUnreadCount

Optional activeChannelUnreadCount: number

The unread count of the active channel, it’s used by the message list component to display unread UI

This property isn’t always updated, please use channel.read to display up-to-date read information

Defined in

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

activeParentMessage$

activeParentMessage$: Observable<undefined | StreamMessage<T>>

Emits the currently selected parent message. If no message is selected, it emits undefined.

Defined in

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

activeParentMessageId$

activeParentMessageId$: Observable<undefined | string>

Emits the id of the currently selected parent message. If no message is selected, it emits undefined.

Defined in

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

activeThreadMessages$

activeThreadMessages$: Observable<StreamMessage<T>[]>

Emits the list of currently loaded thread replies belonging to the selected parent message. If there is no currently active thread it emits an empty array.

Defined in

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

beforeSendMessage

Optional beforeSendMessage: (input: MessageInput<T>) => MessageInput<T> | Promise<MessageInput<T>>

The provided method will be called before a new message is sent to Stream’s API. You can use this hook to tranfrom or enrich the message being sent.

Type declaration

(input): MessageInput<T> | Promise<MessageInput<T>>

Parameters

Returns

MessageInput<T> | Promise<MessageInput<T>>

Defined in

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

beforeUpdateMessage

Optional beforeUpdateMessage: (message: StreamMessage<T>) => StreamMessage<T> | Promise<StreamMessage<T>>

The provided method will be called before a message is sent to Stream’s API for update. You can use this hook to tranfrom or enrich the message being updated.

Type declaration

(message): StreamMessage<T> | Promise<StreamMessage<T>>

Parameters

Returns

StreamMessage<T> | Promise<StreamMessage<T>>

Defined in

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

bouncedMessage$

bouncedMessage$: BehaviorSubject<undefined | StreamMessage<T>>

If you’re using semantic filters for moderation you can set up rules for bouncing messages.

If a message is bounced, it will be emitted via this Observable. The built-in MessageBouncePrompt component will display the bounce option to the user if a bounced message is clicked.

Defined in

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

channelQueryState$

channelQueryState$: Observable<undefined | ChannelQueryState>

The result of the latest channel query request.

Defined in

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

channels$

channels$: Observable<undefined | Channel<T>[]>

Emits the currently loaded and watched channel list.

:::important If you want to subscribe to channel events, you need to manually reenter Angular’s change detection zone, our Change detection guide explains this in detail. :::

Defined in

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

customAddedToChannelNotificationHandler

Optional customAddedToChannelNotificationHandler: (clientEvent: ClientEvent<DefaultStreamChatGenerics>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void) => void

Custom event handler to call when the user is added to a channel, provide an event handler if you want to override the default channel list ordering.

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(clientEvent, channelListSetter): void

Parameters

Returns

void

Defined in

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

customChannelDeletedHandler

Optional customChannelDeletedHandler: (event: Event<DefaultGenerics>, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: undefined | StreamMessage<T>) => void) => void

Custom event handler to call when a channel is deleted, provide an event handler if you want to override the default channel list ordering.

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(event, channel, channelListSetter, messageListSetter, threadListSetter, parentMessageSetter): void

Parameters

Returns

void

Defined in

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

customChannelHiddenHandler

Optional customChannelHiddenHandler: (event: Event<DefaultGenerics>, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: undefined | StreamMessage<T>) => void) => void

Custom event handler to call when a channel becomes hidden, provide an event handler if you want to override the default channel list ordering.

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(event, channel, channelListSetter, messageListSetter, threadListSetter, parentMessageSetter): void

Parameters

Returns

void

Defined in

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

customChannelTruncatedHandler

Optional customChannelTruncatedHandler: (event: Event<DefaultGenerics>, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: undefined | StreamMessage<T>) => void) => void

Custom event handler to call when a channel is truncated, provide an event handler if you want to override the default channel list ordering.

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(event, channel, channelListSetter, messageListSetter, threadListSetter, parentMessageSetter): void

Parameters

Returns

void

Defined in

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

customChannelUpdatedHandler

Optional customChannelUpdatedHandler: (event: Event<DefaultGenerics>, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<DefaultStreamChatGenerics>[]) => void, threadListSetter: (messages: StreamMessage<DefaultStreamChatGenerics>[]) => void, parentMessageSetter: (message: undefined | StreamMessage<DefaultStreamChatGenerics>) => void) => void

Custom event handler to call when a channel is updated, provide an event handler if you want to override the default channel list ordering.

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(event, channel, channelListSetter, messageListSetter, threadListSetter, parentMessageSetter): void

Parameters

Returns

void

Defined in

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

customChannelVisibleHandler

Optional customChannelVisibleHandler: (event: Event<DefaultGenerics>, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: undefined | StreamMessage<T>) => void) => void

Custom event handler to call when a channel becomes visible, provide an event handler if you want to override the default channel list ordering.

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(event, channel, channelListSetter, messageListSetter, threadListSetter, parentMessageSetter): void

Parameters

Returns

void

Defined in

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

customFileDeleteRequest

Optional customFileDeleteRequest: (url: string, channel: Channel<T>) => Promise<void>

You can override the default file delete request - override this if you use your own CDN

Type declaration

(url, channel): Promise<void>

Parameters

Returns

Promise<void>

Defined in

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

customFileUploadRequest

Optional customFileUploadRequest: (file: File, channel: Channel<T>) => Promise<{ file: string }>

You can override the default file upload request - you can use this to upload files to your own CDN

Type declaration

(file, channel): Promise<{ file: string }>

Parameters

Returns

Promise<{ file: string }>

Defined in

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

customImageDeleteRequest

Optional customImageDeleteRequest: (url: string, channel: Channel<T>) => Promise<void>

You can override the default image delete request - override this if you use your own CDN

Type declaration

(url, channel): Promise<void>

Parameters

Returns

Promise<void>

Defined in

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

customImageUploadRequest

Optional customImageUploadRequest: (file: File, channel: Channel<T>) => Promise<{ file: string }>

You can override the default image upload request - you can use this to upload images to your own CDN

Type declaration

(file, channel): Promise<{ file: string }>

Parameters

Returns

Promise<{ file: string }>

Defined in

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

customNewMessageHandler

Optional customNewMessageHandler: (event: Event<DefaultGenerics>, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: undefined | StreamMessage<T>) => void) => void

Custom event handler to call if a new message received from a channel that is being watched, provide an event handler if you want to override the default channel list ordering.

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(event, channel, channelListSetter, messageListSetter, threadListSetter, parentMessageSetter): void

Parameters

Returns

void

Defined in

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

customNewMessageNotificationHandler

Optional customNewMessageNotificationHandler: (clientEvent: ClientEvent<DefaultStreamChatGenerics>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void) => void

Custom event handler to call if a new message received from a channel that is not being watched, provide an event handler if you want to override the default channel list ordering

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(clientEvent, channelListSetter): void

Parameters

Returns

void

Defined in

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

customRemovedFromChannelNotificationHandler

Optional customRemovedFromChannelNotificationHandler: (clientEvent: ClientEvent<DefaultStreamChatGenerics>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void) => void

Custom event handler to call when the user is removed from a channel, provide an event handler if you want to override the default channel list ordering.

If you’re adding a new channel, make sure that it’s a watched channel.

Type declaration

(clientEvent, channelListSetter): void

Parameters

Returns

void

Defined in

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

hasMoreChannels$

hasMoreChannels$: Observable<boolean>

Emits false if there are no more pages of channels that can be loaded.

Defined in

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

jumpToMessage$

jumpToMessage$: Observable<{ id?: string ; parentId?: string }>

Emits the ID of the message the message list should jump to (can be a channel message or thread message)

Defined in

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

latestMessageDateByUserByChannels$

latestMessageDateByUserByChannels$: Observable<{ [key: string]: Date; }>

Emits a map that contains the date of the latest message sent by the current user by channels (this is used to detect if slow mode countdown should be started)

Defined in

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

messageDeleteConfirmationHandler

Optional messageDeleteConfirmationHandler: (message: StreamMessage<T>) => Promise<boolean>

The provided method will be called before deleting a message. If the returned Promise resolves to true to deletion will go ahead. If false is returned, the message won’t be deleted.

Type declaration

(message): Promise<boolean>

Parameters

Returns

Promise<boolean>

Defined in

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

messageToQuote$

messageToQuote$: Observable<undefined | StreamMessage<T>>

Emits the currently selected message to quote

Defined in

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

usersTypingInChannel$

usersTypingInChannel$: Observable<UserResponse<T>[]>

Emits the list of users that are currently typing in the channel (current user is not included)

Defined in

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

usersTypingInThread$

usersTypingInThread$: Observable<UserResponse<T>[]>

Emits the list of users that are currently typing in the active thread (current user is not included)

Defined in

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

MAX_MESSAGE_REACTIONS_TO_FETCH

▪ Static Readonly MAX_MESSAGE_REACTIONS_TO_FETCH: 1200

Defined in

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

Accessors

activeChannel

get activeChannel(): undefined | Channel<T>

The current active channel

Returns

undefined | Channel<T>

Defined in

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

activeChannelMessages

get activeChannelMessages(): (StreamMessage<T> | MessageResponse<T> | FormatMessageResponse<T>)[]

The current active channel messages

Returns

(StreamMessage<T> | MessageResponse<T> | FormatMessageResponse<T>)[]

Defined in

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

activeChannelThreadReplies

get activeChannelThreadReplies(): (StreamMessage<T> | MessageResponse<T> | FormatMessageResponse<T>)[]

The current thread replies

Returns

(StreamMessage<T> | MessageResponse<T> | FormatMessageResponse<T>)[]

Defined in

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

channels

get channels(): Channel<T>[]

The current list of channels

Returns

Channel<T>[]

Defined in

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

customPaginator

set customPaginator(paginator): void

By default the SDK uses an offset based pagination, you can change/extend this by providing your own custom paginator method.

The method will be called with the result of the latest channel query.

You can return either an offset, or a filter using the $lte/$gte operator. If you return a filter, it will be merged with the filter provided for the init method.

Parameters

Returns

void

Defined in

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

shouldMarkActiveChannelAsRead

get shouldMarkActiveChannelAsRead(): boolean

If set to false, read events won’t be sent as new messages are received. If set to true active channel (if any) will immediately be marked as read.

Returns

boolean

Defined in

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

set shouldMarkActiveChannelAsRead(shouldMarkActiveChannelAsRead): void

If set to false, read events won’t be sent as new messages are received. If set to true active channel (if any) will immediately be marked as read.

Parameters

Returns

void

Defined in

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

Methods

addChannel

addChannel(channel): void

Add a new channel to the channel list The channel will be added to the beginning of the channel list

Parameters

Returns

void

Defined in

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

addReaction

addReaction(messageId, reactionType, customData?): Promise<void>

Adds a reaction to a message.

Parameters

Returns

Promise<void>

Defined in

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

autocompleteMembers

autocompleteMembers(searchTerm): Promise<ChannelMemberResponse<T>[]>

Returns the autocomplete options for current channel members. If the channel has less than 100 members, it returns the channel members, otherwise sends a search request with the given search term.

Parameters

Returns

Promise<ChannelMemberResponse<T>[]>

The list of members matching the search filter

Defined in

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

clearMessageJump

clearMessageJump(): void

Clears the currently selected message to jump

Returns

void

Defined in

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

deleteAttachment

deleteAttachment(attachmentUpload): Promise<void>

Deletes an uploaded file by URL. If you want to know more about file uploads check out the platform documentation

Parameters

Returns

Promise<void>

Defined in

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

deleteMessage

deleteMessage(message, isLocalDelete?): Promise<void>

Deletes the message from the active channel

Parameters

Returns

Promise<void>

Defined in

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

deselectActiveChannel

deselectActiveChannel(): void

Deselects the currently active (if any) channel

Returns

void

Defined in

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

getMessageReactions

getMessageReactions(messageId): Promise<ReactionResponse<T>[]>

Get the last 1200 reactions of a message in the current active channel. If you need to fetch more reactions please use the following endpoint.

Parameters

Returns

Promise<ReactionResponse<T>[]>

all reactions of a message

Deprecated

use messageReactionsService.queryReactions() instead

Defined in

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

init

init(filters, sort?, options?, shouldSetActiveChannel?): Promise<Channel<T>[]>

Queries the channels with the given filters, sorts and options. More info about channel querying 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.

Parameters

Returns

Promise<Channel<T>[]>

the list of channels found by the query

Defined in

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

initWithCustomQuery

initWithCustomQuery(query, options?): Promise<Channel<T>[]>

Queries the channels with the given query function. More info about channel querying can be found in the platform documentation.

Parameters

Returns

Promise<Channel<T>[]>

the channels that were loaded

Defined in

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

jumpToMessage

jumpToMessage(messageId, parentMessageId?): Promise<void>

Jumps to the selected message inside the message list, if the message is not yet loaded, it’ll load the message (and it’s surroundings) from the API.

Parameters

Returns

Promise<void>

Defined in

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

loadMoreChannels

loadMoreChannels(): Promise<void>

Loads the next page of channels. The page size can be set in the query option object.

Returns

Promise<void>

Defined in

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

loadMoreMessages

loadMoreMessages(direction?): undefined | false | Promise<QueryChannelAPIResponse<T>>

Loads the next page of messages of the active channel. The page size can be set in the query option object.

Parameters

Returns

undefined | false | Promise<QueryChannelAPIResponse<T>>

Defined in

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

loadMoreThreadReplies

loadMoreThreadReplies(direction?): false | Promise<void>

Loads the next page of messages of the active thread. The page size can be set in the query option object.

Parameters

Returns

false | Promise<void>

Defined in

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

markMessageUnread

markMessageUnread(messageId): Promise<undefined | null | APIResponse>

Marks the channel from the given message as unread

Parameters

Returns

Promise<undefined | null | APIResponse>

the result of the request

Defined in

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

pinMessage

pinMessage(message): Promise<void>

Pins the given message in the channel

Parameters

Returns

Promise<void>

Defined in

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

removeChannel

removeChannel(cid, shouldStopWatching?): void

Parameters

Returns

void

Defined in

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

removeReaction

removeReaction(messageId, reactionType): Promise<void>

Removes a reaction from a message.

Parameters

Returns

Promise<void>

Defined in

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

resendMessage

resendMessage(message): Promise<StreamMessage<T>>

Resends the given message to the active channel

Parameters

Returns

Promise<StreamMessage<T>>

Defined in

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

reset

reset(): void

Resets the activeChannel$, channels$ and activeChannelMessages$ Observables. Useful when disconnecting a chat user, use in combination with disconnectUser.

Returns

void

Defined in

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

selectMessageToQuote

selectMessageToQuote(message): void

Selects or deselects the current message to quote reply to

Parameters

Returns

void

Defined in

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

sendAction

sendAction(messageId, formData, parentMessageId?): Promise<void>

Runs a message action in the current channel. Updates the message list based on the action result (if no message is returned, the message will be removed from the message list).

Parameters

Returns

Promise<void>

Defined in

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

sendMessage

sendMessage(text, attachments?, mentionedUsers?, parentId?, quotedMessageId?, customData?): Promise<StreamMessage<T>>

Sends a message to the active channel. The message is immediately added to the message list, if an error occurs and the message can’t be sent, the error is indicated in state of the message.

Parameters

Returns

Promise<StreamMessage<T>>

Defined in

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

setAsActiveChannel

setAsActiveChannel(channel): void

Sets the given channel as active and marks it as read. If the channel wasn’t previously part of the channel, it will be added to the beginning of the list.

Parameters

Returns

void

Defined in

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

setAsActiveParentMessage

setAsActiveParentMessage(message, loadMessagesForm?): Promise<void>

Sets the given message as an active parent message. If undefined is provided, it will deleselect the current parent message.

Parameters

Returns

Promise<void>

Defined in

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

typingStarted

typingStarted(parentId?): Promise<void>

Call this method if user started typing in the active channel

Parameters

Returns

Promise<void>

Defined in

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

typingStopped

typingStopped(parentId?): Promise<void>

Call this method if user stopped typing in the active channel

Parameters

Returns

Promise<void>

Defined in

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

unpinMessage

unpinMessage(message): Promise<void>

Removes the given message from pinned messages

Parameters

Returns

Promise<void>

Defined in

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

updateMessage

updateMessage(message): Promise<StreamMessage<T> | T["messageType"] & {} & {} & {} & Omit<MessageResponse<{}>, "status" | "created_at" | "pinned_at" | "updated_at" | "deleted_at"> & UR & {}>

Updates the message in the active channel

Parameters

Returns

Promise<StreamMessage<T> | T["messageType"] & {} & {} & {} & Omit<MessageResponse<{}>, "status" | "created_at" | "pinned_at" | "updated_at" | "deleted_at"> & UR & {}>

Defined in

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

uploadAttachments

uploadAttachments(uploads): Promise<AttachmentUpload<DefaultStreamChatGenerics>[]>

Uploads files to the channel. If you want to know more about file uploads check out the platform documentation.

Parameters

Returns

Promise<AttachmentUpload<DefaultStreamChatGenerics>[]>

the result of file upload requests

Defined in

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