Skip to content

Commit 3cffdb1

Browse files
committed
docs: replace rc links with latest
1 parent e97d5d3 commit 3cffdb1

31 files changed

+116
-119
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
- [Register](https://getstream.io/chat/trial/) to get an API key for Stream Chat
1212
- [Angular Chat Tutorial](https://getstream.io/chat/angular/tutorial/)
13-
- [Docs](https://getstream.io/chat/docs/sdk/angular/v6-rc/)
13+
- [Docs](https://getstream.io/chat/docs/sdk/angular/)
1414
- [Chat UI Kit](https://getstream.io/chat/ui-kit/)
1515
- [Demo application](https://angular-chat-demo-getstreamio.vercel.app/)
1616
- [Codesandbox](https://codesandbox.io/p/devbox/stream-chat-angular-sample-app-rc3hyw)
@@ -33,7 +33,7 @@ For complete pricing and details visit our [Chat Pricing Page](https://getstream
3333

3434
## Docs
3535

36-
The [docs](https://getstream.io/chat/docs/sdk/angular/v6-rc/) provide a brief description about the components and services in the library.
36+
The [docs](https://getstream.io/chat/docs/sdk/angular/) provide a brief description about the components and services in the library.
3737

3838
The Angular library is created using the [stream-chat-js](https://github.com/getstream/stream-chat-js) library. For the most common use cases our services should give a nice abstraction over this library, however you might need it for more advanced customization, the [documentation](https://getstream.io/chat/docs/js/) is on our website.
3939

copy-generated-service-docs.ts

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,15 @@ fs.readdir(sourcePath, (err: any, files: string[]) => {
3636
`\n` +
3737
`title: ${file.replace('.md', '')}` +
3838
`\n` +
39-
`slug: /chat/docs/sdk/angular/v6-rc/services/${file.replace(
40-
'.md',
41-
''
42-
)}/` +
39+
`slug: /chat/docs/sdk/angular/services/${file.replace('.md', '')}/` +
4340
`\n` +
4441
`---` +
4542
'\n\n' +
4643
data
4744
.replace(`# Class: ${file.replace('.md', '')}`, '')
4845
.replace(
4946
/\b(?!README)(\w+)\.md\b/g,
50-
'/chat/docs/sdk/angular/v6-rc/services/$1'
47+
'/chat/docs/sdk/angular/services/$1'
5148
)
5249
.replace(/\s/g, '')
5350
.replace(/\s/g, '')

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
"generate-docs": "npm run typedoc:services && npm run typedoc:components && npm run copy-docs:v6",
3939
"typedoc:services": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-reference-excluder --cleanOutputDir true --excludeConstructors true --hideBreadcrumbs true --hideInPageTOC true --excludePrivate true --out temp-service-docs --exclude '!**/*service.ts' --excludeNotDocumented --tsconfig projects/stream-chat-angular/tsconfig.lib.json projects/stream-chat-angular/src/public-api.ts",
4040
"typedoc:components": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-reference-excluder --cleanOutputDir true --excludeConstructors true --sort source-order --hideBreadcrumbs true --hideInPageTOC true --excludePrivate true --excludeNotDocumented --out temp-component-docs --exclude '!**/*component.ts' --tsconfig projects/stream-chat-angular/tsconfig.lib.json projects/stream-chat-angular/src/public-api.ts",
41-
"copy-docs:v6": "ts-node copy-generated-service-docs.ts ../docs/data/docs/chat-sdk/angular/v6-rc/06-services & (ts-node remove-generated-component-docs-content ../docs/data/docs/chat-sdk/angular/v6-rc/05-components && ts-node copy-generated-component-docs.ts ../docs/data/docs/chat-sdk/angular/v6-rc/05-components)"
41+
"copy-docs:v6": "ts-node copy-generated-service-docs.ts ../docs/data/docs/chat-sdk/angular/06-services & (ts-node remove-generated-component-docs-content ../docs/data/docs/chat-sdk/angular/05-components && ts-node copy-generated-component-docs.ts ../docs/data/docs/chat-sdk/angular/05-components)"
4242
},
4343
"lint-staged": {
4444
"**/*": [

projects/stream-chat-angular/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- [Register](https://getstream.io/chat/trial/) to get an API key for Stream Chat
1212
- [Angular Chat Tutorial](https://getstream.io/chat/angular/tutorial/)
1313
- [Demo Apps](https://getstream.io/chat/demos/)
14-
- [Docs](https://getstream.io/chat/docs/sdk/angular/v6-rc/)
14+
- [Docs](https://getstream.io/chat/docs/sdk/angular/)
1515
- [Chat UI Kit](https://getstream.io/chat/ui-kit/)
1616

1717
With our component library, you can build a variety of chat use cases, including:
@@ -32,7 +32,7 @@ For complete pricing and details visit our [Chat Pricing Page](https://getstream
3232

3333
## Docs
3434

35-
The [docs](https://getstream.io/chat/docs/sdk/angular/v6-rc/) provide a brief description about the components and services in the library.
35+
The [docs](https://getstream.io/chat/docs/sdk/angular/) provide a brief description about the components and services in the library.
3636

3737
The Angular library is created using the [stream-chat-js](https://github.com/getstream/stream-chat-js) library. For the most common use cases our services should give a nice abstraction over this library, however you might need it for more advanced customization, the [documentation](https://getstream.io/chat/docs/js/) is on our website.
3838

projects/stream-chat-angular/src/lib/attachment-configuration.service.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ export class AttachmentConfigurationService {
239239
sizeRestriction = undefined;
240240
if (displayWarning) {
241241
console.warn(
242-
`Invalid value set for height/max-height and/or max-width for HTML element, this can cause scrolling issues inside the message list, more info https://getstream.io/chat/docs/sdk/angular/v6-rc/components/AttachmentListComponent/#image-and-video-sizing, attachment URL: ${url.toString()}`
242+
`Invalid value set for height/max-height and/or max-width for HTML element, this can cause scrolling issues inside the message list, more info https://getstream.io/chat/docs/sdk/angular/components/AttachmentListComponent/#image-and-video-sizing, attachment URL: ${url.toString()}`
243243
);
244244
}
245245
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ export class AttachmentService {
3434
*/
3535
attachmentUploadInProgressCounter$ = new BehaviorSubject<number>(0);
3636
/**
37-
* 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/v6-rc/components/AttachmentPreviewListComponent/) to display the attachment previews.
37+
* 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.
3838
*/
3939
attachmentUploads$: Observable<AttachmentUpload[]>;
4040
/**
4141
* You can get and set the list if uploaded custom attachments
4242
*
43-
* 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/v6-rc/services/CustomTemplatesService/).
43+
* 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/).
4444
*/
4545
customAttachments$ = new BehaviorSubject<Attachment[]>([]);
4646
/**
@@ -204,7 +204,7 @@ export class AttachmentService {
204204
/**
205205
* You can add custom `image`, `video` and `file` attachments using this method.
206206
*
207-
* 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/v6-rc/services/ChannelService/)
207+
* 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/)
208208
* @param attachment
209209
*
210210
* Will set `isCustomAttachment` to `true` on the attachment. This is a non-standard field, other SDKs will ignore this property.

projects/stream-chat-angular/src/lib/avatar-placeholder/avatar-placeholder.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { CustomTemplatesService } from '../custom-templates.service';
44
import { AvatarContext, AvatarLocation, AvatarType } from '../types';
55

66
/**
7-
* The `AvatarPlaceholder` component displays the [default avatar](/chat/docs/sdk/angular/v6-rc/components/AvatarComponent/) unless a [custom template](/chat/docs/sdk/angular/v6-rc/services/CustomTemplatesService/) is provided. This component is used by the SDK internally, you likely won't need to use it.
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.
88
*/
99
@Component({
1010
selector: 'stream-avatar-placeholder',

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export class ChannelService {
5959
* Emits the currently loaded and [watched](/chat/docs/javascript/watch_channel/) channel list.
6060
*
6161
* :::important
62-
* 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/v6-rc/concepts/change-detection/) explains this in detail.
62+
* 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.
6363
* :::
6464
*/
6565
channels$: Observable<Channel[] | undefined>;
@@ -71,7 +71,7 @@ export class ChannelService {
7171
* Emits the currently active channel.
7272
*
7373
* :::important
74-
* 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/v6-rc/concepts/change-detection/) explains this in detail.
74+
* 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.
7575
* :::
7676
*
7777
* The active channel will always be marked as read when a new message is received
@@ -120,7 +120,7 @@ export class ChannelService {
120120
/**
121121
* If you're using [semantic filters for moderation](/moderation/docs/) you can set up rules for bouncing messages.
122122
*
123-
* If a message is bounced, it will be emitted via this `Observable`. The built-in [`MessageBouncePrompt` component](/chat/docs/sdk/angular/v6-rc/components/MessageBouncePromptComponent/) will display the bounce option to the user if a bounced message is clicked.
123+
* 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.
124124
*/
125125
bouncedMessage$: BehaviorSubject<StreamMessage | undefined>;
126126
/**
@@ -136,7 +136,7 @@ export class ChannelService {
136136
*/
137137
activeChannelUnreadCount?: number;
138138
/**
139-
* 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/v6-rc/services/ChannelService/#channels/)
139+
* 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/)
140140
*
141141
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
142142
*/
@@ -148,7 +148,7 @@ export class ChannelService {
148148
) => void
149149
) => void;
150150
/**
151-
* 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/v6-rc/services/ChannelService/#channels/).
151+
* 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/).
152152
*
153153
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
154154
*/
@@ -160,7 +160,7 @@ export class ChannelService {
160160
) => void
161161
) => void;
162162
/**
163-
* 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/v6-rc/services/ChannelService/#channels/).
163+
* 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/).
164164
*
165165
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
166166
*/
@@ -172,7 +172,7 @@ export class ChannelService {
172172
) => void
173173
) => void;
174174
/**
175-
* 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/v6-rc/services/ChannelService/#channels/).
175+
* 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/).
176176
*
177177
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
178178
*/
@@ -188,7 +188,7 @@ export class ChannelService {
188188
parentMessageSetter: (message: StreamMessage | undefined) => void
189189
) => void;
190190
/**
191-
* 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/v6-rc/services/ChannelService/#channels/).
191+
* 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/).
192192
*
193193
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
194194
*/
@@ -204,7 +204,7 @@ export class ChannelService {
204204
parentMessageSetter: (message: StreamMessage | undefined) => void
205205
) => void;
206206
/**
207-
* 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/v6-rc/services/ChannelService/#channels/).
207+
* 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/).
208208
*
209209
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
210210
*/
@@ -220,7 +220,7 @@ export class ChannelService {
220220
parentMessageSetter: (message: StreamMessage | undefined) => void
221221
) => void;
222222
/**
223-
* 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/v6-rc/services/ChannelService/#channels/).
223+
* 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/).
224224
*
225225
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
226226
*/
@@ -236,7 +236,7 @@ export class ChannelService {
236236
parentMessageSetter: (message: StreamMessage | undefined) => void
237237
) => void;
238238
/**
239-
* 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/v6-rc/services/ChannelService/#channels/).
239+
* 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/).
240240
*
241241
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
242242
*/
@@ -252,7 +252,7 @@ export class ChannelService {
252252
parentMessageSetter: (message: StreamMessage | undefined) => void
253253
) => void;
254254
/**
255-
* 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/v6-rc/services/ChannelService/#channels/).
255+
* 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/).
256256
*
257257
* If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel.
258258
*/
@@ -773,7 +773,7 @@ export class ChannelService {
773773
}
774774

775775
/**
776-
* Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](/chat/docs/sdk/angular/v6-rc/services/ChatClientService/#disconnectuser/).
776+
* 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/).
777777
*/
778778
reset() {
779779
this.deselectActiveChannel();
@@ -969,7 +969,7 @@ export class ChannelService {
969969

970970
/**
971971
* Uploads files to the channel. If you want to know more about [file uploads](/chat/docs/javascript/file_uploads/) check out the platform documentation.
972-
* @param uploads the attachments to upload (output of the [`AttachmentService`](/chat/docs/sdk/angular/v6-rc/services/AttachmentService/))
972+
* @param uploads the attachments to upload (output of the [`AttachmentService`](/chat/docs/sdk/angular/services/AttachmentService/))
973973
* @returns the result of file upload requests
974974
*/
975975
async uploadAttachments(
@@ -1050,7 +1050,7 @@ export class ChannelService {
10501050

10511051
/**
10521052
* 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
1053-
* @param attachmentUpload Attachment to be deleted (output of the [`AttachmentService`](/chat/docs/sdk/angular/v6-rc/services/AttachmentService/))
1053+
* @param attachmentUpload Attachment to be deleted (output of the [`AttachmentService`](/chat/docs/sdk/angular/services/AttachmentService/))
10541054
*/
10551055
async deleteAttachment(attachmentUpload: AttachmentUpload) {
10561056
const channel = this.activeChannelSubject.getValue()!;
@@ -1656,7 +1656,7 @@ export class ChannelService {
16561656

16571657
/**
16581658
* 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).
1659-
* @deprecated use [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/v6-rc/services/MessageReactionsService/#queryreactions) instead
1659+
* @deprecated use [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions) instead
16601660
* @param messageId
16611661
* @returns all reactions of a message
16621662
*/

0 commit comments

Comments
 (0)