mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
[ADF-2152] Updated See Also sections in docs (#2846)
This commit is contained in:
committed by
Eugenio Romano
parent
c9a3b048b4
commit
f5ef324dd2
@@ -12,8 +12,3 @@ Searches the repository.
|
|||||||
See the
|
See the
|
||||||
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-search-rest-api/docs/SearchApi.md#search)
|
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-search-rest-api/docs/SearchApi.md#search)
|
||||||
for the format of the query and returned data.
|
for the format of the query and returned data.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
|
|
||||||
<!-- seealso end -->
|
|
@@ -11,15 +11,10 @@ Gets shared links available to the current user.
|
|||||||
|
|
||||||
Content Services allows users to generate URLs that can be shared with
|
Content Services allows users to generate URLs that can be shared with
|
||||||
other people, even if they don't have a Content Services account. These
|
other people, even if they don't have a Content Services account. These
|
||||||
URLs are known as *shared links*.
|
URLs are known as _shared links_.
|
||||||
|
|
||||||
Use `getSharedLinks` to find all the shared links that are available to
|
Use `getSharedLinks` to find all the shared links that are available to
|
||||||
the current user. You can supply a number of `options` to refine the
|
the current user. You can supply a number of `options` to refine the
|
||||||
search; see the
|
search; see the
|
||||||
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SharedlinksApi.md#findsharedlinks)
|
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SharedlinksApi.md#findsharedlinks)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
|
|
||||||
<!-- seealso end -->
|
|
@@ -40,9 +40,6 @@ class SiteMembersModel {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Sites api service](sites.service.md)
|
- [Sites api service](sites-api.service.md)
|
||||||
<!-- seealso end -->
|
|
||||||
|
@@ -40,12 +40,6 @@ and
|
|||||||
[getSite](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite)
|
[getSite](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite)
|
||||||
for more information about the available options.
|
for more information about the available options.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Site model](site.model.md)
|
- [Site model](site.model.md)
|
||||||
<!-- seealso end -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@@ -16,7 +16,7 @@ Displays the Start Form for a process.
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| ---- | ---- | ------- | ----------- |
|
||||||
| processDefinitionId | string | | Definition ID of the process to start. |
|
| processDefinitionId | string | | Definition ID of the process to start. |
|
||||||
| processId | string | | Process ID of the process to start. |
|
| processId | string | | Process ID of the process to start. |
|
||||||
| showOutcomeButtons | boolean | true | Should form outcome buttons be shown? |
|
| showOutcomeButtons | boolean | true | Should form outcome buttons be shown? |
|
||||||
@@ -26,7 +26,7 @@ Displays the Start Form for a process.
|
|||||||
### Events
|
### Events
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
| --- | --- |
|
| ---- | ----------- |
|
||||||
| outcomeClick | Emitted when the user clicks one of the outcome buttons that completes the form. |
|
| outcomeClick | Emitted when the user clicks one of the outcome buttons that completes the form. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
@@ -40,7 +40,6 @@ The `outcomeClick` event is passed a string containing the ID of the outcome but
|
|||||||
the user clicked. You can pass this value to the `startProcess` method (defined in the
|
the user clicked. You can pass this value to the `startProcess` method (defined in the
|
||||||
[Process service](process.service.md)) when activating the process, if necessary.
|
[Process service](process.service.md)) when activating the process, if necessary.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
## See also
|
||||||
<!-- seealso start -->
|
|
||||||
|
|
||||||
<!-- seealso end -->
|
- [Process service](process.service.md)
|
||||||
|
@@ -32,10 +32,7 @@ more widely supported by browsers and can be set to expire after a certain date.
|
|||||||
If local storage is not available then non-persistent memory storage within the app is
|
If local storage is not available then non-persistent memory storage within the app is
|
||||||
used instead.
|
used instead.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Cookie service](cookie.service.md)
|
- [Cookie service](cookie.service.md)
|
||||||
- [Content service](content.service.md)
|
- [Content service](content.service.md)
|
||||||
<!-- seealso end -->
|
|
@@ -1,4 +1,4 @@
|
|||||||
# Alfresco Tag Node Actions List component
|
# Tag Node Actions List component
|
||||||
|
|
||||||
Shows available actions for tags.
|
Shows available actions for tags.
|
||||||
|
|
||||||
@@ -15,5 +15,5 @@ Shows available actions for tags.
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Attribute | Type | Default | Description |
|
| Attribute | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| --------- | ---- | ------- | ----------- |
|
||||||
| nodeId | string | | The identifier of a node |
|
| nodeId | string | | The identifier of a node |
|
@@ -1,5 +1,9 @@
|
|||||||
# Alfresco Tag List component
|
# Tag List component
|
||||||
|
|
||||||
Shows tags for an item.
|
Shows tags for an item.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
- [Tag service](tag.service.md)
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
# Alfresco Tag Node List component
|
# Tag Node List component
|
||||||
|
|
||||||
Shows tags for a node.
|
Shows tags for a node.
|
||||||
|
|
||||||
@@ -15,5 +15,5 @@ Shows tags for a node.
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Attribute | Type | Default | Description |
|
| Attribute | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| --------- | ---- | ------- | ----------- |
|
||||||
| nodeId | string | | The identifier of a node |
|
| nodeId | string | | The identifier of a node |
|
||||||
|
@@ -35,12 +35,6 @@ in the Alfresco JS API for more information about the types returned by Tag
|
|||||||
service methods and for the implementation of the REST API the service is
|
service methods and for the implementation of the REST API the service is
|
||||||
based on.
|
based on.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Tag list component](tag-list.component.md)
|
- [Tag list component](tag-list.component.md)
|
||||||
<!-- seealso end -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
# Activiti Filter component
|
# Task Filters component
|
||||||
|
|
||||||
Shows all available filters.
|
Shows all available filters.
|
||||||
|
|
||||||
@@ -11,7 +11,7 @@ Shows all available filters.
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| --- | --- | --- |
|
| ---- | ---- | ----------- |
|
||||||
| filterParam | [FilterParamsModel](#filterparamsmodel) | The params to filter the task filter. If there is no match the default one (first filter of the list) is selected |
|
| filterParam | [FilterParamsModel](#filterparamsmodel) | The params to filter the task filter. If there is no match the default one (first filter of the list) is selected |
|
||||||
| appId | string | Display filters available to the current user for the application with the specified ID. |
|
| appId | string | Display filters available to the current user for the application with the specified ID. |
|
||||||
| `appName` | string | Display filters available to the current user for the application with the specified name. |
|
| `appName` | string | Display filters available to the current user for the application with the specified name. |
|
||||||
@@ -22,7 +22,7 @@ If both `appId` and `appName` are specified then `appName` will take precedence
|
|||||||
### Events
|
### Events
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
| --- | --- |
|
| ---- | ----------- |
|
||||||
| filterClick | Raised when the filter in the list is clicked |
|
| filterClick | Raised when the filter in the list is clicked |
|
||||||
| success | Raised when the list is loaded |
|
| success | Raised when the list is loaded |
|
||||||
| error | Raised if there is an error during the loading |
|
| error | Raised if there is an error during the loading |
|
||||||
@@ -35,7 +35,6 @@ If both `appId` and `appName` are specified then `appName` will take precedence
|
|||||||
<adf-filters
|
<adf-filters
|
||||||
[filterParam]="{name:'My tasks'}">
|
[filterParam]="{name:'My tasks'}">
|
||||||
</adf-filters>
|
</adf-filters>
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
You can use inside the filterParam one of the properties from [FilterParamsModel](#filterparamsmodel) (see below).
|
You can use inside the filterParam one of the properties from [FilterParamsModel](#filterparamsmodel) (see below).
|
||||||
@@ -51,7 +50,7 @@ You can use inside the filterParam one of the properties from [FilterParamsModel
|
|||||||
```
|
```
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| --- | --- | --- |
|
| ---- | ---- | ----------- |
|
||||||
| id | string | The id of the task filter |
|
| id | string | The id of the task filter |
|
||||||
| name | string | The name of the task filter, lowercase is checked |
|
| name | string | The name of the task filter, lowercase is checked |
|
||||||
| index | string | The zero-based position of the filter in the array. |
|
| index | string | The zero-based position of the filter in the array. |
|
||||||
@@ -61,9 +60,6 @@ You can use inside the filterParam one of the properties from [FilterParamsModel
|
|||||||
The task filter often works well as an item in an accordion menu. See the [Accordion component](accordion.component.md)
|
The task filter often works well as an item in an accordion menu. See the [Accordion component](accordion.component.md)
|
||||||
page for an example of how to do set this up.
|
page for an example of how to do set this up.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Filter model](filter.model.md)
|
- [Filter model](filter.model.md)
|
||||||
<!-- seealso end -->
|
|
@@ -1,4 +1,4 @@
|
|||||||
# Activiti Task Header component
|
# Task Header component
|
||||||
|
|
||||||
Shows all the information related to a task.
|
Shows all the information related to a task.
|
||||||
|
|
||||||
@@ -15,14 +15,14 @@ Shows all the information related to a task.
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| ---- | ---- | ------- | ----------- |
|
||||||
| taskDetails | [TaskDetailsModel](#taskdetailsmodel) | | (**required**) The task details related to the task. |
|
| taskDetails | [TaskDetailsModel](#taskdetailsmodel) | | (**required**) The task details related to the task. |
|
||||||
| formName | string | | The name of the form. |
|
| formName | string | | The name of the form. |
|
||||||
|
|
||||||
### Events
|
### Events
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
| --- | --- |
|
| ---- | ----------- |
|
||||||
| claim | Raised when the task is claimed. |
|
| claim | Raised when the task is claimed. |
|
||||||
| unclaim | Raised when the task is unclaimed (requeued). |
|
| unclaim | Raised when the task is unclaimed (requeued). |
|
||||||
|
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
# Activiti Task List component
|
# Task List component
|
||||||
|
|
||||||
Renders a list containing all the tasks matched by the parameters specified.
|
Renders a list containing all the tasks matched by the parameters specified.
|
||||||
|
|
||||||
@@ -11,6 +11,7 @@ Renders a list containing all the tasks matched by the parameters specified.
|
|||||||
[assignment]="'assignee'">
|
[assignment]="'assignee'">
|
||||||
</adf-tasklist>
|
</adf-tasklist>
|
||||||
```
|
```
|
||||||
|
|
||||||
You can pass schema as data adapter for the tasklist like shown below :
|
You can pass schema as data adapter for the tasklist like shown below :
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -79,12 +80,14 @@ define static custom schema in the app.config.json as shown below json format.
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<adf-tasklist
|
<adf-tasklist
|
||||||
[appId]="'1'"
|
[appId]="'1'"
|
||||||
[presetColumn]="'customSchema'">
|
[presetColumn]="'customSchema'">
|
||||||
</adf-tasklist>
|
</adf-tasklist>
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also use both HTML-based and app.config.json custom schema declaration at same time like shown below:
|
You can also use both HTML-based and app.config.json custom schema declaration at same time like shown below:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@@ -107,6 +110,7 @@ You can also use both HTML-based and app.config.json custom schema declaration a
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<adf-tasklist
|
<adf-tasklist
|
||||||
[appId]="'1'"
|
[appId]="'1'"
|
||||||
@@ -124,7 +128,7 @@ You can also use both HTML-based and app.config.json custom schema declaration a
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| ---- | ---- | ------- | ----------- |
|
||||||
| appId | string | | The id of the app. |
|
| appId | string | | The id of the app. |
|
||||||
| processDefinitionKey | string | | The processDefinitionKey of the process. |
|
| processDefinitionKey | string | | The processDefinitionKey of the process. |
|
||||||
| processInstanceId | string | | The processInstanceId of the process. |
|
| processInstanceId | string | | The processInstanceId of the process. |
|
||||||
@@ -143,7 +147,7 @@ You can also use both HTML-based and app.config.json custom schema declaration a
|
|||||||
### Events
|
### Events
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
| --- | --- |
|
| ---- | ----------- |
|
||||||
| success | Raised when the task list is loaded |
|
| success | Raised when the task list is loaded |
|
||||||
| rowClick | Raised when the task in the list is clicked |
|
| rowClick | Raised when the task in the list is clicked |
|
||||||
| rowsSelected | Raised when the a row is selected/unselected |
|
| rowsSelected | Raised when the a row is selected/unselected |
|
||||||
@@ -172,10 +176,7 @@ typical tasklist.
|
|||||||
|
|
||||||
You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [DataColumn](data-column.component.md) page for more information about these features.
|
You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [DataColumn](data-column.component.md) page for more information about these features.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Data column component](data-column.component.md)
|
- [Data column component](data-column.component.md)
|
||||||
- [DataTableAdapter](DataTableAdapter.md)
|
- [DataTableAdapter](DataTableAdapter.md)
|
||||||
<!-- seealso end -->
|
|
||||||
|
@@ -17,6 +17,7 @@ export class SomePageComponent implements OnInit {
|
|||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
#### getTaskDetails(taskId: string): Observable`<TaskDetailsModel>`
|
#### getTaskDetails(taskId: string): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Get Task Instance metadata for passed in Task Instance ID:
|
Get Task Instance metadata for passed in Task Instance ID:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -31,7 +32,6 @@ this.tasklistService.getTaskDetails(taskInstanceId).subscribe( (taskInstance: Ta
|
|||||||
The `taskInstanceId` refers to a Task Instance identifier in APS.
|
The `taskInstanceId` refers to a Task Instance identifier in APS.
|
||||||
The returned `taskInstance` object is of type `TaskDetailsModel` and looks like in this sample:
|
The returned `taskInstance` object is of type `TaskDetailsModel` and looks like in this sample:
|
||||||
|
|
||||||
```
|
|
||||||
adhocTaskCanBeReassigned: false
|
adhocTaskCanBeReassigned: false
|
||||||
assignee: UserProcessModel {pictureId: null, id: 1, email: "admin@app.activiti.com", firstName: null, lastName: "Administrator"}
|
assignee: UserProcessModel {pictureId: null, id: 1, email: "admin@app.activiti.com", firstName: null, lastName: "Administrator"}
|
||||||
category: null
|
category: null
|
||||||
@@ -63,9 +63,9 @@ processInstanceId: "11337"
|
|||||||
processInstanceName: null
|
processInstanceName: null
|
||||||
processInstanceStartUserId: "1"
|
processInstanceStartUserId: "1"
|
||||||
taskDefinitionKey: "clarifyInvoice"
|
taskDefinitionKey: "clarifyInvoice"
|
||||||
```
|
|
||||||
|
|
||||||
#### getTaskChecklist(id: string): Observable`<TaskDetailsModel[]>`
|
#### getTaskChecklist(id: string): Observable`<TaskDetailsModel[]>`
|
||||||
|
|
||||||
Get all the sub-task instances for a Task Instance, also called the check list:
|
Get all the sub-task instances for a Task Instance, also called the check list:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -79,7 +79,6 @@ this.tasklistService.getTaskChecklist(parentTaskId).subscribe( (subTasks: TaskDe
|
|||||||
|
|
||||||
The response is an array of `TaskDetailsModel` representing the sub-tasks:
|
The response is an array of `TaskDetailsModel` representing the sub-tasks:
|
||||||
|
|
||||||
```
|
|
||||||
Sub Tasks:
|
Sub Tasks:
|
||||||
0:
|
0:
|
||||||
adhocTaskCanBeReassigned: false
|
adhocTaskCanBeReassigned: false
|
||||||
@@ -115,12 +114,12 @@ Sub Tasks:
|
|||||||
taskDefinitionKey: null
|
taskDefinitionKey: null
|
||||||
1 :
|
1 :
|
||||||
{processDefinitionVersion: 0, id: "74746", name: "Verify with the person that did the purchase", priority: 50, assignee: UserProcessModel, …}
|
{processDefinitionVersion: 0, id: "74746", name: "Verify with the person that did the purchase", priority: 50, assignee: UserProcessModel, …}
|
||||||
```
|
|
||||||
|
|
||||||
Looking at the `TaskDetailsModel` for a sub-task we can see that it has a parent task ID that matches what we specified
|
Looking at the `TaskDetailsModel` for a sub-task we can see that it has a parent task ID that matches what we specified
|
||||||
when calling this method.
|
when calling this method.
|
||||||
|
|
||||||
#### getTasks(requestNode: TaskQueryRequestRepresentationModel): Observable`<TaskListModel>`
|
#### getTasks(requestNode: TaskQueryRequestRepresentationModel): Observable`<TaskListModel>`
|
||||||
|
|
||||||
Get tasks matching passed in query definition:
|
Get tasks matching passed in query definition:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -161,7 +160,6 @@ pooled tasks (i.e. tasks that needs to be claimed by a user), then use `candidat
|
|||||||
A `TaskListModel` object is returned for a successful query and the `data` property is an array of
|
A `TaskListModel` object is returned for a successful query and the `data` property is an array of
|
||||||
`TaskDetailsModel`:
|
`TaskDetailsModel`:
|
||||||
|
|
||||||
```
|
|
||||||
data:
|
data:
|
||||||
0: {id: "75010", name: "Approve Invoice - Invoice-10202.pdf", description: null, category: null, assignee: {…}, …}
|
0: {id: "75010", name: "Approve Invoice - Invoice-10202.pdf", description: null, category: null, assignee: {…}, …}
|
||||||
1: {id: "74746", name: "Verify with the person that did the purchase", description: null, category: "2", assignee: {…}, …}
|
1: {id: "74746", name: "Verify with the person that did the purchase", description: null, category: "2", assignee: {…}, …}
|
||||||
@@ -172,11 +170,11 @@ length: 5
|
|||||||
size: 5
|
size: 5
|
||||||
start: 0
|
start: 0
|
||||||
total: 10
|
total: 10
|
||||||
```
|
|
||||||
|
|
||||||
We can see that this query resulted in 10 tasks (see `total`), but only 5 were returned as we set `size` to `5`.
|
We can see that this query resulted in 10 tasks (see `total`), but only 5 were returned as we set `size` to `5`.
|
||||||
|
|
||||||
#### getTotalTasks(requestNode: TaskQueryRequestRepresentationModel): Observable`<any>`
|
#### getTotalTasks(requestNode: TaskQueryRequestRepresentationModel): Observable`<any>`
|
||||||
|
|
||||||
Get total number of tasks matching passed in query definition:
|
Get total number of tasks matching passed in query definition:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -202,16 +200,15 @@ this.tasklistService.getTotalTasks(taskQuery).subscribe( (response: any) => {
|
|||||||
This is pretty much the same type of query as the `getTasks` method, except that here we just
|
This is pretty much the same type of query as the `getTasks` method, except that here we just
|
||||||
return how many Task Instances it matched in the `total` property:
|
return how many Task Instances it matched in the `total` property:
|
||||||
|
|
||||||
```
|
|
||||||
data:[]
|
data:[]
|
||||||
size: 0
|
size: 0
|
||||||
start: 0
|
start: 0
|
||||||
total: 10
|
total: 10
|
||||||
```
|
|
||||||
|
|
||||||
When you call this method it always sets the `size` property to `0`.
|
When you call this method it always sets the `size` property to `0`.
|
||||||
|
|
||||||
#### findTasksByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable`<TaskListModel>`
|
#### findTasksByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable`<TaskListModel>`
|
||||||
|
|
||||||
Find and return Task Instances by state `open` or `completed` and query model:
|
Find and return Task Instances by state `open` or `completed` and query model:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -235,6 +232,7 @@ this.tasklistService.findTasksByState(taskQuery, taskState).subscribe( (taskList
|
|||||||
console.log('Error: ', error);
|
console.log('Error: ', error);
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
The number of tasks that are returned is controlled by the `size` property.
|
The number of tasks that are returned is controlled by the `size` property.
|
||||||
|
|
||||||
This is a convenience method on top of the `getTasks` method. It overwrites the `requestNode.state` property
|
This is a convenience method on top of the `getTasks` method. It overwrites the `requestNode.state` property
|
||||||
@@ -242,6 +240,7 @@ with passed in `state` before making the call to `getTasks`.
|
|||||||
For an example of the response see the `getTasks` method.
|
For an example of the response see the `getTasks` method.
|
||||||
|
|
||||||
#### findAllTaskByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable`<TaskListModel>`
|
#### findAllTaskByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable`<TaskListModel>`
|
||||||
|
|
||||||
Find and return all Task Instances by state `open` or `completed` and query model:
|
Find and return all Task Instances by state `open` or `completed` and query model:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -274,6 +273,7 @@ passed in `state` before making any other calls. Before making the `getTasks` ca
|
|||||||
**Note** that this can return a lot of data if you are not careful.
|
**Note** that this can return a lot of data if you are not careful.
|
||||||
|
|
||||||
#### findAllTasksWithoutState(requestNode: TaskQueryRequestRepresentationModel): Observable`<TaskListModel>`
|
#### findAllTasksWithoutState(requestNode: TaskQueryRequestRepresentationModel): Observable`<TaskListModel>`
|
||||||
|
|
||||||
Find and return all Task Instances that matches query model, regardless of state:
|
Find and return all Task Instances that matches query model, regardless of state:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -305,6 +305,7 @@ Internally it basically calls `findTasksByState(requestNode, 'open')` and
|
|||||||
**Note** that this can return a lot of data if you are not careful.
|
**Note** that this can return a lot of data if you are not careful.
|
||||||
|
|
||||||
#### assignTaskByUserId(taskId: string, userId: number): Observable`<TaskDetailsModel>`
|
#### assignTaskByUserId(taskId: string, userId: number): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Assign a Task Instance to a user via the User ID:
|
Assign a Task Instance to a user via the User ID:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -320,6 +321,7 @@ this.tasklistService.assignTaskByUserId(taskId, userId).subscribe( (taskInstance
|
|||||||
The user ID identifies a User in APS.
|
The user ID identifies a User in APS.
|
||||||
|
|
||||||
#### assignTask(taskId: string, requestNode: any): Observable`<TaskDetailsModel>`
|
#### assignTask(taskId: string, requestNode: any): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Assign a task to a user via a user object with an `id` property, for example:
|
Assign a task to a user via a user object with an `id` property, for example:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -336,6 +338,7 @@ This method does the same as the `assignTaskByUserId` method, the only differenc
|
|||||||
method can be used when you have an object where the User ID is contained in an `id` property.
|
method can be used when you have an object where the User ID is contained in an `id` property.
|
||||||
|
|
||||||
#### claimTask(taskId: string): Observable`<TaskDetailsModel>`
|
#### claimTask(taskId: string): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Claim a pooled task (i.e. candidate task) as current user so it can be worked on and later on completed:
|
Claim a pooled task (i.e. candidate task) as current user so it can be worked on and later on completed:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -352,6 +355,7 @@ The response will be `null` if the task was claimed successfully.
|
|||||||
The task assignment changes from `candidate` to `assignee`.
|
The task assignment changes from `candidate` to `assignee`.
|
||||||
|
|
||||||
#### unclaimTask(taskId: string): Observable`<TaskDetailsModel>`
|
#### unclaimTask(taskId: string): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Return a claimed task to the pool (i.e. make it a candidate task):
|
Return a claimed task to the pool (i.e. make it a candidate task):
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -366,6 +370,7 @@ this.tasklistService.unclaimTask(taskId).subscribe( (taskInstance: TaskDetailsMo
|
|||||||
The task assignment changes from `assignee` to `candidate`.
|
The task assignment changes from `assignee` to `candidate`.
|
||||||
|
|
||||||
#### completeTask(taskId: string)
|
#### completeTask(taskId: string)
|
||||||
|
|
||||||
Complete a Task Instance as current user and progress Process Instance:
|
Complete a Task Instance as current user and progress Process Instance:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -377,9 +382,10 @@ This only works if the Task Instance has only one Outcome (i.e. the default `Com
|
|||||||
If the Task Instance has multiple Outcomes, such as Approve and Reject, then this method does not
|
If the Task Instance has multiple Outcomes, such as Approve and Reject, then this method does not
|
||||||
work, and the Task Instance has to be completed via its associated form. Otherwise you will see an error such as:
|
work, and the Task Instance has to be completed via its associated form. Otherwise you will see an error such as:
|
||||||
|
|
||||||
*ERROR Error: Uncaught (in promise): Error: {"message":"Task must be completed using it's form","messageKey":"GENERAL.ERROR.BAD-REQUEST"}*
|
_ERROR Error: Uncaught (in promise): Error: {"message":"Task must be completed using it's form","messageKey":"GENERAL.ERROR.BAD-REQUEST"}_
|
||||||
|
|
||||||
#### updateTask(taskId: any, updated): Observable`<TaskDetailsModel>`
|
#### updateTask(taskId: any, updated): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Update name, description, and due date for a Task Instance:
|
Update name, description, and due date for a Task Instance:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -395,10 +401,10 @@ this.tasklistService.updateTask(taskId, updateData).subscribe( (updatedTaskDetai
|
|||||||
console.log('Error: ', error);
|
console.log('Error: ', error);
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
The response is all info about the updated Task Instance, in this example a stand-alone task was updated so there
|
The response is all info about the updated Task Instance, in this example a stand-alone task was updated so there
|
||||||
is no associated process:
|
is no associated process:
|
||||||
|
|
||||||
```
|
|
||||||
adhocTaskCanBeReassigned: false
|
adhocTaskCanBeReassigned: false
|
||||||
assignee: undefined
|
assignee: undefined
|
||||||
category: null
|
category: null
|
||||||
@@ -429,9 +435,9 @@ processInstanceId: null
|
|||||||
processInstanceName: null
|
processInstanceName: null
|
||||||
processInstanceStartUserId: null
|
processInstanceStartUserId: null
|
||||||
taskDefinitionKey: null
|
taskDefinitionKey: null
|
||||||
```
|
|
||||||
|
|
||||||
#### createNewTask(task: TaskDetailsModel): Observable`<TaskDetailsModel>`
|
#### createNewTask(task: TaskDetailsModel): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Create a new stand-alone Task Instance that is not associated with a Process Instance:
|
Create a new stand-alone Task Instance that is not associated with a Process Instance:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -452,7 +458,6 @@ and that is not assigned to a user (i.e. `assignee: null`).
|
|||||||
|
|
||||||
The response looks like this, we can see that an ID was generated for the Task Instance:
|
The response looks like this, we can see that an ID was generated for the Task Instance:
|
||||||
|
|
||||||
```
|
|
||||||
Created task details:
|
Created task details:
|
||||||
adhocTaskCanBeReassigned: false
|
adhocTaskCanBeReassigned: false
|
||||||
assignee: null
|
assignee: null
|
||||||
@@ -485,12 +490,12 @@ Created task details:
|
|||||||
processInstanceName: null
|
processInstanceName: null
|
||||||
processInstanceStartUserId: null
|
processInstanceStartUserId: null
|
||||||
taskDefinitionKey: null
|
taskDefinitionKey: null
|
||||||
```
|
|
||||||
|
|
||||||
See the `attachFormToATask` method for how to attach a form to the User Task. And see the `assignTaskByUserId` method
|
See the `attachFormToATask` method for how to attach a form to the User Task. And see the `assignTaskByUserId` method
|
||||||
for how to assign a user to the new Task Instance.
|
for how to assign a user to the new Task Instance.
|
||||||
|
|
||||||
#### attachFormToATask(taskId: string, formId: number): Observable`<any>`
|
#### attachFormToATask(taskId: string, formId: number): Observable`<any>`
|
||||||
|
|
||||||
Attach a form to a User Task:
|
Attach a form to a User Task:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -510,6 +515,7 @@ in APS when you work with it). See the `getFormList` method for how fetch a list
|
|||||||
The response will be `null` if form was attached successfully to task.
|
The response will be `null` if form was attached successfully to task.
|
||||||
|
|
||||||
#### getFormList(): Observable`<Form []>`
|
#### getFormList(): Observable`<Form []>`
|
||||||
|
|
||||||
Get a list of the available reusable forms:
|
Get a list of the available reusable forms:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -522,7 +528,6 @@ this.tasklistService.getFormList().subscribe( (formList: Form[]) => {
|
|||||||
|
|
||||||
A successful response looks like this:
|
A successful response looks like this:
|
||||||
|
|
||||||
```
|
|
||||||
Available forms:
|
Available forms:
|
||||||
|
|
||||||
0:
|
0:
|
||||||
@@ -531,7 +536,6 @@ Available forms:
|
|||||||
1: {name: "cm:folder", id: 3012}
|
1: {name: "cm:folder", id: 3012}
|
||||||
2: {name: "Alfresco Node Form", id: 3011}
|
2: {name: "Alfresco Node Form", id: 3011}
|
||||||
3: {name: "Employee", id: 3010}
|
3: {name: "Employee", id: 3010}
|
||||||
```
|
|
||||||
|
|
||||||
The form id property can be used with the `attachFormToATask` method.
|
The form id property can be used with the `attachFormToATask` method.
|
||||||
|
|
||||||
@@ -539,6 +543,7 @@ The form id property can be used with the `attachFormToATask` method.
|
|||||||
Only reusable forms are included.
|
Only reusable forms are included.
|
||||||
|
|
||||||
#### addTask(task: TaskDetailsModel): Observable`<TaskDetailsModel>`
|
#### addTask(task: TaskDetailsModel): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Add a Sub-Task (i.e. checklist task) to a parent Task Instance:
|
Add a Sub-Task (i.e. checklist task) to a parent Task Instance:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -557,7 +562,6 @@ this.tasklistService.addTask(subTaskDetails).subscribe( (updatedTaskDetails: Tas
|
|||||||
The response includes the new sub-task id and also parent task name.
|
The response includes the new sub-task id and also parent task name.
|
||||||
In this example the parent task was just a stand-alone task, so no process information is included:
|
In this example the parent task was just a stand-alone task, so no process information is included:
|
||||||
|
|
||||||
```
|
|
||||||
adhocTaskCanBeReassigned: false
|
adhocTaskCanBeReassigned: false
|
||||||
assignee: null
|
assignee: null
|
||||||
category: null
|
category: null
|
||||||
@@ -589,9 +593,9 @@ processInstanceId: null
|
|||||||
processInstanceName: null
|
processInstanceName: null
|
||||||
processInstanceStartUserId:null
|
processInstanceStartUserId:null
|
||||||
taskDefinitionKey: null
|
taskDefinitionKey: null
|
||||||
```
|
|
||||||
|
|
||||||
#### deleteTask(taskId: string): Observable`<TaskDetailsModel>`
|
#### deleteTask(taskId: string): Observable`<TaskDetailsModel>`
|
||||||
|
|
||||||
Delete a Sub-Task (i.e. checklist task):
|
Delete a Sub-Task (i.e. checklist task):
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -606,6 +610,7 @@ this.tasklistService.deleteTask(taskId).subscribe( (taskDetails: TaskDetailsMode
|
|||||||
**Note**. you can only delete so called checklist tasks with this method.
|
**Note**. you can only delete so called checklist tasks with this method.
|
||||||
|
|
||||||
#### fetchTaskAuditJsonById(taskId: string): Observable`<any>`
|
#### fetchTaskAuditJsonById(taskId: string): Observable`<any>`
|
||||||
|
|
||||||
Fetch Task Audit log as JSON for a Task Instance ID:
|
Fetch Task Audit log as JSON for a Task Instance ID:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -620,7 +625,6 @@ this.tasklistService.fetchTaskAuditJsonById(taskId)
|
|||||||
|
|
||||||
The response is JSON object with the Task Instance audit log:
|
The response is JSON object with the Task Instance audit log:
|
||||||
|
|
||||||
```
|
|
||||||
{
|
{
|
||||||
taskId: "15368",
|
taskId: "15368",
|
||||||
taskName: "Approve by someone in Accounting",
|
taskName: "Approve by someone in Accounting",
|
||||||
@@ -629,9 +633,9 @@ The response is JSON object with the Task Instance audit log:
|
|||||||
processDefinitionVersion: 1,
|
processDefinitionVersion: 1,
|
||||||
…
|
…
|
||||||
}
|
}
|
||||||
```
|
|
||||||
|
|
||||||
#### fetchTaskAuditPdfById(taskId: string): Observable`<Blob>`
|
#### fetchTaskAuditPdfById(taskId: string): Observable`<Blob>`
|
||||||
|
|
||||||
Fetch Task Audit log as JSON for a Task Instance ID:
|
Fetch Task Audit log as JSON for a Task Instance ID:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
@@ -644,8 +648,3 @@ this.tasklistService.fetchTaskAuditPdfById(taskId)
|
|||||||
```
|
```
|
||||||
|
|
||||||
The response is PDF with the Task Instance audit log.
|
The response is PDF with the Task Instance audit log.
|
||||||
|
|
||||||
|
|
||||||
<!-- seealso start -->
|
|
||||||
|
|
||||||
<!-- seealso end -->
|
|
@@ -17,10 +17,7 @@ be highlighted with added HTML (see the
|
|||||||
[Highlight Transform service](highlight-transform.service.md) for more information about how
|
[Highlight Transform service](highlight-transform.service.md) for more information about how
|
||||||
this is implemented). The parameter can contain spaces, in which case each separate "word" in the string will be highlighted individually.
|
this is implemented). The parameter can contain spaces, in which case each separate "word" in the string will be highlighted individually.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Highlight directive](highlight.directive.md)
|
- [Highlight directive](highlight.directive.md)
|
||||||
- [Highlight transform service](highlight-transform.service.md)
|
- [Highlight transform service](highlight-transform.service.md)
|
||||||
<!-- seealso end -->
|
|
@@ -11,7 +11,7 @@ Implements text field input masks.
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| ---- | ---- | ------- | ----------- |
|
||||||
| textMask | any | | Object defining mask and "reversed" status. |
|
| textMask | any | | Object defining mask and "reversed" status. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
@@ -60,8 +60,3 @@ However, with reversed (right-to-left) ordering, the textbox would show
|
|||||||
`2.3`
|
`2.3`
|
||||||
|
|
||||||
...and these digits would slide leftward as the user typed more.
|
...and these digits would slide leftward as the user typed more.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
|
|
||||||
<!-- seealso end -->
|
|
@@ -20,7 +20,7 @@ a document node or a MIME type. The default mapping between types
|
|||||||
and icons is shown in the table below:
|
and icons is shown in the table below:
|
||||||
|
|
||||||
| Document | Icon | Types |
|
| Document | Icon | Types |
|
||||||
| --- | --- | --- |
|
| -------- | ---- | ----- |
|
||||||
| Compressed archive |  | 'application/x-compressed', 'application/x-zip-compressed', 'application/zip' |
|
| Compressed archive |  | 'application/x-compressed', 'application/x-zip-compressed', 'application/zip' |
|
||||||
| Text |  | 'text/plain', 'application/json', 'application/x-javascript', 'application/vnd.apple.pages' |
|
| Text |  | 'text/plain', 'application/json', 'application/x-javascript', 'application/vnd.apple.pages' |
|
||||||
| Bitmap/raster image |  | 'image/png', 'image/jpeg', 'image/gif' |
|
| Bitmap/raster image |  | 'image/png', 'image/jpeg', 'image/gif' |
|
||||||
@@ -54,14 +54,6 @@ GIF <mat-icon svgIcon="image/gif"></mat-icon>
|
|||||||
.....
|
.....
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Mime type icon pipe](mime-type-icon.pipe.md)
|
- [Mime type icon pipe](mime-type-icon.pipe.md)
|
||||||
<!-- seealso end -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@@ -15,8 +15,3 @@ Converts a recent past date into a number of days ago.
|
|||||||
The pipe finds the difference between the input date and the current date. If it
|
The pipe finds the difference between the input date and the current date. If it
|
||||||
is less than seven days then then the date will be formatted as "X days ago".
|
is less than seven days then then the date will be formatted as "X days ago".
|
||||||
Otherwise, the usual full date format is used.
|
Otherwise, the usual full date format is used.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
|
|
||||||
<!-- seealso end -->
|
|
@@ -12,3 +12,8 @@ Divides groups of elements in a Toolbar with a visual separator.
|
|||||||
<button></button>
|
<button></button>
|
||||||
</adf-toolbar>
|
</adf-toolbar>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
- [Toolbar component](toolbar.component.md)
|
||||||
|
- [Toolbar Title component](toolbar-title.component.md)
|
||||||
|
@@ -18,3 +18,8 @@ Supplies custom HTML to be included in a Toolbar component title.
|
|||||||
## Details
|
## Details
|
||||||
|
|
||||||
You can use this component to include any HTML or Angular components in the Toolbar title section.
|
You can use this component to include any HTML or Angular components in the Toolbar title section.
|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
- [Toolbar component](toolbar.component.md)
|
||||||
|
- [Toolbar divider component](toolbar-divider.component.md)
|
||||||
|
@@ -105,3 +105,8 @@ For example:
|
|||||||

|

|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [Toolbar Divider component](toolbar-divider.component.md)
|
||||||
|
- [Toolbar Title component](toolbar-title.component.md)
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
# Alfresco User Info component
|
# User Info component
|
||||||
|
|
||||||
Shows user information.
|
Shows user information.
|
||||||
|
|
||||||
@@ -11,7 +11,7 @@ Shows user information.
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| ---- | ---- | ------- | ----------- |
|
||||||
| ecmBackgroundImage | string | (alfresco image) | Custom path for the background banner image for ECM users |
|
| ecmBackgroundImage | string | (alfresco image) | Custom path for the background banner image for ECM users |
|
||||||
| bpmBackgroundImage | string | (alfresco image) | Custom path for the background banner image for BPM users |
|
| bpmBackgroundImage | string | (alfresco image) | Custom path for the background banner image for BPM users |
|
||||||
| menuPositionX | string | | Custom choice for opening the menu bottom : `before` or `after` |
|
| menuPositionX | string | | Custom choice for opening the menu bottom : `before` or `after` |
|
||||||
|
@@ -13,14 +13,9 @@ Takes the name fields of a UserProcessModel object and extracts and formats the
|
|||||||
## Details
|
## Details
|
||||||
|
|
||||||
The pipe gets the initial characters of the user's first and last names and
|
The pipe gets the initial characters of the user's first and last names and
|
||||||
concatenates them. The results are returned in an HTML <div> element.
|
concatenates them. The results are returned in an HTML <div> element.
|
||||||
|
|
||||||
The first pipe parameter specifies an optional CSS class to add to the <div>
|
The first pipe parameter specifies an optional CSS class to add to the <div>
|
||||||
element (eg, a background color is commonly used to emphasise initials). The
|
element (eg, a background color is commonly used to emphasise initials). The
|
||||||
second parameter is an optional delimiter to add between the initials.
|
second parameter is an optional delimiter to add between the initials.
|
||||||
Both parameters default to empty strings.
|
Both parameters default to empty strings.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
|
|
||||||
<!-- seealso end -->
|
|
@@ -13,9 +13,6 @@ it is likely to change and so its properties are not listed here. For the
|
|||||||
latest version of the class, see the
|
latest version of the class, see the
|
||||||
[source file](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/models/user-process.model.ts).
|
[source file](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/models/user-process.model.ts).
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [People process service](people-process.service.md)
|
- [People process service](people-process.service.md)
|
||||||
<!-- seealso end -->
|
|
@@ -11,7 +11,7 @@ Displays the version history of a node in a [Version Manager component](version-
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| --- | --- | --- |
|
| ---- | ---- | ----------- |
|
||||||
| id | string | The node id you want to see the version history of. |
|
| id | string | The node id you want to see the version history of. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
@@ -19,9 +19,6 @@ Displays the version history of a node in a [Version Manager component](version-
|
|||||||
Inside the version manager component, there is the underlying VersionListComponent.
|
Inside the version manager component, there is the underlying VersionListComponent.
|
||||||
The VersionListComponent loads and displays the version history of a node.
|
The VersionListComponent loads and displays the version history of a node.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Version manager component](version-manager.component.md)
|
- [Version manager component](version-manager.component.md)
|
||||||
<!-- seealso end -->
|
|
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Displays the version history of a node with the ability to upload a new version.
|
Displays the version history of a node with the ability to upload a new version.
|
||||||
|
|
||||||
 `This component is still in experimental phase, it has several limitations which will be resolved soon.`
|
 `This component is still in experimental phase, it has several limitations which will be resolved soon.`
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -15,7 +15,7 @@ Displays the version history of a node with the ability to upload a new version.
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
| --- | --- | --- |
|
| ---- | ---- | ----------- |
|
||||||
| node | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | The node you want to manage the version history of. |
|
| node | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | The node you want to manage the version history of. |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
@@ -25,13 +25,10 @@ Displays the version history of a node with the ability to upload a new version.
|
|||||||
Each version has a context menu on the right, with the following actions.
|
Each version has a context menu on the right, with the following actions.
|
||||||
|
|
||||||
| Action | Versions | Description |
|
| Action | Versions | Description |
|
||||||
| --- | --- | --- |
|
| ------ | -------- | ----------- |
|
||||||
| Restore | All | Revert the current version to the selected one with creating a new version of it. |
|
| Restore | All | Revert the current version to the selected one with creating a new version of it. |
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Version list component](version-list.component.md)
|
- [Version list component](version-list.component.md)
|
||||||
- [Document list component](document-list.component.md)
|
- [Document list component](document-list.component.md)
|
||||||
<!-- seealso end -->
|
|
@@ -1,4 +1,4 @@
|
|||||||
# Alfresco Viewer component
|
# Viewer component
|
||||||
|
|
||||||
Displays content from an ACS repository.
|
Displays content from an ACS repository.
|
||||||
|
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
# Alfresco Webscript Get component
|
# Webscript component
|
||||||
|
|
||||||
Provides access to Webscript features.
|
Provides access to Webscript features.
|
||||||
|
|
||||||
|
@@ -20,7 +20,7 @@ export class CustomEditorComponent extends WidgetComponent {}
|
|||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| ---- | ---- | ------- | ----------- |
|
||||||
| readOnly | boolean | false | Does the widget show a read-only value? (ie, can't be edited) |
|
| readOnly | boolean | false | Does the widget show a read-only value? (ie, can't be edited) |
|
||||||
| field | [FormFieldModel](form-field.model.md) | | Data to be displayed in the field |
|
| field | [FormFieldModel](form-field.model.md) | | Data to be displayed in the field |
|
||||||
|
|
||||||
@@ -30,9 +30,6 @@ The Widget component is the base class for all standard and custom form widgets.
|
|||||||
[Form Extensibility and Customisation](extensibility.md) page for full details about
|
[Form Extensibility and Customisation](extensibility.md) page for full details about
|
||||||
implementing custom widgets.
|
implementing custom widgets.
|
||||||
|
|
||||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
|
||||||
<!-- seealso start -->
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [Extensibility](extensibility.md)
|
- [Extensibility](extensibility.md)
|
||||||
<!-- seealso end -->
|
|
Reference in New Issue
Block a user