Skip to content

Commit f067095

Browse files
committed
Update docs generation to v7-rc
1 parent 15dbe3e commit f067095

30 files changed

+103
-103
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/v7-rc/)
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/v7-rc/) 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

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@
3535
"preanalyze:sample-app": "npm run build:sample-app",
3636
"analyze:sample-app": "webpack-bundle-analyzer dist/sample-app/stats.json",
3737
"copy-css": "rm -rf projects/stream-chat-angular/src/assets/styles && copyfiles --up 5 \"node_modules/@stream-io/stream-chat-css/dist/v2/**/*\" projects/stream-chat-angular/src/assets/styles && copyfiles --up 5 \"node_modules/@stream-io/stream-chat-css/dist/assets/**/*\" projects/stream-chat-angular/src/assets/assets",
38-
"generate-docs": "npm run typedoc:services && npm run typedoc:components && npm run copy-docs:v6",
38+
"generate-docs": "npm run typedoc:services && npm run typedoc:components && npm run copy-docs:v7",
3939
"typedoc:services": "typedoc --plugin typedoc-plugin-markdown --cleanOutputDir true --hideBreadcrumbs true --hidePageHeader 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 --cleanOutputDir true --sort source-order --hideBreadcrumbs true --hidePageHeader 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:v7": "ts-node copy-generated-service-docs.ts ../docs/data/docs/chat-sdk/angular/v7-rc/06-services & (ts-node remove-generated-component-docs-content ../docs/data/docs/chat-sdk/angular/v7-rc/05-components && ts-node copy-generated-component-docs.ts ../docs/data/docs/chat-sdk/angular/v7-rc/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/v7-rc/)
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/v7-rc/) 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/v7-rc/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/v7-rc/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/v7-rc/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/v7-rc/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
@@ -9,7 +9,7 @@ import { CustomTemplatesService } from '../custom-templates.service';
99
import { AvatarContext, AvatarLocation, AvatarType } from '../types';
1010

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

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ export class ChannelService {
125125
/**
126126
* If you're using [semantic filters for moderation](/moderation/docs/) you can set up rules for bouncing messages.
127127
*
128-
* 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.
128+
* If a message is bounced, it will be emitted via this `Observable`. The built-in [`MessageBouncePrompt` component](/chat/docs/sdk/angular/v7-rc/components/MessageBouncePromptComponent/) will display the bounce option to the user if a bounced message is clicked.
129129
*/
130130
bouncedMessage$: BehaviorSubject<StreamMessage | undefined>;
131131
/**
@@ -587,7 +587,7 @@ export class ChannelService {
587587
}
588588

589589
/**
590-
* 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/).
590+
* Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](/chat/docs/sdk/angular/v7-rc/services/ChatClientService/#disconnectuser/).
591591
*/
592592
reset() {
593593
this.deselectActiveChannel();
@@ -781,7 +781,7 @@ export class ChannelService {
781781

782782
/**
783783
* Uploads files to the channel. If you want to know more about [file uploads](/chat/docs/javascript/file_uploads/) check out the platform documentation.
784-
* @param uploads the attachments to upload (output of the [`AttachmentService`](/chat/docs/sdk/angular/v6-rc/services/AttachmentService/))
784+
* @param uploads the attachments to upload (output of the [`AttachmentService`](/chat/docs/sdk/angular/v7-rc/services/AttachmentService/))
785785
* @returns the result of file upload requests
786786
*/
787787
async uploadAttachments(
@@ -862,7 +862,7 @@ export class ChannelService {
862862

863863
/**
864864
* 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
865-
* @param attachmentUpload Attachment to be deleted (output of the [`AttachmentService`](/chat/docs/sdk/angular/v6-rc/services/AttachmentService/))
865+
* @param attachmentUpload Attachment to be deleted (output of the [`AttachmentService`](/chat/docs/sdk/angular/v7-rc/services/AttachmentService/))
866866
*/
867867
async deleteAttachment(attachmentUpload: AttachmentUpload) {
868868
const channel = this.activeChannelSubject.getValue()!;
@@ -1379,7 +1379,7 @@ export class ChannelService {
13791379

13801380
/**
13811381
* 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).
1382-
* @deprecated use [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/v6-rc/services/MessageReactionsService/#queryreactions) instead
1382+
* @deprecated use [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/v7-rc/services/MessageReactionsService/#queryreactions) instead
13831383
* @param messageId
13841384
* @returns all reactions of a message
13851385
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { ThemeService } from '../theme.service';
66
import { CustomTemplatesService } from '../custom-templates.service';
77

88
/**
9-
* The `Channel` component is a container component that displays the [`ChannelHeader`](/chat/docs/sdk/angular/v6-rc/components/ChannelHeaderComponent/), [`MessageList`](/chat/docs/sdk/angular/v6-rc/components/MessageListComponent), [`NotificationList`](/chat/docs/sdk/angular/v6-rc/components/NotificationListComponent/) and [`MessageInput`](/chat/docs/sdk/angular/v6-rc/components/MessageInputComponent/) components. You can also provide the [`Thread`](/chat/docs/sdk/angular/v6-rc/components/ThreadComponent/) component to use message [threads](/chat/docs/javascript/threads/).
9+
* The `Channel` component is a container component that displays the [`ChannelHeader`](/chat/docs/sdk/angular/v7-rc/components/ChannelHeaderComponent/), [`MessageList`](/chat/docs/sdk/angular/v7-rc/components/MessageListComponent), [`NotificationList`](/chat/docs/sdk/angular/v7-rc/components/NotificationListComponent/) and [`MessageInput`](/chat/docs/sdk/angular/v7-rc/components/MessageInputComponent/) components. You can also provide the [`Thread`](/chat/docs/sdk/angular/v7-rc/components/ThreadComponent/) component to use message [threads](/chat/docs/javascript/threads/).
1010
*/
1111
@Component({
1212
selector: 'stream-channel',

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export class ChatClientService {
4444
*/
4545
connectionState$: Observable<'offline' | 'online'>;
4646
/**
47-
* 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/v6-rc/code-examples/channel-invites/) guide.
47+
* 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/v7-rc/code-examples/channel-invites/) guide.
4848
*/
4949
pendingInvites$: Observable<Channel[]>;
5050
/**
@@ -174,7 +174,7 @@ export class ChatClientService {
174174
}
175175

176176
/**
177-
* Disconnects the current user, and closes the WebSocket connection. Useful when disconnecting a chat user, use in combination with [`reset`](/chat/docs/sdk/angular/v6-rc/services/ChannelService/#reset/).
177+
* Disconnects the current user, and closes the WebSocket connection. Useful when disconnecting a chat user, use in combination with [`reset`](/chat/docs/sdk/angular/v7-rc/services/ChannelService/#reset/).
178178
*/
179179
async disconnectUser() {
180180
this.pendingInvitesSubject.next([]);

0 commit comments

Comments
 (0)