SP.Taxonomy.TermStore object (sp.taxonomy)

  • Article

Represents a store that contains metadata within child SP.Taxonomy.TermGroup object (sp.taxonomy) objects, SP.Taxonomy.TermSet object (sp.taxonomy) objects, and SP.Taxonomy.Term object (sp.taxonomy) objects.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.Taxonomy.TermStore()

Members

The TermStore object has the following members.

Constructor

The TermStore object has the following constructor.

Constructor

Description

TermStore

Initializes a new instance of the SP.Taxonomy.TermStore object (sp.taxonomy) object.

Methods

The TermStore object has the following methods.

Method

Description

addLanguage

Adds a working language to the SP.Taxonomy.TermStore object (sp.taxonomy) object.

commitAll

Commits all updates to the database that have occurred since the last update or rollback.

createGroup

Creates a new SP.Taxonomy.TermGroup object (sp.taxonomy) object in this SP.Taxonomy.TermStore object (sp.taxonomy).

deleteLanguage

Deletes a working language from the SP.Taxonomy.TermStore object (sp.taxonomy) object.

getChanges

Gets a list of changes to the SP.Taxonomy.TermStore object (sp.taxonomy) object.

getGroup

Represents a store that contains metadata within child SP.Taxonomy.TermGroup object (sp.taxonomy) objects, SP.Taxonomy.TermSet object (sp.taxonomy) objects, and SP.Taxonomy.Term object (sp.taxonomy) objects.

getSiteCollectionGroup

Returns the associated site collection group for the SP.Site object (sp.js) object.

getTerm

Gets a Term based on its ID.

getTermInTermSet

Gets a SP.Taxonomy.Term object (sp.taxonomy) object that is based on the ID of the SP.Taxonomy.TermSet object (sp.taxonomy) object and the ID of the term.

getTerms

Gets more than one specified SP.Taxonomy.Term object (sp.taxonomy) object from the term store.

getTermsById

Gets more than one specified SP.Taxonomy.TermStore.getTerms Method (sp.taxonomy) object from the term store.

getTermSet

Retrieves a TermSet object based on a TermSet ID.

getTermSetsByName

Retrieves by name a SP.Taxonomy.TermSetCollection object (sp.taxonomy) object.

getTermSetsByTermLabel

Retrieves by label a SP.Taxonomy.TermSetCollection object (sp.taxonomy) object.

getTermSetsWithCustomProperty

Retrieves by custom property a SP.Taxonomy.TermSetCollection object (sp.taxonomy) object.

getTermsWithCustomProperty

Gets by custom property a SP.Taxonomy.TermCollection object (sp.taxonomy) object.

rollbackAll

Discards all updates that have occurred since the last commit or rollback.

updateCache

Forces the taxonomy cache to communicate with the managed metadata service to check for changes to any taxonomy objects in a SP.Taxonomy.TermStore object (sp.taxonomy).

updateUsedTermsOnSite

This method makes sure that the current SP.Taxonomy.TermStore object (sp.taxonomy) object is aware of all child SP.Taxonomy.Term object (sp.taxonomy) objects that are used in the requested site collection.

Properties

The TermStore object has the following properties.

Property

Description

contentTypePublishingHub

Gets the URI of the SP.Site object (sp.js) object used as the content type syndication hub, if it exists.

defaultLanguage

Gets the LCID of the default working language for the current SP.Taxonomy.TermStore object (sp.taxonomy) object.

groups

Gets a collection of SP.Taxonomy.TermGroup object (sp.taxonomy) objects from the term store.

hashTagsTermSet

Gets the hash tags term set for a SP.Taxonomy.TermStore object (sp.taxonomy) object that contains a set of # tags.

id

Gets the unique identifier of the SP.Taxonomy.TermStore object (sp.taxonomy) object.

isOnline

Indicates whether this term store is currently online (available).

keywordsTermSet

Gets the SP.Taxonomy.TermSet object (sp.taxonomy) object for this SP.Taxonomy.TermStore object (sp.taxonomy) object.

languages

Gets an integer collection of LCIDs.

name

Gets the name of the current SP.Taxonomy.TermStore object (sp.taxonomy) object.

orphanedTermsTermSet

Gets the SP.Taxonomy.TermSet object (sp.taxonomy) for this SP.Taxonomy.TermStore object (sp.taxonomy) that contains the set of Orphaned Term objects.

systemGroup

Gets the SP.Taxonomy.TermGroup object (sp.taxonomy) object for this SP.Taxonomy.TermStore object (sp.taxonomy) object that contains the set of System TermSets (Keywords and Orphaned Terms).

workingLanguage

Gets the current working language for the SP.Taxonomy.TermStore object (sp.taxonomy) object.