mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2847] Added class members heading to core docs (#3260)
This commit is contained in:
committed by
Eugenio Romano
parent
9b78fcb445
commit
71ee4cf028
@@ -37,6 +37,8 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
|
|||||||
</adf-login>
|
</adf-login>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
|
@@ -8,7 +8,9 @@ Shows a notification message with optional feedback.
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
- `openSnackMessage(message: string, millisecondsDuration?: number): MatSnackBarRef<any>`
|
- `openSnackMessage(message: string, millisecondsDuration?: number): MatSnackBarRef<any>`
|
||||||
Opens a snackbar notification to show a message.
|
Opens a snackbar notification to show a message.
|
||||||
|
@@ -6,7 +6,9 @@ Status: Active
|
|||||||
|
|
||||||
Sets the page title.
|
Sets the page title.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
- `setTitle(value: string = '')`
|
- `setTitle(value: string = '')`
|
||||||
Sets the page title.
|
Sets the page title.
|
||||||
|
@@ -24,6 +24,8 @@ Adds pagination to the component it is used with.
|
|||||||
</adf-pagination>
|
</adf-pagination>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
|
@@ -2,7 +2,9 @@
|
|||||||
|
|
||||||
Accesses the Content Services Search API.
|
Accesses the Content Services Search API.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
`search(query: any): Observable<NodePaging>`<br/>
|
`search(query: any): Observable<NodePaging>`<br/>
|
||||||
Searches the repository.
|
Searches the repository.
|
||||||
|
@@ -6,7 +6,9 @@ Status: Active
|
|||||||
|
|
||||||
Provides fine control of parameters to a search.
|
Provides fine control of parameters to a search.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
`generateQueryBody(searchTerm: string, maxResults: string, skipCount: string): QueryBody`<br/>
|
`generateQueryBody(searchTerm: string, maxResults: string, skipCount: string): QueryBody`<br/>
|
||||||
Generates a QueryBody object with custom search parameters.
|
Generates a QueryBody object with custom search parameters.
|
||||||
|
@@ -6,7 +6,9 @@ Status: Active
|
|||||||
|
|
||||||
Finds shared links to Content Services items.
|
Finds shared links to Content Services items.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
- `getSharedLinks(options: any = {}): Observable<NodePaging>`
|
- `getSharedLinks(options: any = {}): Observable<NodePaging>`
|
||||||
Gets shared links available to the current user.
|
Gets shared links available to the current user.
|
||||||
|
@@ -26,6 +26,8 @@ Displays a sidebar-action menu information panel.
|
|||||||
</adf-sidebar-action-menu>
|
</adf-sidebar-action-menu>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
|
@@ -8,7 +8,9 @@ Last reviewed: 2018-03-21
|
|||||||
|
|
||||||
Accesses and manipulates sites from a Content Services repository.
|
Accesses and manipulates sites from a Content Services repository.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
- `getSites(opts: any = {}): Observable<SitePaging>`
|
- `getSites(opts: any = {}): Observable<SitePaging>`
|
||||||
Gets a list of all sites in the repository.
|
Gets a list of all sites in the repository.
|
||||||
|
@@ -17,6 +17,8 @@ Displays the Start Form for a process.
|
|||||||
</adf-start-form>
|
</adf-start-form>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
|
@@ -6,7 +6,9 @@ Status: Active
|
|||||||
|
|
||||||
Stores items in the form of key-value pairs.
|
Stores items in the form of key-value pairs.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
- `getItem(key: string): string`
|
- `getItem(key: string): string`
|
||||||
Gets an item.
|
Gets an item.
|
||||||
|
@@ -14,6 +14,8 @@ Implements text field input masks.
|
|||||||
<input [textMask]="{mask: mask, isReversed: isMaskReversed}">
|
<input [textMask]="{mask: mask, isReversed: isMaskReversed}">
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
|
@@ -8,7 +8,9 @@ Last reviewed: 2018-03-21
|
|||||||
|
|
||||||
Retrieves an SVG thumbnail image to represent a document type.
|
Retrieves an SVG thumbnail image to represent a document type.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
- `getDocumentThumbnailUrl(node: any): string`
|
- `getDocumentThumbnailUrl(node: any): string`
|
||||||
Gets a thumbnail URL for the given document node.
|
Gets a thumbnail URL for the given document node.
|
||||||
|
@@ -21,6 +21,8 @@ Simple container for headers, titles, actions and breadcrumbs.
|
|||||||
</adf-toolbar>
|
</adf-toolbar>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
|
@@ -6,7 +6,9 @@ Status: Active
|
|||||||
|
|
||||||
Supports localisation.
|
Supports localisation.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
- `addTranslationFolder(name: string = '', path: string = '')`
|
- `addTranslationFolder(name: string = '', path: string = '')`
|
||||||
Adds a new folder of translation source files.
|
Adds a new folder of translation source files.
|
||||||
|
@@ -12,6 +12,8 @@ Shows user information.
|
|||||||
<adf-userinfo></adf-userinfo>
|
<adf-userinfo></adf-userinfo>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Class members
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Default value | Description |
|
| Name | Type | Default value | Description |
|
||||||
|
@@ -8,7 +8,9 @@ Last reviewed: 2018-04-16
|
|||||||
|
|
||||||
Stores preferences for components.
|
Stores preferences for components.
|
||||||
|
|
||||||
## Methods
|
## Class members
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
- `get(property: string, defaultValue?: string): string`
|
- `get(property: string, defaultValue?: string): string`
|
||||||
Gets a preference property.
|
Gets a preference property.
|
||||||
|
Reference in New Issue
Block a user