mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
[ADF-1586] Added Content Services doc files (#2683)
This commit is contained in:
committed by
Eugenio Romano
parent
dae7cbfc90
commit
a2ee8dbfcf
46
docs/tag.service.md
Normal file
46
docs/tag.service.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Tag service
|
||||
|
||||
Manages tags in Content Services.
|
||||
|
||||
## Methods
|
||||
|
||||
`getTagsByNodeId(nodeId: string): any`<br/>
|
||||
Gets a list of tags added to a node.
|
||||
|
||||
`getAllTheTags()`<br/>
|
||||
Gets a list of all the tags already defined in the repository.
|
||||
|
||||
`addTag(nodeId: string, tagName: string): any`<br/>
|
||||
Adds a tag to a node.
|
||||
|
||||
`removeTag(nodeId: string, tag: string): any`<br/>
|
||||
Removes a tag from a node.
|
||||
|
||||
## Details
|
||||
|
||||
Content Services supports
|
||||
[tagging](http://docs.alfresco.com/5.2/tasks/site-content-tag.html)
|
||||
of file and folder nodes to assist with searches. A tag is a short
|
||||
text string added to an item, rather like a hashtag in social media.
|
||||
|
||||
Usually, it is wise to let the user see a list of existing tags and let
|
||||
them choose one by clicking. If they type a tag name with incorrect spelling
|
||||
then it will be treated as a new tag, even though that was not intended.
|
||||
Use `getAllTheTags` to find all tags in the repository when you need to
|
||||
construct a list like this.
|
||||
|
||||
See the
|
||||
[Tags API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagsApi.md)
|
||||
in the Alfresco JS API for more information about the types returned by Tag
|
||||
service methods and for the implementation of the REST API the service is
|
||||
based on.
|
||||
|
||||
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
|
||||
<!-- seealso start -->
|
||||
## See also
|
||||
|
||||
- [Tag list component](tag-list.component.md)
|
||||
<!-- seealso end -->
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user