ConceptService
Top level api object from which all other api modules are available. ConceptService class
A Service class filled with utility functions for Concept items and enhanced data loading. ConceptService is accessed through the writer
Available operations to register callback handlers
getPropertyMap() ⇒ object
object
Get loaded property map
Returns: object
- PropertyMap
on(conceptType, operation, handler)
Function to register handlers for specific ConceptType operations
Parameters
Example
off(conceptType, operation, handler)
Function to remove registered handler
Parameters
Example
has(conceptType, operation) ⇒ boolean
boolean
Function to check if a specific conceptType has a registered handler for a specific operation
Returns: boolean
- if a handler has been registered
Parameters
Example
trigger(operation, conceptItem)
Function to trigger registered handler for conceptType operations
Parameters
Example
getArticleConceptByUUID(uuid)
Get article concept by uuid
Parameters
getArticleConceptsByType(conceptType, multipleTypes, subtypes) ⇒ array
array
Get concepts of a specific type, currently in the article
Returns: array
- ConceptItems
Parameters
addArticleConcept(conceptItem, triggerDocumentChanged)
Add concept link to article
Parameters
addArticleConcepts(conceptItems, triggerDocumentChanged)
Add an array of concept links to article
Parameters
updateArticleChannelRel(conceptItem)
Update concept rel
Parameters
updateArticleConcept(conceptItem, triggerDocumentChanged)
Update existing concept link in article
Parameters
~~removeArticleConceptItem() ~~
Deprecated
removeArticleConcept(conceptItem)
Remove concept link from article
Parameters
removeArticleConcepts(conceptItems)
Remove an array of concept links from article
Parameters
removeAllArticleLinksOfType(conceptType)
Remove all links of a specific type from the article
Parameters
extractBroaderText(conceptItem, [truncated]) ⇒ string
string
Recursive function to extract n number of parent names
Returns: string
- Broader names combine
Parameters
getConceptItemXml(conceptItem) ⇒ string
string
Get the actual concept XML from storage
Returns: string
- XML response
Parameters
getConceptItemConfigJson(conceptItem)
Get the concept type config, cached or remote
Parameters
createConceptItemXml(xml)
Create a new concept item in storage
Parameters
updateConceptItemXml(uuid, xml)
Update the actual concept item in storage
Parameters
fetchConceptItemProperties(conceptItem, string) ⇒ object
object
fetch remaining props (not stored on the article) from oc
Returns: object
- conceptItem
Parameters
Example
searchForConceptSuggestions(args, conceptTypes, term, subtypes, associatedWith, allowedStatuses, customQuery) ⇒ array
array
Search for concepts
Returns: array
- response An array with result objects
Parameters
Example
search(query) ⇒ array
array
A search Concept function Will use submitted query to search for items with contenttype concept
Returns: array
- searchResult
Parameters
getRemoteConceptsByType(conceptType) ⇒ array
array
Get concepts from remote storage by concept-type
Returns: array
- array of concepts with matching type
Parameters
getGroupConcepts(groupType, includeConceptsWithoutGroup)
Get all concept-groups by group-type (subType), optionally include all concepts of subtype, that does not have an associated group
Parameters
Last updated