mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2557] Updated docs with new props script (#3149)
* [ADF-2557] Updated docs for services with new props script * [ADF-2557] Updated service docs with new props script
This commit is contained in:
committed by
Eugenio Romano
parent
8769c257f8
commit
1d517d3a8a
40
docs/core/apps-process.service.md
Normal file
40
docs/core/apps-process.service.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-04-05
|
||||
---
|
||||
|
||||
# Apps Process service
|
||||
|
||||
Gets details of the Process Services apps that are deployed for the user.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- `getApplicationDetailsById(appId: number = null): Observable<AppDefinitionRepresentation>`<br/>
|
||||
Gets the details for a specific app ID number.
|
||||
- `appId: number = null` - ID of the target app
|
||||
- **Returns** `Observable<AppDefinitionRepresentation>` - Details of the app
|
||||
- `getDeployedApplications(): Observable<AppDefinitionRepresentation[]>`<br/>
|
||||
Gets a list of deployed apps for this user.
|
||||
- **Returns** `Observable<AppDefinitionRepresentation[]>` - The list of deployed apps
|
||||
- `getDeployedApplicationsByName(name: string = null): Observable<AppDefinitionRepresentation>`<br/>
|
||||
Gets a list of deployed apps for this user, where the app name is \`name\`.
|
||||
- `name: string = null` - Name of the app
|
||||
- **Returns** `Observable<AppDefinitionRepresentation>` - The list of deployed apps
|
||||
|
||||
## Details
|
||||
|
||||
This service can be used to access the Process Services apps that are available
|
||||
to the current user. You can find more information about the
|
||||
returned `AppDefinitionRepresentation` class in the [Filter model page](filter.model.md)
|
||||
and in the
|
||||
[Process Services Apps API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppsApi.md#getAppDefinitions).
|
||||
The methods of this service make use of the
|
||||
[getAppDefinitions](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppsApi.md#getAppDefinitions)
|
||||
method, also from the Apps API.
|
||||
|
||||
## See also
|
||||
|
||||
- [Filter model](filter.model.md)
|
Reference in New Issue
Block a user