From f5ef324dd21d6ba64cb728d503b0fa6061ab2e75 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Wed, 17 Jan 2018 17:11:48 +0000 Subject: [PATCH] [ADF-2152] Updated See Also sections in docs (#2846) --- docs/search-api.service.md | 5 - docs/shared-links-api.service.md | 7 +- docs/site.model.md | 5 +- docs/sites-api.service.md | 8 +- docs/start-form.component.md | 9 +- docs/storage.service.md | 7 +- docs/tag-actions.component.md | 8 +- docs/tag-list.component.md | 8 +- docs/tag-node-list.component.md | 8 +- docs/tag.service.md | 8 +- docs/task-filters.component.md | 24 +- docs/task-header.component.md | 10 +- docs/task-list.component.md | 41 +-- docs/tasklist.service.md | 435 +++++++++++++++--------------- docs/text-highlight.pipe.md | 7 +- docs/text-mask.component.md | 17 +- docs/thumbnail.service.md | 16 +- docs/time-ago.pipe.md | 5 - docs/toolbar-divider.component.md | 7 +- docs/toolbar-title.component.md | 5 + docs/toolbar.component.md | 5 + docs/user-info.component.md | 12 +- docs/user-initial.pipe.md | 9 +- docs/user-process.model.md | 5 +- docs/version-list.component.md | 7 +- docs/version-manager.component.md | 17 +- docs/viewer.component.md | 4 +- docs/webscript.component.md | 2 +- docs/widget.component.md | 7 +- 29 files changed, 328 insertions(+), 380 deletions(-) diff --git a/docs/search-api.service.md b/docs/search-api.service.md index 784c8c3d25..81d4859868 100644 --- a/docs/search-api.service.md +++ b/docs/search-api.service.md @@ -12,8 +12,3 @@ Searches the repository. See the [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. - - - - - \ No newline at end of file diff --git a/docs/shared-links-api.service.md b/docs/shared-links-api.service.md index 59fac0115a..e0f980b79e 100644 --- a/docs/shared-links-api.service.md +++ b/docs/shared-links-api.service.md @@ -11,15 +11,10 @@ Gets shared links available to the current user. 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 -URLs are known as *shared links*. +URLs are known as _shared links_. 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 search; see the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SharedlinksApi.md#findsharedlinks) for more information. - - - - - \ No newline at end of file diff --git a/docs/site.model.md b/docs/site.model.md index 48b78e2163..c85c5af6ba 100644 --- a/docs/site.model.md +++ b/docs/site.model.md @@ -40,9 +40,6 @@ class SiteMembersModel { } ``` - - ## See also -- [Sites api service](sites.service.md) - \ No newline at end of file +- [Sites api service](sites-api.service.md) diff --git a/docs/sites-api.service.md b/docs/sites-api.service.md index 3b45e94842..38b8b8abc4 100644 --- a/docs/sites-api.service.md +++ b/docs/sites-api.service.md @@ -40,12 +40,6 @@ and [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. - - ## See also -- [Site model](site.model.md) - - - - +- [Site model](site.model.md) diff --git a/docs/start-form.component.md b/docs/start-form.component.md index f9a16dcbad..a8d1d18f53 100644 --- a/docs/start-form.component.md +++ b/docs/start-form.component.md @@ -16,7 +16,7 @@ Displays the Start Form for a process. ### Properties | Name | Type | Default | Description | -| --- | --- | --- | --- | +| ---- | ---- | ------- | ----------- | | processDefinitionId | string | | Definition ID of the process to start. | | processId | string | | Process ID of the process to start. | | showOutcomeButtons | boolean | true | Should form outcome buttons be shown? | @@ -26,7 +26,7 @@ Displays the Start Form for a process. ### Events | Name | Description | -| --- | --- | +| ---- | ----------- | | outcomeClick | Emitted when the user clicks one of the outcome buttons that completes the form. | ## 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 [Process service](process.service.md)) when activating the process, if necessary. - - +## See also - \ No newline at end of file +- [Process service](process.service.md) diff --git a/docs/storage.service.md b/docs/storage.service.md index 04c14e13d4..ce3cbe3ed2 100644 --- a/docs/storage.service.md +++ b/docs/storage.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 used instead. - - ## See also -- [Cookie service](cookie.service.md) -- [Content service](content.service.md) - \ No newline at end of file +- [Cookie service](cookie.service.md) +- [Content service](content.service.md) diff --git a/docs/tag-actions.component.md b/docs/tag-actions.component.md index eb247e837b..ad6974f559 100644 --- a/docs/tag-actions.component.md +++ b/docs/tag-actions.component.md @@ -1,4 +1,4 @@ -# Alfresco Tag Node Actions List component +# Tag Node Actions List component Shows available actions for tags. @@ -10,10 +10,10 @@ Shows available actions for tags. -``` +``` ### Properties | Attribute | Type | Default | Description | -| --- | --- | --- | --- | -| nodeId | string | | The identifier of a node | \ No newline at end of file +| --------- | ---- | ------- | ----------- | +| nodeId | string | | The identifier of a node | diff --git a/docs/tag-list.component.md b/docs/tag-list.component.md index 7d005fe86a..5fb700cdc5 100644 --- a/docs/tag-list.component.md +++ b/docs/tag-list.component.md @@ -1,5 +1,9 @@ -# Alfresco Tag List component +# Tag List component Shows tags for an item. -![Custom columns](docassets/images/tag2.png) \ No newline at end of file +![Custom columns](docassets/images/tag2.png) + +## See Also + +- [Tag service](tag.service.md) diff --git a/docs/tag-node-list.component.md b/docs/tag-node-list.component.md index 335c95b93a..30e4dd4dea 100644 --- a/docs/tag-node-list.component.md +++ b/docs/tag-node-list.component.md @@ -1,4 +1,4 @@ -# Alfresco Tag Node List component +# Tag Node List component Shows tags for a node. @@ -10,10 +10,10 @@ Shows tags for a node. -``` +``` ### Properties | Attribute | Type | Default | Description | -| --- | --- | --- | --- | -| nodeId | string | | The identifier of a node | +| --------- | ---- | ------- | ----------- | +| nodeId | string | | The identifier of a node | diff --git a/docs/tag.service.md b/docs/tag.service.md index e669188604..5c4478eda7 100644 --- a/docs/tag.service.md +++ b/docs/tag.service.md @@ -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 based on. - - ## See also -- [Tag list component](tag-list.component.md) - - - - +- [Tag list component](tag-list.component.md) diff --git a/docs/task-filters.component.md b/docs/task-filters.component.md index 6cc6d1b296..a548d59c78 100644 --- a/docs/task-filters.component.md +++ b/docs/task-filters.component.md @@ -1,4 +1,4 @@ -# Activiti Filter component +# Task Filters component Shows all available filters. @@ -11,7 +11,7 @@ Shows all available filters. ### Properties | 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 | | 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. | @@ -22,20 +22,19 @@ If both `appId` and `appName` are specified then `appName` will take precedence ### Events | Name | Description | -| --- | --- | -| filterClick | Raised when the filter in the list is clicked | -| success | Raised when the list is loaded | -| error | Raised if there is an error during the loading | +| ---- | ----------- | +| filterClick | Raised when the filter in the list is clicked | +| success | Raised when the list is loaded | +| error | Raised if there is an error during the loading | ## Details ### How filter the activiti task filters - ```html +```html + [filterParam]="{name:'My tasks'}"> - ``` 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 | -| --- | --- | --- | +| ---- | ---- | ----------- | | id | string | The id of the task filter | | name | string | The name of the task filter, lowercase is checked | | 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) page for an example of how to do set this up. - - ## See also -- [Filter model](filter.model.md) - \ No newline at end of file +- [Filter model](filter.model.md) diff --git a/docs/task-header.component.md b/docs/task-header.component.md index cb0c0c3130..6f01d3279c 100644 --- a/docs/task-header.component.md +++ b/docs/task-header.component.md @@ -1,4 +1,4 @@ -# Activiti Task Header component +# Task Header component Shows all the information related to a task. @@ -15,14 +15,14 @@ Shows all the information related to a task. ### Properties | Name | Type | Default | Description | -| --- | --- | --- | --- | -| taskDetails | [TaskDetailsModel](#taskdetailsmodel) | | (**required**) The task details related to the task. | -| formName | string | | The name of the form. | +| ---- | ---- | ------- | ----------- | +| taskDetails | [TaskDetailsModel](#taskdetailsmodel) | | (**required**) The task details related to the task. | +| formName | string | | The name of the form. | ### Events | Name | Description | -| --- | --- | +| ---- | ----------- | | claim | Raised when the task is claimed. | | unclaim | Raised when the task is unclaimed (requeued). | diff --git a/docs/task-list.component.md b/docs/task-list.component.md index 12bc8a1205..368c2ec4f7 100644 --- a/docs/task-list.component.md +++ b/docs/task-list.component.md @@ -1,4 +1,4 @@ -# Activiti Task List component +# Task List component 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'"> ``` + You can pass schema as data adapter for the tasklist like shown below : ```ts @@ -79,12 +80,14 @@ define static custom schema in the app.config.json as shown below json format. } } ``` + ```html ``` + You can also use both HTML-based and app.config.json custom schema declaration at same time like shown below: ```json @@ -107,6 +110,7 @@ You can also use both HTML-based and app.config.json custom schema declaration a } } ``` + ```html Possible values are:
  • assignee : where the current user is the assignee
  • candidate: where the current user is a task candidate
  • group_x: where the task is assigned to a group where the current user is a member of.
  • no value: where the current user is involved
    • | -| 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. | -| multiselect | boolean | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | -| state | string || Define state of the processes. Possible values are: `completed`, `active` | +| assignment | string | | The assignment of the process. | +| 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. | +| multiselect | boolean | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | +| state | string | | Define state of the processes. Possible values are: `completed`, `active` | | hasIcon | boolean | true | Toggle the icon on the left . | -| landingTaskId | string | | Define which task id should be selected after the reloading. If the task id doesn't exist or nothing is passed it will select the first task | -| sort | string | | Define the sort of the processes. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | -| data | [DataTableAdapter](DataTableAdapter.md) | | JSON object that represent the number and the type of the columns that you want show (see the [example](#datatableadapter-example) section below) | +| landingTaskId | string | | Define which task id should be selected after the reloading. If the task id doesn't exist or nothing is passed it will select the first task | +| sort | string | | Define the sort of the processes. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | +| data | [DataTableAdapter](DataTableAdapter.md) | | JSON object that represent the number and the type of the columns that you want show (see the [example](#datatableadapter-example) section below) | ### Events | Name | Description | -| --- | --- | +| ---- | ----------- | | success | Raised when the task list is loaded | | 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 | ## Details @@ -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. - - ## See also -- [Data column component](data-column.component.md) -- [DataTableAdapter](DataTableAdapter.md) - +- [Data column component](data-column.component.md) +- [DataTableAdapter](DataTableAdapter.md) diff --git a/docs/tasklist.service.md b/docs/tasklist.service.md index b6c79f20d0..1e5f8035ed 100644 --- a/docs/tasklist.service.md +++ b/docs/tasklist.service.md @@ -17,6 +17,7 @@ export class SomePageComponent implements OnInit { ## Methods #### getTaskDetails(taskId: string): Observable`` + Get Task Instance metadata for passed in Task Instance ID: ```ts @@ -31,41 +32,40 @@ this.tasklistService.getTaskDetails(taskInstanceId).subscribe( (taskInstance: Ta The `taskInstanceId` refers to a Task Instance identifier in APS. The returned `taskInstance` object is of type `TaskDetailsModel` and looks like in this sample: -``` -adhocTaskCanBeReassigned: false -assignee: UserProcessModel {pictureId: null, id: 1, email: "admin@app.activiti.com", firstName: null, lastName: "Administrator"} -category: null -created: Wed Oct 11 2017 09:07:14 GMT+0100 (BST) {} -description: null -dueDate: null -duration: null -endDate: null -executionId: "11337" -formKey: "9" -id: "15303" -initiatorCanCompleteTask: false -involvedPeople: [] -managerOfCandidateGroup: false -memberOfCandidateGroup: false -memberOfCandidateUsers: false -name: "Clarify Invoice - Invoice-20302.pdf" -parentTaskId: null -parentTaskName: null -priority: 50 -processDefinitionCategory: "http://www.activiti.org/processdef" -processDefinitionDeploymentId: "18" -processDefinitionDescription: "This is a simple invoice approval process that allows a person to assign a dedicated approver for the the invoice. It will then be routed to the Accounting department for payment preparation. Once payment is prepared the invoice will be stored in a specific folder and an email notification will be sent." -processDefinitionId: "InvoiceApprovalProcess:2:21" -processDefinitionKey: "InvoiceApprovalProcess" -processDefinitionName: "Invoice Approval Process" -processDefinitionVersion: 2 -processInstanceId: "11337" -processInstanceName: null -processInstanceStartUserId: "1" -taskDefinitionKey: "clarifyInvoice" -``` + adhocTaskCanBeReassigned: false + assignee: UserProcessModel {pictureId: null, id: 1, email: "admin@app.activiti.com", firstName: null, lastName: "Administrator"} + category: null + created: Wed Oct 11 2017 09:07:14 GMT+0100 (BST) {} + description: null + dueDate: null + duration: null + endDate: null + executionId: "11337" + formKey: "9" + id: "15303" + initiatorCanCompleteTask: false + involvedPeople: [] + managerOfCandidateGroup: false + memberOfCandidateGroup: false + memberOfCandidateUsers: false + name: "Clarify Invoice - Invoice-20302.pdf" + parentTaskId: null + parentTaskName: null + priority: 50 + processDefinitionCategory: "http://www.activiti.org/processdef" + processDefinitionDeploymentId: "18" + processDefinitionDescription: "This is a simple invoice approval process that allows a person to assign a dedicated approver for the the invoice. It will then be routed to the Accounting department for payment preparation. Once payment is prepared the invoice will be stored in a specific folder and an email notification will be sent." + processDefinitionId: "InvoiceApprovalProcess:2:21" + processDefinitionKey: "InvoiceApprovalProcess" + processDefinitionName: "Invoice Approval Process" + processDefinitionVersion: 2 + processInstanceId: "11337" + processInstanceName: null + processInstanceStartUserId: "1" + taskDefinitionKey: "clarifyInvoice" #### getTaskChecklist(id: string): Observable`` + Get all the sub-task instances for a Task Instance, also called the check list: ```ts @@ -79,48 +79,47 @@ this.tasklistService.getTaskChecklist(parentTaskId).subscribe( (subTasks: TaskDe The response is an array of `TaskDetailsModel` representing the sub-tasks: -``` -Sub Tasks: - 0: - adhocTaskCanBeReassigned: false - assignee: UserProcessModel {pictureId: null, id: 1, email: "admin@app.activiti.com", firstName: null, lastName: "Administrator"} - category: "2" - created: "2017-10-29T07:29:28.881+0000" - description: null - dueDate: null - duration: null - endDate: null - executionId: null - formKey: null - id: "74745" - initiatorCanCompleteTask: false - involvedPeople: undefined - managerOfCandidateGroup: false - memberOfCandidateGroup: false - memberOfCandidateUsers: false - name: "Double check invoice amount" - parentTaskId: "15303" - parentTaskName: "Clarify Invoice - Invoice-10292.pdf" - priority: 50 - processDefinitionCategory: null - processDefinitionDeploymentId: null - processDefinitionDescription: null - processDefinitionId: null - processDefinitionKey: null - processDefinitionName: null - processDefinitionVersion: 0 - processInstanceId: null - processInstanceName: null - processInstanceStartUserId: null - taskDefinitionKey: null - 1 : - {processDefinitionVersion: 0, id: "74746", name: "Verify with the person that did the purchase", priority: 50, assignee: UserProcessModel, …} -``` + Sub Tasks: + 0: + adhocTaskCanBeReassigned: false + assignee: UserProcessModel {pictureId: null, id: 1, email: "admin@app.activiti.com", firstName: null, lastName: "Administrator"} + category: "2" + created: "2017-10-29T07:29:28.881+0000" + description: null + dueDate: null + duration: null + endDate: null + executionId: null + formKey: null + id: "74745" + initiatorCanCompleteTask: false + involvedPeople: undefined + managerOfCandidateGroup: false + memberOfCandidateGroup: false + memberOfCandidateUsers: false + name: "Double check invoice amount" + parentTaskId: "15303" + parentTaskName: "Clarify Invoice - Invoice-10292.pdf" + priority: 50 + processDefinitionCategory: null + processDefinitionDeploymentId: null + processDefinitionDescription: null + processDefinitionId: null + processDefinitionKey: null + processDefinitionName: null + processDefinitionVersion: 0 + processInstanceId: null + processInstanceName: null + processInstanceStartUserId: null + taskDefinitionKey: null + 1 : + {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 when calling this method. #### getTasks(requestNode: TaskQueryRequestRepresentationModel): Observable`` + Get tasks matching passed in query definition: ```ts @@ -161,22 +160,21 @@ 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 `TaskDetailsModel`: -``` -data: - 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: {…}, …} - 2: {id: "74745", name: "Double check invoice amount", description: null, category: "2", assignee: {…}, …} - 3: {id: "20686", name: "Sample checklist task 1", description: null, category: "2", assignee: {…}, …} - 4: {id: "15303", name: "Clarify Invoice - Invoice-20302.pdf", description: null, category: null, assignee: {…}, …} -length: 5 -size: 5 -start: 0 -total: 10 -``` + data: + 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: {…}, …} + 2: {id: "74745", name: "Double check invoice amount", description: null, category: "2", assignee: {…}, …} + 3: {id: "20686", name: "Sample checklist task 1", description: null, category: "2", assignee: {…}, …} + 4: {id: "15303", name: "Clarify Invoice - Invoice-20302.pdf", description: null, category: null, assignee: {…}, …} + length: 5 + size: 5 + start: 0 + 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`. #### getTotalTasks(requestNode: TaskQueryRequestRepresentationModel): Observable`` + Get total number of tasks matching passed in query definition: ```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 return how many Task Instances it matched in the `total` property: -``` -data:[] -size: 0 -start: 0 -total: 10 -``` + data:[] + size: 0 + start: 0 + total: 10 When you call this method it always sets the `size` property to `0`. #### findTasksByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable`` + Find and return Task Instances by state `open` or `completed` and query model: ```ts @@ -235,6 +232,7 @@ this.tasklistService.findTasksByState(taskQuery, taskState).subscribe( (taskList console.log('Error: ', error); }); ``` + 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 @@ -242,6 +240,7 @@ with passed in `state` before making the call to `getTasks`. For an example of the response see the `getTasks` method. #### findAllTaskByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable`` + Find and return all Task Instances by state `open` or `completed` and query model: ```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. #### findAllTasksWithoutState(requestNode: TaskQueryRequestRepresentationModel): Observable`` + Find and return all Task Instances that matches query model, regardless of state: ```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. #### assignTaskByUserId(taskId: string, userId: number): Observable`` + Assign a Task Instance to a user via the User ID: ```ts @@ -320,6 +321,7 @@ this.tasklistService.assignTaskByUserId(taskId, userId).subscribe( (taskInstance The user ID identifies a User in APS. #### assignTask(taskId: string, requestNode: any): Observable`` + Assign a task to a user via a user object with an `id` property, for example: ```ts @@ -335,7 +337,8 @@ this.tasklistService.assignTask(taskId, user).subscribe( (taskInstance: TaskDeta This method does the same as the `assignTaskByUserId` method, the only difference is that this method can be used when you have an object where the User ID is contained in an `id` property. -#### claimTask(taskId: string): Observable`` +#### claimTask(taskId: string): Observable`` + Claim a pooled task (i.e. candidate task) as current user so it can be worked on and later on completed: ```ts @@ -348,10 +351,11 @@ this.tasklistService.claimTask(taskId).subscribe( (taskInstance: TaskDetailsMode ``` The response will be `null` if the task was claimed successfully. - + The task assignment changes from `candidate` to `assignee`. -#### unclaimTask(taskId: string): Observable`` +#### unclaimTask(taskId: string): Observable`` + Return a claimed task to the pool (i.e. make it a candidate task): ```ts @@ -362,10 +366,11 @@ this.tasklistService.unclaimTask(taskId).subscribe( (taskInstance: TaskDetailsMo console.log('Error: ', error); }); ``` - + 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: ```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 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`` -#### updateTask(taskId: any, updated): Observable`` Update name, description, and due date for a Task Instance: ```ts @@ -395,43 +401,43 @@ this.tasklistService.updateTask(taskId, updateData).subscribe( (updatedTaskDetai 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 is no associated process: -``` -adhocTaskCanBeReassigned: false -assignee: undefined -category: null -created: Mon Nov 13 2017 16:34:49 GMT+0000 (GMT) {} -description: "Updated description" -dueDate: Sat Feb 10 2018 11:00:00 GMT+0000 (GMT) {} -duration: NaN -endDate: null -executionId: null -formKey: "5005" -id: "80002" -initiatorCanCompleteTask: false -managerOfCandidateGroup: false -memberOfCandidateGroup: false -memberOfCandidateUsers: false -name: "Updated name" -parentTaskId: null -parentTaskName: null -priority: 50 -processDefinitionCategory: null -processDefinitionDeploymentId: null -processDefinitionDescription: null -processDefinitionId: null -processDefinitionKey: null -processDefinitionName: null -processDefinitionVersion: 0 -processInstanceId: null -processInstanceName: null -processInstanceStartUserId: null -taskDefinitionKey: null -``` + adhocTaskCanBeReassigned: false + assignee: undefined + category: null + created: Mon Nov 13 2017 16:34:49 GMT+0000 (GMT) {} + description: "Updated description" + dueDate: Sat Feb 10 2018 11:00:00 GMT+0000 (GMT) {} + duration: NaN + endDate: null + executionId: null + formKey: "5005" + id: "80002" + initiatorCanCompleteTask: false + managerOfCandidateGroup: false + memberOfCandidateGroup: false + memberOfCandidateUsers: false + name: "Updated name" + parentTaskId: null + parentTaskName: null + priority: 50 + processDefinitionCategory: null + processDefinitionDeploymentId: null + processDefinitionDescription: null + processDefinitionId: null + processDefinitionKey: null + processDefinitionName: null + processDefinitionVersion: 0 + processInstanceId: null + processInstanceName: null + processInstanceStartUserId: null + taskDefinitionKey: null #### createNewTask(task: TaskDetailsModel): Observable`` + Create a new stand-alone Task Instance that is not associated with a Process Instance: ```ts @@ -452,45 +458,44 @@ 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: -``` -Created task details: - adhocTaskCanBeReassigned: false - assignee: null - category: null - created: Mon Nov 13 2017 16:34:49 GMT+0000 (GMT) {} - description: "A new stand-alone task" - dueDate: null - duration: null - endDate: null - executionId: null - formKey: null - id: "80002" - initiatorCanCompleteTask: false - involvedPeople: undefined - managerOfCandidateGroup: false - memberOfCandidateGroup: false - memberOfCandidateUsers: false - name: "Some Task" - parentTaskId: null - parentTaskName: null - priority: 50 - processDefinitionCategory: null - processDefinitionDeploymentId: null - processDefinitionDescription: null - processDefinitionId: null - processDefinitionKey: null - processDefinitionName: null - processDefinitionVersion: 0 - processInstanceId: null - processInstanceName: null - processInstanceStartUserId: null - taskDefinitionKey: null -``` + Created task details: + adhocTaskCanBeReassigned: false + assignee: null + category: null + created: Mon Nov 13 2017 16:34:49 GMT+0000 (GMT) {} + description: "A new stand-alone task" + dueDate: null + duration: null + endDate: null + executionId: null + formKey: null + id: "80002" + initiatorCanCompleteTask: false + involvedPeople: undefined + managerOfCandidateGroup: false + memberOfCandidateGroup: false + memberOfCandidateUsers: false + name: "Some Task" + parentTaskId: null + parentTaskName: null + priority: 50 + processDefinitionCategory: null + processDefinitionDeploymentId: null + processDefinitionDescription: null + processDefinitionId: null + processDefinitionKey: null + processDefinitionName: null + processDefinitionVersion: 0 + processInstanceId: null + processInstanceName: null + processInstanceStartUserId: null + taskDefinitionKey: null 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. #### attachFormToATask(taskId: string, formId: number): Observable`` + Attach a form to a User Task: ```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. #### getFormList(): Observable`
    ` + Get a list of the available reusable forms: ```ts @@ -522,16 +528,14 @@ this.tasklistService.getFormList().subscribe( (formList: Form[]) => { A successful response looks like this: -``` -Available forms: + Available forms: -0: - id: 5005 - name: "Name Info" -1: {name: "cm:folder", id: 3012} -2: {name: "Alfresco Node Form", id: 3011} -3: {name: "Employee", id: 3010} -``` + 0: + id: 5005 + name: "Name Info" + 1: {name: "cm:folder", id: 3012} + 2: {name: "Alfresco Node Form", id: 3011} + 3: {name: "Employee", id: 3010} 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. #### addTask(task: TaskDetailsModel): Observable`` + Add a Sub-Task (i.e. checklist task) to a parent Task Instance: ```ts @@ -557,41 +562,40 @@ this.tasklistService.addTask(subTaskDetails).subscribe( (updatedTaskDetails: Tas 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: -``` -adhocTaskCanBeReassigned: false -assignee: null -category: null -created: Tue Nov 14 2017 13:32:41 GMT+0000 (GMT) {} -description: null -dueDate: null -duration: null -endDate: null -executionId: null -formKey: null -id: "80003" -initiatorCanCompleteTask: false -involvedPeople: undefined -managerOfCandidateGroup: false -memberOfCandidateGroup: false -memberOfCandidateUsers: false -name: "Check the invoice amount" -parentTaskId: "80002" -parentTaskName: "Some Task" -priority: 50 -processDefinitionCategory: null -processDefinitionDeploymentId: null -processDefinitionDescription: null -processDefinitionId: null -processDefinitionKey: null -processDefinitionName: null -processDefinitionVersion: 0 -processInstanceId: null -processInstanceName: null -processInstanceStartUserId:null -taskDefinitionKey: null -``` + adhocTaskCanBeReassigned: false + assignee: null + category: null + created: Tue Nov 14 2017 13:32:41 GMT+0000 (GMT) {} + description: null + dueDate: null + duration: null + endDate: null + executionId: null + formKey: null + id: "80003" + initiatorCanCompleteTask: false + involvedPeople: undefined + managerOfCandidateGroup: false + memberOfCandidateGroup: false + memberOfCandidateUsers: false + name: "Check the invoice amount" + parentTaskId: "80002" + parentTaskName: "Some Task" + priority: 50 + processDefinitionCategory: null + processDefinitionDeploymentId: null + processDefinitionDescription: null + processDefinitionId: null + processDefinitionKey: null + processDefinitionName: null + processDefinitionVersion: 0 + processInstanceId: null + processInstanceName: null + processInstanceStartUserId:null + taskDefinitionKey: null #### deleteTask(taskId: string): Observable`` + Delete a Sub-Task (i.e. checklist task): ```ts @@ -606,6 +610,7 @@ this.tasklistService.deleteTask(taskId).subscribe( (taskDetails: TaskDetailsMode **Note**. you can only delete so called checklist tasks with this method. #### fetchTaskAuditJsonById(taskId: string): Observable`` + Fetch Task Audit log as JSON for a Task Instance ID: ```ts @@ -620,18 +625,17 @@ this.tasklistService.fetchTaskAuditJsonById(taskId) The response is JSON object with the Task Instance audit log: -``` -{ - taskId: "15368", - taskName: "Approve by someone in Accounting", - processInstanceId: "15361", - processDefinitionName: "Process With Pooled task", - processDefinitionVersion: 1, - … -} -``` + { + taskId: "15368", + taskName: "Approve by someone in Accounting", + processInstanceId: "15361", + processDefinitionName: "Process With Pooled task", + processDefinitionVersion: 1, + … + } #### fetchTaskAuditPdfById(taskId: string): Observable`` + Fetch Task Audit log as JSON for a Task Instance ID: ```ts @@ -644,8 +648,3 @@ this.tasklistService.fetchTaskAuditPdfById(taskId) ``` The response is PDF with the Task Instance audit log. - - - - - \ No newline at end of file diff --git a/docs/text-highlight.pipe.md b/docs/text-highlight.pipe.md index 9c80cc0978..ca7fb50138 100644 --- a/docs/text-highlight.pipe.md +++ b/docs/text-highlight.pipe.md @@ -17,10 +17,7 @@ be highlighted with added HTML (see the [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. - - ## See also -- [Highlight directive](highlight.directive.md) -- [Highlight transform service](highlight-transform.service.md) - \ No newline at end of file +- [Highlight directive](highlight.directive.md) +- [Highlight transform service](highlight-transform.service.md) diff --git a/docs/text-mask.component.md b/docs/text-mask.component.md index 564637f894..68b74f4d48 100644 --- a/docs/text-mask.component.md +++ b/docs/text-mask.component.md @@ -11,7 +11,7 @@ Implements text field input masks. ### Properties | Name | Type | Default | Description | -| --- | --- | --- | --- | +| ---- | ---- | ------- | ----------- | | textMask | any | | Object defining mask and "reversed" status. | ## Details @@ -36,11 +36,11 @@ text mask in ADF would be: The following characters have special meaning within a mask; all other characters are included in the text as they are: -- **"0"**: Denotes a digit -- **"9"**: Denotes a digit that can optionally be left out -- **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9) -- **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z) -- **"#"**: Denotes a string of zero or more digits +- **"0"**: Denotes a digit +- **"9"**: Denotes a digit that can optionally be left out +- **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9) +- **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z) +- **"#"**: Denotes a string of zero or more digits The mask is passed to the directive in the `mask` field of the parameter object. The `reversed` field indicates that digits in the mask are "filled up" in @@ -60,8 +60,3 @@ However, with reversed (right-to-left) ordering, the textbox would show `2.3` ...and these digits would slide leftward as the user typed more. - - - - - \ No newline at end of file diff --git a/docs/thumbnail.service.md b/docs/thumbnail.service.md index 572aa76a64..d5bbfa4bc8 100644 --- a/docs/thumbnail.service.md +++ b/docs/thumbnail.service.md @@ -20,16 +20,16 @@ a document node or a MIME type. The default mapping between types and icons is shown in the table below: | Document | Icon | Types | -| --- | --- | --- | +| -------- | ---- | ----- | | Compressed archive | ![Archive thumbnail](docassets/images/ft_ic_archive.png) | 'application/x-compressed', 'application/x-zip-compressed', 'application/zip' | | Text | ![Text thumbnail](docassets/images/ft_ic_document.png) | 'text/plain', 'application/json', 'application/x-javascript', 'application/vnd.apple.pages' | | Bitmap/raster image | ![Bitmap thumbnail](docassets/images/ft_ic_raster_image.png) | 'image/png', 'image/jpeg', 'image/gif' | | MP4 video | ![MP4 thumbnail](docassets/images/ft_ic_video.png) | 'video/mp4' | -| SVG vector image| ![SVG thumbnail](docassets/images/ft_ic_vector_image.png) | 'image/svg+xml' | +| SVG vector image | ![SVG thumbnail](docassets/images/ft_ic_vector_image.png) | 'image/svg+xml' | | HTML file | ![HTML thumbnail](docassets/images/ft_ic_website.png) | 'text/html' | | PDF file | ![PDF thumbnail](docassets/images/ft_ic_pdf.png) | 'application/pdf' | | Folder | ![Folder thumbnail](docassets/images/ft_ic_folder.png) | | -| Disabled folder | ![Disabled folder thumbnail](docassets/images/ft_ic_folder_disable.png) | | +| Disabled folder | ![Disabled folder thumbnail](docassets/images/ft_ic_folder_disable.png) | | | Excel spreadsheet | ![Spreadsheet thumbnail](docassets/images/ft_ic_ms_excel.png) | 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.spreadsheetml.template' | | PowerPoint slideshow | ![PowerPoint thumbnail](docassets/images/ft_ic_ms_powerpoint.png) | 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.presentationml.template', 'application/vnd.openxmlformats-officedocument.presentationml.slideshow' | | Word document | ![Word thumbnail](docassets/images/ft_ic_ms_word.png) | 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' | @@ -54,14 +54,6 @@ GIF ..... ``` - - - - ## See also -- [Mime type icon pipe](mime-type-icon.pipe.md) - - - - +- [Mime type icon pipe](mime-type-icon.pipe.md) diff --git a/docs/time-ago.pipe.md b/docs/time-ago.pipe.md index 4af4c339d5..17d078232d 100644 --- a/docs/time-ago.pipe.md +++ b/docs/time-ago.pipe.md @@ -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 is less than seven days then then the date will be formatted as "X days ago". Otherwise, the usual full date format is used. - - - - - \ No newline at end of file diff --git a/docs/toolbar-divider.component.md b/docs/toolbar-divider.component.md index d6ecf6af76..ee9a6e4b64 100644 --- a/docs/toolbar-divider.component.md +++ b/docs/toolbar-divider.component.md @@ -11,4 +11,9 @@ Divides groups of elements in a Toolbar with a visual separator. -``` \ No newline at end of file +``` + +## See Also + +- [Toolbar component](toolbar.component.md) +- [Toolbar Title component](toolbar-title.component.md) diff --git a/docs/toolbar-title.component.md b/docs/toolbar-title.component.md index 5de232d5cd..292701cadf 100644 --- a/docs/toolbar-title.component.md +++ b/docs/toolbar-title.component.md @@ -18,3 +18,8 @@ Supplies custom HTML to be included in a Toolbar component title. ## Details 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) diff --git a/docs/toolbar.component.md b/docs/toolbar.component.md index 8b858ea82b..960639546b 100644 --- a/docs/toolbar.component.md +++ b/docs/toolbar.component.md @@ -105,3 +105,8 @@ For example: ![](docassets/images/adf-toolbar-06.png) ![](docassets/images/adf-toolbar-07.png) + +## See also + +- [Toolbar Divider component](toolbar-divider.component.md) +- [Toolbar Title component](toolbar-title.component.md) diff --git a/docs/user-info.component.md b/docs/user-info.component.md index 0eecc0ab2f..fe7046a027 100644 --- a/docs/user-info.component.md +++ b/docs/user-info.component.md @@ -1,4 +1,4 @@ -# Alfresco User Info component +# User Info component Shows user information. @@ -11,13 +11,13 @@ Shows user information. ### Properties | Name | Type | Default | Description | -| --- | --- | --- | --- | +| ---- | ---- | ------- | ----------- | | 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 | -| menuPositionX | string | | Custom choice for opening the menu bottom : `before` or `after` | -| menuPositionY | string | | Custom choice for opening the menu bottom : `above` or `below` | -| namePosition | string | `right` | When the username is showed this define his position relatively the user info button. It can be two values : `right` or `left`| -| showName | boolean | true | Show/Hide the username next the user info button| +| menuPositionX | string | | Custom choice for opening the menu bottom : `before` or `after` | +| menuPositionY | string | | Custom choice for opening the menu bottom : `above` or `below` | +| namePosition | string | `right` | When the username is showed this define his position relatively the user info button. It can be two values : `right` or `left` | +| showName | boolean | true | Show/Hide the username next the user info button | ## Details diff --git a/docs/user-initial.pipe.md b/docs/user-initial.pipe.md index a83eb89d4a..7ca5e08da3 100644 --- a/docs/user-initial.pipe.md +++ b/docs/user-initial.pipe.md @@ -13,14 +13,9 @@ Takes the name fields of a UserProcessModel object and extracts and formats the ## Details 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 second parameter is an optional delimiter to add between the initials. Both parameters default to empty strings. - - - - - \ No newline at end of file diff --git a/docs/user-process.model.md b/docs/user-process.model.md index bfe5872cf3..92cab98473 100644 --- a/docs/user-process.model.md +++ b/docs/user-process.model.md @@ -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 [source file](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/models/user-process.model.ts). - - ## See also -- [People process service](people-process.service.md) - \ No newline at end of file +- [People process service](people-process.service.md) diff --git a/docs/version-list.component.md b/docs/version-list.component.md index 200099ddb6..3f3a7d5089 100644 --- a/docs/version-list.component.md +++ b/docs/version-list.component.md @@ -11,7 +11,7 @@ Displays the version history of a node in a [Version Manager component](version- ### Properties | Name | Type | Description | -| --- | --- | --- | +| ---- | ---- | ----------- | | id | string | The node id you want to see the version history of. | ## 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. The VersionListComponent loads and displays the version history of a node. - - ## See also -- [Version manager component](version-manager.component.md) - \ No newline at end of file +- [Version manager component](version-manager.component.md) diff --git a/docs/version-manager.component.md b/docs/version-manager.component.md index 0891319ccd..97b3f0de9f 100644 --- a/docs/version-manager.component.md +++ b/docs/version-manager.component.md @@ -2,7 +2,7 @@ Displays the version history of a node with the ability to upload a new version. -![#f03c15](https://placehold.it/15/f03c15/000000?text=+) `This component is still in experimental phase, it has several limitations which will be resolved soon.` +![\#f03c15](https://placehold.it/15/f03c15/000000?text=+) `This component is still in experimental phase, it has several limitations which will be resolved soon.` ![Version Manager](docassets/images/version-manager.png) @@ -15,7 +15,7 @@ Displays the version history of a node with the ability to upload a new version. ### Properties | 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. | ## Details @@ -24,14 +24,11 @@ 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. -| Action | Versions | Description | -| --- | --- | --- | -| Restore | All | Revert the current version to the selected one with creating a new version of it. | +| Action | Versions | Description | +| ------ | -------- | ----------- | +| Restore | All | Revert the current version to the selected one with creating a new version of it. | - - ## See also -- [Version list component](version-list.component.md) -- [Document list component](document-list.component.md) - \ No newline at end of file +- [Version list component](version-list.component.md) +- [Document list component](document-list.component.md) diff --git a/docs/viewer.component.md b/docs/viewer.component.md index e9ea6770e9..461fb87414 100644 --- a/docs/viewer.component.md +++ b/docs/viewer.component.md @@ -1,4 +1,4 @@ -# Alfresco Viewer component +# Viewer component Displays content from an ACS repository. @@ -49,7 +49,7 @@ Using with file url: | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | | fileNodeId | string | | Node Id of the file to load | -| sharedLinkId | string | | Shared link id (to display shared file) | +| sharedLinkId | string | | Shared link id (to display shared file) | | urlFile | string | | If you want to load an external file that does not come from ECM you can use this Url where to load the file | | urlFileViewer | string | null | Viewer to use with the `urlFile` address (`pdf`, `image`, `media`, `text`). Used when `urlFile` has no filename and extension. | | urlBlob | Blob | | If you want to load a Blob File | diff --git a/docs/webscript.component.md b/docs/webscript.component.md index 1e02b37863..9cd7d3400a 100644 --- a/docs/webscript.component.md +++ b/docs/webscript.component.md @@ -1,4 +1,4 @@ -# Alfresco Webscript Get component +# Webscript component Provides access to Webscript features. diff --git a/docs/widget.component.md b/docs/widget.component.md index 023c156c1f..f74e5573de 100644 --- a/docs/widget.component.md +++ b/docs/widget.component.md @@ -20,7 +20,7 @@ export class CustomEditorComponent extends WidgetComponent {} ### Properties | Name | Type | Default | Description | -| --- | --- | --- | --- | +| ---- | ---- | ------- | ----------- | | 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 | @@ -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 implementing custom widgets. - - ## See also -- [Extensibility](extensibility.md) - \ No newline at end of file +- [Extensibility](extensibility.md)