ChannelService

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

Properties

activeChannel$

activeChannel$: Observable<undefined | Channel>

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

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

activeChannelMessages$

activeChannelMessages$: Observable<StreamMessage[]>

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

Defined in

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

activeChannelPinnedMessages$

activeChannelPinnedMessages$: Observable<StreamMessage[]>

Emits the list of pinned messages of the active channel.

Defined in

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

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

activeParentMessage$

activeParentMessage$: Observable<undefined | StreamMessage>

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

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

activeThreadMessages$

activeThreadMessages$: Observable<StreamMessage[]>

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

beforeSendMessage

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

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 | Promise<MessageInput>

Parameters

Name	Type
`input`	`MessageInput`

Returns

MessageInput | Promise<MessageInput>

Defined in

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

beforeUpdateMessage

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

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 | Promise<StreamMessage>

Parameters

Name	Type
`message`	`StreamMessage`

Returns

StreamMessage | Promise<StreamMessage>

Defined in

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

bouncedMessage$

bouncedMessage$: BehaviorSubject<undefined | StreamMessage>

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

channelQueryState$

channelQueryState$: Observable<undefined | ChannelQueryState>

The result of the latest channel query request.

Defined in

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

channels$

channels$: Observable<undefined | Channel[]>

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

customAddedToChannelNotificationHandler

Optional customAddedToChannelNotificationHandler: (clientEvent: ClientEvent, channelListSetter: (channels: Channel[], 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

Name	Type
`clientEvent`	`ClientEvent`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`

Returns

void

Defined in

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

customChannelDeletedHandler

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

Name	Type
`event`	`Event`
`channel`	`Channel`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`
`messageListSetter`	(`messages`: `StreamMessage`[]) => `void`
`threadListSetter`	(`messages`: `StreamMessage`[]) => `void`
`parentMessageSetter`	(`message`: `undefined` \| `StreamMessage`) => `void`

Returns

void

Defined in

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

customChannelHiddenHandler

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

Name	Type
`event`	`Event`
`channel`	`Channel`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`
`messageListSetter`	(`messages`: `StreamMessage`[]) => `void`
`threadListSetter`	(`messages`: `StreamMessage`[]) => `void`
`parentMessageSetter`	(`message`: `undefined` \| `StreamMessage`) => `void`

Returns

void

Defined in

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

customChannelTruncatedHandler

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

Name	Type
`event`	`Event`
`channel`	`Channel`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`
`messageListSetter`	(`messages`: `StreamMessage`[]) => `void`
`threadListSetter`	(`messages`: `StreamMessage`[]) => `void`
`parentMessageSetter`	(`message`: `undefined` \| `StreamMessage`) => `void`

Returns

void

Defined in

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

customChannelUpdatedHandler

Optional customChannelUpdatedHandler: (event: Event, channel: Channel, channelListSetter: (channels: Channel[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage[]) => void, threadListSetter: (messages: StreamMessage[]) => void, parentMessageSetter: (message: undefined | StreamMessage) => 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

Name	Type
`event`	`Event`
`channel`	`Channel`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`
`messageListSetter`	(`messages`: `StreamMessage`[]) => `void`
`threadListSetter`	(`messages`: `StreamMessage`[]) => `void`
`parentMessageSetter`	(`message`: `undefined` \| `StreamMessage`) => `void`

Returns

void

Defined in

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

customChannelVisibleHandler

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

Name	Type
`event`	`Event`
`channel`	`Channel`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`
`messageListSetter`	(`messages`: `StreamMessage`[]) => `void`
`threadListSetter`	(`messages`: `StreamMessage`[]) => `void`
`parentMessageSetter`	(`message`: `undefined` \| `StreamMessage`) => `void`

Returns

void

Defined in

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

customFileDeleteRequest

Optional customFileDeleteRequest: (url: string, channel: Channel) => 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

Name	Type
`url`	`string`
`channel`	`Channel`

Returns

Promise<void>

Defined in

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

customFileUploadRequest

Optional customFileUploadRequest: (file: File, channel: Channel) => 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

Name	Type
`file`	`File`
`channel`	`Channel`

Returns

Promise<{ file: string }>

Defined in

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

customImageDeleteRequest

Optional customImageDeleteRequest: (url: string, channel: Channel) => 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

Name	Type
`url`	`string`
`channel`	`Channel`

Returns

Promise<void>

Defined in

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

customImageUploadRequest

Optional customImageUploadRequest: (file: File, channel: Channel) => 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

Name	Type
`file`	`File`
`channel`	`Channel`

Returns

Promise<{ file: string }>

Defined in

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

customNewMessageHandler

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

Name	Type
`event`	`Event`
`channel`	`Channel`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`
`messageListSetter`	(`messages`: `StreamMessage`[]) => `void`
`threadListSetter`	(`messages`: `StreamMessage`[]) => `void`
`parentMessageSetter`	(`message`: `undefined` \| `StreamMessage`) => `void`

Returns

void

Defined in

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

customNewMessageNotificationHandler

Optional customNewMessageNotificationHandler: (clientEvent: ClientEvent, channelListSetter: (channels: Channel[], 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

Name	Type
`clientEvent`	`ClientEvent`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`

Returns

void

Defined in

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

customRemovedFromChannelNotificationHandler

Optional customRemovedFromChannelNotificationHandler: (clientEvent: ClientEvent, channelListSetter: (channels: Channel[], 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

Name	Type
`clientEvent`	`ClientEvent`
`channelListSetter`	(`channels`: `Channel`[], `shouldStopWatchingRemovedChannels?`: `boolean`) => `void`

Returns

void

Defined in

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

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

isMessageLoadingInProgress

isMessageLoadingInProgress: boolean = false

Defined in

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

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

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

messageDeleteConfirmationHandler

Optional messageDeleteConfirmationHandler: (message: StreamMessage) => 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

Name	Type
`message`	`StreamMessage`

Returns

Promise<boolean>

Defined in

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

messageToQuote$

messageToQuote$: Observable<undefined | StreamMessage>

Emits the currently selected message to quote

Defined in

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

usersTypingInChannel$

usersTypingInChannel$: Observable<UserResponse[]>

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

usersTypingInThread$

usersTypingInThread$: Observable<UserResponse[]>

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

MAX_MESSAGE_REACTIONS_TO_FETCH

▪ Static Readonly MAX_MESSAGE_REACTIONS_TO_FETCH: 1200

Defined in

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

Accessors

activeChannel

get activeChannel(): undefined | Channel

The current active channel

Returns

undefined | Channel

Defined in

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

activeChannelMessages

get activeChannelMessages(): (MessageResponse | FormatMessageResponse | StreamMessage)[]

The current active channel messages

Returns

(MessageResponse | FormatMessageResponse | StreamMessage)[]

Defined in

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

activeChannelThreadReplies

get activeChannelThreadReplies(): (MessageResponse | FormatMessageResponse | StreamMessage)[]

The current thread replies

Returns

(MessageResponse | FormatMessageResponse | StreamMessage)[]

Defined in

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

channels

get channels(): Channel[]

The current list of channels

Returns

Channel[]

Defined in

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

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

Name	Type
`paginator`	`undefined` \| (`channelQueryResult`: `Channel`[]) => `NextPageConfiguration`

Returns

void

Defined in

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

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

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

Name	Type
`shouldMarkActiveChannelAsRead`	`boolean`

Returns

void

Defined in

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

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

Name	Type
`channel`	`Channel`

Returns

void

Defined in

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

addReaction

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

Adds a reaction to a message.

Parameters

Name	Type	Description
`messageId`	`string`	The id of the message to add the reaction to
`reactionType`	`string`	The type of the reaction
`customData?`	`CustomReactionData`

Returns

Promise<void>

Defined in

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

autocompleteMembers

autocompleteMembers(searchTerm): Promise<ChannelMemberResponse[]>

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

Name	Type	Description
`searchTerm`	`string`	Text to search for in the names of members

Returns

Promise<ChannelMemberResponse[]>

The list of members matching the search filter

Defined in

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

clearMessageJump

clearMessageJump(): void

Clears the currently selected message to jump

Returns

void

Defined in

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

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

Name	Type	Description
`attachmentUpload`	`AttachmentUpload`	Attachment to be deleted (output of the `AttachmentService`)

Returns

Promise<void>

Defined in

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

deleteMessage

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

Deletes the message from the active channel

Parameters

Name	Type	Default value	Description
`message`	`StreamMessage`	`undefined`	Message to be deleted
`isLocalDelete`	`boolean`	`false`	set this `true` if you want to delete a message that’s only part of the local state, not yet saved on the backend

Returns

Promise<void>

Defined in

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

deselectActiveChannel

deselectActiveChannel(): void

Deselects the currently active (if any) channel

Returns

void

Defined in

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

getMessageReactions

getMessageReactions(messageId): Promise<ReactionResponse[]>

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

Name	Type
`messageId`	`string`

Returns

Promise<ReactionResponse[]>

all reactions of a message

Deprecated

use messageReactionsService.queryReactions() instead

Defined in

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

init

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

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

Name	Type	Default value	Description
`filters`	`ChannelFilters`	`undefined`
`sort?`	`ChannelSort`	`undefined`
`options?`	`ChannelOptions`	`undefined`
`shouldSetActiveChannel`	`boolean`	`true`	Decides if the first channel in the result should be made as an active channel or not.

Returns

Promise<Channel[]>

the list of channels found by the query

Defined in

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

initWithCustomQuery

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

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

Parameters

Name	Type	Description
`query`	(`queryType`: `ChannelQueryType`) => `Promise`<`ChannelQueryResult`>
`options`	`Object`
`options.messagePageSize`	`number`	How many messages should we load? The default is 25
`options.shouldSetActiveChannel`	`boolean`	The `shouldSetActiveChannel` specifies if the first channel in the result should be selected as the active channel or not. Default is `true`.

Returns

Promise<Channel[]>

the channels that were loaded

Defined in

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

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

Name	Type	Description
`messageId`	`string`	The ID of the message to be loaded, ‘latest’ means jump to the latest messages
`parentMessageId?`	`string`	The ID of the parent message if we want to load a thread message

Returns

Promise<void>

Defined in

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

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

loadMoreMessages

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

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

Parameters

Name	Type	Default value
`direction`	`"older"` \| `"newer"`	`'older'`

Returns

undefined | false | Promise<QueryChannelAPIResponse>

Defined in

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

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

Name	Type	Default value
`direction`	`"older"` \| `"newer"`	`'older'`

Returns

false | Promise<void>

Defined in

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

markMessageUnread

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

Marks the channel from the given message as unread

Parameters

Name	Type
`messageId`	`string`

Returns

Promise<undefined | null | APIResponse>

the result of the request

Defined in

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

pinMessage

pinMessage(message): Promise<void>

Pins the given message in the channel

Parameters

Name	Type
`message`	`StreamMessage`

Returns

Promise<void>

Defined in

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

removeChannel

removeChannel(cid, shouldStopWatching?): void

Parameters

Name	Type	Default value
`cid`	`string`	`undefined`
`shouldStopWatching`	`boolean`	`true`

Returns

void

Defined in

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

removeReaction

removeReaction(messageId, reactionType): Promise<void>

Removes a reaction from a message.

Parameters

Name	Type	Description
`messageId`	`string`	The id of the message to remove the reaction from
`reactionType`	`string`	Thr type of reaction to remove

Returns

Promise<void>

Defined in

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

resendMessage

resendMessage(message): Promise<StreamMessage>

Resends the given message to the active channel

Parameters

Name	Type	Description
`message`	`StreamMessage`	The message to resend

Returns

Promise<StreamMessage>

Defined in

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

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

selectMessageToQuote

selectMessageToQuote(message): void

Selects or deselects the current message to quote reply to

Parameters

Name	Type	Description
`message`	`undefined` \| `StreamMessage`	The message to select, if called with `undefined`, it deselects the message

Returns

void

Defined in

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

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

Name	Type
`messageId`	`string`
`formData`	`Record`<`string`, `string`>
`parentMessageId?`	`string`

Returns

Promise<void>

Defined in

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

sendMessage

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

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

Name	Type	Default value	Description
`text`	`string`	`undefined`	The text of the message
`attachments`	`Attachment`[]	`[]`	The attachments
`mentionedUsers`	`UserResponse`[]	`[]`	Mentioned users
`parentId`	`undefined` \| `string`	`undefined`	Id of the parent message (if sending a thread reply)
`quotedMessageId`	`undefined` \| `string`	`undefined`	Id of the message to quote (if sending a quote reply)
`customData`	`undefined` \| `CustomMessageData`	`undefined`

Returns

Promise<StreamMessage>

Defined in

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

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.