mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4249] Updates for doc review (#4454)
* [ADF-4249] Updates for doc review * [ADF-4249] Clarified text slightly
This commit is contained in:
committed by
Eugenio Romano
parent
34b5c5a1b3
commit
7fe066b068
@@ -171,7 +171,7 @@ for more information about installing and using the source code.
|
|||||||
| [Apps Process service](core/services/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) |
|
| [Apps Process service](core/services/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) |
|
||||||
| [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) |
|
| [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) |
|
||||||
| [Auth Guard Ecm service](core/services/auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) |
|
| [Auth Guard Ecm service](core/services/auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) |
|
||||||
| [Auth Guard SSO Role service](core/services/auth-guard-sso-role.service.md) | Allow to check the user roles of a user | [Source](../lib/core/services/auth-guard-sso-role.service.ts) |
|
| [Auth Guard SSO Role service](core/services/auth-guard-sso-role.service.md) | Checks the user roles of a user. | [Source](../lib/core/services/auth-guard-sso-role.service.ts) |
|
||||||
| [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) |
|
| [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) |
|
||||||
| [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) |
|
| [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) |
|
||||||
| [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/userinfo/services/bpm-user.service.ts) |
|
| [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/userinfo/services/bpm-user.service.ts) |
|
||||||
@@ -414,6 +414,12 @@ for more information about installing and using the source code.
|
|||||||
| [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md)  | 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 Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md)  | 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)  | 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) |
|
| [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md)  | 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) |
|
||||||
|
|
||||||
|
### Directives
|
||||||
|
|
||||||
|
| Name | Description | Source link |
|
||||||
|
| ---- | ----------- | ----------- |
|
||||||
|
| [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md)  | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) |
|
||||||
|
|
||||||
### Pipes
|
### Pipes
|
||||||
|
|
||||||
| Name | Description | Source link |
|
| Name | Description | Source link |
|
||||||
@@ -431,6 +437,7 @@ for more information about installing and using the source code.
|
|||||||
| [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md)  | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
|
| [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md)  | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
|
||||||
| [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md)  | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
|
| [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md)  | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
|
||||||
| [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md)  | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
|
| [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md)  | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
|
||||||
|
| [Task Cloud Service](process-services-cloud/services/task-cloud.service.md)  | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts) |
|
||||||
| [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md)  | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
| [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md)  | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
||||||
| [Task Header Cloud Service](process-services-cloud/services/task-header-cloud.service.md)  | Manages cloud tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) |
|
| [Task Header Cloud Service](process-services-cloud/services/task-header-cloud.service.md)  | Manages cloud tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) |
|
||||||
| [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md)  | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
| [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md)  | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
||||||
@@ -453,7 +460,7 @@ for more information about installing and using the source code.
|
|||||||
| Name | Description | Source link |
|
| Name | Description | Source link |
|
||||||
| ---- | ----------- | ----------- |
|
| ---- | ----------- | ----------- |
|
||||||
| [Dynamic Component](extensions/components/dynamic.component.md)  | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) |
|
| [Dynamic Component](extensions/components/dynamic.component.md)  | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) |
|
||||||
| [Preview Extension Component](extensions/components/preview-extension.component.md)  | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) |
|
| [Preview Extension Component](extensions/components/preview-extension.component.md)  | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) |
|
||||||
|
|
||||||
### Services
|
### Services
|
||||||
|
|
||||||
|
@@ -2,7 +2,7 @@
|
|||||||
Title: Search Query Builder service
|
Title: Search Query Builder service
|
||||||
Added: v2.3.0
|
Added: v2.3.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-06-12
|
Last reviewed: 2019-03-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# [Search Query Builder service](../../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts")
|
# [Search Query Builder service](../../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts")
|
||||||
@@ -44,10 +44,9 @@ Stores information from all the custom search and faceted search widgets, compil
|
|||||||
Gets all pre-configured sorting options that users can choose from.
|
Gets all pre-configured sorting options that users can choose from.
|
||||||
- **Returns** [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
|
- **Returns** [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
|
||||||
- **getSupportedLabel**(configLabel: `string`): `string`<br/>
|
- **getSupportedLabel**(configLabel: `string`): `string`<br/>
|
||||||
|
Encloses a label name with double quotes if it contains whitespace characters.
|
||||||
- _configLabel:_ `string` -
|
- _configLabel:_ `string` - Original label text
|
||||||
- **Returns** `string` -
|
- **Returns** `string` - Label, possibly with quotes if it contains spaces
|
||||||
|
|
||||||
- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts)`[]`<br/>
|
- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts)`[]`<br/>
|
||||||
Gets the buckets currently added to a field
|
Gets the buckets currently added to a field
|
||||||
- _field:_ `string` - The target fields
|
- _field:_ `string` - The target fields
|
||||||
@@ -96,7 +95,7 @@ constructor(queryBuilder: SearchQueryBuilderService) {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** Since ADF 3.0.0, the query contains the `"facetFormat": "V2"` parameter so that all the responses have the same structure even if coming from search queries containing facetFields, facetQueries, grouped facetQueries or facetIntervals.
|
> **Note:** From ADF 3.0.0, the query contains the `"facetFormat": "V2"` parameter so that all the responses have the same structure whether they come from search queries containing facetFields, facetQueries, grouped facetQueries or facetIntervals.
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
|
@@ -2,7 +2,7 @@
|
|||||||
Title: About Component
|
Title: About Component
|
||||||
Added: v2.4.0
|
Added: v2.4.0
|
||||||
Status: Experimental
|
Status: Experimental
|
||||||
Last reviewed: 2018-11-14
|
Last reviewed: 2019-03-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# [About Component](../../../lib/core/about/about.component.ts "Defined in about.component.ts")
|
# [About Component](../../../lib/core/about/about.component.ts "Defined in about.component.ts")
|
||||||
@@ -10,33 +10,38 @@ Last reviewed: 2018-11-14
|
|||||||
Shows a general version and status overview of the installed ADF library.
|
Shows a general version and status overview of the installed ADF library.
|
||||||
|
|
||||||
## Basic Usage
|
## Basic Usage
|
||||||
|
|
||||||
With default input values
|
With default input values
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<adf-about></adf-about>
|
<adf-about></adf-about>
|
||||||
```
|
```
|
||||||
|
|
||||||
With custom input values:
|
With custom input values:
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<adf-about
|
<adf-about
|
||||||
githubUrlCommitAlpha="https://githubcom/Alfresco/alfresco-ng2-components/commits/"
|
githubUrlCommitAlpha="https://github.com/Alfresco/alfresco-ng2-components/commits/"
|
||||||
showExtensions="false"
|
showExtensions="false"
|
||||||
regexp="^(@alfresco)"
|
regexp="^(@alfresco)"
|
||||||
></adf-about>
|
></adf-about>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
| ---- | ---- | ------------- | ----------- |
|
| ---- | ---- | ------------- | ----------- |
|
||||||
| githubUrlCommitAlpha | `string` | https://githubcom/Alfresco/alfresco-ng2-components/commits/ | Version of ADF to be used |
|
| githubUrlCommitAlpha | `string` | | Commit corresponding to the version of ADF to be used. |
|
||||||
| showExtensions | `boolean` | true | Parameter for hide or show extensions block |
|
| regexp | `string` | "^(@alfresco)" | Regular expression for filtering dependencies packages. |
|
||||||
| regexp | `string` | ^(@alfresco) | Regular expression for filtering dependencies packages |
|
| showExtensions | `boolean` | true | Toggles showing/hiding of extensions block. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|
||||||
Use this component to get a general overview of the version of ADF installed and the status of the [Content service](../services/content.service.md) and [Process service](../../process-services/services/process.service.md).
|
Use this component to get a general overview of the version of ADF installed and the status of the [Content service](../services/content.service.md) and [Process service](../../process-services/services/process.service.md).
|
||||||
|
|
||||||
Note at the moment this component is mostly for internal use and it requires you to:
|
Note that at the moment this component is mostly for internal use and it requires you to:
|
||||||
|
|
||||||
- create a version file : `npm list --depth=0 --json=true --prod=true > versions.json`
|
- create a version file : `npm list --depth=0 --json=true --prod=true > versions.json`
|
||||||
- provide this version file in the `dist` folder
|
- provide this version file in the `dist` folder
|
||||||
|
@@ -2,11 +2,12 @@
|
|||||||
Title: Auth Guard SSO Role service
|
Title: Auth Guard SSO Role service
|
||||||
Added: v3.1.0
|
Added: v3.1.0
|
||||||
Status: Active
|
Status: Active
|
||||||
|
Last reviewed: 2019-03-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# [Auth Guard SSO role service](../../../lib/core/services/auth-guard-sso-role.service.ts "Defined in auth-guard-sso-role.service.ts")
|
# [Auth Guard SSO role service](../../../lib/core/services/auth-guard-sso-role.service.ts "Defined in auth-guard-sso-role.service.ts")
|
||||||
|
|
||||||
Allow to check the user roles of a user
|
Checks the user roles of a user.
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
|
||||||
@@ -28,11 +29,11 @@ const appRoutes: Routes = [
|
|||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
If the user now clicks on a link or button that follows this route, they will be not able to access to this content if the user does not have the roles.
|
If the user now clicks on a link or button that follows this route, they will be not able to access this content if they do not have the roles.
|
||||||
|
|
||||||
## Redirect over forbidden
|
## Redirect over forbidden
|
||||||
|
|
||||||
If the you want to redirect the user to a different page over a forbidden error you can use the **redirectUrl** as the example below:
|
If the you want to redirect the user to a page after a forbidden access, you can use the **redirectUrl** as in the example below:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
const appRoutes: Routes = [
|
const appRoutes: Routes = [
|
||||||
@@ -47,7 +48,7 @@ const appRoutes: Routes = [
|
|||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: you can use this Guard in and with the other ADF auth guard.
|
**Note**: you can use this Guard in and with the other ADF auth guards.
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
|
@@ -2,7 +2,7 @@
|
|||||||
Title: Authentication Service
|
Title: Authentication Service
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2018-11-19
|
Last reviewed: 2019-03-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# [Authentication Service](../../../lib/core/services/authentication.service.ts "Defined in authentication.service.ts")
|
# [Authentication Service](../../../lib/core/services/authentication.service.ts "Defined in authentication.service.ts")
|
||||||
@@ -73,8 +73,8 @@ Provides authentication to ACS and APS.
|
|||||||
Checks whether the "remember me" cookie was set or not.
|
Checks whether the "remember me" cookie was set or not.
|
||||||
- **Returns** `boolean` - True if set, false otherwise
|
- **Returns** `boolean` - True if set, false otherwise
|
||||||
- **isSSODiscoveryConfigured**(): `boolean`<br/>
|
- **isSSODiscoveryConfigured**(): `boolean`<br/>
|
||||||
Check if SSO is configured correctly
|
Checks if SSO is configured correctly.
|
||||||
- **Returns** `boolean` -
|
- **Returns** `boolean` - True if configured correctly, false otherwise
|
||||||
- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
|
- **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Function>`<br/>
|
||||||
Logs the user in.
|
Logs the user in.
|
||||||
- _username:_ `string` - Username for the login
|
- _username:_ `string` - Username for the login
|
||||||
|
@@ -2,7 +2,7 @@
|
|||||||
Title: Content service
|
Title: Content service
|
||||||
Added: v2.0.0
|
Added: v2.0.0
|
||||||
Status: Active
|
Status: Active
|
||||||
Last reviewed: 2019-02-13
|
Last reviewed: 2019-03-13
|
||||||
---
|
---
|
||||||
|
|
||||||
# [Content service](../../../lib/core/services/content.service.ts "Defined in content.service.ts")
|
# [Content service](../../../lib/core/services/content.service.ts "Defined in content.service.ts")
|
||||||
@@ -58,7 +58,7 @@ Accesses app-generated data objects via URLs and file downloads.
|
|||||||
- **hasPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permission: [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string`): `boolean`<br/>
|
- **hasPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permission: [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string`): `boolean`<br/>
|
||||||
Checks if the user has permission on that node
|
Checks if the user has permission on that node
|
||||||
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to check permissions
|
- _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to check permissions
|
||||||
- _permission:_ [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` -
|
- _permission:_ [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` - Required permission type
|
||||||
- **Returns** `boolean` - True if the user has the required permissions, false otherwise
|
- **Returns** `boolean` - True if the user has the required permissions, false otherwise
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
|
@@ -2,7 +2,7 @@
|
|||||||
Title: Extension Service
|
Title: Extension Service
|
||||||
Added: v3.0.0
|
Added: v3.0.0
|
||||||
Status: Experimental
|
Status: Experimental
|
||||||
Last reviewed: 2018-12-17
|
Last reviewed: 2019-03-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# [Extension Service](../../../lib/extensions/src/lib/services/extension.service.ts "Defined in extension.service.ts")
|
# [Extension Service](../../../lib/extensions/src/lib/services/extension.service.ts "Defined in extension.service.ts")
|
||||||
@@ -35,10 +35,9 @@ Manages and runs basic extension functionality.
|
|||||||
- _key:_ `string` - Key name to look for
|
- _key:_ `string` - Key name to look for
|
||||||
- **Returns** `RuleEvaluator` - RuleEvaluator or null if not found
|
- **Returns** `RuleEvaluator` - RuleEvaluator or null if not found
|
||||||
- **getFeature**(key: `string`): `any[]`<br/>
|
- **getFeature**(key: `string`): `any[]`<br/>
|
||||||
|
Gets features by key.
|
||||||
- _key:_ `string` -
|
- _key:_ `string` - Key string, using dot notation
|
||||||
- **Returns** `any[]` -
|
- **Returns** `any[]` - Features array found by key
|
||||||
|
|
||||||
- **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)<br/>
|
- **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)<br/>
|
||||||
Retrieves a route using its ID value.
|
Retrieves a route using its ID value.
|
||||||
- _id:_ `string` - The ID value to look for
|
- _id:_ `string` - The ID value to look for
|
||||||
|
@@ -1,26 +0,0 @@
|
|||||||
---
|
|
||||||
Title: Complete Cloud Task
|
|
||||||
Added: v3.1.0
|
|
||||||
Status: Experimental
|
|
||||||
Last reviewed: 2019-02-28
|
|
||||||
---
|
|
||||||
|
|
||||||
# [Complete task directive](../../lib/process-services-cloud/src/lib/task/task-header/directives/complete-task.directive.ts "Defined in complete-task.directive.ts")
|
|
||||||
|
|
||||||
Complete a task
|
|
||||||
|
|
||||||
## Basic Usage
|
|
||||||
|
|
||||||
```html
|
|
||||||
<button adf-cloud-complete-task [appName]="appName" [taskId]="taskId" (success)="onTaskCompleted()">Complete</button>
|
|
||||||
```
|
|
||||||
## Class members
|
|
||||||
|
|
||||||
### Properties
|
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
|
||||||
| ---- | ---- | ------------- | ----------- |
|
|
||||||
| taskId | `string` | empty |(Required) The id of the task. |
|
|
||||||
| appName | `string` | empty | (Required) The name of the application. |
|
|
||||||
| success | `EventEmitter<any>` | empty | Emitted when the task is completed. |
|
|
||||||
| error | `EventEmitter<any>` | empty | Emitted when the task cannot be completed. |
|
|
@@ -0,0 +1,32 @@
|
|||||||
|
---
|
||||||
|
Title: Complete Task Directive
|
||||||
|
Added: v3.1.0
|
||||||
|
Status: Experimental
|
||||||
|
Last reviewed: 2019-03-19
|
||||||
|
---
|
||||||
|
|
||||||
|
# [Complete task directive](../../../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts "Defined in complete-task.directive.ts")
|
||||||
|
|
||||||
|
Completes a task.
|
||||||
|
|
||||||
|
## Basic Usage
|
||||||
|
|
||||||
|
```html
|
||||||
|
<button adf-cloud-complete-task [appName]="appName" [taskId]="taskId" (success)="onTaskCompleted()">Complete</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
| Name | Type | Default value | Description |
|
||||||
|
| ---- | ---- | ------------- | ----------- |
|
||||||
|
| appName | `string` | | (Required) The name of the application. |
|
||||||
|
| taskId | `string` | | (Required) The id of the task. |
|
||||||
|
|
||||||
|
### Events
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | ---- | ----------- |
|
||||||
|
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be completed. |
|
||||||
|
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is completed. |
|
@@ -2,37 +2,37 @@
|
|||||||
Title: Task Cloud Service
|
Title: Task Cloud Service
|
||||||
Added: v3.1.0
|
Added: v3.1.0
|
||||||
Status: Experimental
|
Status: Experimental
|
||||||
Last reviewed: 2019-02-28
|
Last reviewed: 2019-03-19
|
||||||
---
|
---
|
||||||
|
|
||||||
# [Task Cloud Service](../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts "Defined in task-cloud.service.ts")
|
# [Task Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts "Defined in task-cloud.service.ts")
|
||||||
|
|
||||||
Manage task cloud.
|
Manages task cloud.
|
||||||
|
|
||||||
## Class members
|
## Class members
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
|
|
||||||
- **completeTask**(appName: `string`, taskId: `string`)<br/>
|
- **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
|
||||||
Complete a task
|
|
||||||
- _appName:_ `string` - Name of the app
|
|
||||||
- _taskId:_ `string` - ID of the task to complete
|
|
||||||
|
|
||||||
- **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts))<br/>
|
|
||||||
Validate if a task can be completed.
|
Validate if a task can be completed.
|
||||||
- _taskDetails:_ [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts) - Task details object
|
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
|
||||||
|
- **Returns** `boolean` - Boolean value if the task can be completed
|
||||||
- **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): `any`<br/>
|
- **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): `any`<br/>
|
||||||
Claims a task for an assignee.
|
Claims a task for an assignee.
|
||||||
- _appName:_ `string` - Name of the app
|
- _appName:_ `string` - Name of the app
|
||||||
- _taskId:_ `string` - ID of the task to claim
|
- _taskId:_ `string` - ID of the task to claim
|
||||||
- _assignee:_ `string` - User to assign the task to
|
- _assignee:_ `string` - User to assign the task to
|
||||||
- **Returns** `any` - Details of the claimed task
|
- **Returns** `any` - Details of the claimed task
|
||||||
- **getTaskById**(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)`>`<br/>
|
- **completeTask**(appName: `string`, taskId: `string`): `any`<br/>
|
||||||
|
Complete a task.
|
||||||
|
- _appName:_ `string` - Name of the app
|
||||||
|
- _taskId:_ `string` - ID of the task to complete
|
||||||
|
- **Returns** `any` - Details of the task that was completed
|
||||||
|
- **getTaskById**(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)`>`<br/>
|
||||||
Gets details of a task.
|
Gets details of a task.
|
||||||
- _appName:_ `string` - Name of the app
|
- _appName:_ `string` - Name of the app
|
||||||
- _taskId:_ `string` - ID of the task whose details you want
|
- _taskId:_ `string` - ID of the task whose details you want
|
||||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details
|
||||||
- **unclaimTask**(appName: `string`, taskId: `string`): `any`<br/>
|
- **unclaimTask**(appName: `string`, taskId: `string`): `any`<br/>
|
||||||
Un-claims a task.
|
Un-claims a task.
|
||||||
- _appName:_ `string` - Name of the app
|
- _appName:_ `string` - Name of the app
|
||||||
@@ -48,10 +48,10 @@ Manage task cloud.
|
|||||||
## Details
|
## Details
|
||||||
|
|
||||||
The methods work in much the same way as the equivalent methods in the
|
The methods work in much the same way as the equivalent methods in the
|
||||||
[Tasklist service](../process-services/tasklist.service.md)
|
[Tasklist service](../../process-services/services/tasklist.service.md)
|
||||||
but they use the cloud variants of the classes for return values. See the
|
but they use the cloud variants of the classes for return values. See the
|
||||||
[Tasklist service](../process-services/tasklist.service.md) page for usage examples.
|
[Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples.
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Tasklist service](../process-services/tasklist.service.md)
|
- [Tasklist service](../../process-services/services/tasklist.service.md)
|
@@ -12,6 +12,7 @@ backend services have been tested with each released version of ADF.
|
|||||||
|
|
||||||
## Versions
|
## Versions
|
||||||
|
|
||||||
|
- [v3.1.0](#v310)
|
||||||
- [v3.0.0](#v300)
|
- [v3.0.0](#v300)
|
||||||
- [v2.6.0](#v260)
|
- [v2.6.0](#v260)
|
||||||
- [v2.5.0](#v250)
|
- [v2.5.0](#v250)
|
||||||
@@ -21,10 +22,23 @@ backend services have been tested with each released version of ADF.
|
|||||||
- [v2.1.0](#v210)
|
- [v2.1.0](#v210)
|
||||||
- [v2.0.0](#v200)
|
- [v2.0.0](#v200)
|
||||||
|
|
||||||
## v3.0.0
|
## v3.1.0
|
||||||
|
|
||||||
**Release:** Forthcoming<br/>
|
**Release:** Forthcoming<br/>
|
||||||
|
|
||||||
|
<!--v310 start-->
|
||||||
|
|
||||||
|
- [Auth guard sso role service](core/services/auth-guard-sso-role.service.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)
|
||||||
|
|
||||||
|
<!--v310 end-->
|
||||||
|
|
||||||
|
## v3.0.0
|
||||||
|
|
||||||
|
**Release:** 2019-02-13<br/>
|
||||||
|
|
||||||
### Components added
|
### Components added
|
||||||
|
|
||||||
<!--v300 start-->
|
<!--v300 start-->
|
||||||
|
@@ -403,6 +403,11 @@ export class SearchQueryBuilderService {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encloses a label name with double quotes if it contains whitespace characters.
|
||||||
|
* @param configLabel Original label text
|
||||||
|
* @returns Label, possibly with quotes if it contains spaces
|
||||||
|
*/
|
||||||
getSupportedLabel(configLabel: string): string {
|
getSupportedLabel(configLabel: string): string {
|
||||||
const spaceInsideLabelIndex = configLabel.search(/\s/g);
|
const spaceInsideLabelIndex = configLabel.search(/\s/g);
|
||||||
if (spaceInsideLabelIndex > -1) {
|
if (spaceInsideLabelIndex > -1) {
|
||||||
|
@@ -39,8 +39,14 @@ export class AboutComponent implements OnInit {
|
|||||||
modules: ObjectDataTableAdapter;
|
modules: ObjectDataTableAdapter;
|
||||||
extensionColumns: string[] = ['$id', '$name', '$version', '$vendor', '$license', '$runtime', '$description'];
|
extensionColumns: string[] = ['$id', '$name', '$version', '$vendor', '$license', '$runtime', '$description'];
|
||||||
extensions$: Observable<ExtensionRef[]>;
|
extensions$: Observable<ExtensionRef[]>;
|
||||||
|
|
||||||
|
/** Commit corresponding to the version of ADF to be used. */
|
||||||
@Input() githubUrlCommitAlpha = 'https://github.com/Alfresco/alfresco-ng2-components/commits/';
|
@Input() githubUrlCommitAlpha = 'https://github.com/Alfresco/alfresco-ng2-components/commits/';
|
||||||
|
|
||||||
|
/** Toggles showing/hiding of extensions block. */
|
||||||
@Input() showExtensions = true;
|
@Input() showExtensions = true;
|
||||||
|
|
||||||
|
/** Regular expression for filtering dependencies packages. */
|
||||||
@Input() regexp = '^(@alfresco)';
|
@Input() regexp = '^(@alfresco)';
|
||||||
|
|
||||||
ecmHost = '';
|
ecmHost = '';
|
||||||
|
@@ -316,7 +316,8 @@ export class AuthenticationService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if SSO is configured correctly
|
* Checks if SSO is configured correctly.
|
||||||
|
* @returns True if configured correctly, false otherwise
|
||||||
*/
|
*/
|
||||||
isSSODiscoveryConfigured() {
|
isSSODiscoveryConfigured() {
|
||||||
return this.alfrescoApi.getInstance().storage.getItem('discovery') ? true : false;
|
return this.alfrescoApi.getInstance().storage.getItem('discovery') ? true : false;
|
||||||
|
@@ -175,7 +175,7 @@ export class ContentService {
|
|||||||
/**
|
/**
|
||||||
* Checks if the user has permission on that node
|
* Checks if the user has permission on that node
|
||||||
* @param node Node to check permissions
|
* @param node Node to check permissions
|
||||||
* @param permission
|
* @param permission Required permission type
|
||||||
* @returns True if the user has the required permissions, false otherwise
|
* @returns True if the user has the required permissions, false otherwise
|
||||||
*/
|
*/
|
||||||
hasPermissions(node: Node, permission: PermissionsEnum | string): boolean {
|
hasPermissions(node: Node, permission: PermissionsEnum | string): boolean {
|
||||||
@@ -205,7 +205,7 @@ export class ContentService {
|
|||||||
/**
|
/**
|
||||||
* Checks if the user has permissions on that node
|
* Checks if the user has permissions on that node
|
||||||
* @param node Node to check allowableOperations
|
* @param node Node to check allowableOperations
|
||||||
* @param permission Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
|
* @param allowableOperation Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
|
||||||
* @returns True if the user has the required permissions, false otherwise
|
* @returns True if the user has the required permissions, false otherwise
|
||||||
*/
|
*/
|
||||||
hasAllowableOperations(node: Node, allowableOperation: AllowableOperationsEnum | string): boolean {
|
hasAllowableOperations(node: Node, allowableOperation: AllowableOperationsEnum | string): boolean {
|
||||||
|
@@ -80,6 +80,11 @@ export class ExtensionService {
|
|||||||
this.features = this.loader.getFeatures(config);
|
this.features = this.loader.getFeatures(config);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets features by key.
|
||||||
|
* @param key Key string, using dot notation
|
||||||
|
* @returns Features array found by key
|
||||||
|
*/
|
||||||
getFeature(key: string): any[] {
|
getFeature(key: string): any[] {
|
||||||
let properties: string[] = Array.isArray(key) ? [key] : key.split('.');
|
let properties: string[] = Array.isArray(key) ? [key] : key.split('.');
|
||||||
return properties.reduce((prev, curr) => prev && prev[curr], this.features) || [];
|
return properties.reduce((prev, curr) => prev && prev[curr], this.features) || [];
|
||||||
|
@@ -3,7 +3,7 @@ items:
|
|||||||
name: <%= name %>
|
name: <%= name %>
|
||||||
fullName: <%= name %>
|
fullName: <%= name %>
|
||||||
source:
|
source:
|
||||||
path: <%= sources[0].fileName %>
|
path: <%= 'lib/' + sources[0].fileName %>
|
||||||
startLine: <%= sources[0].line %>
|
startLine: <%= sources[0].line %>
|
||||||
children:
|
children:
|
||||||
<%_ if (typeof children !== "undefined") { -%>
|
<%_ if (typeof children !== "undefined") { -%>
|
||||||
|
Reference in New Issue
Block a user