inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-26 17:24:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/content-services/tag.service.md
Andy Stark 3ba72f00f8 [ADF-3551] Updates for doc review (#3784) 
* [ADF-3551] Updated doc comments

* [ADF-3551] Updated doc comments

* [ADF-3551] Doc files updated with new doc comments
2018-09-13 12:59:57 +01:00

2.2 KiB
Raw Blame History

Added, Status, Last reviewed
Added Status Last reviewed
v2.0.0 Active 2018-04-05

Tag service

Manages tags in Content Services.

Class members

Methods

  • addTag(nodeId: string, tagName: string): any
    Adds a tag to a node.
    • nodeId: string - ID of the target node
    • tagName: string - Name of the tag to add
    • Returns any - TagEntry object (defined in JSAPI) with details of the new tag
  • getAllTheTags(opts?: any): Observable<TagPaging>
    Gets a list of all the tags already defined in the repository.
    • opts: any - (Optional) Options supported by JSAPI
    • Returns Observable<TagPaging> - TagPaging object (defined in JSAPI) containing the tags
  • getTagsByNodeId(nodeId: string): any
    Gets a list of tags added to a node.
    • nodeId: string - ID of the target node
    • Returns any - TagPaging object (defined in JSAPI) containing the tags
  • removeTag(nodeId: string, tag: string): any
    Removes a tag from a node.
    • nodeId: string - ID of the target node
    • tag: string - Name of the tag to remove
    • Returns any - Null object when the operation completes

Details

Content Services supports tagging 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 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.

See also