inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation build (#6762)

Browse Source 
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
This commit is contained in:
Eugenio Romano
2021-03-03 14:08:15 +00:00
committed by GitHub
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/process-services-cloud/services/process-cloud.service.md
View File

@@ -13,28 +13,29 @@ Manages cloud process instances.
### Methods
* **cancelProcess**(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/>
- **cancelProcess**(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/>
Cancels a process.
* *appName:* `string` - Name of the app
* *processInstanceId:* `string` - Id of the process to cancel
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Operation Information
* **getApplicationVersions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>`<br/>
- _appName:_ `string` - Name of the app
- _processInstanceId:_ `string` - Id of the process to cancel
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Operation Information
- **getApplicationVersions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>`<br/>
Gets the application versions associated with an app.
* *appName:* `string` - Name of the target app
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>` - Array of Application Version Models
* **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>` - Array of Application Version Models
- **getBasePath**(appName: `string`): `string`<br/>
* *appName:* `string` -
* **Returns** `string` -
* **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/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/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
* **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/>
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
- **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
- _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
@@ -45,5 +46,5 @@ but they use the cloud variants of the classes for return values. See the
## See also
* [Process list Cloud Service](process-list-cloud.service.md)
* [Process header cloud component](../../process-services-cloud/components/process-header-cloud.component.md)
- [Process list Cloud Service](process-list-cloud.service.md)
- [Process header cloud component](../../process-services-cloud/components/process-header-cloud.component.md)