mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
[ADF-1586] Added Core services docs (#2582)
This commit is contained in:
Andy Stark
Eugenio Romano
parent
092e07c545
commit
c17abc4344
@ -78,90 +78,6 @@ for more information about installing and using the source code.
|
||||
### Components
|
||||
|
||||
- [Diagram component](diagram.component.md)
|
||||
- [*Diagram alfresco publish task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-alfresco-publish-task.component.ts)
|
||||
- [*Diagram box publish task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-box-publish-task.component.ts)
|
||||
- [*Diagram business rule task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-business-rule-task.component.ts)
|
||||
- [*Diagram camel task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-camel-task.component.ts)
|
||||
- [*Diagram container service task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-container-service-task.component.ts)
|
||||
- [*Diagram google drive publish task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-google-drive-publish-task.component.ts)
|
||||
- [*Diagram manual task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-manual-task.component.ts)
|
||||
- [*Diagram mule task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-mule-task.component.ts)
|
||||
- [*Diagram receive task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-receive-task.component.ts)
|
||||
- [*Diagram rest call task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-rest-call-task.component.ts)
|
||||
- [*Diagram script task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-script-task.component.ts)
|
||||
- [*Diagram send task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-send-task.component.ts)
|
||||
- [*Diagram service task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-service-task.component.ts)
|
||||
- [*Diagram task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-task.component.ts)
|
||||
- [*Diagram user task component](../ng2-components/ng2-activiti-diagrams/src/components/activities/diagram-user-task.component.ts)
|
||||
- [*Diagram boundary event component](../ng2-components/ng2-activiti-diagrams/src/components/boundary-events/diagram-boundary-event.component.ts)
|
||||
- [*Diagram throw event component](../ng2-components/ng2-activiti-diagrams/src/components/boundary-events/diagram-throw-event.component.ts)
|
||||
- [*Diagram sequence flow component](../ng2-components/ng2-activiti-diagrams/src/components/diagram-sequence-flow.component.ts)
|
||||
- [*Diagram end event component](../ng2-components/ng2-activiti-diagrams/src/components/events/diagram-end-event.component.ts)
|
||||
- [*Diagram event component](../ng2-components/ng2-activiti-diagrams/src/components/events/diagram-event.component.ts)
|
||||
- [*Diagram start event component](../ng2-components/ng2-activiti-diagrams/src/components/events/diagram-start-event.component.ts)
|
||||
- [*Diagram event gateway component](../ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-event-gateway.component.ts)
|
||||
- [*Diagram exclusive gateway component](../ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-exclusive-gateway.component.ts)
|
||||
- [*Diagram gateway component](../ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-gateway.component.ts)
|
||||
- [*Diagram inclusive gateway component](../ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-inclusive-gateway.component.ts)
|
||||
- [*Diagram parallel gateway component](../ng2-components/ng2-activiti-diagrams/src/components/gateways/diagram-parallel-gateway.component.ts)
|
||||
- [*Diagram container icon event component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-container-icon-event.component.ts)
|
||||
- [*Diagram icon alfresco publish task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-alfresco-publish-task.component.ts)
|
||||
- [*Diagram icon box publish task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-box-publish-task.component.ts)
|
||||
- [*Diagram icon business rule task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-business-rule-task.component.ts)
|
||||
- [*Diagram icon camel task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-camel-task.component.ts)
|
||||
- [*Diagram icon error component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-error.component.ts)
|
||||
- [*Diagram icon google drive publish task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-google-drive-publish-task.component.ts)
|
||||
- [*Diagram icon manual task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-manual-task.component.ts)
|
||||
- [*Diagram icon message component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-message.component.ts)
|
||||
- [*Diagram icon mule task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-mule-task.component.ts)
|
||||
- [*Diagram icon receive task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-receive-task.component.ts)
|
||||
- [*Diagram icon rest call task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-rest-call-task.component.ts)
|
||||
- [*Diagram icon script task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-script-task.component.ts)
|
||||
- [*Diagram icon send task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-send-task.component.ts)
|
||||
- [*Diagram icon service task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-service-task.component.ts)
|
||||
- [*Diagram icon signal component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-signal.component.ts)
|
||||
- [*Diagram icon timer component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-timer.component.ts)
|
||||
- [*Diagram icon user task component](../ng2-components/ng2-activiti-diagrams/src/components/icons/diagram-icon-user-task.component.ts)
|
||||
- [*Diagram intermediate catching event component](../ng2-components/ng2-activiti-diagrams/src/components/intermediate-catching-events/diagram-intermediate-catching-event.component.ts)
|
||||
- [*Raphael icon alfresco publish component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-alfresco-publish.component.ts)
|
||||
- [*Raphael icon box publish component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-box-publish.component.ts)
|
||||
- [*Raphael icon business rule component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-business-rule.component.ts)
|
||||
- [*Raphael icon camel component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-camel.component.ts)
|
||||
- [*Raphael icon error component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-error.component.ts)
|
||||
- [*Raphael icon google drive publish component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-google-drive-publish.component.ts)
|
||||
- [*Raphael icon manual component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-manual.component.ts)
|
||||
- [*Raphael icon message component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-message.component.ts)
|
||||
- [*Raphael icon mule component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-mule.component.ts)
|
||||
- [*Raphael icon receive component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-receive.component.ts)
|
||||
- [*Raphael icon rest call component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-rest-call.component.ts)
|
||||
- [*Raphael icon script component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-script.component.ts)
|
||||
- [*Raphael icon send component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-send.component.ts)
|
||||
- [*Raphael icon service component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-service.component.ts)
|
||||
- [*Raphael icon signal component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-signal.component.ts)
|
||||
- [*Raphael icon timer component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-timer.component.ts)
|
||||
- [*Raphael icon user component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/icons/raphael-icon-user.component.ts)
|
||||
- [*Raphael circle component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-circle.component.ts)
|
||||
- [*Raphael cross component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-cross.component.ts)
|
||||
- [*Raphael flow arrow component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-flow-arrow.component.ts)
|
||||
- [*Raphael multiline text component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-multiline-text.component.ts)
|
||||
- [*Raphael pentagon component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-pentagon.component.ts)
|
||||
- [*Raphael plus component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-plus.component.ts)
|
||||
- [*Raphael rect component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-rect.component.ts)
|
||||
- [*Raphael rhombus component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-rhombus.component.ts)
|
||||
- [*Raphael text component](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael-text.component.ts)
|
||||
- [*Diagram event subprocess component](../ng2-components/ng2-activiti-diagrams/src/components/structural/diagram-event-subprocess.component.ts)
|
||||
- [*Diagram subprocess component](../ng2-components/ng2-activiti-diagrams/src/components/structural/diagram-subprocess.component.ts)
|
||||
- [*Diagram lane component](../ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-lane.component.ts)
|
||||
- [*Diagram lanes component](../ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-lanes.component.ts)
|
||||
- [*Diagram pool component](../ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-pool.component.ts)
|
||||
- [*Diagram pools component](../ng2-components/ng2-activiti-diagrams/src/components/swimlanes/diagram-pools.component.ts)
|
||||
- [*Diagram tooltip component](../ng2-components/ng2-activiti-diagrams/src/components/tooltip/diagram-tooltip.component.ts)
|
||||
|
||||
### Services
|
||||
|
||||
- [*Raphael service](../ng2-components/ng2-activiti-diagrams/src/components/raphael/raphael.service.ts)
|
||||
- [*Diagram color service](../ng2-components/ng2-activiti-diagrams/src/services/diagram-color.service.ts)
|
||||
- [*Diagrams service](../ng2-components/ng2-activiti-diagrams/src/services/diagrams.service.ts)
|
||||
<!-- ng2-activiti-diagrams end -->
|
||||
|
||||
[(Back to Contents)](#contents)
|
||||
@ -293,6 +209,7 @@ for more information about installing and using the source code.
|
||||
|
||||
### Models
|
||||
|
||||
- [Filter model](filter.model.md)
|
||||
- [Task details model](task-details.model.md)
|
||||
|
||||
### Services
|
||||
@ -354,15 +271,19 @@ for more information about installing and using the source code.
|
||||
|
||||
- [Alfresco api service](alfresco-api.service.md)
|
||||
- [App config service](app-config.service.md)
|
||||
- [Apps process service](apps-process.service.md)
|
||||
- [Authentication service](authentication.service.md)
|
||||
- [Card view update service](card-view-update.service.md)
|
||||
- [Cookie service](cookie.service.md)
|
||||
- [Deleted nodes api service](deleted-nodes-api.service.md)
|
||||
- [Highlight transform service](highlight-transform.service.md)
|
||||
- [Log service](log.service.md)
|
||||
- [Nodes api service](nodes-api.service.md)
|
||||
- [Notification service](notification.service.md)
|
||||
- [Page title service](page-title.service.md)
|
||||
- [Renditions service](renditions.service.md)
|
||||
- [Sites api service](sites-api.service.md)
|
||||
- [Storage service](storage.service.md)
|
||||
- [Thumbnail service](thumbnail.service.md)
|
||||
- [Translation service](translation.service.md)
|
||||
- [Upload service](upload.service.md)
|
||||
@ -370,22 +291,18 @@ for more information about installing and using the source code.
|
||||
- [*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)
|
||||
- [*Apps process service](../ng2-components/ng2-alfresco-core/src/services/apps-process.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)
|
||||
- [*Cookie service](../ng2-components/ng2-alfresco-core/src/services/cookie.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)
|
||||
- [*Page title service](../ng2-components/ng2-alfresco-core/src/services/page-title.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)
|
||||
- [*Search api service](../ng2-components/ng2-alfresco-core/src/services/search-api.service.ts)
|
||||
- [*Search service](../ng2-components/ng2-alfresco-core/src/services/search.service.ts)
|
||||
- [*Shared links api service](../ng2-components/ng2-alfresco-core/src/services/shared-links-api.service.ts)
|
||||
- [*Storage service](../ng2-components/ng2-alfresco-core/src/services/storage.service.ts)
|
||||
- [*Translate loader service](../ng2-components/ng2-alfresco-core/src/services/translate-loader.service.ts)
|
||||
<!-- ng2-alfresco-core end -->
|
||||
|
||||
|
||||
32
docs/apps-process.service.md
Normal file
32
docs/apps-process.service.md
Normal file
@ -0,0 +1,32 @@
|
||||
# Apps Process service
|
||||
|
||||
Gets details of the Process Services apps that are deployed for the user.
|
||||
|
||||
## Methods
|
||||
|
||||
`getDeployedApplications(): Observable<AppDefinitionRepresentation[]>`<br/>
|
||||
Gets a list of deployed apps for this user.
|
||||
|
||||
`getDeployedApplicationsByName(name: string): Observable<AppDefinitionRepresentation>`<br/>
|
||||
Gets a list of deployed apps for this user, where the app name is `name`.
|
||||
|
||||
`getApplicationDetailsById(appId: number): Observable<AppDefinitionRepresentation>`<br/>
|
||||
Get the details for a specific app ID number.
|
||||
|
||||
## 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.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Filter model](filter.model.md)
|
||||
<!-- seealso end -->
|
||||
29
docs/cookie.service.md
Normal file
29
docs/cookie.service.md
Normal file
@ -0,0 +1,29 @@
|
||||
# Cookie service
|
||||
|
||||
Stores key-value data items as browser cookies.
|
||||
|
||||
## Methods
|
||||
|
||||
`getItem(key: string): string | null` <br/>
|
||||
Gets an item identified by `key`.
|
||||
|
||||
` setItem(key: string, data: string, expiration: Date | null, path: string | null): void ` <br/>
|
||||
Stores an item under `key`.
|
||||
|
||||
## Details
|
||||
|
||||
This service uses browser [cookies](https://en.wikipedia.org/wiki/HTTP_cookie)
|
||||
to store data in the form of key-value pairs. An optional `expiration` date can be
|
||||
supplied for the cookie and a `path` can be used to reduce the chances of name
|
||||
clashes with cookies from other sources.
|
||||
|
||||
Cookies have a storage size limit that varies between browsers but is often around
|
||||
4KB. Consider using [web storage](storage.service.md) if you need to store data
|
||||
beyond this size.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Storage service](storage.service.md)
|
||||
<!-- seealso end -->
|
||||
72
docs/filter.model.md
Normal file
72
docs/filter.model.md
Normal file
@ -0,0 +1,72 @@
|
||||
# Filter model
|
||||
|
||||
Contains classes related to filters in Process Services.
|
||||
|
||||
## Details
|
||||
|
||||
You can find more information about the usage of these classes in the
|
||||
[APS Rest API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api)
|
||||
and in various ADF docs (see the [See Also](#see-also) section for links).
|
||||
|
||||
```ts
|
||||
class AppDefinitionRepresentationModel {
|
||||
defaultAppId: string;
|
||||
deploymentId: string;
|
||||
name: string;
|
||||
description: string;
|
||||
theme: string;
|
||||
icon: string;
|
||||
id: number;
|
||||
modelId: number;
|
||||
tenantId: number;
|
||||
}
|
||||
|
||||
class FilterParamsModel {
|
||||
id: string;
|
||||
name: string;
|
||||
index: number;
|
||||
}
|
||||
|
||||
class FilterRepresentationModel implements UserTaskFilterRepresentation {
|
||||
id: number;
|
||||
appId: number;
|
||||
name: string;
|
||||
recent: boolean;
|
||||
icon: string;
|
||||
filter: FilterParamRepresentationModel;
|
||||
index: number;
|
||||
}
|
||||
|
||||
class FilterParamRepresentationModel {
|
||||
processDefinitionId: string;
|
||||
processDefinitionKey: string;
|
||||
name: string;
|
||||
state: string;
|
||||
sort: string;
|
||||
assignment: string;
|
||||
dueAfter: Date;
|
||||
dueBefore: Date;
|
||||
}
|
||||
|
||||
class TaskQueryRequestRepresentationModel implements TaskQueryRequestRepresentation {
|
||||
appDefinitionId: string;
|
||||
processInstanceId: string;
|
||||
processDefinitionId: string;
|
||||
text: string;
|
||||
assignment: string;
|
||||
state: string;
|
||||
start: string;
|
||||
sort: string;
|
||||
page: number;
|
||||
size: number;
|
||||
}
|
||||
```
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Process filters component](process-filters.component.md)
|
||||
- [Task filters component](task-filters.component.md)
|
||||
- [Apps process service](apps-process.service.md)
|
||||
<!-- seealso end -->
|
||||
27
docs/page-title.service.md
Normal file
27
docs/page-title.service.md
Normal file
@ -0,0 +1,27 @@
|
||||
# Page Title service
|
||||
|
||||
Sets the page title.
|
||||
|
||||
## Methods
|
||||
|
||||
`setTitle(value: string = '')`<br/>
|
||||
Sets the page title.
|
||||
|
||||
## Details
|
||||
|
||||
If an application name is supplied in the app config file then this will
|
||||
be concatenated with the `value` parameter when `setTitle` is called, giving
|
||||
a result of the form "PageName - AppName" (see
|
||||
[App Config service](app-config.service.md) for more information). If `value`
|
||||
is not supplied then just the app name is used; this will default to
|
||||
"Alfresco ADF Application" when no app name set in the config file.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [App config service](app-config.service.md)
|
||||
<!-- seealso end -->
|
||||
|
||||
|
||||
|
||||
@ -2,22 +2,6 @@
|
||||
|
||||
Collection of criteria used to filter process instances, which may be customized by users.
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
* [Properties](#properties)
|
||||
* [Events](#events)
|
||||
- [Details](#details)
|
||||
* [How filter the activiti process filters](#how-filter-the-activiti-process-filters)
|
||||
* [FilterParamsModel](#filterparamsmodel)
|
||||
* [How to create an accordion menu with the processes filter](#how-to-create-an-accordion-menu-with-the-processes-filter)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
@ -82,4 +66,11 @@ You can use inside the filterParam one of the properties defined by [FilterParam
|
||||
### How to create an accordion menu with the processes filter
|
||||
|
||||
The process filter often works well as an item in an accordion menu. See the [Accordion component](accordion.component.md)
|
||||
page for an example of how to do set this up.
|
||||
page for an example of how to do set this up.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Filter model](filter.model.md)
|
||||
<!-- seealso end -->
|
||||
@ -8,6 +8,7 @@
|
||||
"angular-material-design": ["theming"],
|
||||
"app-config.service": [],
|
||||
"apps-list.component": [],
|
||||
"apps-process.service": ["filter.model"],
|
||||
"authentication.service": [],
|
||||
"breadcrumb.component": ["document-list.component"],
|
||||
"card-view.component": ["card-view-update.service"],
|
||||
@ -17,6 +18,7 @@
|
||||
"content-action.component": ["document-list.component", "document-actions.service", "folder-actions.service"],
|
||||
"content.widget": [],
|
||||
"context-menu.directive": [],
|
||||
"cookie.service": [],
|
||||
"create-process-attachment.component": [],
|
||||
"create-task-attachment.component": [],
|
||||
"data-column.component": ["document-list.component", "datatable.component", "task-list.component"],
|
||||
@ -41,6 +43,7 @@
|
||||
"dropdown-breadcrumb.component": ["document-list.component", "breadcrumb.component"],
|
||||
"extensibility": [],
|
||||
"file-uploading-dialog.component": [],
|
||||
"filter.model": ["process-filters.component", "task-filters.component"],
|
||||
"folder-actions.service": ["document-actions.service"],
|
||||
"form-list.component": [],
|
||||
"form-field.model": ["extensibility", "FormFieldValidator", "form-rendering.service"],
|
||||
@ -67,6 +70,7 @@
|
||||
"nodes-api.service": ["document-library.model", "deleted-nodes-api.service"],
|
||||
"notification.service": [],
|
||||
"pagination.component": [],
|
||||
"page-title.service": ["app-config.service"],
|
||||
"permissions-style.model": ["document-list.component"],
|
||||
"people-search.component": [],
|
||||
"people.component": [],
|
||||
@ -88,6 +92,7 @@
|
||||
"start-process.component": [],
|
||||
"start-task.component": [],
|
||||
"stencils": [],
|
||||
"storage.service": ["cookie.service"],
|
||||
"tag-actions.component": [],
|
||||
"tag-list.component": [],
|
||||
"tag-node-list.component": [],
|
||||
|
||||
40
docs/storage.service.md
Normal file
40
docs/storage.service.md
Normal file
@ -0,0 +1,40 @@
|
||||
# Storage service
|
||||
|
||||
Stores items in the form of key-value pairs.
|
||||
|
||||
## Methods
|
||||
|
||||
`getItem(key: string): string | null` <br/>
|
||||
Gets an item identified by `key`.
|
||||
|
||||
`setItem(key: string, data: string)` <br/>
|
||||
Stores an item under `key`.
|
||||
|
||||
`clear()` <br/>
|
||||
Removes all currently stored items.
|
||||
|
||||
`removeItem(key: string)` <br/>
|
||||
Removes the item identified by `key`.
|
||||
|
||||
`hasItem(key: string): boolean` <br/>
|
||||
Is any item currently stored under `key`?
|
||||
|
||||
## Details
|
||||
|
||||
The service will check to see if
|
||||
[web storage](https://developer.mozilla.org/en-US/docs/Web/API/Storage/LocalStorage)
|
||||
is available on the browser. If it is available then the service will use it to
|
||||
store the key-value items persistently. Web storage can be used in a similar way to
|
||||
[cookies](cookie.service.md) but with a much higher size limit (several MB for
|
||||
web storage compared to a few KB for cookies). However, cookies are
|
||||
more widely supported by browsers and can be set to expire after a certain date.
|
||||
|
||||
If local storage is not available then non-persistent memory storage within the app is
|
||||
used instead.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Cookie service](cookie.service.md)
|
||||
<!-- seealso end -->
|
||||
@ -2,22 +2,6 @@
|
||||
|
||||
Shows all available filters.
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
* [Properties](#properties)
|
||||
* [Events](#events)
|
||||
- [Details](#details)
|
||||
* [How filter the activiti task filters](#how-filter-the-activiti-task-filters)
|
||||
* [FilterParamsModel](#filterparamsmodel)
|
||||
* [How to create an accordion menu with the task filter](#how-to-create-an-accordion-menu-with-the-task-filter)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
@ -76,3 +60,10 @@ You can use inside the filterParam one of the properties from [FilterParamsModel
|
||||
|
||||
The task filter often works well as an item in an accordion menu. See the [Accordion component](accordion.component.md)
|
||||
page for an example of how to do set this up.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Filter model](filter.model.md)
|
||||
<!-- seealso end -->
|
||||
@ -13,5 +13,7 @@
|
||||
"card-view-content-proxy",
|
||||
"login-footer.directive",
|
||||
"login-header.directive",
|
||||
"no-task-detail-template"
|
||||
"no-task-detail-template",
|
||||
"diagram",
|
||||
"raphael"
|
||||
]
|
||||
Loading…
x
Reference in New Issue
Block a user