diff --git a/docs/README.md b/docs/README.md index 3e1fc03a77..8df74f924c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -275,6 +275,7 @@ for more information about installing and using the source code. | [Search control component](content-services/components/search-control.component.md) | Displays a input text that shows find-as-you-type suggestions. | [Source](../lib/content-services/src/lib/search/components/search-control.component.ts) | | [Search date range component](content-services/components/search-date-range.component.md) | Implements a date range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-date-range/search-date-range.component.ts) | | [Search Filter component](content-services/components/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/src/lib/search/components/search-filter/search-filter.component.ts) | +| [SearchHeader component](content-services/components/search-header.component.md) | Displays a button opening a menu designed to filter a document list. | [Source](../lib/content-services/src/lib/search/components/search-header/search-header.component.ts) | | [Search number range component](content-services/components/search-number-range.component.md) | Implements a number range widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.ts) | | [Search radio component](content-services/components/search-radio.component.md) | Implements a radio button list widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-radio/search-radio.component.ts) | | [Search slider component](content-services/components/search-slider.component.md) | Implements a numeric slider widget for the Search Filter component. | [Source](../lib/content-services/src/lib/search/components/search-slider/search-slider.component.ts) | @@ -371,6 +372,7 @@ for more information about installing and using the source code. | [Checklist Component](process-services/components/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/src/lib/task-list/components/checklist.component.ts) | | [Create Process Attachment component](process-services/components/create-process-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance. | [Source](../lib/process-services/src/lib/attachment/create-process-attachment.component.ts) | | [Create Task Attachment Component](process-services/components/create-task-attachment.component.md) | Displays an Upload Component (Drag and Click) to upload the attachment to a specified task. | [Source](../lib/process-services/src/lib/attachment/create-task-attachment.component.ts) | +| [Form custom outcomes component](process-services/components/form-custom-outcome.component.md) | Supplies custom outcome buttons to be included in Form component. | [Source](../lib/process-services/src/lib/form/form-custom-outcomes.component.ts) | | [Form component](process-services/components/form.component.md) | Shows a Form from APS | [Source](../lib/process-services/src/lib/form/form.component.ts) | | [People list component](process-services/components/people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/src/lib/people/components/people-list/people-list.component.ts) | | [People Search component](process-services/components/people-search.component.md) | Searches users/people. | [Source](../lib/process-services/src/lib/people/components/people-search/people-search.component.ts) | @@ -397,8 +399,16 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | +| [Claim Task Directive](process-services/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/claim-task.directive.ts) | | [Process Audit Directive](process-services/directives/process-audit.directive.md) | Fetches the Process Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/process-list/components/process-audit.directive.ts) | | [Task Audit Directive](process-services/directives/task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../lib/process-services/src/lib/task-list/components/task-audit.directive.ts) | +| [Unclaim Task Directive](process-services/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services/src/lib/task-list/components/task-form/unclaim-task.directive.ts) | + +### Pipes + +| Name | Description | Source link | +| ---- | ----------- | ----------- | +| [Process name pipe](process-services/pipes/process-name.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services/src/lib/pipes/process-name.pipe.ts) | ### Services @@ -440,7 +450,7 @@ for more information about installing and using the source code. | [Start Process Cloud Component](process-services-cloud/components/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | | [Start Task Cloud Component](process-services-cloud/components/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | | [Task Filters Cloud component](process-services-cloud/components/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | -| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/testing/src/lib/process-services-cloud/pages/task-form-cloud-component.page.ts) | +| [Form cloud component](process-services-cloud/components/task-form-cloud.component.md) | Shows a form for a task. | [Source](../lib/process-services-cloud/src/lib/task/task-form/components/task-form-cloud.component.ts) | | [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | | [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | @@ -449,22 +459,23 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Cancel Process Directive](process-services-cloud/directives/cancel-process.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Cancels a process | [Source](../lib/process-services-cloud/src/lib/process/directives/cancel-process.directive.ts) | -| [Claim Task Directive](process-services-cloud/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts) | +| [Claim Task Cloud Directive](process-services-cloud/directives/claim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task-cloud.directive.ts) | | [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | -| [Unclaim Task Directive](process-services-cloud/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts) | +| [Unclaim Task Cloud Directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task-cloud.directive.ts) | ### Pipes | Name | Description | Source link | | ---- | ----------- | ----------- | | [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | +| [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) | When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. | [Source](../lib/process-services-cloud/src/lib/pipes/process-name-cloud.pipe.ts) | ### Services | Name | Description | Source link | | ---- | ----------- | ----------- | | [Apps Process Cloud Service](process-services-cloud/services/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | -| [Form cloud service](process-services-cloud/services/form-cloud.service.md) | Implements Process Services form methods | [Source](../lib/testing/src/lib/form-cloud/actions/form-cloud.service.ts) | +| [Form cloud service](process-services-cloud/services/form-cloud.service.md) | Implements Process Services form methods | [Source](../lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts) | | [Group Cloud Service](process-services-cloud/services/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | | [Local Preference Cloud Service](process-services-cloud/services/local-preference-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages Local Storage preferences. | [Source](../lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts) | | [Process Cloud Service](process-services-cloud/services/process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud process instances. | [Source](../lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts) | diff --git a/docs/content-services/components/document-list.component.md b/docs/content-services/components/document-list.component.md index a58f790d14..e8438818b9 100644 --- a/docs/content-services/components/document-list.component.md +++ b/docs/content-services/components/document-list.component.md @@ -75,7 +75,7 @@ Displays the documents from a repository. | rowStyle | `string` | | The inline style to apply to every row. See the Angular NgStyle docs for more details and usage examples. | | rowStyleClass | `string` | | The CSS class to apply to every row | | selectionMode | `string` | "single" | Row selection mode. Can be null, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showHeader | `ShowHeaderMode` | "data" | Indicate which is the desired behaviour for the header. Can have 3 values `always`, `never` and `data`. `data` won't display the header if the datatable is empty and will display it otherwise. | +| showHeader | `string` | | Toggles the header | | sorting | `string[]` | ['name', 'asc'] | Defines default sorting. The format is an array of 2 strings `[key, direction]` i.e. `['name', 'desc']` or `['name', 'asc']`. Set this value only if you want to override the default sorting detected by the component based on columns. | | sortingMode | `string` | "client" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. | | stickyHeader | `boolean` | false | Toggles the sticky header mode. | diff --git a/docs/content-services/components/search-header.component.md b/docs/content-services/components/search-header.component.md index 19b2382f88..031263cd5b 100644 --- a/docs/content-services/components/search-header.component.md +++ b/docs/content-services/components/search-header.component.md @@ -4,22 +4,13 @@ Added: v3.9.0 Status: Active Last reviewed: 2020-19-06 --- + # [SearchHeader component](../../../lib/content-services/src/lib/search/components/search-header/search-header.component.ts "Defined in search-header.component.ts") Displays a button opening a menu designed to filter a document list. ![SearchHeader demo](../../docassets/images/search-header-demo.png) -## Contents - -- [Basic usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) -- [Details](#details) - - [example](#example) -- [See also](#see-also) - ## Basic usage **app.component.html** @@ -45,9 +36,10 @@ Displays a button opening a menu designed to filter a document list. **app.config.json** ```json + ``` -This component is designed to be used as transcluded inside the document list component. With the good configurations it will allow the user to filter the data displayed by that component. +This component is designed to be used as transcluded inside the [document list component](../../content-services/components/document-list.component.md). With the good configurations it will allow the user to filter the data displayed by that component. ## Class members @@ -55,22 +47,17 @@ This component is designed to be used as transcluded inside the document list co | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| col | `DataColumn` | | The column the filter will be applied on. | -| currentFolderNodeId | `string` | | The id of the current folder of the document list. | -| maxItems | `number` | | Pagination parameter coming from the document list. | -| skipCount | `number` | | An other pagination parameter coming from the document list. | -| widgetContainer | `SearchWidgetContainerComponent` | | View of the child facet widget generated inside the menu. Used to control that widget through the apply and clear buttons. | -| isActive | `boolean` | | A boolean telling if the current data displayed in the document list is affected by that filter. | -| category | `SearchCategory` | | The category of the filter. It contains the information regarding the way the filter is filtering the data. This is get with the column information and the configuration of the search-header inside the config file | -| isFilterServiceActive | `boolean` | | Boolean to check if the SearchHeaderQueryBuilderService is active | +| col | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | | The column the filter will be applied on. | +| currentFolderNodeId | `string` | | The id of the current folder of the document list. | +| maxItems | `number` | | Maximum number of search results to show in a page. | +| skipCount | `number` | | The offset of the start of the page within the results list. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| update | `EventEmitter` | Emitted when the result of the filter is received from the API, should be passed to the `node` member of the document list. | -| clear | `EventEmitter` | Emitted when the last of all the filters is cleared. This should be used to trigger a `reload()` of the document list with no `node` member. | - +| clear | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the last of all the filters is cleared. | +| update | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` | Emitted when the result of the filter is received from the API. | ## See also diff --git a/docs/content-services/services/search-query-builder.service.md b/docs/content-services/services/search-query-builder.service.md index 057c03043a..bb83bb059b 100644 --- a/docs/content-services/services/search-query-builder.service.md +++ b/docs/content-services/services/search-query-builder.service.md @@ -51,6 +51,14 @@ Stores information from all the custom search and faceted search widgets, compil Gets the buckets currently added to a field - _field:_ `string` - The target fields - **Returns** [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts)`[]` - Bucket array +- **isFilterServiceActive**(): `boolean`
+ + - **Returns** `boolean` - + +- **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts)
+ + - **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/search-configuration.interface.ts) - + - **removeFilterQuery**(query: `string`)
Removes an existing filter query. - _query:_ `string` - The query to remove @@ -58,8 +66,8 @@ Stores information from all the custom search and faceted search widgets, compil Removes an existing bucket from a field. - _field:_ [`FacetField`](../../../lib/content-services/src/lib/search/facet-field.interface.ts) - The target field - _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/src/lib/search/facet-field-bucket.interface.ts) - Bucket to remove -- **resetToDefaults**()
- Resets the query to the defaults specified in the app config. +- **setUpConfiguration**()
+ - **update**()
Builds the current query and triggers the `updated` event. diff --git a/docs/core/components/datatable.component.md b/docs/core/components/datatable.component.md index c00e626384..cdf7dbe0dd 100644 --- a/docs/core/components/datatable.component.md +++ b/docs/core/components/datatable.component.md @@ -346,6 +346,7 @@ Learm more about styling your datatable: [Customizing the component's styles](#c | ---- | ---- | ------------- | ----------- | | actions | `boolean` | false | Toggles the data actions column. | | actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | +| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. | | columns | `any[]` | \[] | The columns that the datatable will show. | | contextMenu | `boolean` | false | Toggles custom context menu for the component. | | data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data source for the table | @@ -360,7 +361,7 @@ Learm more about styling your datatable: [Customizing the component's styles](#c | rowStyleClass | `string` | "" | The CSS class to apply to every row. | | rows | `any[]` | \[] | The rows that the datatable will show. | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | -| showHeader | `ShowHeaderMode` | "data" | Indicate which is the desired behaviour for the header. Can have 3 values `always`, `never` and `data`. `data` won't display the header if the datatable is empty and will display it otherwise. | +| showHeader | `string` | | Toggles the header. | | sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] | | stickyHeader | `boolean` | false | Toggles the sticky header mode. | @@ -368,11 +369,11 @@ Learm more about styling your datatable: [Customizing the component's styles](#c | Name | Type | Description | | ---- | ---- | ----------- | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/datatable/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. | | rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | ## Details diff --git a/docs/core/services/card-item-types.service.md b/docs/core/services/card-item-types.service.md index 4673745340..8ea69912a0 100644 --- a/docs/core/services/card-item-types.service.md +++ b/docs/core/services/card-item-types.service.md @@ -18,6 +18,10 @@ Maps type names to field component types for the [Card View component](../compon - _type:_ `string` - The type whose resolver you want - _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function +- **register**(components: `Function`, override: `boolean` = `false`)
+ Register multiple components + - _components:_ `Function` - + - _override:_ `boolean` - - **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`
Finds the component type that is needed to render a form field. - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render diff --git a/docs/core/services/form-rendering.service.md b/docs/core/services/form-rendering.service.md index f18d8c19f5..e9d178a564 100644 --- a/docs/core/services/form-rendering.service.md +++ b/docs/core/services/form-rendering.service.md @@ -18,6 +18,10 @@ Maps a form field type string onto the corresponding form [widget component](../ - _type:_ `string` - The type whose resolver you want - _defaultValue:_ `Type<__type>` - Default type returned for types that are not yet mapped - **Returns** [`DynamicComponentResolveFunction`](../../../lib/core/services/dynamic-component-mapper.service.ts) - Resolver function +- **register**(components: `Function`, override: `boolean` = `false`)
+ Register multiple components + - _components:_ `Function` - + - _override:_ `boolean` - - **resolveComponentType**(model: [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts), defaultValue: `Type<__type>` = `this.defaultValue`): `Type<__type>`
Finds the component type that is needed to render a form field. - _model:_ [`DynamicComponentModel`](../../../lib/core/services/dynamic-component-mapper.service.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) field model for the field to render diff --git a/docs/core/services/sites.service.md b/docs/core/services/sites.service.md index ff830f9170..7810b509fa 100644 --- a/docs/core/services/sites.service.md +++ b/docs/core/services/sites.service.md @@ -13,11 +13,28 @@ Accesses and manipulates sites from a Content Services repository. ### Methods +- **approveSiteMembershipRequest**(siteId: `string`, inviteeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`|__type>`
+ Accept site membership requests. + - _siteId:_ `string` - The identifier of a site. + - _inviteeId:_ `string` - The invitee user name. + - _opts:_ `any` - (Optional) Options supported by JS-API + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`|__type>` - Null response notifying when the operation is complete +- **createSiteMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMemberEntry.ts)`|__type>`
+ Creates a site membership for person **personId** on site **siteId**. + - _siteId:_ `string` - The identifier of a site + - _siteMembershipBodyCreate:_ [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts) - The person to add and their role + - _opts:_ `any` - (Optional) Optional parameters + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMemberEntry.ts)`|__type>` - Site member entry - **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a site. - _siteId:_ `string` - Site to delete - _permanentFlag:_ `boolean` - True: deletion is permanent; False: site is moved to the trash - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete +- **deleteSiteMembership**(siteId: `string`, personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Delete a site membership + - _siteId:_ `string` - The identifier of a site. + - _personId:_ `string` - The identifier of a person. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete - **getEcmCurrentLoggedUserName**(): `string`
Gets the username of the user currently logged into ACS. - **Returns** `string` - Username string @@ -34,10 +51,31 @@ Accesses and manipulates sites from a Content Services repository. Gets a list of all a site's members. - _siteId:_ `string` - ID of the target site - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>` - Site members +- **getSiteMembershipRequests**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`|__type>`
+ Gets a list of site membership requests. + - _opts:_ `any` - (Optional) Options supported by JS-API + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`|__type>` - Site membership requests +- **getSiteNameFromNodePath**(node: [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)): `string`
+ Looks for a site inside the path of a [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) and returns its guid if it finds one. (return an empty string if no site is found) + - _node:_ [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to look for parent site + - **Returns** `string` - Site guid - **getSites**(opts: `any` = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>`
Gets a list of all sites in the repository. - _opts:_ `any` - Options supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>` - List of sites +- **rejectSiteMembershipRequest**(siteId: `string`, inviteeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`|__type>`
+ Reject site membership requests. + - _siteId:_ `string` - The identifier of a site. + - _inviteeId:_ `string` - The invitee user name. + - _opts:_ `any` - (Optional) Options supported by JS-API + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`|__type>` - Null response notifying when the operation is complete +- **updateSiteMembership**(siteId: `string`, personId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMemberEntry.ts)`|__type>`
+ Update a site membership + - _siteId:_ `string` - The identifier of a site. + - _personId:_ `string` - The identifier of a person. + - _siteMembershipBodyUpdate:_ [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts) - The persons new role + - _opts:_ `any` - (Optional) Optional parameters + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMemberEntry.ts)`|__type>` - Site member entry> ## Details diff --git a/docs/extensions/services/extension.service.md b/docs/extensions/services/extension.service.md index 9d96435cc2..c8c5836a8b 100644 --- a/docs/extensions/services/extension.service.md +++ b/docs/extensions/services/extension.service.md @@ -55,11 +55,11 @@ Manages and runs basic extension functionality. - **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>`
Loads and registers an extension config file and plugins (specified by path properties). - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>` - The loaded config data -- **runExpression**(value: `string`, context?: `any`): `any`
+- **runExpression**(value: `string|__type`, context?: `any`): `Function`
Runs a lightweight expression stored in a string. - - _value:_ `string` - String containing the expression or literal value + - _value:_ `string|__type` - String containing the expression or literal value - _context:_ `any` - (Optional) Parameter object for the expression with details of app state - - **Returns** `any` - Result of evaluated expression, if found, or the literal value otherwise + - **Returns** `Function` - Result of evaluated expression, if found, or the literal value otherwise - **setAuthGuards**(values: `Function`)
Adds one or more new auth guards to the existing set. - _values:_ `Function` - The new auth guards to add diff --git a/docs/process-services-cloud/components/process-list-cloud.component.md b/docs/process-services-cloud/components/process-list-cloud.component.md index e828ef73c2..627c45e23b 100644 --- a/docs/process-services-cloud/components/process-list-cloud.component.md +++ b/docs/process-services-cloud/components/process-list-cloud.component.md @@ -75,11 +75,11 @@ when the process list is empty: | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/datatable/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected. | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details diff --git a/docs/process-services-cloud/components/task-form-cloud.component.md b/docs/process-services-cloud/components/task-form-cloud.component.md index ed91e1244b..1765f73942 100644 --- a/docs/process-services-cloud/components/task-form-cloud.component.md +++ b/docs/process-services-cloud/components/task-form-cloud.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-04-17 --- -# [Task form cloud component](../../../lib/testing/src/lib/process-services-cloud/pages/task-form-cloud-component.page.ts "Defined in task-form-cloud-component.page.ts") +# [Task form cloud component](../../../lib/process-services-cloud/src/lib/task/task-form/components/task-form-cloud.component.ts "Defined in task-form-cloud.component.ts") Shows a [`form`](../../../lib/process-services-cloud/src/lib/form/models/form-cloud.model.ts) for a task. @@ -31,6 +31,31 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar ## Class members +### Properties + +| Name | Type | Default value | Description | +| ---- | ---- | ------------- | ----------- | +| appName | `string` | "" | App id to fetch corresponding form and values. | +| readOnly | `boolean` | false | Toggle readonly state of the task. | +| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. | +| showCompleteButton | `boolean` | true | Toggle rendering of the `Complete` button. | +| showRefreshButton | `boolean` | false | Toggle rendering of the `Refresh` button. | +| showValidationIcon | `boolean` | true | Toggle rendering of the `Validation` icon. | +| taskId | `string` | | Task id to fetch corresponding form and values. | + +### Events + +| Name | Type | Description | +| ---- | ---- | ----------- | +| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the cancel button is clicked. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs. | +| 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. | +| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is saved. | +| taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | +| taskCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | +| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed. | + ## See also - [Form component](./form-cloud.component.md) diff --git a/docs/process-services-cloud/components/task-list-cloud.component.md b/docs/process-services-cloud/components/task-list-cloud.component.md index 448ef4c22e..ce77f58538 100644 --- a/docs/process-services-cloud/components/task-list-cloud.component.md +++ b/docs/process-services-cloud/components/task-list-cloud.component.md @@ -80,11 +80,11 @@ when the task list is empty: | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/datatable/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | +| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | -| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details diff --git a/docs/process-services-cloud/directives/claim-task-cloud.directive.md b/docs/process-services-cloud/directives/claim-task-cloud.directive.md index b0e2ac335e..a53863da05 100644 --- a/docs/process-services-cloud/directives/claim-task-cloud.directive.md +++ b/docs/process-services-cloud/directives/claim-task-cloud.directive.md @@ -22,7 +22,7 @@ Claims a task | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appName | `string` | "" | (Required) The name of the application. | -| taskId | `string` | "" | (Required) The id of the task. | +| taskId | `string` | | (Required) The id of the task. | ### Events diff --git a/docs/process-services-cloud/pipes/process-name-cloud.pipe.md b/docs/process-services-cloud/pipes/process-name-cloud.pipe.md index 199425b39d..a912cfc8ba 100644 --- a/docs/process-services-cloud/pipes/process-name-cloud.pipe.md +++ b/docs/process-services-cloud/pipes/process-name-cloud.pipe.md @@ -8,22 +8,26 @@ Last reviewed: 2020-06-02 # [Process name cloud pipe](../../../lib/process-services-cloud/src/lib/pipes/process-name-cloud.pipe.ts "Defined in process-name-cloud.pipe.ts") When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. + ## Basic Usage + processNameCloudPipe.transform('Example - %{processDefinition} - %{datetime}', new ProcessDefinitionCloud({ name: 'upload-passport'})); + ### Properties | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | processNameFormat | string | undefined | The process name format including the preferred identifiers to be used | -| selectedProcessDefinition | ProcessDefinitionCloud | undefined | (optional) The selected process definition | +| selectedProcessDefinition | [`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts) | undefined | (optional) The selected process definition | ## Details + The pipe offers a convenient way to format a process name using a process name format template. The supported identifiers that can be used in the process name format are the following: -- %{processDefinition} -- %{datetime} +- %{processDefinition} +- %{datetime} When the %{processDefinition} identifier is used, the selected process definition provided will be added and positioned in the same place as the identifier. @@ -31,10 +35,11 @@ will be added and positioned in the same place as the identifier. When the %{datetime} identifier is used, the current datetime will be added and positioned in the same place as the identifier. Important Notes: -- All the identifiers are case-insensitive. -- The identifiers can be used in any position (beginning, middle, end, custom). -- The identifiers can NOT be used more than once each in the same processNameFormat (The second occurrence of each identifier will be ignored -and handled as a plain string). + +- All the identifiers are case-insensitive. +- The identifiers can be used in any position (beginning, middle, end, custom). +- The identifiers can NOT be used more than once each in the same processNameFormat (The second occurrence of each identifier will be ignored + and handled as a plain string). #### Result diff --git a/docs/process-services-cloud/services/form-cloud.service.md b/docs/process-services-cloud/services/form-cloud.service.md index 9453cf20cb..16335d6553 100644 --- a/docs/process-services-cloud/services/form-cloud.service.md +++ b/docs/process-services-cloud/services/form-cloud.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-04-12 --- -# [Form cloud service](../../../lib/testing/src/lib/form-cloud/actions/form-cloud.service.ts "Defined in form-cloud.service.ts") +# [Form cloud service](../../../lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts "Defined in form-cloud.service.ts") Implements Process Services form methods @@ -26,25 +26,75 @@ class MyComponent { ### Methods -- **getForms**(appName: `string`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
+- **completeTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), outcome: `string`, version: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ Completes a task form. + - _appName:_ `string` - Name of the app + - _taskId:_ `string` - ID of the target task + - _processInstanceId:_ `string` - ID of processInstance + - _formId:_ `string` - ID of the form to complete + - _formValues:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object + - _outcome:_ `string` - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) outcome + - _version:_ `number` - of the form + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details +- **createTemporaryRawRelatedContent**(file: `any`, nodeId: `string`, contentHost: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ + - _file:_ `any` - + - _nodeId:_ `string` - + - _contentHost:_ `string` - + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - + +- **getBasePath**(appName: `string`): `string`
- _appName:_ `string` - - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - + - **Returns** `string` - -- **getIdByFormName**(appName: `string`, formName: `string`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
+- **getDropDownJsonData**(url: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Parses JSON data to create a corresponding form. + - _url:_ `string` - String data to make the request + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Array of FormFieldOption object +- **getForm**(appName: `string`, formKey: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>`
+ Gets a form definition. + - _appName:_ `string` - Name of the app + - _formKey:_ `string` - key of the target task + - _version:_ `number` - (Optional) Version of the form + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>` - Form definition +- **getProcessStorageFolderTask**(appName: `string`, taskId: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessStorageCloudModel`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`>`
- _appName:_ `string` - - - _formName:_ `string` - - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - + - _taskId:_ `string` - + - _processInstanceId:_ `string` - + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessStorageCloudModel`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`>` - -- **submitForm**(formId: `any`, appName: `any`, taskId: `any`, processInstanceId: `any`, values: `any`): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)``
- - - _formId:_ `any` - - - _appName:_ `any` - - - _taskId:_ `any` - - - _processInstanceId:_ `any` - - - _values:_ `any` - - - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`` - +- **getTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ Gets details of a task + - _appName:_ `string` - Name of the app + - _taskId:_ `string` - ID of the target task + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task +- **getTaskForm**(appName: `string`, taskId: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Gets the form definition of a task. + - _appName:_ `string` - Name of the app + - _taskId:_ `string` - ID of the target task + - _version:_ `number` - (Optional) Version of the form + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Form definition +- **getTaskVariables**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>`
+ Gets the variables of a task. + - _appName:_ `string` - Name of the app + - _taskId:_ `string` - ID of the target task + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>` - Task variables +- **parseForm**(json: `any`, data?: [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]`, readOnly: `boolean` = `false`): [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)
+ Parses JSON data to create a corresponding form. + - _json:_ `any` - JSON data to create the form + - _data:_ [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` - (Optional) Values for the form's fields + - _readOnly:_ `boolean` - Toggles whether or not the form should be read-only + - **Returns** [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) created from the JSON specification +- **saveTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, values: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ Saves a task form. + - _appName:_ `string` - Name of the app + - _taskId:_ `string` - ID of the target task + - _processInstanceId:_ `string` - ID of processInstance + - _formId:_ `string` - ID of the form to save + - _values:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details ## See also diff --git a/docs/process-services-cloud/services/start-process-cloud.service.md b/docs/process-services-cloud/services/start-process-cloud.service.md index 0dcb9393b2..6f32dea669 100644 --- a/docs/process-services-cloud/services/start-process-cloud.service.md +++ b/docs/process-services-cloud/services/start-process-cloud.service.md @@ -18,6 +18,11 @@ Gets process definitions and starts processes. - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just created +- **deleteProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Delete an existing process instance + - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + - _processInstanceId:_ `string` - process instance to update + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **getBasePath**(appName: `string`): `string`
- _appName:_ `string` - @@ -27,16 +32,23 @@ Gets process definitions and starts processes. Gets the process definitions associated with an app. - _appName:_ `string` - Name of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions -- **startCreatedProcess**(appName: `string`, createdProcessInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+- **startCreatedProcess**(appName: `string`, createdProcessInstanceId: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Starts an already created process using the process instance id. - _appName:_ `string` - - _createdProcessInstanceId:_ `string` - process instance id of the process previously created + - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started - **startProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started +- **updateProcess**(appName: `string`, processInstanceId: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+ Update an existing process instance + - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + - _processInstanceId:_ `string` - process instance to update + - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started ## Details diff --git a/docs/process-services/components/process-list.component.md b/docs/process-services/components/process-list.component.md index 364d9722ab..4706a8f59a 100644 --- a/docs/process-services/components/process-list.component.md +++ b/docs/process-services/components/process-list.component.md @@ -73,7 +73,7 @@ when the process list is empty: | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | 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. | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details diff --git a/docs/process-services/components/start-process.component.md b/docs/process-services/components/start-process.component.md index 4dfe3f5098..842c132f90 100644 --- a/docs/process-services/components/start-process.component.md +++ b/docs/process-services/components/start-process.component.md @@ -22,6 +22,8 @@ Starts a process. - [Starting a process not included in an app](#starting-a-process-not-included-in-an-app) - [Custom data example](#custom-data-example) - [Attaching a File to the start form of the process](#attaching-a-file-to-the-start-form-of-the-process) + - [Starting a process with a selected application](#starting-a-process-with-a-selected-application) + - [Error handling](#error-handling) - [See also](#see-also) ## Basic Usage @@ -42,8 +44,8 @@ Starts a process. | name | `string` | "" | (optional) Name to assign to the current process. | | processDefinitionName | `string` | | (optional) Definition name of the process to start. | | processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. | +| showSelectApplicationDropdown | `boolean` | false | (optional) Hide or show application selection dropdown. | | showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. | -| showSelectApplicationDropdown | `boolean` | false | application selection dropdown. | | title | `string` | | (optional) Define the header of the component. | | values | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. | | variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/RestVariable.md). | @@ -52,8 +54,9 @@ Starts a process. | Name | Type | Description | | ---- | ---- | ----------- | -| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when the process is canceled. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when an error occurs. | +| applicationSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when application selection changes. | +| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the process is canceled. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`>` | Emitted when process definition selection changes. | | start | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when the process starts. | @@ -194,7 +197,6 @@ You can use the `showSelectApplicationDropdown` property to Hide or show applica ![Start process with selected application](../../docassets/images/start-process-with-selected-application.png) - ### Error handling When an error occurs, the component will emit an error event that can be used to handle errors. Example: diff --git a/docs/process-services/components/task-form.component.md b/docs/process-services/components/task-form.component.md index 8f1fe3c599..d31d210580 100644 --- a/docs/process-services/components/task-form.component.md +++ b/docs/process-services/components/task-form.component.md @@ -48,7 +48,7 @@ Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.mod | 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. | | showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | | taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | -| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued). | +| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is unclaimed (ie, requeued).. | ## See also diff --git a/docs/process-services/components/task-header.component.md b/docs/process-services/components/task-header.component.md index f8927caadb..8a1a391843 100644 --- a/docs/process-services/components/task-header.component.md +++ b/docs/process-services/components/task-header.component.md @@ -26,8 +26,8 @@ Shows all the information related to a task. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | formName | `string` | null | The name of the form. | -| taskDetails | [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) | | (required) Details related to the task. | | showClaimRelease | `boolean` | true | Toggles display of the claim/release button. | +| taskDetails | [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) | | (required) Details related to the task. | ### Events diff --git a/docs/process-services/components/task-list.component.md b/docs/process-services/components/task-list.component.md index c6c1d12f54..a7ac8f3aa4 100644 --- a/docs/process-services/components/task-list.component.md +++ b/docs/process-services/components/task-list.component.md @@ -83,7 +83,7 @@ when the task list is empty: | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | -| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details diff --git a/docs/process-services/directives/claim-task.directive.md b/docs/process-services/directives/claim-task.directive.md index c6ca70f042..c10e378d6d 100644 --- a/docs/process-services/directives/claim-task.directive.md +++ b/docs/process-services/directives/claim-task.directive.md @@ -21,11 +21,11 @@ Claims a task | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| taskId | `string` | "" | (Required) The id of the task. | +| taskId | `string` | | (Required) The id of the task. | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be claimed. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is claimed. | diff --git a/docs/process-services/pipes/process-name.pipe.md b/docs/process-services/pipes/process-name.pipe.md index 2e41b58ab3..c48af99b88 100644 --- a/docs/process-services/pipes/process-name.pipe.md +++ b/docs/process-services/pipes/process-name.pipe.md @@ -8,22 +8,26 @@ Last reviewed: 2020-06-02 # [Process name pipe](../../../lib/process-services/src/lib/pipes/process-name.pipe.ts "Defined in process-name.pipe.ts") When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided. + ## Basic Usage + processNamePipe.transform('Example - %{processDefinition} - %{datetime}', new ProcessDefinitionRepresentation({ name: 'upload-passport'})); + ### Properties | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | processNameFormat | string | undefined | The process name format including the preferred identifiers to be used | -| selectedProcessDefinition | ProcessDefinitionRepresentation | undefined | (optional) The selected process definition | +| selectedProcessDefinition | [`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md) | undefined | (optional) The selected process definition | ## Details + The pipe offers a convenient way to format a process name using a process name format template. The supported identifiers that can be used in the process name format are the following: -- %{processDefinition} -- %{datetime} +- %{processDefinition} +- %{datetime} When the %{processDefinition} identifier is used, the selected process definition provided will be added and positioned in the same place as the identifier. @@ -31,10 +35,11 @@ will be added and positioned in the same place as the identifier. When the %{datetime} identifier is used, the current datetime will be added and positioned in the same place as the identifier. Important Notes: -- All the identifiers are case-insensitive. -- The identifiers can be used in any position (beginning, middle, end, custom). -- The identifiers can NOT be used more than once each in the same processNameFormat (The second occurrence of each identifier will be ignored -and handled as a plain string). + +- All the identifiers are case-insensitive. +- The identifiers can be used in any position (beginning, middle, end, custom). +- The identifiers can NOT be used more than once each in the same processNameFormat (The second occurrence of each identifier will be ignored + and handled as a plain string). #### Result diff --git a/docs/process-services/services/process-filter.service.md b/docs/process-services/services/process-filter.service.md index 323a200793..9dcec3783e 100644 --- a/docs/process-services/services/process-filter.service.md +++ b/docs/process-services/services/process-filter.service.md @@ -39,9 +39,10 @@ Manage Process Filters, which are pre-configured Process Instance queries. Gets all filters defined for a Process App. - _appId:_ `number` - ID of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>` - Array of filter details -- **getRunningFilterInstance**(appId: `number`): [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)
+- **getRunningFilterInstance**(appId: `number`, index?: `number`): [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)
Creates and returns a filter that matches "running" process instances. - _appId:_ `number` - ID of the target app + - _index:_ `number` - (Optional) of the filter (optional) - **Returns** [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - Filter just created ## Details diff --git a/docs/process-services/services/task-filter.service.md b/docs/process-services/services/task-filter.service.md index 235881ab7c..d17f1b7879 100644 --- a/docs/process-services/services/task-filter.service.md +++ b/docs/process-services/services/task-filter.service.md @@ -25,21 +25,25 @@ Manage Task Filters, which are pre-configured Task Instance queries. Creates and returns the default filters for a process app. - _appId:_ `number` - ID of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>` - Array of default filters just created -- **getCompletedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
+- **getCompletedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
Creates and returns a filter for "Completed" task instances. - _appId:_ `number` - ID of the target app + - _index:_ `number` - (Optional) of the filter (optional) - **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter -- **getInvolvedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
+- **getInvolvedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
Creates and returns a filter for "Involved" task instances. - _appId:_ `number` - ID of the target app + - _index:_ `number` - (Optional) of the filter (optional) - **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter -- **getMyTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
+- **getMyTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
Creates and returns a filter for "My Tasks" task instances. - _appId:_ `number` - ID of the target app + - _index:_ `number` - (Optional) of the filter (optional) - **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter -- **getQueuedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
+- **getQueuedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
Creates and returns a filter for "Queued Tasks" task instances. - _appId:_ `number` - ID of the target app + - _index:_ `number` - (Optional) of the filter (optional) - **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter - **getTaskFilterById**(filterId: `number`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`
Gets a task filter by ID. diff --git a/docs/versionIndex.md b/docs/versionIndex.md index f4ab32bfc6..35be67cdce 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -12,6 +12,8 @@ backend services have been tested with each released version of ADF. ## Versions +- [v3.9.0](#v390) +- [v3.8.0](#v380) - [v3.7.0](#v370) - [v3.6.0](#v360) - [v3.5.0](#v350) @@ -29,7 +31,29 @@ backend services have been tested with each released version of ADF. - [v2.1.0](#v210) - [v2.0.0](#v200) -## v3.6.0 +## v3.8.0 + + + +- [Claim task cloud directive](process-services-cloud/directives/claim-task-cloud.directive.md) +- [Claim task directive](process-services/directives/claim-task.directive.md) +- [Form custom outcome component](process-services/components/form-custom-outcome.component.md) +- [Process name cloud pipe](process-services-cloud/pipes/process-name-cloud.pipe.md) +- [Process name pipe](process-services/pipes/process-name.pipe.md) +- [Search header component](content-services/components/search-header.component.md) +- [Unclaim task cloud directive](process-services-cloud/directives/unclaim-task-cloud.directive.md) +- [Unclaim task directive](process-services/directives/unclaim-task.directive.md) +- [Version comparison component](content-services/components/version-comparison.component.md) + + + +## v3.8.0 + + + + + +## v3.7.0 **Release:** 2020-02-03
@@ -112,11 +136,9 @@ backend services have been tested with each released version of ADF. - [Auth guard sso role service](core/services/auth-guard-sso-role.service.md) -- [Claim task directive](process-services-cloud/directives/claim-task.directive.md) - [Complete task directive](process-services-cloud/directives/complete-task.directive.md) - [Preview extension component](extensions/components/preview-extension.component.md) - [Task cloud service](process-services-cloud/services/task-cloud.service.md) -- [Unclaim task directive](process-services-cloud/directives/unclaim-task.directive.md) diff --git a/lib/content-services/src/lib/search/components/search-header/search-header.component.ts b/lib/content-services/src/lib/search/components/search-header/search-header.component.ts index 44704e7a1c..5f8e0ef85b 100644 --- a/lib/content-services/src/lib/search/components/search-header/search-header.component.ts +++ b/lib/content-services/src/lib/search/components/search-header/search-header.component.ts @@ -32,21 +32,28 @@ import { takeUntil } from 'rxjs/operators'; encapsulation: ViewEncapsulation.None }) export class SearchHeaderComponent implements OnInit, OnChanges, OnDestroy { + + /** The column the filter will be applied on. */ @Input() col: DataColumn; + /** The id of the current folder of the document list. */ @Input() currentFolderNodeId: string; + /** Maximum number of search results to show in a page. */ @Input() maxItems: number; + /** The offset of the start of the page within the results list. */ @Input() skipCount: number; + /** Emitted when the result of the filter is received from the API. */ @Output() update: EventEmitter = new EventEmitter(); + /** Emitted when the last of all the filters is cleared. */ @Output() clear: EventEmitter = new EventEmitter(); diff --git a/scripts/travis/update/update-children.sh b/scripts/travis/update/update-children.sh index 659932b8fa..62adaa868d 100755 --- a/scripts/travis/update/update-children.sh +++ b/scripts/travis/update/update-children.sh @@ -8,7 +8,7 @@ if ([ "$TRAVIS_BRANCH" = "master" ]); then JS_VERSION=$(npm view @alfresco/js-api version) else VERSION=$(npm view @alfresco/adf-core@beta version) - JS_VERSION=$(npm view @alfresco/js-api@beta version) + JS_VERSION=$(npm view @alfresco/js-api@alpha version) fi; echo "Update Generator" diff --git a/scripts/travis/update/update-project.sh b/scripts/travis/update/update-project.sh index 9c3397982e..35ea4e20f8 100755 --- a/scripts/travis/update/update-project.sh +++ b/scripts/travis/update/update-project.sh @@ -3,7 +3,7 @@ set -e TEMP_GENERATOR_DIR=".tmp-generator"; VERSION=$(npm view @alfresco/adf-core@beta version) -JS_VERSION=$(npm view @alfresco/js-api@beta version) +JS_VERSION=$(npm view @alfresco/js-api@alpha version) show_help() { echo "Usage: update-project.sh" diff --git a/scripts/update-version.sh b/scripts/update-version.sh index efcf393ee3..60bfb5d51e 100755 --- a/scripts/update-version.sh +++ b/scripts/update-version.sh @@ -77,7 +77,7 @@ next_beta_mode() { echo "====== version lib ${VERSION} =====" DIFFERENT_JS_API=true - VERSION_JS_API=$(npm view @alfresco/js-api@beta version) + VERSION_JS_API=$(npm view @alfresco/js-api@alpha version) echo "====== version js-api ${DIFFERENT_JS_API} =====" } @@ -89,7 +89,7 @@ last_beta_mode() { echo "====== version lib ${VERSION} =====" DIFFERENT_JS_API=true - VERSION_JS_API=$(npm view @alfresco/js-api@beta version) + VERSION_JS_API=$(npm view @alfresco/js-api@alpha version) echo "====== version js-api ${DIFFERENT_JS_API} =====" }