mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Restructured remaining doc folders and fixed links (#4441)
* [ADF-4152] Moved proc services cloud docs to subfolders * [ADF-4152] Fixed links in PS cloud docs * [ADF-4152] Added subfolders and checked links for extensions and insights docs * [ADF-4152] Moved proc services cloud docs to subfolders * [ADF-4152] Fixed links in PS cloud docs * [ADF-4152] Added subfolders and checked links for extensions and insights docs * [ADF-4152] Fixed links in Proc cloud, Insights and Extensions docs * [ADF-4152] Updated links in user guide * [ADF-4152] Fixed broken links in tutorials * [ADF-4152] Fixed remaining links in core docs * [ADF-4152] Fixed remaining links in proc services docs * [ADF-4152] Fixed remaining links in content services docs * [ADF-4152] Fixed links in breaking changes docs * [ADF-4152] Updated main README index page * [ADF-4152] Fixed glitches with preview ext component docs
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
8edf92f325
commit
31479cfaa4
@@ -0,0 +1,28 @@
|
||||
---
|
||||
Title: Apps Process Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Apps Process Cloud Service](../../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts "Defined in apps-process-cloud.service.ts")
|
||||
|
||||
Gets details of deployed apps for the current user.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getDeployedApplicationsByStatus**(status: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>`<br/>
|
||||
Gets a list of deployed apps for this user by status.
|
||||
- _status:_ `string` - Required status value
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>` - The list of deployed apps
|
||||
|
||||
## Details
|
||||
|
||||
This service implements some features of the [Apps process service](../../core/services/apps-process.service.md)
|
||||
with modifications for cloud use.
|
||||
|
||||
## See also
|
||||
|
||||
- [Apps process service](../../core/services/apps-process.service.md)
|
||||
55
docs/process-services-cloud/services/group-cloud.service.md
Normal file
55
docs/process-services-cloud/services/group-cloud.service.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
Title: Group Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-02-06
|
||||
---
|
||||
|
||||
# [Group Cloud Service](../../../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts "Defined in group-cloud.service.ts")
|
||||
|
||||
Searches and gets information for groups.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||
Check if a group has any of the client app roles in the supplied list.
|
||||
- _groupId:_ `string` - ID of the target group
|
||||
- _clientId:_ `string` - ID of the client
|
||||
- _roleNames:_ `string[]` - Array of role names to check
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has one or more of the roles, false otherwise
|
||||
- **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||
Checks if a group has a client app.
|
||||
- _groupId:_ `string` - ID of the target group
|
||||
- _clientId:_ `string` - ID of the client
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has the client app, false otherwise
|
||||
- **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
||||
Check that a group has one or more roles from the supplied list.
|
||||
- _groupId:_ `string` - ID of the target group
|
||||
- _roleNames:_ `string[]` - Array of role names
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has one or more of the roles, false otherwise
|
||||
- **findGroupsByName**(searchParams: [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Finds groups filtered by name.
|
||||
- _searchParams:_ [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts) - Object containing the name filter string
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of group information
|
||||
- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
|
||||
Gets the client ID using the app name.
|
||||
- _applicationName:_ `string` - Name of the app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - client ID string
|
||||
- **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
|
||||
Gets client roles.
|
||||
- _groupId:_ `string` - ID of the target group
|
||||
- _clientId:_ `string` - ID of the client
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - List of roles
|
||||
- **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>`<br/>
|
||||
Gets details for a specified group.
|
||||
- _groupId:_ `string` - ID of the target group
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>` - Group details
|
||||
|
||||
## Details
|
||||
|
||||
See the
|
||||
[Groups API](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/GroupsApi.md)
|
||||
page in the Alfresco JS-API docs for further details about the information about the format
|
||||
of the returned data.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
Title: Process Filter Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Process Filter Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts "Defined in process-filter-cloud.service.ts")
|
||||
|
||||
Manage Process Filters, which are pre-configured Process Instance queries.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **addFilter**(filter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
|
||||
Adds a new process instance filter
|
||||
- _filter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to add
|
||||
- **deleteFilter**(filter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
|
||||
Delete process instance filter
|
||||
- _filter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to delete
|
||||
- **getAllProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "All" Process instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
|
||||
- **getCompletedProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "Completed" Process instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
|
||||
- **getProcessFilterById**(appName: `string`, id: `string`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
|
||||
Get process instance filter for given filter id
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _id:_ `string` - Id of the target process instance filter
|
||||
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - Details of process filter
|
||||
- **getProcessFilters**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
|
||||
Gets all process instance filters for a process app.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process filter details
|
||||
- **getRunningProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "Running" Process instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
|
||||
- **updateFilter**(filter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
|
||||
Update process instance filter
|
||||
- _filter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to update
|
||||
|
||||
## Details
|
||||
|
||||
The methods of this service generally return an instance of
|
||||
[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) or an array of instances.
|
||||
|
||||
You can use the returned filters to get matching process instances for the process app,
|
||||
such as 'Running', 'Completed', 'All', etc.
|
||||
|
||||
## See also
|
||||
|
||||
- [Process filters cloud component](../components/process-filters-cloud.component.md)
|
||||
- [Task filter cloud service](task-filter-cloud.service.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
Title: Process Header Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-03-08
|
||||
---
|
||||
|
||||
# [Process Header Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-header/services/process-header-cloud.service.ts "Defined in process-header-cloud.service.ts")
|
||||
|
||||
Manages cloud process instances.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
|
||||
Gets details of a process instance.
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _processInstanceId:_ `string` - ID of the process instance whose details you want
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Process instance details
|
||||
|
||||
## Details
|
||||
|
||||
The methods work in much the same way as the equivalent methods in the
|
||||
[Process list Cloud Component](../components/process-list-cloud.component.md)
|
||||
but they use the cloud variants of the classes for return values. See the
|
||||
[Process list Cloud Service](process-list-cloud.service.md) page for usage examples.
|
||||
|
||||
## See also
|
||||
|
||||
- [Process list Cloud Service](process-list-cloud.service.md)
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
Title: Process List Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-02-06
|
||||
---
|
||||
|
||||
# [Process List Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts "Defined in process-list-cloud.service.ts")
|
||||
|
||||
Searches processes.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Finds a process using an object with optional query properties.
|
||||
- _requestNode:_ [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Process information
|
||||
|
||||
## Details
|
||||
|
||||
Note that for a call to `getProcessByRequest`, the
|
||||
[`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) object
|
||||
must at minimum have the `appName` property correctly set.
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
Title: Start Process Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Start Process Cloud Service](../../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts "Defined in start-process-cloud.service.ts")
|
||||
|
||||
Gets process definitions and starts processes.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>`<br/>
|
||||
Gets the process definitions associated with an app.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
|
||||
- **startProcess**(appName: `string`, requestPayload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
|
||||
Starts a process based on a process definition, name, form values or variables.
|
||||
- _appName:_ `string` - name of the Application
|
||||
- _requestPayload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc)
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started
|
||||
|
||||
## Details
|
||||
|
||||
You can use the `startProcess` method in much the same way as the `startProcess` method in the
|
||||
[Process service](../../process-services/services/process.service.md) (see the [Process service](../../process-services/services/process.service.md) page
|
||||
for an example). However, the cloud version
|
||||
combines the process details and variables conveniently into the
|
||||
[`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) object.
|
||||
|
||||
## See also
|
||||
|
||||
- [Process service](../../process-services/services/process.service.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
Title: Start Task Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Start Task Cloud Service](../../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts "Defined in start-task-cloud.service.ts")
|
||||
|
||||
Starts standalone tasks.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **createNewTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
|
||||
Creates a new standalone task.
|
||||
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task to create
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task
|
||||
|
||||
## Details
|
||||
|
||||
The `createNewTask` method works the same way as the method with the same name in the
|
||||
[Tasklist service](../../process-services/services/tasklist.service.md)
|
||||
but uses the cloud variants of the classes for the parameter and return value. See the
|
||||
[Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples.
|
||||
|
||||
## See also
|
||||
|
||||
- [Tasklist service](../../process-services/services/tasklist.service.md)
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
Title: Task Filter Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Task Filter Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts "Defined in task-filter-cloud.service.ts")
|
||||
|
||||
Manages task filters.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **addFilter**(filter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
|
||||
Adds a new task filter.
|
||||
- _filter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The new filter to add
|
||||
- **deleteFilter**(filter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
|
||||
Deletes a task filter
|
||||
- _filter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The filter to delete
|
||||
- **getCompletedTasksFilterInstance**(appName: `string`): [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "Completed" task instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The newly created filter
|
||||
- **getMyTasksFilterInstance**(appName: `string`): [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "My Tasks" task instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The newly created filter
|
||||
- **getTaskFilterById**(appName: `string`, id: `string`): [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
|
||||
Gets a task filter.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _id:_ `string` - ID of the task
|
||||
- **Returns** [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - Details of the task filter
|
||||
- **getTaskListFilters**(appName?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
|
||||
Gets all task filters for a process app.
|
||||
- _appName:_ `string` - (Optional) Name of the target app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task filter details
|
||||
- **getUsername**(): `string`<br/>
|
||||
Gets the username field from the access token.
|
||||
- **Returns** `string` - Username string
|
||||
- **getValueFromToken**(key: `string`)<br/>
|
||||
Gets a named value from the access token.
|
||||
- _key:_ `string` - Key name of the value
|
||||
- **updateFilter**(filter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
|
||||
Updates a task filter.
|
||||
- _filter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The filter to update
|
||||
|
||||
## Details
|
||||
|
||||
The methods of this service generally return an instance of [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) or
|
||||
an array of instances. For example, you could use `getTaskListFilters` as follows:
|
||||
|
||||
```ts
|
||||
this.taskFilterService.getTaskListFilters(appName).subscribe( (filters: TaskFilterCloudModel[]) => {
|
||||
console.log('Task filters: ', filters);
|
||||
}, error => {
|
||||
console.log('Error: ', error);
|
||||
});
|
||||
```
|
||||
|
||||
These filters can now be used to get matching task instances for the process app.
|
||||
|
||||
## See also
|
||||
|
||||
- [Task filter service](../../process-services/services/task-filter.service.md)
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
Title: Task Header Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-18
|
||||
---
|
||||
|
||||
# [Task Header Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts "Defined in task-header-cloud.service.ts")
|
||||
|
||||
Manages cloud tasks.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): `any`<br/>
|
||||
Claims a task for an assignee.
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _taskId:_ `string` - ID of the task to claim
|
||||
- _assignee:_ `string` - User to assign the task to
|
||||
- **Returns** `any` - Details of the claimed task
|
||||
- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
|
||||
Gets details of a task.
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _taskId:_ `string` - ID of the task whose details you want
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details
|
||||
- **unclaimTask**(appName: `string`, taskId: `string`): `any`<br/>
|
||||
Un-claims a task.
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _taskId:_ `string` - ID of the task to unclaim
|
||||
- **Returns** `any` - Details of the task that was unclaimed
|
||||
- **updateTask**(appName: `string`, taskId: `string`, updatePayload: `any`): `any`<br/>
|
||||
Updates the details (name, description, due date) for a task.
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _taskId:_ `string` - ID of the task to update
|
||||
- _updatePayload:_ `any` - Data to update the task
|
||||
- **Returns** `any` - Updated task details
|
||||
|
||||
## Details
|
||||
|
||||
The methods work in much the same way as the equivalent methods in the
|
||||
[Tasklist service](../../process-services/services/tasklist.service.md)
|
||||
but they use the cloud variants of the classes for return values. See the
|
||||
[Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples.
|
||||
|
||||
## See also
|
||||
|
||||
- [Tasklist service](../../process-services/services/tasklist.service.md)
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
Title: Task List Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-02-06
|
||||
---
|
||||
|
||||
# [Task List Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts "Defined in task-list-cloud.service.ts")
|
||||
|
||||
Searches tasks.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
||||
Finds a task using an object with optional query properties.
|
||||
- _requestNode:_ [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Task information
|
||||
|
||||
## Details
|
||||
|
||||
Note that for a call to `getTaskByRequest`, the
|
||||
[`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) object
|
||||
must at minimum have the `appName` property correctly set.
|
||||
Reference in New Issue
Block a user