[ADF-3745] Added docs for remaining classes (#4277)

docs/README.md

@@ -401,7 +401,6 @@ for more information about installing and using the source code.
 | [Task filters cloud component](process-services-cloud/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) |
 | [Task header cloud component](process-services-cloud/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | 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](process-services-cloud/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | 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
 
@@ -414,14 +413,14 @@ for more information about installing and using the source code.
 | Name | Description | Source link |
 | ---- | ----------- | ----------- |
 | [Apps process cloud service](process-services-cloud/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | 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](process-services-cloud/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups.  | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) |
 | [Process filter cloud service](process-services-cloud/process-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | 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-services-cloud/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes.  | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
 | [Start process cloud service](process-services-cloud/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | 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](process-services-cloud/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks.  | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
 | [Task filter cloud service](process-services-cloud/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters.  | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
 | [Task header cloud service](process-services-cloud/task-header-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | 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) |
+| [Task list cloud service](process-services-cloud/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks.  | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-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) |
 
 <!--process-services-cloud end-->
 
@@ -441,7 +440,6 @@ for more information about installing and using the source code.
 | Name | Description | Source link |
 | ---- | ----------- | ----------- |
 | [Dynamic component](extensions/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) |
-| [Dynamic tab component](extensions/dynamic-tab.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extensions with tabs. | [Source](../lib/extensions/src/lib/components/dynamic-tab/dynamic-tab.component.ts) |
 
 ## Services
 

docs/core/login.component.md

@@ -2,7 +2,7 @@
 Title: Login component
 Added: v2.0.0
 Status: Active
-Last reviewed: 2019-01-16
+Last reviewed: 2019-02-06
 ---
 
 # [Login component](../../lib/core/login/components/login.component.ts "Defined in login.component.ts")
@@ -25,6 +25,7 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
     -   [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token)
     -   [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
     -   [Single Sign-On (SSO)](#single-sign-on-sso)
+    -   [Kerberos](#kerberos)
 -   [See Also](#see-also)
 
 ## Basic usage
@@ -335,6 +336,18 @@ must contain the full URI value:
 > In the default ADF application configurations the `silent-refresh.html` file
 > gets automatically copied to the application output when building for production.
 
+### Kerberos
+
+Setting the `withCredentials` property to true in the `auth` section of
+`app.config.json` will enable Kerberos and bypass the normal login:
+
+```json
+{
+  "auth": {
+    "withCredentials": "true"
+  },
+```
+
 ## See Also
 
 -   [Logout directive](logout.directive.md)

docs/extensions/dynamic-tab.component.md

@@ -1,18 +0,0 @@
----
-Title: Dynamic Tab Component
-Added: v3.0.0
-Status: Experimental
-Last reviewed: 2018-12-17
----
-
-# [Dynamic Tab Component](../../lib/core/about/about.component.ts "Defined in about.component.ts")
-
-Displays dynamically-loaded extensions with tabs.
-
-## Class members
-
-## Details
-
-## See also
-
-- Dynamic component

docs/process-services-cloud/README.md

@@ -28,7 +28,6 @@ for more information about installing and using the source code.
 | [Task filters cloud component](task-filters-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) ![Experimental](../docassets/images/ExperimentalIcon.png) | 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) |
+| [Task list cloud service](task-list-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Searches tasks.  | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-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) |
 
 <!--process-services-cloud end-->

docs/process-services-cloud/group-cloud.service.md

@@ -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.

docs/process-services-cloud/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.

docs/process-services-cloud/task-list-cloud.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.

docs/versionIndex.md

@@ -31,7 +31,6 @@ backend services have been tested with each released version of ADF.
 
 -   [App list cloud component](process-services-cloud/app-list-cloud.component.md)
 -   [Apps process cloud service](process-services-cloud/apps-process-cloud.service.md)
--   [Dynamic tab component](extensions/dynamic-tab.component.md)
 -   [Dynamic component](extensions/dynamic.component.md)
 -   [Edit process filter cloud component](process-services-cloud/edit-process-filter-cloud.component.md)
 -   [Edit task filter cloud component](process-services-cloud/edit-task-filter-cloud.component.md)
@@ -40,6 +39,7 @@ backend services have been tested with each released version of ADF.
 -   [Format space pipe](core/format-space.pipe.md)
 -   [Full name pipe](core/full-name.pipe.md)
 -   [Group cloud component](process-services-cloud/group-cloud.component.md)
+-   [Group cloud service](process-services-cloud/group-cloud.service.md)
 -   [Group initial pipe](process-services-cloud/group-initial.pipe.md)
 -   [Icon component](core/icon.component.md)
 -   [Identity user service](core/identity-user.service.md)
@@ -48,6 +48,7 @@ backend services have been tested with each released version of ADF.
 -   [Process filter cloud service](process-services-cloud/process-filter-cloud.service.md)
 -   [Process filters cloud component](process-services-cloud/process-filters-cloud.component.md)
 -   [Process list cloud component](process-services-cloud/process-list-cloud.component.md)
+-   [Process list cloud service](process-services-cloud/process-list-cloud.service.md)
 -   [Start process cloud component](process-services-cloud/start-process-cloud.component.md)
 -   [Start process cloud service](process-services-cloud/start-process-cloud.service.md)
 -   [Start task cloud component](process-services-cloud/start-task-cloud.component.md)
@@ -57,6 +58,7 @@ backend services have been tested with each released version of ADF.
 -   [Task header cloud component](process-services-cloud/task-header-cloud.component.md)
 -   [Task header cloud service](process-services-cloud/task-header-cloud.service.md)
 -   [Task list cloud component](process-services-cloud/task-list-cloud.component.md)
+-   [Task list cloud service](process-services-cloud/task-list-cloud.service.md)
 -   [Tree view component](content-services/tree-view.component.md)
 
 <!--v300 end-->

lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts

@@ -33,6 +33,11 @@ export class GroupCloudService {
         private logService: LogService
     ) {}
 
+    /**
+     * Finds groups filtered by name.
+     * @param searchParams Object containing the name filter string
+     * @returns List of group information
+     */
     findGroupsByName(searchParams: GroupSearchParam): Observable<any> {
         if (searchParams.name === '') {
             return of([]);
@@ -50,6 +55,11 @@ export class GroupCloudService {
         );
     }
 
+    /**
+     * Gets details for a specified group.
+     * @param groupId ID of the target group
+     * @returns Group details
+     */
     getGroupDetailsById(groupId: string) {
         const url = this.getGroupsApi() + '/' + groupId;
         const httpMethod = 'GET', pathParams = {}, queryParams = {}, bodyParam = {}, headerParams = {},
@@ -64,6 +74,12 @@ export class GroupCloudService {
         );
     }
 
+    /**
+     * Check that a group has one or more roles from the supplied list.
+     * @param groupId ID of the target group
+     * @param roleNames Array of role names
+     * @returns True if the group has one or more of the roles, false otherwise
+     */
     checkGroupHasRole(groupId: string, roleNames: string[]): Observable<boolean>  {
         return this.getGroupDetailsById(groupId).pipe(map((response: GroupModel) => {
             let availableGroupRoles = [];
@@ -84,6 +100,11 @@ export class GroupCloudService {
         }));
     }
 
+    /**
+     * Gets the client ID using the app name.
+     * @param applicationName Name of the app
+     * @returns client ID string
+     */
     getClientIdByApplicationName(applicationName: string): Observable<string> {
         const url = this.getApplicationIdApi();
         const httpMethod = 'GET', pathParams = {}, queryParams = {clientId: applicationName}, bodyParam = {}, headerParams = {}, formParams = {},
@@ -101,6 +122,12 @@ export class GroupCloudService {
             );
     }
 
+    /**
+     * Gets client roles.
+     * @param groupId ID of the target group
+     * @param clientId ID of the client
+     * @returns List of roles
+     */
     getClientRoles(groupId: string, clientId: string): Observable<any[]> {
         const url = this.groupClientRoleMappingApi(groupId, clientId);
         const httpMethod = 'GET', pathParams = {}, queryParams = {}, bodyParam = {}, headerParams = {},
@@ -113,6 +140,12 @@ export class GroupCloudService {
                 );
     }
 
+    /**
+     * Checks if a group has a client app.
+     * @param groupId ID of the target group
+     * @param clientId ID of the client
+     * @returns True if the group has the client app, false otherwise
+     */
     checkGroupHasClientApp(groupId: string, clientId: string): Observable<boolean> {
         return this.getClientRoles(groupId, clientId).pipe(
                     map((response: any[]) => {
@@ -125,6 +158,13 @@ export class GroupCloudService {
             );
     }
 
+    /**
+     * Check if a group has any of the client app roles in the supplied list.
+     * @param groupId ID of the target group
+     * @param clientId ID of the client
+     * @param roleNames Array of role names to check
+     * @returns True if the group has one or more of the roles, false otherwise
+     */
     checkGroupHasAnyClientAppRole(groupId: string, clientId: string, roleNames: string[]): Observable<boolean> {
         return this.getClientRoles(groupId, clientId).pipe(
             map((clientRoles: any[]) => {

lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts

@@ -30,6 +30,11 @@ export class ProcessListCloudService {
                 private logService: LogService) {
     }
 
+    /**
+     * Finds a process using an object with optional query properties.
+     * @param requestNode Query object
+     * @returns Process information
+     */
     getProcessByRequest(requestNode: ProcessQueryCloudRequestModel): Observable<any> {
         if (requestNode.appName) {
             let queryUrl = this.buildQueryUrl(requestNode);

lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts

@@ -32,6 +32,11 @@ export class TaskListCloudService {
     contentTypes = ['application/json'];
     accepts = ['application/json'];
 
+    /**
+     * Finds a task using an object with optional query properties.
+     * @param requestNode Query object
+     * @returns Task information
+     */
     getTaskByRequest(requestNode: TaskQueryCloudRequestModel): Observable<any> {
         if (requestNode.appName) {
             let queryUrl = this.buildQueryUrl(requestNode);

tools/doc/doctool.config.json

@@ -147,13 +147,16 @@
         "layout-container",
         "search-",
         "empty-custom-content",
+        "custom-empty-content",
         "view-util",
         "clipboard",
         "external-alfresco",
         "content-node-share",
         "tree-view",
         "dialog",
-        "[Cc]olumn"
+        "[Cc]olumn",
+        "app-details-cloud",
+        "dynamic-tab"
     ],
     "fileCheckerFilter": [
         "README",