stream-chat-angular 5.9.1 → 5.11.0-test-update.1
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/assets/version.d.ts +1 -1
- package/esm2020/assets/version.mjs +2 -2
- package/esm2020/lib/attachment.service.mjs +4 -4
- package/esm2020/lib/avatar-placeholder/avatar-placeholder.component.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 +15 -15
- package/esm2020/lib/chat-client.service.mjs +7 -7
- package/esm2020/lib/custom-templates.service.mjs +44 -44
- package/esm2020/lib/icon/icon-placeholder/icon-placeholder.component.mjs +2 -2
- package/esm2020/lib/icon/loading-indicator-placeholder/loading-indicator-placeholder.component.mjs +2 -2
- package/esm2020/lib/message/message.component.mjs +4 -4
- package/esm2020/lib/message-actions-box/message-actions-box.component.mjs +3 -3
- package/esm2020/lib/message-actions.service.mjs +2 -2
- package/esm2020/lib/message-bounce-prompt/message-bounce-prompt.component.mjs +2 -2
- package/esm2020/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.mjs +86 -33
- package/esm2020/lib/message-input/emoji-input.service.mjs +3 -3
- package/esm2020/lib/message-input/message-input-config.service.mjs +11 -4
- package/esm2020/lib/message-input/message-input.component.mjs +4 -4
- package/esm2020/lib/message-input/textarea/textarea.component.mjs +2 -2
- package/esm2020/lib/message-list/message-list.component.mjs +2 -2
- package/esm2020/lib/message-reactions/message-reactions.component.mjs +5 -5
- package/esm2020/lib/message-reactions-selector/message-reactions-selector.component.mjs +3 -3
- package/esm2020/lib/message-reactions.service.mjs +5 -5
- package/esm2020/lib/message.service.mjs +2 -2
- package/esm2020/lib/notification/notification.component.mjs +2 -2
- package/esm2020/lib/notification.service.mjs +2 -2
- package/esm2020/lib/stream-i18n.service.mjs +2 -2
- package/esm2020/lib/theme.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 +193 -136
- package/fesm2015/stream-chat-angular.mjs.map +1 -1
- package/fesm2020/stream-chat-angular.mjs +191 -133
- package/fesm2020/stream-chat-angular.mjs.map +1 -1
- package/lib/attachment.service.d.ts +4 -4
- package/lib/avatar-placeholder/avatar-placeholder.component.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 +37 -37
- package/lib/chat-client.service.d.ts +10 -10
- package/lib/custom-templates.service.d.ts +43 -43
- package/lib/icon/icon-placeholder/icon-placeholder.component.d.ts +1 -1
- package/lib/icon/loading-indicator-placeholder/loading-indicator-placeholder.component.d.ts +1 -1
- package/lib/message/message.component.d.ts +3 -3
- package/lib/message-actions-box/message-actions-box.component.d.ts +2 -2
- package/lib/message-actions.service.d.ts +2 -2
- package/lib/message-bounce-prompt/message-bounce-prompt.component.d.ts +1 -1
- package/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.d.ts +8 -5
- package/lib/message-input/emoji-input.service.d.ts +2 -2
- package/lib/message-input/message-input-config.service.d.ts +12 -4
- package/lib/message-input/message-input.component.d.ts +8 -8
- package/lib/message-input/textarea/textarea.component.d.ts +2 -2
- package/lib/message-list/message-list.component.d.ts +1 -1
- package/lib/message-reactions/message-reactions.component.d.ts +4 -4
- package/lib/message-reactions-selector/message-reactions-selector.component.d.ts +2 -2
- package/lib/message-reactions.service.d.ts +6 -6
- package/lib/message.service.d.ts +1 -1
- package/lib/notification/notification.component.d.ts +1 -1
- package/lib/notification.service.d.ts +1 -1
- package/lib/stream-i18n.service.d.ts +1 -1
- package/lib/theme.service.d.ts +1 -1
- package/lib/thread/thread.component.d.ts +1 -1
- package/lib/types.d.ts +40 -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;
|
|
@@ -25,13 +25,13 @@ export declare class AttachmentService<T extends DefaultStreamChatGenerics = Def
|
|
|
25
25
|
*/
|
|
26
26
|
attachmentUploadInProgressCounter$: BehaviorSubject<number>;
|
|
27
27
|
/**
|
|
28
|
-
* Emits the state of the uploads ([`AttachmentUpload[]`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/types.ts)), it adds a state (`success`, `error` or `uploading`) to each file the user selects for upload. It is used by the [`AttachmentPreviewList`](
|
|
28
|
+
* Emits the state of the uploads ([`AttachmentUpload[]`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/types.ts)), it adds a state (`success`, `error` or `uploading`) to each file the user selects for upload. It is used by the [`AttachmentPreviewList`](/chat/docs/sdk/angular/components/AttachmentPreviewListComponent/) to display the attachment previews.
|
|
29
29
|
*/
|
|
30
30
|
attachmentUploads$: Observable<AttachmentUpload[]>;
|
|
31
31
|
/**
|
|
32
32
|
* You can get and set the list if uploaded custom attachments
|
|
33
33
|
*
|
|
34
|
-
* By default the SDK components won't display these, but you can provide your own `customAttachmentPreviewListTemplate$` and `customAttachmentListTemplate$` for the [`CustomTemplatesService`](
|
|
34
|
+
* By default the SDK components won't display these, but you can provide your own `customAttachmentPreviewListTemplate$` and `customAttachmentListTemplate$` for the [`CustomTemplatesService`](/chat/docs/sdk/angular/services/CustomTemplatesService/).
|
|
35
35
|
*/
|
|
36
36
|
customAttachments$: BehaviorSubject<Attachment<T>[]>;
|
|
37
37
|
/**
|
|
@@ -67,7 +67,7 @@ export declare class AttachmentService<T extends DefaultStreamChatGenerics = Def
|
|
|
67
67
|
/**
|
|
68
68
|
* You can add custom `image`, `video` and `file` attachments using this method.
|
|
69
69
|
*
|
|
70
|
-
* Note: If you just want to use your own CDN for file uploads, you don't necessary need this method, you can just specify you own upload function in the [`ChannelService`](
|
|
70
|
+
* Note: If you just want to use your own CDN for file uploads, you don't necessary need this method, you can just specify you own upload function in the [`ChannelService`](/chat/docs/sdk/angular/services/ChannelService/)
|
|
71
71
|
* @param attachment
|
|
72
72
|
*/
|
|
73
73
|
addAttachment(attachment: Attachment<T>): void;
|
|
@@ -4,7 +4,7 @@ import { CustomTemplatesService } from '../custom-templates.service';
|
|
|
4
4
|
import { AvatarContext, AvatarLocation, AvatarType, DefaultStreamChatGenerics } from '../types';
|
|
5
5
|
import * as i0 from "@angular/core";
|
|
6
6
|
/**
|
|
7
|
-
* The `AvatarPlaceholder` component displays the [default avatar](
|
|
7
|
+
* The `AvatarPlaceholder` component displays the [default avatar](/chat/docs/sdk/angular/components/AvatarComponent/) unless a [custom template](/chat/docs/sdk/angular/services/CustomTemplatesService/) is provided. This component is used by the SDK internally, you likely won't need to use it.
|
|
8
8
|
*/
|
|
9
9
|
export declare class AvatarPlaceholderComponent implements OnChanges {
|
|
10
10
|
customTemplatesService: CustomTemplatesService;
|
|
@@ -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`](
|
|
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,10 +17,10 @@ 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
|
-
* If you want to subscribe to channel events, you need to manually reenter Angular's change detection zone, our [Change detection guide](
|
|
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.
|
|
24
24
|
* :::
|
|
25
25
|
*/
|
|
26
26
|
channels$: Observable<Channel<T>[] | undefined>;
|
|
@@ -32,7 +32,7 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
32
32
|
* Emits the currently active channel.
|
|
33
33
|
*
|
|
34
34
|
* :::important
|
|
35
|
-
* If you want to subscribe to channel events, you need to manually reenter Angular's change detection zone, our [Change detection guide](
|
|
35
|
+
* 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.
|
|
36
36
|
* :::
|
|
37
37
|
*
|
|
38
38
|
* The active channel will always be marked as read when a new message is received
|
|
@@ -84,9 +84,9 @@ 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
|
-
* If a message is bounced, it will be emitted via this `Observable`. The built-in [`MessageBouncePrompt` component](
|
|
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
|
*/
|
|
91
91
|
bouncedMessage$: BehaviorSubject<StreamMessage<T> | undefined>;
|
|
92
92
|
/**
|
|
@@ -102,57 +102,57 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
102
102
|
*/
|
|
103
103
|
activeChannelUnreadCount?: number;
|
|
104
104
|
/**
|
|
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](
|
|
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
|
-
* 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](
|
|
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
|
-
* 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](
|
|
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
|
-
* Custom event handler to call when a channel is deleted, provide an event handler if you want to override the [default channel list ordering](
|
|
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
|
-
* Custom event handler to call when a channel is updated, provide an event handler if you want to override the [default channel list ordering](
|
|
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
|
-
* Custom event handler to call when a channel is truncated, provide an event handler if you want to override the [default channel list ordering](
|
|
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
|
-
* Custom event handler to call when a channel becomes hidden, provide an event handler if you want to override the [default channel list ordering](
|
|
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
|
-
* Custom event handler to call when a channel becomes visible, provide an event handler if you want to override the [default channel list ordering](
|
|
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
|
-
* 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](
|
|
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`.
|
|
@@ -288,11 +288,11 @@ export declare class ChannelService<T extends DefaultStreamChatGenerics = Defaul
|
|
|
288
288
|
messagePageSize: number;
|
|
289
289
|
}): Promise<Channel<T>[]>;
|
|
290
290
|
/**
|
|
291
|
-
* Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](
|
|
291
|
+
* Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](/chat/docs/sdk/angular/services/ChatClientService/#disconnectuser/).
|
|
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](
|
|
413
|
-
* @param uploads the attachments to upload (output of the [`AttachmentService`](
|
|
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
|
+
* @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](
|
|
419
|
-
* @param attachmentUpload Attachment to be deleted (output of the [`AttachmentService`](
|
|
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
|
+
* @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
|
-
* 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](
|
|
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
|
/**
|
|
@@ -35,7 +35,7 @@ export declare class ChatClientService<T extends DefaultStreamChatGenerics = Def
|
|
|
35
35
|
*/
|
|
36
36
|
connectionState$: Observable<'offline' | 'online'>;
|
|
37
37
|
/**
|
|
38
|
-
* Emits the list of pending invites of the user. It emits every pending invitation during initialization and then extends the list when a new invite is received. More information can be found in the [channel invitations](
|
|
38
|
+
* Emits the list of pending invites of the user. It emits every pending invitation during initialization and then extends the list when a new invite is received. More information can be found in the [channel invitations](/chat/docs/sdk/angular/code-examples/channel-invites/) guide.
|
|
39
39
|
*/
|
|
40
40
|
pendingInvites$: Observable<Channel<T>[]>;
|
|
41
41
|
/**
|
|
@@ -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
|
*/
|
|
@@ -67,15 +67,15 @@ export declare class ChatClientService<T extends DefaultStreamChatGenerics = Def
|
|
|
67
67
|
trackPendingChannelInvites?: boolean;
|
|
68
68
|
}): ConnectAPIResponse<T>;
|
|
69
69
|
/**
|
|
70
|
-
* Disconnects the current user, and closes the WebSocket connection. Useful when disconnecting a chat user, use in combination with [`reset`](
|
|
70
|
+
* Disconnects the current user, and closes the WebSocket connection. Useful when disconnecting a chat user, use in combination with [`reset`](/chat/docs/sdk/angular/services/ChannelService/#reset/).
|
|
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>;
|