mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2557] Updated docs with new props script (#3149)
* [ADF-2557] Updated docs for services with new props script * [ADF-2557] Updated service docs with new props script
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
8769c257f8
commit
1d517d3a8a
@@ -1,48 +1,63 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-04-05
|
||||
---
|
||||
|
||||
# Document List service
|
||||
|
||||
Implements node operations used by the Document List component.
|
||||
|
||||
## Methods
|
||||
## Class members
|
||||
|
||||
- `deleteNode(nodeId: string): Observable<any>`
|
||||
Deletes a node.
|
||||
- `nodeId` - ID of the node to delete
|
||||
- `copyNode(nodeId: string, targetParentId: string): any`
|
||||
Copy a node to destination node
|
||||
- `nodeId` - The id of the node to be copied
|
||||
- `targetParentId` - The id of the folder where the node will be copied
|
||||
- `moveNode(nodeId: string, targetParentId: string): any`
|
||||
Move a node to destination node
|
||||
- `nodeId` - The id of the node to be moved
|
||||
- `targetParentId` - The id of the folder where the node will be moved
|
||||
- `createFolder(name: string, parentId: string): Observable<MinimalNodeEntity>`
|
||||
Create a new folder in the path.
|
||||
- `name` - Folder name
|
||||
- `parentId` - Parent folder ID
|
||||
- `getFolder(folder: string, opts?: any): any`
|
||||
Gets the folder node with the specified relative name path below the root node.
|
||||
- `folder` - Path to folder.
|
||||
- `opts` - (Optional) Options.
|
||||
- `getFolderNode(nodeId: string): Promise<MinimalNodeEntryEntity>`
|
||||
Gets a folder node via its node ID.
|
||||
- `nodeId` - ID of the folder node
|
||||
- `getDocumentThumbnailUrl(node: MinimalNodeEntity): any`
|
||||
Get thumbnail URL for the given document node.
|
||||
- `node` - Node to get URL for.
|
||||
- `getMimeTypeIcon(mimeType: string): string`
|
||||
Gets the icon that represents a MIME type.
|
||||
- `mimeType` - MIME type to get the icon for
|
||||
- `getDefaultMimeTypeIcon(): string`
|
||||
Gets a default icon for MIME types with no specific icon.
|
||||
### Methods
|
||||
|
||||
- `hasPermission(node: any, permission: PermissionsEnum|string): boolean`
|
||||
Checks if a node has the specified permission.
|
||||
- `node` - Target node
|
||||
- `permission` - Permission level to query
|
||||
- `copyNode(nodeId: string = null, targetParentId: string = null): any`<br/>
|
||||
Copy a node to destination node
|
||||
- `nodeId: string = null` - The id of the node to be copied
|
||||
- `targetParentId: string = null` - The id of the folder where the node will be copied
|
||||
- **Returns** `any` - NodeEntry for the copied node
|
||||
- `createFolder(name: string = null, parentId: string = null): Observable<MinimalNodeEntity>`<br/>
|
||||
Create a new folder in the path.
|
||||
- `name: string = null` - Folder name
|
||||
- `parentId: string = null` - Parent folder ID
|
||||
- **Returns** `Observable<MinimalNodeEntity>` - Details of the created folder node
|
||||
- `deleteNode(nodeId: string = null): Observable<any>`<br/>
|
||||
Deletes a node.
|
||||
- `nodeId: string = null` - ID of the node to delete
|
||||
- **Returns** `Observable<any>` - Empty response when the operation is complete
|
||||
- `getDefaultMimeTypeIcon(): string`<br/>
|
||||
Gets a default icon for MIME types with no specific icon.
|
||||
- **Returns** `string` - Path to the icon file
|
||||
- `getDocumentThumbnailUrl(node: MinimalNodeEntity = null): string`<br/>
|
||||
Get thumbnail URL for the given document node.
|
||||
- `node: MinimalNodeEntity = null` - Node to get URL for.
|
||||
- **Returns** `string` - Thumbnail URL string
|
||||
- `getFolder(folder: string = null, opts?: any = null, includeFields: string[] = []): Observable<NodePaging>`<br/>
|
||||
Gets the folder node with the specified relative name path below the root node.
|
||||
- `folder: string = null` - Path to folder.
|
||||
- `opts?: any = null` - (Optional) Options.
|
||||
- `includeFields: string[] = []` - Extra information to include (available options are "aspectNames", "isLink" and "association")
|
||||
- **Returns** `Observable<NodePaging>` - Details of the folder
|
||||
- `getFolderNode(nodeId: string = null, includeFields: string[] = []): Promise<MinimalNodeEntryEntity>`<br/>
|
||||
Gets a folder node via its node ID.
|
||||
- `nodeId: string = null` - ID of the folder node
|
||||
- `includeFields: string[] = []` - Extra information to include (available options are "aspectNames", "isLink" and "association")
|
||||
- **Returns** `Promise<MinimalNodeEntryEntity>` - Details of the folder
|
||||
- `getMimeTypeIcon(mimeType: string = null): string`<br/>
|
||||
Gets the icon that represents a MIME type.
|
||||
- `mimeType: string = null` - MIME type to get the icon for
|
||||
- **Returns** `string` - Path to the icon file
|
||||
- `hasPermission(node: any = null, permission: PermissionsEnum | string = null): boolean`<br/>
|
||||
Checks if a node has the specified permission.
|
||||
- `node: any = null` - Target node
|
||||
- `permission: PermissionsEnum | string = null` - Permission level to query
|
||||
- **Returns** `boolean` - True if the node has the permission, false otherwise
|
||||
- `moveNode(nodeId: string = null, targetParentId: string = null): any`<br/>
|
||||
Move a node to destination node
|
||||
- `nodeId: string = null` - The id of the node to be moved
|
||||
- `targetParentId: string = null` - The id of the folder where the node will be moved
|
||||
- **Returns** `any` - NodeEntry for the moved node
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -1,23 +1,30 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-04-05
|
||||
---
|
||||
|
||||
# Folder Actions service
|
||||
|
||||
Implements the folder menu actions for the Document List component.
|
||||
|
||||
## Methods
|
||||
## Class members
|
||||
|
||||
- `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
|
||||
### Methods
|
||||
|
||||
- `canExecuteAction(obj: any = null): boolean`<br/>
|
||||
Checks if an action is available for a particular item.
|
||||
- `obj: any = null` - Item to check
|
||||
- **Returns** `boolean` - True if the action is available, false otherwise
|
||||
- `getHandler(key: string = null): ContentActionHandler`<br/>
|
||||
Gets the handler function for an action.
|
||||
- `key: string = null` - Identifier for the action
|
||||
- **Returns** `ContentActionHandler` - The handler function
|
||||
- `setHandler(key: string = null, handler: ContentActionHandler = null): boolean`<br/>
|
||||
Sets a new handler function for an action.
|
||||
- `key: string = null` - Identifier for the action
|
||||
- `handler: ContentActionHandler = null` - The new handler function
|
||||
- **Returns** `boolean` - True if the key was a valid action identifier, false otherwise
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -1,27 +1,34 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-04-05
|
||||
---
|
||||
|
||||
# Tag service
|
||||
|
||||
Manages tags in Content Services.
|
||||
|
||||
## Methods
|
||||
## Class members
|
||||
|
||||
- `getTagsByNodeId(nodeId: string): any`
|
||||
Gets a list of tags added to a node.
|
||||
- `nodeId` - ID of the target node
|
||||
- `getAllTheTags(): any`
|
||||
Gets a list of all the tags already defined in the repository.
|
||||
### Methods
|
||||
|
||||
- `addTag(nodeId: string, tagName: string): any`
|
||||
Adds a tag to a node.
|
||||
- `nodeId` - ID of the target node
|
||||
- `tagName` - Name of the tag to add
|
||||
- `removeTag(nodeId: string, tag: string): any`
|
||||
Removes a tag from a node.
|
||||
- `nodeId` - ID of the target node
|
||||
- `tag` - Name of the tag to remove
|
||||
- `addTag(nodeId: string = null, tagName: string = null): any`<br/>
|
||||
Adds a tag to a node.
|
||||
- `nodeId: string = null` - ID of the target node
|
||||
- `tagName: string = null` - Name of the tag to add
|
||||
- **Returns** `any` - TagEntry object (defined in JSAPI) with details of the new tag
|
||||
- `getAllTheTags(): any`<br/>
|
||||
Gets a list of all the tags already defined in the repository.
|
||||
- **Returns** `any` - TagPaging object (defined in JSAPI) containing the tags
|
||||
- `getTagsByNodeId(nodeId: string = null): any`<br/>
|
||||
Gets a list of tags added to a node.
|
||||
- `nodeId: string = null` - ID of the target node
|
||||
- **Returns** `any` - TagPaging object (defined in JSAPI) containing the tags
|
||||
- `removeTag(nodeId: string = null, tag: string = null): any`<br/>
|
||||
Removes a tag from a node.
|
||||
- `nodeId: string = null` - ID of the target node
|
||||
- `tag: string = null` - Name of the tag to remove
|
||||
- **Returns** `any` - Null object when the operation completes
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
Reference in New Issue
Block a user