From b7284051ab23940b6faf6b5b65f20ae4be5e71a8 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Thu, 17 Jan 2019 10:07:25 +0000 Subject: [PATCH] [ADF-3921] Reviewed docs where deprecated stuff was removed (#4172) --- docs/core/form.component.md | 6 +++--- docs/core/host-settings.component.md | 2 +- docs/core/infinite-pagination.component.md | 4 ++-- docs/core/login.component.md | 12 ++++++------ docs/core/node-restore.directive.md | 2 +- docs/core/upload.service.md | 2 +- docs/core/user-preferences.service.md | 2 +- docs/core/viewer.component.md | 11 ++++------- docs/process-services/process-list.component.md | 11 ++++++----- 9 files changed, 25 insertions(+), 27 deletions(-) diff --git a/docs/core/form.component.md b/docs/core/form.component.md index 378826c076..c440e8e004 100644 --- a/docs/core/form.component.md +++ b/docs/core/form.component.md @@ -2,7 +2,7 @@ Title: Form component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-14 +Last reviewed: 2019-01-16 --- # [Form component](../../lib/core/form/components/form.component.ts "Defined in form.component.ts") @@ -58,7 +58,7 @@ Any content in the body of `` will be shown when no form definition is | disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. | | fieldValidators | [`FormFieldValidator`](../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Contains a list of form field validator instances. | | form | [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../lib/core/form/components/widgets/core/form.model.ts) instance. | -| formId | `string` | | The id of the form definition to load and display with custom values. | +| formId | `number` | | The id of the form definition to load and display with custom values. | | formName | `string` | | Name of the form definition to load and display with custom values. | | nameNode | `string` | | Name to assign to the new node where the metadata are stored. | | nodeId | `string` | | Content Services node ID for the form metadata. | @@ -77,6 +77,7 @@ Any content in the body of `` will be shown when no form definition is | Name | Type | Description | | ---- | ---- | ----------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | | executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | | formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | | formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. | @@ -84,7 +85,6 @@ Any content in the body of `` will be shown when no form definition is | formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../core/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | | formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | | formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | ## Details diff --git a/docs/core/host-settings.component.md b/docs/core/host-settings.component.md index de7906e5bd..f6e2d74fa4 100644 --- a/docs/core/host-settings.component.md +++ b/docs/core/host-settings.component.md @@ -2,7 +2,7 @@ Title: Host settings component Added: v2.0.0 Status: Internal -Last reviewed: 2018-09-13 +Last reviewed: 2019-01-16 --- # [Host settings component](../../lib/core/settings/host-settings.component.ts "Defined in host-settings.component.ts") diff --git a/docs/core/infinite-pagination.component.md b/docs/core/infinite-pagination.component.md index aaa8577dd8..075bf44016 100644 --- a/docs/core/infinite-pagination.component.md +++ b/docs/core/infinite-pagination.component.md @@ -2,7 +2,7 @@ Title: Infinite Pagination component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-13 +Last reviewed: 2019-01-16 --- # [Infinite Pagination component](../../lib/core/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts") @@ -46,7 +46,7 @@ Adds "infinite" pagination to the component it is used with. | Name | Type | Description | | ---- | ---- | ----------- | -| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts)`>` | Emitted when the "Load More" button is clicked. | +| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../lib/core/models/pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. | ## Details diff --git a/docs/core/login.component.md b/docs/core/login.component.md index bd0c798f8b..773a9df13e 100644 --- a/docs/core/login.component.md +++ b/docs/core/login.component.md @@ -2,7 +2,7 @@ Title: Login component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-13 +Last reviewed: 2019-01-16 --- # [Login component](../../lib/core/login/components/login.component.ts "Defined in login.component.ts") @@ -24,7 +24,7 @@ Authenticates to Alfresco Content Services and Alfresco Process Services. - [Customizing validation rules](#customizing-validation-rules) - [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token) - [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour) - - [SSO login](#sso-login) + - [Single Sign-On (SSO)](#single-sign-on-sso) - [See Also](#see-also) ## Basic usage @@ -98,7 +98,7 @@ with custom input fields handled by your application or parent component: ### Handling events -**[app.component](../../demo-shell/src/app/app.component.ts).html** +**app.component.html** ```html ``` -**[app.component](../../demo-shell/src/app/app.component.ts).ts** +**app.component.ts** ```ts export class AppComponent { @@ -302,8 +302,8 @@ automatically to the authorization server when the user is not logged-in You can also enable automatic redirection to OAuth provider by utilising the following properties: -* silentLogin -* redirectSilentIframeUri +- silentLogin +- redirectSilentIframeUri ```json { diff --git a/docs/core/node-restore.directive.md b/docs/core/node-restore.directive.md index c6e388ad7d..8f5ed42b88 100644 --- a/docs/core/node-restore.directive.md +++ b/docs/core/node-restore.directive.md @@ -2,7 +2,7 @@ Title: Node Restore directive Added: v2.0.0 Status: Active -Last reviewed: 2018-11-13 +Last reviewed: 2019-01-16 --- # [Node Restore directive](../../lib/core/directives/node-restore.directive.ts "Defined in node-restore.directive.ts") diff --git a/docs/core/upload.service.md b/docs/core/upload.service.md index bedcfc4aec..d2b3622052 100644 --- a/docs/core/upload.service.md +++ b/docs/core/upload.service.md @@ -2,7 +2,7 @@ Title: Upload Service Added: v2.0.0 Status: Active -Last reviewed: 2018-11-12 +Last reviewed: 2019-01-16 --- # [Upload Service](../../lib/core/services/upload.service.ts "Defined in upload.service.ts") diff --git a/docs/core/user-preferences.service.md b/docs/core/user-preferences.service.md index 8c32a34a9b..87ced849d3 100644 --- a/docs/core/user-preferences.service.md +++ b/docs/core/user-preferences.service.md @@ -2,7 +2,7 @@ Title: User Preferences Service Added: v2.0.0 Status: Active -Last reviewed: 2018-11-20 +Last reviewed: 2019-01-16 --- # [User Preferences Service](../../lib/core/services/user-preferences.service.ts "Defined in user-preferences.service.ts") diff --git a/docs/core/viewer.component.md b/docs/core/viewer.component.md index a904877a00..f313ac4696 100644 --- a/docs/core/viewer.component.md +++ b/docs/core/viewer.component.md @@ -2,7 +2,7 @@ Title: Viewer component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-13 +Last reviewed: 2019-01-16 --- # [Viewer component](../../lib/core/viewer/components/viewer.component.ts "Defined in viewer.component.ts") @@ -80,15 +80,14 @@ See the [Custom layout](#custom-layout) section for full details of all availabl | allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. | | allowGoBack | `boolean` | true | Allows `back` navigation | | allowLeftSidebar | `boolean` | false | Allow the left the sidebar. | -| allowRightSidebar | `boolean` | false | Allow the right sidebar. | | allowNavigate | `boolean` | false | Toggles before/next navigation. You can use the arrow buttons to navigate between documents in the collection. | | allowPrint | `boolean` | false | Toggles printing. | +| allowRightSidebar | `boolean` | false | Allow the right sidebar. | | allowThumbnails | `boolean` | true | Toggles PDF thumbnails. | | blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File | | canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. | | canNavigateNext | `boolean` | true | Toggles the next (">") button. Requires `allowNavigate` to be enabled. | | displayName | `string` | | Specifies the name of the file when it is not available from the URL. | -| downloadUrl | `string` | null | URL to download. | | fileName | `string` | | Content filename. | | maxRetries | `number` | 10 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | | mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). | @@ -96,11 +95,11 @@ See the [Custom layout](#custom-layout) section for full details of all availabl | overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. | | sharedLinkId | `string` | null | Shared link id (to display shared file). | | showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. | -| showRightSidebar | `boolean` | false |Toggles Right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. | +| showRightSidebar | `boolean` | false | Toggles right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. | | showToolbar | `boolean` | true | Hide or show the toolbar | | showViewer | `boolean` | true | Hide or show the viewer | | sidebarLeftTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the left sidebar. The template context contains the loaded node data. | -| sidebarRightTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for right sidebar. The template context contains the loaded node data. | +| sidebarRightTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the right sidebar. The template context contains the loaded node data. | | thumbnailsTemplate | [`TemplateRef`](https://angular.io/api/core/TemplateRef)`` | null | The template for the pdf thumbnails. | | urlFile | `string` | "" | If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from. | | urlFileViewer | `string` | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. | @@ -109,14 +108,12 @@ See the [Custom layout](#custom-layout) section for full details of all availabl | Name | Type | Description | | ---- | ---- | ----------- | -| download | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Download' button. | | extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the filename extension changes. | | goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Back' button. | | invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the shared link used is not valid. | | navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Before' ("<") button. | | navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when user clicks 'Navigate Next' (">") button. | | print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Print' button. | -| share | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../lib/core/events/base.event.ts)`>` | Emitted when user clicks the 'Share' button. | | showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the viewer is shown or hidden. | ## Keyboard shortcuts diff --git a/docs/process-services/process-list.component.md b/docs/process-services/process-list.component.md index 539678f4ee..36abcdd4e0 100644 --- a/docs/process-services/process-list.component.md +++ b/docs/process-services/process-list.component.md @@ -2,7 +2,7 @@ Title: Process Instance List Added: v2.0.0 Status: Active -Last reviewed: 2018-05-24 +Last reviewed: 2019-01-16 --- # [Process Instance List](../../lib/process-services/process-list/components/process-list.component.ts "Defined in process-list.component.ts") @@ -23,7 +23,7 @@ Renders a list containing all the process instances matched by the parameters sp ## Basic Usage -**[app.component](../../demo-shell/src/app/app.component.ts).html** +**app.component.html** ```html ` | Emitted when an error occurs while loading the list of process instances from the server. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list of process instances has been loaded successfully from the server. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details