stream-chat-angular 5.10.0 → 5.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -4
- package/assets/version.d.ts +1 -1
- package/esm2020/assets/version.mjs +2 -2
- package/esm2020/lib/attachment.service.mjs +2 -2
- package/esm2020/lib/channel/channel.component.mjs +2 -2
- package/esm2020/lib/channel-header/channel-header.component.mjs +2 -2
- package/esm2020/lib/channel-query.mjs +1 -1
- package/esm2020/lib/channel.service.mjs +12 -12
- package/esm2020/lib/chat-client.service.mjs +6 -6
- package/esm2020/lib/custom-templates.service.mjs +2 -2
- package/esm2020/lib/message/message.component.mjs +3 -3
- package/esm2020/lib/message-actions-box/message-actions-box.component.mjs +2 -2
- package/esm2020/lib/message-input/message-input-config.service.mjs +2 -2
- package/esm2020/lib/message-input/message-input.component.mjs +3 -3
- package/esm2020/lib/message-list/message-list.component.mjs +2 -2
- package/esm2020/lib/message-reactions/message-reactions.component.mjs +3 -3
- package/esm2020/lib/message-reactions-selector/message-reactions-selector.component.mjs +2 -2
- package/esm2020/lib/message-reactions.service.mjs +4 -4
- package/esm2020/lib/message.service.mjs +2 -2
- package/esm2020/lib/thread/thread.component.mjs +2 -2
- package/esm2020/lib/types.mjs +1 -1
- package/fesm2015/stream-chat-angular.mjs +36 -36
- package/fesm2015/stream-chat-angular.mjs.map +1 -1
- package/fesm2020/stream-chat-angular.mjs +36 -36
- package/fesm2020/stream-chat-angular.mjs.map +1 -1
- package/lib/attachment.service.d.ts +1 -1
- package/lib/channel/channel.component.d.ts +1 -1
- package/lib/channel-header/channel-header.component.d.ts +1 -1
- package/lib/channel-query.d.ts +1 -1
- package/lib/channel.service.d.ts +22 -22
- package/lib/chat-client.service.d.ts +7 -7
- package/lib/custom-templates.service.d.ts +1 -1
- package/lib/message/message.component.d.ts +2 -2
- package/lib/message-actions-box/message-actions-box.component.d.ts +1 -1
- package/lib/message-input/message-input-config.service.d.ts +1 -1
- package/lib/message-input/message-input.component.d.ts +3 -3
- package/lib/message-list/message-list.component.d.ts +1 -1
- package/lib/message-reactions/message-reactions.component.d.ts +2 -2
- package/lib/message-reactions-selector/message-reactions-selector.component.d.ts +1 -1
- package/lib/message-reactions.service.d.ts +4 -4
- package/lib/message.service.d.ts +1 -1
- package/lib/thread/thread.component.d.ts +1 -1
- package/lib/types.d.ts +1 -1
- package/package.json +2 -2
- package/src/assets/version.ts +1 -1
|
@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
|
|
|
9
9
|
/**
|
|
10
10
|
* The `AttachmentService` manages the uploads of a message input.
|
|
11
11
|
*
|
|
12
|
-
* You can read more about [uploads](
|
|
12
|
+
* You can read more about [uploads](/chat/docs/javascript/file_uploads/) in the Stream API documentation. You can use Stream's API or the dashboard to customize the [file](/chat/docs/javascript/app_setting_overview/#file-uploads) and [image upload](/chat/docs/javascript/app_setting_overview/#image-uploads) configuration.
|
|
13
13
|
*/
|
|
14
14
|
export declare class AttachmentService<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> {
|
|
15
15
|
private channelService;
|
|
@@ -4,7 +4,7 @@ import { ThemeService } from '../theme.service';
|
|
|
4
4
|
import { CustomTemplatesService } from '../custom-templates.service';
|
|
5
5
|
import * as i0 from "@angular/core";
|
|
6
6
|
/**
|
|
7
|
-
* The `Channel` component is a container component that displays the [`ChannelHeader`](/chat/docs/sdk/angular/components/ChannelHeaderComponent/), [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent), [`NotificationList`](/chat/docs/sdk/angular/components/NotificationListComponent/) and [`MessageInput`](/chat/docs/sdk/angular/components/MessageInputComponent/) components. You can also provide the [`Thread`](/chat/docs/sdk/angular/components/ThreadComponent/) component to use message [threads](
|
|
7
|
+
* The `Channel` component is a container component that displays the [`ChannelHeader`](/chat/docs/sdk/angular/components/ChannelHeaderComponent/), [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent), [`NotificationList`](/chat/docs/sdk/angular/components/NotificationListComponent/) and [`MessageInput`](/chat/docs/sdk/angular/components/MessageInputComponent/) components. You can also provide the [`Thread`](/chat/docs/sdk/angular/components/ThreadComponent/) component to use message [threads](/chat/docs/javascript/threads/).
|
|
8
8
|
*/
|
|
9
9
|
export declare class ChannelComponent {
|
|
10
10
|
private channelService;
|
|
@@ -6,7 +6,7 @@ import { CustomTemplatesService } from '../custom-templates.service';
|
|
|
6
6
|
import { ChannelActionsContext, ChannelHeaderInfoContext, DefaultStreamChatGenerics } from '../types';
|
|
7
7
|
import * as i0 from "@angular/core";
|
|
8
8
|
/**
|
|
9
|
-
* The `ChannelHeader` component displays the avatar and name of the currently active channel along with member and watcher information. You can read about [the difference between members and watchers](
|
|
9
|
+
* The `ChannelHeader` component displays the avatar and name of the currently active channel along with member and watcher information. You can read about [the difference between members and watchers](/chat/docs/javascript/watch_channel/#watchers-vs-members) in the platform documentation. Please note that number of watchers is only displayed if the user has [`connect-events` capability](/chat/docs/javascript/channel_capabilities/)
|
|
10
10
|
*/
|
|
11
11
|
export declare class ChannelHeaderComponent implements OnInit, OnDestroy {
|
|
12
12
|
private channelService;
|
package/lib/channel-query.d.ts
CHANGED
|
@@ -16,7 +16,7 @@ export declare class ChannelQuery<T extends DefaultStreamChatGenerics = DefaultS
|
|
|
16
16
|
*
|
|
17
17
|
* The method will be called with the result of the latest channel query.
|
|
18
18
|
*
|
|
19
|
-
* You can return either an offset, or a filter using the [`$lte`/`$gte` operator](
|
|
19
|
+
* You can return either an offset, or a filter using the [`$lte`/`$gte` operator](/chat/docs/javascript/query_syntax_operators/). If you return a filter, it will be merged with the filter provided for the `init` method.
|
|
20
20
|
*/
|
|
21
21
|
customPaginator?: (channelQueryResult: Channel<T>[]) => NextPageConfiguration;
|
|
22
22
|
private nextPageConfiguration?;
|
package/lib/channel.service.d.ts
CHANGED
|
@@ -17,7 +17,7 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
17
17
|
*/
|
|
18
18
|
hasMoreChannels$: Observable<boolean>;
|
|
19
19
|
/**
|
|
20
|
-
* Emits the currently loaded and [watched](
|
|
20
|
+
* Emits the currently loaded and [watched](/chat/docs/javascript/watch_channel/) channel list.
|
|
21
21
|
*
|
|
22
22
|
* :::important
|
|
23
23
|
* If you want to subscribe to channel events, you need to manually reenter Angular's change detection zone, our [Change detection guide](/chat/docs/sdk/angular/concepts/change-detection/) explains this in detail.
|
|
@@ -84,7 +84,7 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
84
84
|
[key: string]: Date;
|
|
85
85
|
}>;
|
|
86
86
|
/**
|
|
87
|
-
* If you're using [semantic filters for moderation](
|
|
87
|
+
* If you're using [semantic filters for moderation](/moderation/docs/) you can set up rules for bouncing messages.
|
|
88
88
|
*
|
|
89
89
|
* If a message is bounced, it will be emitted via this `Observable`. The built-in [`MessageBouncePrompt` component](/chat/docs/sdk/angular/components/MessageBouncePromptComponent/) will display the bounce option to the user if a bounced message is clicked.
|
|
90
90
|
*/
|
|
@@ -104,55 +104,55 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
104
104
|
/**
|
|
105
105
|
* 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](/chat/docs/sdk/angular/services/ChannelService/#channels/)
|
|
106
106
|
*
|
|
107
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
107
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
108
108
|
*/
|
|
109
109
|
customNewMessageNotificationHandler?: (clientEvent: ClientEvent, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void) => void;
|
|
110
110
|
/**
|
|
111
111
|
* 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](/chat/docs/sdk/angular/services/ChannelService/#channels/).
|
|
112
112
|
*
|
|
113
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
113
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
114
114
|
*/
|
|
115
115
|
customAddedToChannelNotificationHandler?: (clientEvent: ClientEvent, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void) => void;
|
|
116
116
|
/**
|
|
117
117
|
* 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](/chat/docs/sdk/angular/services/ChannelService/#channels/).
|
|
118
118
|
*
|
|
119
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
119
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
120
120
|
*/
|
|
121
121
|
customRemovedFromChannelNotificationHandler?: (clientEvent: ClientEvent, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void) => void;
|
|
122
122
|
/**
|
|
123
123
|
* Custom event handler to call when a channel is deleted, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/).
|
|
124
124
|
*
|
|
125
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
125
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
126
126
|
*/
|
|
127
127
|
customChannelDeletedHandler?: (event: Event, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: StreamMessage<T> | undefined) => void) => void;
|
|
128
128
|
/**
|
|
129
129
|
* Custom event handler to call when a channel is updated, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/).
|
|
130
130
|
*
|
|
131
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
131
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
132
132
|
*/
|
|
133
133
|
customChannelUpdatedHandler?: (event: Event, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage[]) => void, threadListSetter: (messages: StreamMessage[]) => void, parentMessageSetter: (message: StreamMessage | undefined) => void) => void;
|
|
134
134
|
/**
|
|
135
135
|
* Custom event handler to call when a channel is truncated, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/).
|
|
136
136
|
*
|
|
137
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
137
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
138
138
|
*/
|
|
139
139
|
customChannelTruncatedHandler?: (event: Event, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: StreamMessage<T> | undefined) => void) => void;
|
|
140
140
|
/**
|
|
141
141
|
* Custom event handler to call when a channel becomes hidden, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/).
|
|
142
142
|
*
|
|
143
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
143
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
144
144
|
*/
|
|
145
145
|
customChannelHiddenHandler?: (event: Event, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: StreamMessage<T> | undefined) => void) => void;
|
|
146
146
|
/**
|
|
147
147
|
* Custom event handler to call when a channel becomes visible, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/).
|
|
148
148
|
*
|
|
149
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
149
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
150
150
|
*/
|
|
151
151
|
customChannelVisibleHandler?: (event: Event, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: StreamMessage<T> | undefined) => void) => void;
|
|
152
152
|
/**
|
|
153
153
|
* 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](/chat/docs/sdk/angular/services/ChannelService/#channels/).
|
|
154
154
|
*
|
|
155
|
-
* If you're adding a new channel, make sure that it's a [watched](
|
|
155
|
+
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
|
|
156
156
|
*/
|
|
157
157
|
customNewMessageHandler?: (event: Event, channel: Channel<T>, channelListSetter: (channels: Channel<T>[], shouldStopWatchingRemovedChannels?: boolean) => void, messageListSetter: (messages: StreamMessage<T>[]) => void, threadListSetter: (messages: StreamMessage<T>[]) => void, parentMessageSetter: (message: StreamMessage<T> | undefined) => void) => void;
|
|
158
158
|
/**
|
|
@@ -237,7 +237,7 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
237
237
|
*
|
|
238
238
|
* The method will be called with the result of the latest channel query.
|
|
239
239
|
*
|
|
240
|
-
* You can return either an offset, or a filter using the [`$lte`/`$gte` operator](
|
|
240
|
+
* You can return either an offset, or a filter using the [`$lte`/`$gte` operator](/chat/docs/javascript/query_syntax_operators/). If you return a filter, it will be merged with the filter provided for the `init` method.
|
|
241
241
|
*/
|
|
242
242
|
set customPaginator(paginator: ((channelQueryResult: Channel<T>[]) => NextPageConfiguration) | undefined);
|
|
243
243
|
/**
|
|
@@ -257,17 +257,17 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
257
257
|
*/
|
|
258
258
|
setAsActiveParentMessage(message: StreamMessage<T> | undefined, loadMessagesForm?: 'request' | 'state'): Promise<void>;
|
|
259
259
|
/**
|
|
260
|
-
* Loads the next page of messages of the active channel. The page size can be set in the [query option](
|
|
260
|
+
* Loads the next page of messages of the active channel. The page size can be set in the [query option](/chat/docs/javascript/query_channels/#query-options) object.
|
|
261
261
|
* @param direction
|
|
262
262
|
*/
|
|
263
263
|
loadMoreMessages(direction?: 'older' | 'newer'): false | Promise<import("stream-chat").QueryChannelAPIResponse<T>> | undefined;
|
|
264
264
|
/**
|
|
265
|
-
* Loads the next page of messages of the active thread. The page size can be set in the [query option](
|
|
265
|
+
* Loads the next page of messages of the active thread. The page size can be set in the [query option](/chat/docs/javascript/query_channels/#query-options) object.
|
|
266
266
|
* @param direction
|
|
267
267
|
*/
|
|
268
268
|
loadMoreThreadReplies(direction?: 'older' | 'newer'): false | Promise<void>;
|
|
269
269
|
/**
|
|
270
|
-
* Queries the channels with the given filters, sorts and options. More info about [channel querying](
|
|
270
|
+
* Queries the channels with the given filters, sorts and options. More info about [channel querying](/chat/docs/javascript/query_channels/) 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.
|
|
271
271
|
* @param filters
|
|
272
272
|
* @param sort
|
|
273
273
|
* @param options
|
|
@@ -276,7 +276,7 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
276
276
|
*/
|
|
277
277
|
init(filters: ChannelFilters<T>, sort?: ChannelSort<T>, options?: ChannelOptions, shouldSetActiveChannel?: boolean): Promise<Channel<T>[]>;
|
|
278
278
|
/**
|
|
279
|
-
* Queries the channels with the given query function. More info about [channel querying](
|
|
279
|
+
* Queries the channels with the given query function. More info about [channel querying](/chat/docs/javascript/query_channels/) can be found in the platform documentation.
|
|
280
280
|
* @param query
|
|
281
281
|
* @param options
|
|
282
282
|
* @param options.shouldSetActiveChannel The `shouldSetActiveChannel` specifies if the first channel in the result should be selected as the active channel or not. Default is `true`.
|
|
@@ -292,7 +292,7 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
292
292
|
*/
|
|
293
293
|
reset(): void;
|
|
294
294
|
/**
|
|
295
|
-
* Loads the next page of channels. The page size can be set in the [query option](
|
|
295
|
+
* Loads the next page of channels. The page size can be set in the [query option](/chat/docs/javascript/query_channels/#query-options) object.
|
|
296
296
|
*/
|
|
297
297
|
loadMoreChannels(): Promise<void>;
|
|
298
298
|
/**
|
|
@@ -409,18 +409,18 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
409
409
|
*/
|
|
410
410
|
deleteMessage(message: StreamMessage, isLocalDelete?: boolean): Promise<void>;
|
|
411
411
|
/**
|
|
412
|
-
* Uploads files to the channel. If you want to know more about [file uploads](
|
|
412
|
+
* Uploads files to the channel. If you want to know more about [file uploads](/chat/docs/javascript/file_uploads/) check out the platform documentation.
|
|
413
413
|
* @param uploads the attachments to upload (output of the [`AttachmentService`](/chat/docs/sdk/angular/services/AttachmentService/))
|
|
414
414
|
* @returns the result of file upload requests
|
|
415
415
|
*/
|
|
416
416
|
uploadAttachments(uploads: AttachmentUpload[]): Promise<AttachmentUpload[]>;
|
|
417
417
|
/**
|
|
418
|
-
* Deletes an uploaded file by URL. If you want to know more about [file uploads](
|
|
418
|
+
* Deletes an uploaded file by URL. If you want to know more about [file uploads](/chat/docs/javascript/file_uploads/) check out the platform documentation
|
|
419
419
|
* @param attachmentUpload Attachment to be deleted (output of the [`AttachmentService`](/chat/docs/sdk/angular/services/AttachmentService/))
|
|
420
420
|
*/
|
|
421
421
|
deleteAttachment(attachmentUpload: AttachmentUpload): Promise<void>;
|
|
422
422
|
/**
|
|
423
|
-
* 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](
|
|
423
|
+
* 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](/chat/docs/javascript/query_members/#pagination-and-ordering) with the given search term.
|
|
424
424
|
* @param searchTerm Text to search for in the names of members
|
|
425
425
|
* @returns The list of members matching the search filter
|
|
426
426
|
*/
|
|
@@ -503,8 +503,8 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
503
503
|
*/
|
|
504
504
|
get activeChannelThreadReplies(): (StreamMessage<T> | MessageResponse<T> | FormatMessageResponse<T>)[];
|
|
505
505
|
/**
|
|
506
|
-
* 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](
|
|
507
|
-
* @deprecated use [`messageReactionsService.queryReactions()`](
|
|
506
|
+
* 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](/chat/docs/javascript/send_reaction/#paginating-reactions).
|
|
507
|
+
* @deprecated use [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions) instead
|
|
508
508
|
* @param messageId
|
|
509
509
|
* @returns all reactions of a message
|
|
510
510
|
*/
|
|
@@ -20,14 +20,14 @@ export declare class ChatClientService<T extends DefaultStreamChatGenerics = Def
|
|
|
20
20
|
*/
|
|
21
21
|
chatClient: StreamChat<T>;
|
|
22
22
|
/**
|
|
23
|
-
* Emits [`ClientEvent`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/chat-client.service.ts) events. The platform documentation covers [the list of client, user presence and notification events](
|
|
23
|
+
* Emits [`ClientEvent`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/chat-client.service.ts) events. The platform documentation covers [the list of client, user presence and notification events](/chat/docs/javascript/event_object/).
|
|
24
24
|
* :::important
|
|
25
25
|
* For performance reasons this Observable operates outside of the Angular change detection zone. If you subscribe to it, you need to manually reenter Angular's change detection zone, our [Change detection guide](/chat/docs/sdk/angular/concepts/change-detection/) explains this in detail.
|
|
26
26
|
* :::
|
|
27
27
|
*/
|
|
28
28
|
events$: Observable<ClientEvent<T>>;
|
|
29
29
|
/**
|
|
30
|
-
* Emits the current [application settings](
|
|
30
|
+
* Emits the current [application settings](/chat/docs/javascript/app_setting_overview/). Since getting the application settings is an expensive API call and we don't always need the result, this is not initialized by default, you need to call `getApplicationSettings` to load them.
|
|
31
31
|
*/
|
|
32
32
|
appSettings$: Observable<AppSettings | undefined>;
|
|
33
33
|
/**
|
|
@@ -52,14 +52,14 @@ export declare class ChatClientService<T extends DefaultStreamChatGenerics = Def
|
|
|
52
52
|
private appSettingsPromise?;
|
|
53
53
|
constructor(ngZone: NgZone, notificationService: NotificationService);
|
|
54
54
|
/**
|
|
55
|
-
* Creates a [`StreamChat`](https://github.com/GetStream/stream-chat-js/blob/668b3e5521339f4e14fc657834531b4c8bf8176b/src/client.ts#L124) instance using the provided `apiKey`, and connects a user with the given meta data and token. More info about [connecting users](
|
|
55
|
+
* Creates a [`StreamChat`](https://github.com/GetStream/stream-chat-js/blob/668b3e5521339f4e14fc657834531b4c8bf8176b/src/client.ts#L124) instance using the provided `apiKey`, and connects a user with the given meta data and token. More info about [connecting users](/chat/docs/javascript/init_and_users/) can be found in the platform documentation.
|
|
56
56
|
* @param apiKey
|
|
57
57
|
* @param userOrId you can emit this for anonymous logins
|
|
58
58
|
* @param userTokenOrProvider You can provide:<ul>
|
|
59
59
|
* <li> a token, </li>
|
|
60
60
|
* <li> a token provider, a method that returns `Promise<string>`, which can be called when the previous token expires (recommended setup for production applications)</li>
|
|
61
|
-
* <li> the keyword 'guest' to connect as [guest user](
|
|
62
|
-
* <li> the keyword 'anonymous' to connect as [anonymous user](
|
|
61
|
+
* <li> the keyword 'guest' to connect as [guest user](/chat/docs/javascript/authless_users/#guest-users) </li>
|
|
62
|
+
* <li> the keyword 'anonymous' to connect as [anonymous user](/chat/docs/javascript/authless_users/#anonymous-users) </li>
|
|
63
63
|
* </ul>
|
|
64
64
|
* @param clientOptions Setting to provide to the Stream client instance
|
|
65
65
|
*/
|
|
@@ -71,11 +71,11 @@ export declare class ChatClientService<T extends DefaultStreamChatGenerics = Def
|
|
|
71
71
|
*/
|
|
72
72
|
disconnectUser(): Promise<void>;
|
|
73
73
|
/**
|
|
74
|
-
* Loads the current [application settings](
|
|
74
|
+
* Loads the current [application settings](/chat/docs/javascript/app_setting_overview/), if the application settings have already been loaded, it does nothing.
|
|
75
75
|
*/
|
|
76
76
|
getAppSettings(): Promise<void>;
|
|
77
77
|
/**
|
|
78
|
-
* Flag the message with the given ID. If you want to know [more about flags](
|
|
78
|
+
* Flag the message with the given ID. If you want to know [more about flags](/chat/docs/javascript/moderation/) check out the platform documentation.
|
|
79
79
|
* @param messageId
|
|
80
80
|
*/
|
|
81
81
|
flagMessage(messageId: string): Promise<void>;
|
|
@@ -173,7 +173,7 @@ export declare class CustomTemplatesService<T extends DefaultStreamChatGenerics
|
|
|
173
173
|
*/
|
|
174
174
|
attachmentActionsTemplate$: BehaviorSubject<TemplateRef<AttachmentContext> | undefined>;
|
|
175
175
|
/**
|
|
176
|
-
* The template used to display [system messages](
|
|
176
|
+
* The template used to display [system messages](/chat/docs/javascript/silent_messages/) indise the [message component](/chat/docs/sdk/angular/components/MessageComponent/)
|
|
177
177
|
*/
|
|
178
178
|
systemMessageTemplate$: BehaviorSubject<TemplateRef<SystemMessageContext> | undefined>;
|
|
179
179
|
/**
|
|
@@ -34,7 +34,7 @@ export declare class MessageComponent implements OnInit, OnChanges, OnDestroy, A
|
|
|
34
34
|
*/
|
|
35
35
|
message: StreamMessage | undefined;
|
|
36
36
|
/**
|
|
37
|
-
* The list of [channel capabilities](
|
|
37
|
+
* The list of [channel capabilities](/chat/docs/javascript/channel_capabilities/) that are enabled for the current user, the list of [supported interactions](/chat/docs/sdk/angular/concepts/message-interactions/) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI. The [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent/) component automatically sets this based on [channel capabilities](/chat/docs/javascript/channel_capabilities/).
|
|
38
38
|
*/
|
|
39
39
|
enabledMessageActions: string[];
|
|
40
40
|
/**
|
|
@@ -42,7 +42,7 @@ export declare class MessageComponent implements OnInit, OnChanges, OnDestroy, A
|
|
|
42
42
|
*/
|
|
43
43
|
isLastSentMessage: boolean | undefined;
|
|
44
44
|
/**
|
|
45
|
-
* Determines if the message is being dispalyed in a channel or in a [thread](
|
|
45
|
+
* Determines if the message is being dispalyed in a channel or in a [thread](/chat/docs/javascript/threads/).
|
|
46
46
|
*/
|
|
47
47
|
mode: 'thread' | 'main';
|
|
48
48
|
/**
|
|
@@ -23,7 +23,7 @@ export declare class MessageActionsBoxComponent implements OnInit, OnChanges, On
|
|
|
23
23
|
*/
|
|
24
24
|
messageTextHtmlElement: HTMLElement | undefined;
|
|
25
25
|
/**
|
|
26
|
-
* The list of [channel capabilities](
|
|
26
|
+
* The list of [channel capabilities](/chat/docs/javascript/channel_capabilities/) that are enabled for the current user, the list of [supported interactions](/chat/docs/sdk/angular/concepts/message-interactions) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI.
|
|
27
27
|
*/
|
|
28
28
|
enabledActions: string[];
|
|
29
29
|
messageActionItemTemplate: TemplateRef<MessageActionBoxItemContext> | undefined;
|
|
@@ -7,7 +7,7 @@ import * as i0 from "@angular/core";
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class MessageInputConfigService {
|
|
9
9
|
/**
|
|
10
|
-
* If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](
|
|
10
|
+
* If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](/chat/docs/javascript/channel_capabilities/).
|
|
11
11
|
*/
|
|
12
12
|
isFileUploadEnabled: boolean | undefined;
|
|
13
13
|
/**
|
|
@@ -14,7 +14,7 @@ import { VoiceRecorderService } from './voice-recorder.service';
|
|
|
14
14
|
import { AudioRecorderService } from '../voice-recorder/audio-recorder.service';
|
|
15
15
|
import * as i0 from "@angular/core";
|
|
16
16
|
/**
|
|
17
|
-
* The `MessageInput` component displays an input where users can type their messages and upload files, and sends the message to the active channel. The component can be used to compose new messages or update existing ones. To send messages, the chat user needs to have the necessary [channel capability](
|
|
17
|
+
* The `MessageInput` component displays an input where users can type their messages and upload files, and sends the message to the active channel. The component can be used to compose new messages or update existing ones. To send messages, the chat user needs to have the necessary [channel capability](/chat/docs/javascript/channel_capabilities/).
|
|
18
18
|
*/
|
|
19
19
|
export declare class MessageInputComponent implements OnInit, OnChanges, OnDestroy, AfterViewInit {
|
|
20
20
|
private channelService;
|
|
@@ -30,7 +30,7 @@ export declare class MessageInputComponent implements OnInit, OnChanges, OnDestr
|
|
|
30
30
|
readonly voiceRecorderService: VoiceRecorderService;
|
|
31
31
|
audioRecorder?: AudioRecorderService | undefined;
|
|
32
32
|
/**
|
|
33
|
-
* If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](
|
|
33
|
+
* If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](/chat/docs/javascript/channel_capabilities/). If no value is provided, it is set from the [`MessageInputConfigService`](/chat/docs/sdk/angular/services/MessageInputConfigService/).
|
|
34
34
|
*/
|
|
35
35
|
isFileUploadEnabled: boolean | undefined;
|
|
36
36
|
/**
|
|
@@ -42,7 +42,7 @@ export declare class MessageInputComponent implements OnInit, OnChanges, OnDestr
|
|
|
42
42
|
*/
|
|
43
43
|
mentionScope: 'channel' | 'application' | undefined;
|
|
44
44
|
/**
|
|
45
|
-
* Determines if the message is being dispalyed in a channel or in a [thread](
|
|
45
|
+
* Determines if the message is being dispalyed in a channel or in a [thread](/chat/docs/javascript/threads/).
|
|
46
46
|
*/
|
|
47
47
|
mode: 'thread' | 'main';
|
|
48
48
|
/**
|
|
@@ -19,7 +19,7 @@ export declare class MessageListComponent implements AfterViewChecked, OnChanges
|
|
|
19
19
|
private ngZone;
|
|
20
20
|
private cdRef;
|
|
21
21
|
/**
|
|
22
|
-
* Determines if the message list should display channel messages or [thread messages](
|
|
22
|
+
* Determines if the message list should display channel messages or [thread messages](/chat/docs/javascript/threads/).
|
|
23
23
|
*/
|
|
24
24
|
mode: 'main' | 'thread';
|
|
25
25
|
/**
|
|
@@ -5,7 +5,7 @@ import { MessageReactionsService } from '../message-reactions.service';
|
|
|
5
5
|
import { CustomTemplatesService } from '../custom-templates.service';
|
|
6
6
|
import * as i0 from "@angular/core";
|
|
7
7
|
/**
|
|
8
|
-
* The `MessageReactions` component displays the reactions of a message. You can read more about [message reactions](
|
|
8
|
+
* The `MessageReactions` component displays the reactions of a message. You can read more about [message reactions](/chat/docs/javascript/send_reaction/) in the platform documentation.
|
|
9
9
|
*/
|
|
10
10
|
export declare class MessageReactionsComponent implements OnChanges, OnInit, AfterViewInit, OnDestroy {
|
|
11
11
|
private cdRef;
|
|
@@ -30,7 +30,7 @@ export declare class MessageReactionsComponent implements OnChanges, OnInit, Aft
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* List of reactions of a [message](/chat/docs/sdk/angular/types/stream-message/), used to display the users of a reaction type.
|
|
33
|
-
* @deprecated you can fetch the reactions using [`messageReactionsService.queryReactions()`](
|
|
33
|
+
* @deprecated you can fetch the reactions using [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions)
|
|
34
34
|
*/
|
|
35
35
|
latestReactions: ReactionResponse<DefaultStreamChatGenerics>[];
|
|
36
36
|
/**
|
|
@@ -5,7 +5,7 @@ import { ChannelService } from '../channel.service';
|
|
|
5
5
|
import { MessageReactionsService } from '../message-reactions.service';
|
|
6
6
|
import * as i0 from "@angular/core";
|
|
7
7
|
/**
|
|
8
|
-
* The `MessageReactionsSelectorComponent` makes it possible for users to react to a message, the reaction options can be set using the [`MessageReactionsService`](/chat/docs/sdk/angular/services/MessageReactionsService/). You can read more about [message reactions](
|
|
8
|
+
* The `MessageReactionsSelectorComponent` makes it possible for users to react to a message, the reaction options can be set using the [`MessageReactionsService`](/chat/docs/sdk/angular/services/MessageReactionsService/). You can read more about [message reactions](/chat/docs/javascript/send_reaction/) in the platform documentation.
|
|
9
9
|
*/
|
|
10
10
|
export declare class MessageReactionsSelectorComponent implements OnInit, OnDestroy, AfterViewInit {
|
|
11
11
|
private channelService;
|
|
@@ -4,14 +4,14 @@ import { ChatClientService } from './chat-client.service';
|
|
|
4
4
|
import { NotificationService } from './notification.service';
|
|
5
5
|
import * as i0 from "@angular/core";
|
|
6
6
|
/**
|
|
7
|
-
* The `MessageReactionsService` provides customization options to message [reactions](
|
|
7
|
+
* The `MessageReactionsService` provides customization options to message [reactions](/chat/docs/javascript/send_reaction/).
|
|
8
8
|
*
|
|
9
9
|
*/
|
|
10
10
|
export declare class MessageReactionsService {
|
|
11
11
|
private chatClientService;
|
|
12
12
|
private notificationService;
|
|
13
13
|
/**
|
|
14
|
-
* The enabled [reactions](
|
|
14
|
+
* The enabled [reactions](/chat/docs/javascript/send_reaction/) and the associated emoji
|
|
15
15
|
*
|
|
16
16
|
* You can provide any string as a reaction. The emoji can be provided as a string, if you want to use custom images for reactions you have to provide a [custom reactions UI](/chat/docs/sdk/angular/services/CustomTemplatesService/#messagereactionstemplate/)
|
|
17
17
|
*/
|
|
@@ -21,7 +21,7 @@ export declare class MessageReactionsService {
|
|
|
21
21
|
/**
|
|
22
22
|
* By default the [`MessageReactionsComponent`](/chat/docs/sdk/angular/components/MessageReactionsComponent/) will display the reacting users when a reaction is clicked. You can override this with your own UI by providing a custom event handler.
|
|
23
23
|
*
|
|
24
|
-
* The event handler can retrieve all reactions of a message using the [`messageReactionsService.queryReactions()`](
|
|
24
|
+
* The event handler can retrieve all reactions of a message using the [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions)
|
|
25
25
|
*/
|
|
26
26
|
customReactionClickHandler?: (details: MessageReactionClickDetails) => void;
|
|
27
27
|
constructor(chatClientService: ChatClientService, notificationService: NotificationService);
|
|
@@ -38,7 +38,7 @@ export declare class MessageReactionsService {
|
|
|
38
38
|
[key in MessageReactionType]: string;
|
|
39
39
|
};
|
|
40
40
|
/**
|
|
41
|
-
* Query reactions of a specific message, more info in the [API documentation](
|
|
41
|
+
* Query reactions of a specific message, more info in the [API documentation](/chat/docs/javascript/send_reaction/#query-reactions)
|
|
42
42
|
* @param messageId
|
|
43
43
|
* @param type
|
|
44
44
|
* @param next
|
package/lib/message.service.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ export declare class MessageService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
9
9
|
* Decides if the message content should be formatted as text or HTML
|
|
10
10
|
*
|
|
11
11
|
* If you display messages as text the following parts are still be displayed as HTML:
|
|
12
|
-
* - user mentions -> you can customize this with your own template using the [`customTemplatesService.mentionTemplate$`](
|
|
12
|
+
* - user mentions -> you can customize this with your own template using the [`customTemplatesService.mentionTemplate$`](/chat/docs/sdk/angular/services/CustomTemplatesService/#mentiontemplate)
|
|
13
13
|
* - links -> you can customize this by providing you own [`customLinkRenderer`](#customlinkrenderer) method
|
|
14
14
|
*/
|
|
15
15
|
displayAs: 'text' | 'html';
|
|
@@ -6,7 +6,7 @@ import { CustomTemplatesService } from '../custom-templates.service';
|
|
|
6
6
|
import { DefaultStreamChatGenerics, StreamMessage, ThreadHeaderContext } from '../types';
|
|
7
7
|
import * as i0 from "@angular/core";
|
|
8
8
|
/**
|
|
9
|
-
* The `Thread` component represents a [message thread](
|
|
9
|
+
* The `Thread` component represents a [message thread](/chat/docs/javascript/threads/), it is a container component that displays a thread with a header, [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent) and [`MessageInput`](/chat/docs/sdk/angular/components/MessageInputComponent/) components.
|
|
10
10
|
*/
|
|
11
11
|
export declare class ThreadComponent implements OnDestroy {
|
|
12
12
|
customTemplatesService: CustomTemplatesService;
|
package/lib/types.d.ts
CHANGED
|
@@ -208,7 +208,7 @@ export declare type MessageReactionsContext = {
|
|
|
208
208
|
messageReactionCounts: {
|
|
209
209
|
[key in MessageReactionType]?: number;
|
|
210
210
|
};
|
|
211
|
-
/** @deprecated you can fetch the reactions using [`chatService.chatClient.queryReactions()`](
|
|
211
|
+
/** @deprecated you can fetch the reactions using [`chatService.chatClient.queryReactions()`](/chat/docs/javascript/send_reaction/&q=queryReactions#query-reactions) */
|
|
212
212
|
latestReactions: ReactionResponse<DefaultStreamChatGenerics>[];
|
|
213
213
|
ownReactions: ReactionResponse<DefaultStreamChatGenerics>[];
|
|
214
214
|
messageReactionGroups: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "stream-chat-angular",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.11.0",
|
|
4
4
|
"description": "Angular components to create chat conversations or livestream style chat",
|
|
5
5
|
"author": "GetStream",
|
|
6
6
|
"homepage": "https://getstream.io/chat/",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"dayjs": "^1.11.10",
|
|
48
48
|
"emoji-regex": "^10.3.0",
|
|
49
49
|
"fix-webm-duration": "^1.0.6",
|
|
50
|
-
"ngx-float-ui": "^15.0.0|| ^16.0.0 || ^17.0.0 || ^18.0.0 || ^18.0.1-rc.0",
|
|
50
|
+
"ngx-float-ui": "^15.0.0|| ^16.0.0 || ^17.0.0 || ^18.0.0 || ^18.0.1-rc.0 || ^19.0.0",
|
|
51
51
|
"pretty-bytes": "^6.1.1",
|
|
52
52
|
"tslib": "^2.3.0",
|
|
53
53
|
"uuid": "^9.0.1"
|
package/src/assets/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const version = '5.
|
|
1
|
+
export const version = '5.11.0';
|