[ADF-2847] Added class members heading to core docs (#3255)

This commit is contained in:
Andy Stark
2018-05-02 16:44:04 +01:00
committed by Eugenio Romano
parent 8037d4c76c
commit a9ab0af640
15 changed files with 36 additions and 6 deletions

View File

@@ -33,6 +33,8 @@ export class MyComponent implements OnInit {
} }
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@@ -6,7 +6,9 @@ Status: Active
Gets URLs and access info and creates folders in Content Services. Gets URLs and access info and creates folders in Content Services.
## Methods ## Class members
### Methods
`getDocumentThumbnailUrl(nodeId: any, attachment?: boolean, ticket?: string): string`<br/> `getDocumentThumbnailUrl(nodeId: any, attachment?: boolean, ticket?: string): string`<br/>
Gets a thumbnail URL for a node. Gets a thumbnail URL for a node.

View File

@@ -6,7 +6,9 @@ Status: Active
Gets information about the current Process Services user. Gets information about the current Process Services user.
## Methods ## Class members
### Methods
`getCurrentUserInfo(): Observable<BpmUserModel>`<br/> `getCurrentUserInfo(): Observable<BpmUserModel>`<br/>
Gets information about the current user. Gets information about the current user.

View File

@@ -17,6 +17,8 @@ Displays a configurable property list renderer.
</adf-card-view> </adf-card-view>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |

View File

@@ -56,6 +56,8 @@ In the component template use the comment list component:
</adf-comment-list> </adf-comment-list>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@@ -26,6 +26,8 @@ Displays comments from users involved in a specified task or content and allows
</adf-comments> </adf-comments>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@@ -8,7 +8,9 @@ Last reviewed: 2018-04-13
Accesses app-generated data objects via URLs and file downloads. Accesses app-generated data objects via URLs and file downloads.
## Methods ## Class members
### Methods
- `downloadBlob(blob: Blob, fileName: string)` - `downloadBlob(blob: Blob, fileName: string)`
Invokes content download for a Blob with a file name. Invokes content download for a Blob with a file name.

View File

@@ -123,6 +123,8 @@ export class DataTableDemo {
} }
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@@ -6,7 +6,9 @@ Status: Active
Gets a list of items a user has marked as their favorites. Gets a list of items a user has marked as their favorites.
## Methods ## Class members
### Methods
`getFavorites(personId: string, options?: any): Observable<NodePaging>`<br/> `getFavorites(personId: string, options?: any): Observable<NodePaging>`<br/>
Gets the favorites for a user. Gets the favorites for a user.

View File

@@ -18,6 +18,8 @@ that takes an instance of a `FormFieldModel`:
This component depends on the `FormRenderingService` to map the `FormFieldModel` to a Form Field UI component This component depends on the `FormRenderingService` to map the `FormFieldModel` to a Form Field UI component
based on the field type or the metadata information. based on the field type or the metadata information.
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@@ -14,6 +14,8 @@ Shows APS forms as a list.
</adf-form-list> </adf-form-list>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@@ -6,7 +6,9 @@ Status: Active
Maps an APS form field type string onto the corresponding form widget component type. Maps an APS form field type string onto the corresponding form widget component type.
## Methods ## Class members
### Methods
- `getComponentTypeResolver(type: string, defaultValue: Type<{}> = this.defaultValue): DynamicComponentResolveFunction` - `getComponentTypeResolver(type: string, defaultValue: Type<{}> = this.defaultValue): DynamicComponentResolveFunction`
Gets the currently active ComponentTypeResolver function for a field type. Gets the currently active ComponentTypeResolver function for a field type.

View File

@@ -35,6 +35,8 @@ Shows a Form from APS
</adf-form> </adf-form>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@@ -6,7 +6,9 @@ Status: Active
Adds HTML to a string to highlight chosen sections. Adds HTML to a string to highlight chosen sections.
## Methods ## Class members
### Methods
- `highlight(text: string, search: string, wrapperClass: string = 'highlight'): HightlightTransformResult` - `highlight(text: string, search: string, wrapperClass: string = 'highlight'): HightlightTransformResult`
Searches for `search` string(s) within `text` and highlights all occurrences. Searches for `search` string(s) within `text` and highlights all occurrences.

View File

@@ -15,6 +15,8 @@ Validates the URLs for ACS and APS and saves them in the user's local storage
</adf-breadcrumb> </adf-breadcrumb>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |