mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
a7cdcbf7b9
* [ADF-3551] Updated docs plus minor ToC tool fix * [ADF-3551] Updated docs and JSDocs * [ADF-3551] Updated docs and JSDocs
57 lines
2.3 KiB
Markdown
57 lines
2.3 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-09-13
|
|
---
|
|
|
|
# Node Service
|
|
|
|
Gets Alfresco Repository node metadata and creates nodes with metadata.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **createNode**(name: `string`, nodeType: `string`, properties: `any`, path: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Create a new Node from form metadata
|
|
- _name:_ `string` - Node name
|
|
- _nodeType:_ `string` - Node type
|
|
- _properties:_ `any` - Node body properties
|
|
- _path:_ `string` - Path to the node
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - The created node
|
|
- **createNodeMetadata**(nodeType: `string`, nameSpace: `any`, data: `any`, path: `string`, name?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Create a new Node from form metadata.
|
|
- _nodeType:_ `string` - Node type
|
|
- _nameSpace:_ `any` - Namespace for properties
|
|
- _data:_ `any` - Property data to store in the node under namespace
|
|
- _path:_ `string` - Path to the node
|
|
- _name:_ `string` - (Optional) Node name
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - The created node
|
|
- **getNodeMetadata**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../lib/core/form/models/node-metadata.model.ts)`>`<br/>
|
|
Get the metadata and the nodeType for a nodeId cleaned by the prefix.
|
|
- _nodeId:_ `string` - ID of the target node
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeMetadata`](../../lib/core/form/models/node-metadata.model.ts)`>` - Node metadata
|
|
|
|
## Details
|
|
|
|
Note that this service cannot be used to create nodes with content.
|
|
|
|
The `path` parameter to `createNode` and `createNodeMetadata` specifies an intermediate
|
|
path of folders to create between the root and the target node.
|
|
|
|
### Importing
|
|
|
|
```ts
|
|
import { NodeService } from '@alfresco/adf-core';
|
|
|
|
export class SomePageComponent implements OnInit {
|
|
|
|
constructor(private nodeService: NodeService) {
|
|
}
|
|
```
|
|
|
|
## See also
|
|
|
|
- [Nodes api service](nodes-api.service.md)
|
|
- [Deleted nodes api service](deleted-nodes-api.service.md)
|