mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Added docs for remaining classes (#4277)
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
2076746b52
commit
a31803a6bb
@@ -28,7 +28,6 @@ for more information about installing and using the source code.
|
||||
| [Task filters cloud component](task-filters-cloud.component.md)  | Shows all available filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) |
|
||||
| [Task header cloud component](task-header-cloud.component.md)  | Shows all the information related to a task. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) |
|
||||
| [Task list cloud component](task-list-cloud.component.md)  | Renders a list containing all the tasks matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) |
|
||||
| _App details cloud component_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.ts) |
|
||||
|
||||
## Pipes
|
||||
|
||||
@@ -41,13 +40,13 @@ for more information about installing and using the source code.
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Apps process cloud service](apps-process-cloud.service.md)  | Gets details of deployed apps for the current user. | [Source](../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) |
|
||||
| [Group cloud service](group-cloud.service.md)  | Searches and gets information for groups. | [Source](../../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) |
|
||||
| [Process filter cloud service](process-filter-cloud.service.md)  | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) |
|
||||
| [Process list cloud service](process-list-cloud.service.md)  | Searches processes. | [Source](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
|
||||
| [Start process cloud service](start-process-cloud.service.md)  | Gets process definitions and starts processes. | [Source](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
|
||||
| [Start task cloud service](start-task-cloud.service.md)  | Starts standalone tasks. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
|
||||
| [Task filter cloud service](task-filter-cloud.service.md)  | Manages task filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
||||
| [Task header cloud service](task-header-cloud.service.md)  | Manages cloud tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) |
|
||||
| _Group cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) |
|
||||
| _Process list cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
|
||||
| _Task list cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
||||
| [Task list cloud service](task-list-cloud.service.md)  | Searches tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
||||
|
||||
<!--process-services-cloud end-->
|
||||
|
||||
55
docs/process-services-cloud/group-cloud.service.md
Normal file
55
docs/process-services-cloud/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
|
||||
- **getGroupDetailsById**(groupId: `string`): `any`<br/>
|
||||
Gets details for a specified group.
|
||||
- _groupId:_ `string` - ID of the target group
|
||||
- **Returns** `any` - 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.
|
||||
25
docs/process-services-cloud/process-list-cloud.service.md
Normal file
25
docs/process-services-cloud/process-list-cloud.service.md
Normal file
@@ -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.
|
||||
25
docs/process-services-cloud/task-list-cloud.service.md
Normal file
25
docs/process-services-cloud/task-list-cloud.service.md
Normal file
@@ -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