[ADF-1769] Added JSDocs to services (#2937)

* [ADF-1769] Added JSDocs to services

* Removed JSDoc return directives from doc comments
This commit is contained in:
Andy Stark
2018-02-13 22:44:47 +00:00
committed by Eugenio Romano
parent b3955b3f6c
commit 68ded23c9a
10 changed files with 331 additions and 63 deletions
+13
View File
@@ -2,6 +2,19 @@
Implements the folder menu actions for the Document List component.
## Methods
- `getHandler(key: string): ContentActionHandler`
Gets the handler function for an action.
- `key` - Identifier for the action
- `setHandler(key: string, handler: ContentActionHandler): boolean`
Sets a new handler function for an action.
- `key` - Identifier for the action
- `handler` - The new handler function
- `canExecuteAction(obj: any): boolean`
Checks if an action is available for a particular item.
- `obj` - Item to check
## Details
This service implements the built-in actions that can be applied to a folder