mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Updated folder structure of core docs (#4415)
* [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Manual fixes to core doc file links * [ADF-4152] Further automatic + manual link tidying
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
285e56e9fb
commit
5fc05da7aa
27
docs/core/models/bpm-user.model.md
Normal file
27
docs/core/models/bpm-user.model.md
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
Title: Bpm User model
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [Bpm User model](../../../lib/core/userinfo/models/bpm-user.model.ts "Defined in bpm-user.model.ts")
|
||||
|
||||
Contains information about a Process Services user.
|
||||
|
||||
## Details
|
||||
|
||||
Instances of this class are returned by the methods of the
|
||||
[Bpm User service](../services/bpm-user.service.md). It implements the
|
||||
[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/UserRepresentation.md) interface, which is defined in the
|
||||
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserRepresentation.md).
|
||||
|
||||
Note that the Typescript class for this model is in active development;
|
||||
it is likely to change and so its properties are not listed here. For the
|
||||
latest version of the class, see the
|
||||
[source file](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/userinfo/models/bpm-user.model.ts).
|
||||
|
||||
## See also
|
||||
|
||||
- [Bpm user service](../services/bpm-user.service.md)
|
||||
- [Ecm user model](ecm-user.model.md)
|
||||
- [People process service](../services/people-process.service.md)
|
||||
27
docs/core/models/ecm-user.model.md
Normal file
27
docs/core/models/ecm-user.model.md
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
Title: Ecm User model
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [Ecm User model](../../../lib/core/userinfo/models/ecm-user.model.ts "Defined in ecm-user.model.ts")
|
||||
|
||||
Contains information about a Content Services user.
|
||||
|
||||
## Details
|
||||
|
||||
Instances of this class are returned by the methods of the
|
||||
[Ecm User service](../services/ecm-user.service.md). It implements the `Person`
|
||||
interface, which is defined in the
|
||||
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/Person.md).
|
||||
|
||||
Note that the Typescript class for this model is in active development;
|
||||
it is likely to change and so its properties are not listed here. For the
|
||||
latest version of the class, see the
|
||||
[source file](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/userinfo/models/ecm-user.model.ts).
|
||||
|
||||
## See also
|
||||
|
||||
- [Ecm user service](../services/ecm-user.service.md)
|
||||
- [People content service](../services/people-content.service.md)
|
||||
- [Bpm user model](bpm-user.model.md)
|
||||
102
docs/core/models/form-field.model.md
Normal file
102
docs/core/models/form-field.model.md
Normal file
@@ -0,0 +1,102 @@
|
||||
---
|
||||
Title: Form Field model
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-03-20
|
||||
---
|
||||
|
||||
# [Form Field model](../../../lib/core/form/components/widgets/core/form-field.model.ts "Defined in form-field.model.ts")
|
||||
|
||||
Contains the value and metadata for a field of a [`Form`](../../../lib/process-services/task-list/models/form.model.ts) component.
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ---- | ---- | ------- | ----------- |
|
||||
| id | string | | Field ID |
|
||||
| name | string | | Field name |
|
||||
| type | string | | Field type (see [Form Rendering service](../services/form-rendering.service.md) for a list of available type strings) |
|
||||
| value | any | | Field value (implemented by get/set) |
|
||||
| readOnly | boolean | | Is this a read-only field? (Implemented by get/set) |
|
||||
| required | boolean | | Is the field required to have a value? (Implemented by get/set) |
|
||||
| isValid | boolean | | Does the field pass its validation checks? (Implemented by get/set) |
|
||||
| overrideId | boolean | | Should the auto-generated ID (from `name`) be overridden to let the user set a custom ID? |
|
||||
| tab | string | | Name of the current form tab |
|
||||
| rowspan | number | 1 | The number of container rows that the field spans |
|
||||
| colspan | number | 1 | The number of container columns that the field spans |
|
||||
| placeholder | string | null | Placeholder text shown before the field is edited |
|
||||
| minLength | number | 0 | Minimum allowed number of characters in input data |
|
||||
| maxLength | number | 0 | Maximum allowed number of characters in input data |
|
||||
| minValue | string | | Minimum allowed value (eg, for number or date) |
|
||||
| maxValue | string | | Minimum allowed value (eg, for number or date) |
|
||||
| regexPattern | string | | Regular expression that text data should match |
|
||||
| options | [`FormFieldOption`](../../../lib/core/form/components/widgets/core/form-field-option.ts)\[] | \[] | Option items for a dropdown menu |
|
||||
| restUrl | string | | URL for a REST call to populate a dropdown menu |
|
||||
| restResponsePath | string | | Path within REST response JSON to the array of dropdown data |
|
||||
| restIdProperty | string | | JSON property name to use for the `id` property of a dropdown item |
|
||||
| restLabelProperty | string | | JSON property name to use for the `label` property of a dropdown item |
|
||||
| hasEmptyValue | boolean | | Is the field's value empty? (eg, dropdown with no item selected) |
|
||||
| className | string | | CSS class name for the field |
|
||||
| optionType | string | | |
|
||||
| params | [`FormFieldMetadata`](../../../lib/core/form/components/widgets/core/form-field-metadata.ts) | {} | |
|
||||
| hyperlinkUrl | string | | URL for Hyperlink widgets |
|
||||
| displayText | string | | Displayed text for Hyperlink widgets |
|
||||
| isVisible | boolean | true | Is the field shown on the form? |
|
||||
| visibilityCondition | [`WidgetVisibilityModel`](../../../lib/core/form/models/widget-visibility.model.ts) | null | Defines a expression that determines whether the field is visible or not, based on its logical relation to values in other fields |
|
||||
| enableFractions | boolean | false | Are numeric values allowed to contain a decimal point? |
|
||||
| currency | string | null | Currency symbol for Amount widgets |
|
||||
| dateDisplayFormat | string | | Date/time display format template |
|
||||
| numberOfColumns | number | 1 | Number of columns defined by a container field |
|
||||
| fields | [`FormFieldModel`](../../core/models/form-field.model.md)\[] | \[] | Fields contained within a container field |
|
||||
| columns | [`ContainerColumnModel`](../../../lib/core/form/components/widgets/core/container-column.model.ts)\[] | \[] | Column definitions for a container field |
|
||||
| emptyOption | [`FormFieldOption`](../../../lib/core/form/components/widgets/core/form-field-option.ts) | | Dropdown menu item to use when no option is chosen |
|
||||
| validationSummary | string | | Error/information message added during field validation (see [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) interface) |
|
||||
|
||||
## Details
|
||||
|
||||
Every field of a form has an associated [`FormFieldModel`](../../core/models/form-field.model.md) instance that contains the
|
||||
field's value and metadata. The standard widgets use this information to render fields and you can also make use of it in your own custom widgets and field validators.
|
||||
|
||||
### Custom widgets
|
||||
|
||||
You will need to use the properties of [`FormFieldModel`](../../core/models/form-field.model.md) if you want to implement your own
|
||||
custom widgets. Aside from the `value` property (which contains the data value entered into
|
||||
the field), there are also a few other fields that are used for specific types of data. For
|
||||
example, the `currency` property holds the currency symbol to be displayed next to the value
|
||||
(such as the dollar sign $) and the `dateDisplayFormat` defines how the elements of a date/time will be arranged. See the [Form Extensibility and Customization](../../user-guide/extensibility.md) for more information about creating custom widgets.
|
||||
|
||||
### Validation
|
||||
|
||||
A [`Form`](../../../lib/process-services/task-list/models/form.model.ts) or [Task Details](../../process-services/components/task-details.component.md) component can
|
||||
be supplied with a set of validator objects. Each validator applies a particular kind of
|
||||
check to a field. A number of [`FormFieldModel`](../../core/models/form-field.model.md) properties are used by validators. For
|
||||
example, `minValue` and `maxValue` are used to check that a numeric value falls within an
|
||||
allowed range and `regexPattern` defines a regular expression that a text field should
|
||||
match. Also, the `validationSummary` is used to send a message back from the validator
|
||||
for the user to read. See the [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) page for more information about implementing validators.
|
||||
|
||||
### REST properties
|
||||
|
||||
You can set the items shown on a dropdown menu using data returned by a REST call. The
|
||||
properties used by the call are:
|
||||
|
||||
- `restUrl`: The URL for the REST service
|
||||
- `restResponsePath`: Optional path to an array within the JSON object returned by
|
||||
the REST call. Each element in the array corresponds to an item on the dropdown.
|
||||
- `restIdProperty`: The name of a JSON property present in each element of the array
|
||||
selected by `restResponsePath`. Its value will be used for the `id` property of the
|
||||
dropdown item.
|
||||
`restLabelProperty`: The name of a JSON property present in each element of the array
|
||||
selected by `restResponsePath`. Its value will be used for the `label` property of the
|
||||
dropdown item (ie, the text visible to the user).
|
||||
|
||||
The [REST Call Task 101](https://community.alfresco.com/community/bpm/blog/2016/08/31/rest-integration-101)
|
||||
tutorial on the [APS community site](https://community.alfresco.com/community/bpm)
|
||||
contains full details about how the REST calls work, along with a worked example.
|
||||
|
||||
## See also
|
||||
|
||||
- [Extensibility](../../user-guide/extensibility.md)
|
||||
- [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)
|
||||
- [Form rendering service](../services/form-rendering.service.md)
|
||||
- [Form component](../components/form.component.md)
|
||||
78
docs/core/models/product-version.model.md
Normal file
78
docs/core/models/product-version.model.md
Normal file
@@ -0,0 +1,78 @@
|
||||
---
|
||||
Title: Product Version model
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [Product Version model](../../../lib/core/models/product-version.model.ts "Defined in product-version.model.ts")
|
||||
|
||||
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](../services/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;
|
||||
}
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Discovery api service](../services/discovery-api.service.md)
|
||||
24
docs/core/models/user-process.model.md
Normal file
24
docs/core/models/user-process.model.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
Title: User Process model
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# [User Process model](../../../lib/core/models/user-process.model.ts "Defined in user-process.model.ts")
|
||||
|
||||
Represents a Process Services user.
|
||||
|
||||
## Details
|
||||
|
||||
This class contains basic information about a Process Services user and
|
||||
is used throughout ADF to identify and list users (eg, to assign them to
|
||||
a task or to list them in search results).
|
||||
|
||||
Note that the Typescript class for this model is in active development;
|
||||
it is likely to change and so its properties are not listed here. For the
|
||||
latest version of the class, see the
|
||||
[source file](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/models/user-process.model.ts).
|
||||
|
||||
## See also
|
||||
|
||||
- [People process service](../services/people-process.service.md)
|
||||
Reference in New Issue
Block a user