mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1586] Added Core services docs (#2587)
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
3c7122ddab
commit
3fa2dee3a0
@@ -236,11 +236,11 @@ for more information about installing and using the source code.
|
||||
- [Info drawer component](info-drawer.component.md)
|
||||
- [Language menu component](language-menu.component.md)
|
||||
- [Pagination component](pagination.component.md)
|
||||
- [Host settings component](host-settings.component.md)
|
||||
- [Toolbar divider component](toolbar-divider.component.md)
|
||||
- [Toolbar title component](toolbar-title.component.md)
|
||||
- [Toolbar component](toolbar.component.md)
|
||||
- [Card view component](card-view.component.md)
|
||||
- [Host settings component](host-settings.component.md)
|
||||
- [*Infinite pagination component](../ng2-components/ng2-alfresco-core/src/components/pagination/infinite-pagination.component.ts)
|
||||
|
||||
### Directives
|
||||
@@ -256,6 +256,8 @@ for more information about installing and using the source code.
|
||||
|
||||
### Models
|
||||
|
||||
- [Comment process model](comment-process.model.md)
|
||||
- [Product version model](product-version.model.md)
|
||||
- [Site model](site.model.md)
|
||||
|
||||
### Pipes
|
||||
@@ -274,8 +276,10 @@ for more information about installing and using the source code.
|
||||
- [Apps process service](apps-process.service.md)
|
||||
- [Authentication service](authentication.service.md)
|
||||
- [Card view update service](card-view-update.service.md)
|
||||
- [Comment process service](comment-process.service.md)
|
||||
- [Cookie service](cookie.service.md)
|
||||
- [Deleted nodes api service](deleted-nodes-api.service.md)
|
||||
- [Discovery api service](discovery-api.service.md)
|
||||
- [Highlight transform service](highlight-transform.service.md)
|
||||
- [Log service](log.service.md)
|
||||
- [Nodes api service](nodes-api.service.md)
|
||||
@@ -288,15 +292,11 @@ for more information about installing and using the source code.
|
||||
- [Translation service](translation.service.md)
|
||||
- [Upload service](upload.service.md)
|
||||
- [User preferences service](user-preferences.service.md)
|
||||
- [*Context menu service](../ng2-components/ng2-alfresco-core/src/components/context-menu/context-menu.service.ts)
|
||||
- [*Alfresco content service](../ng2-components/ng2-alfresco-core/src/services/alfresco-content.service.ts)
|
||||
- [*Alfresco settings service](../ng2-components/ng2-alfresco-core/src/services/alfresco-settings.service.ts)
|
||||
- [*Auth guard bpm service](../ng2-components/ng2-alfresco-core/src/services/auth-guard-bpm.service.ts)
|
||||
- [*Auth guard ecm service](../ng2-components/ng2-alfresco-core/src/services/auth-guard-ecm.service.ts)
|
||||
- [*Auth guard service](../ng2-components/ng2-alfresco-core/src/services/auth-guard.service.ts)
|
||||
- [*Comment process service](../ng2-components/ng2-alfresco-core/src/services/comment-process.service.ts)
|
||||
- [*Content service](../ng2-components/ng2-alfresco-core/src/services/content.service.ts)
|
||||
- [*Discovery api service](../ng2-components/ng2-alfresco-core/src/services/discovery-api.service.ts)
|
||||
- [*Favorites api service](../ng2-components/ng2-alfresco-core/src/services/favorites-api.service.ts)
|
||||
- [*People content service](../ng2-components/ng2-alfresco-core/src/services/people-content.service.ts)
|
||||
- [*People process service](../ng2-components/ng2-alfresco-core/src/services/people-process.service.ts)
|
||||
|
||||
27
docs/comment-process.model.md
Normal file
27
docs/comment-process.model.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Comment Process model
|
||||
|
||||
Represents a comment added to a Process Services task or process instance.
|
||||
|
||||
## Details
|
||||
|
||||
Instances of this class are returned by the methods of the
|
||||
[Comment Process service](comment-process.service.md). See the Comments API
|
||||
methods in the
|
||||
[Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api)
|
||||
for more information.
|
||||
|
||||
```ts
|
||||
class CommentProcessModel implements CommentRepresentation {
|
||||
id: number;
|
||||
message: string;
|
||||
created: Date;
|
||||
createdBy: LightUserRepresentation;
|
||||
}
|
||||
```
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Comment process service](comment-process.service.md)
|
||||
<!-- seealso end -->
|
||||
34
docs/comment-process.service.md
Normal file
34
docs/comment-process.service.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Comment Process service
|
||||
|
||||
Adds and retrieves comments for task and process instances in Process Services.
|
||||
|
||||
## Methods
|
||||
|
||||
`addTaskComment(taskId: string, message: string): Observable<CommentProcessModel>`<br/>
|
||||
Adds a comment to a task.
|
||||
|
||||
`getTaskComments(taskId: string): Observable<CommentProcessModel[]>`<br/>
|
||||
Gets all comments that have been added to a task.
|
||||
|
||||
`addProcessInstanceComment(processInstanceId: string, message: string): Observable<CommentProcessModel>`<br/>
|
||||
Adds a comment to a process instance.
|
||||
|
||||
`getProcessInstanceComments(processInstanceId: string): Observable<CommentProcessModel[]>`<br/>
|
||||
Gets all comments that have been added to a process instance.
|
||||
|
||||
## Details
|
||||
|
||||
See the [Comment Process model](comment-process.model.md) for more information about the
|
||||
comments returned by the methods of this service. Also, the Comments API section of the
|
||||
[Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api)
|
||||
has further details about the underlying REST API.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Comment process model](comment-process.model.md)
|
||||
<!-- seealso end -->
|
||||
|
||||
|
||||
|
||||
29
docs/discovery-api.service.md
Normal file
29
docs/discovery-api.service.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Discovery Api service
|
||||
|
||||
Gets version and license information for Process Services and Content Services.
|
||||
|
||||
## Methods
|
||||
|
||||
`public getEcmProductInfo(): Observable<EcmProductVersionModel>`<br/>
|
||||
Gets product information for Content Services.
|
||||
|
||||
`public getBpmProductInfo(): Observable<BpmProductVersionModel>`<br/>
|
||||
Gets product information for Process Services.
|
||||
|
||||
## Details
|
||||
|
||||
The product license and version information is returned using the
|
||||
classes defined in the [Product Version model](product-version.model.md).
|
||||
See the
|
||||
[Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-discovery-rest-api)
|
||||
to learn more about the REST API used by this service.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Product version model](product-version.model.md)
|
||||
<!-- seealso end -->
|
||||
|
||||
|
||||
|
||||
75
docs/product-version.model.md
Normal file
75
docs/product-version.model.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# Product Version model
|
||||
|
||||
Contains version and license information classes for Alfresco products.
|
||||
|
||||
## Details
|
||||
|
||||
The classes in this model contain details about the version and license
|
||||
status of Process Services and Content Services. You can access this
|
||||
information from ADF using the [Discovery Api service](discovery-api.service.md).
|
||||
See also the
|
||||
[Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-discovery-rest-api)
|
||||
to learn more about the REST architecture that the service is based on.
|
||||
|
||||
```ts
|
||||
class BpmProductVersionModel {
|
||||
edition: string;
|
||||
majorVersion: string;
|
||||
revisionVersion: string;
|
||||
minorVersion: string;
|
||||
type: string;
|
||||
}
|
||||
|
||||
class EcmProductVersionModel {
|
||||
edition: string;
|
||||
version: VersionModel;
|
||||
license: LicenseModel;
|
||||
status: VersionStatusModel;
|
||||
modules: VersionModuleModel[] = [];
|
||||
}
|
||||
|
||||
class VersionModel {
|
||||
major: string;
|
||||
minor: string;
|
||||
patch: string;
|
||||
hotfix: string;
|
||||
schema: number;
|
||||
label: string;
|
||||
display: string;
|
||||
}
|
||||
|
||||
class LicenseModel {
|
||||
issuedAt: string;
|
||||
expiresAt: string;
|
||||
remainingDays: number;
|
||||
holder: string;
|
||||
mode: string;
|
||||
isClusterEnabled: boolean;
|
||||
isCryptodocEnabled: boolean;
|
||||
}
|
||||
|
||||
class VersionStatusModel {
|
||||
isReadOnly: boolean;
|
||||
isAuditEnabled: boolean;
|
||||
isQuickShareEnabled: boolean;
|
||||
isThumbnailGenerationEnabled: boolean;
|
||||
}
|
||||
|
||||
class VersionModuleModel {
|
||||
id: string;
|
||||
title: string;
|
||||
description: string;
|
||||
version: string;
|
||||
installDate: string;
|
||||
installState: string;
|
||||
versionMin: string;
|
||||
versionMax: string;
|
||||
}
|
||||
```
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Discovery api service](discovery-api.service.md)
|
||||
<!-- seealso end -->
|
||||
@@ -15,6 +15,8 @@
|
||||
"card-view-update.service": [],
|
||||
"checklist.component": [],
|
||||
"comments.component": [],
|
||||
"comment-process.model": [],
|
||||
"comment-process.service": ["comment-process.model"],
|
||||
"content-action.component": ["document-list.component", "document-actions.service", "folder-actions.service"],
|
||||
"content.widget": [],
|
||||
"context-menu.directive": [],
|
||||
@@ -29,6 +31,7 @@
|
||||
"DataTableAdapter": ["datatable.component", "task-list.component"],
|
||||
"deleted-nodes-api.service": [],
|
||||
"diagram.component": [],
|
||||
"discovery-api.service": ["product-version.model"],
|
||||
"document-actions.service": [],
|
||||
"document-library.model": [],
|
||||
"document-list.component": [
|
||||
@@ -82,6 +85,7 @@
|
||||
"process-instance-header.component": [],
|
||||
"process-instance-tasks.component": [],
|
||||
"process-list.component": [],
|
||||
"product-version.model": [],
|
||||
"rating.component": ["like.component"],
|
||||
"renditions.service": [],
|
||||
"search-control.component": ["search.component"],
|
||||
|
||||
@@ -15,5 +15,7 @@
|
||||
"login-header.directive",
|
||||
"no-task-detail-template",
|
||||
"diagram",
|
||||
"raphael"
|
||||
"raphael",
|
||||
"context-menu",
|
||||
"alfresco-settings"
|
||||
]
|
||||
Reference in New Issue
Block a user