Share via


TaxonomySession members

Wraps all of the associated TermStore objects for an Site object.

The TaxonomySession type exposes the following members.

Constructors

  Name Description
Public method TaxonomySession Initializes a new instance of a TaxonomySession object.

Top

Properties

  Name Description
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property ObjectVersion Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property OfflineTermStoreNames Gets a StringCollection of names of TermStore objects that are currently offline.
Public property Path Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property TermStores A collection of TermStore objects that are associated with the SPWebApplication object of the current SPSite object.
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)

Top

Methods

  Name Description
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method GetDefaultKeywordsTermStore Gets the TermStore object to be used for keywords
Public method GetDefaultSiteCollectionTermStore Gets the TermStore object to be used for metadata that are specific to the site collection, such as column-specific TermSet objects.
Public methodStatic member GetTaxonomySession This method retrieves a TaxonomySession object for performing taxonomy-related operations.
Public method GetTerm Gets a Term object that is based on Term IDs. If the current Term belongs to multiple TermSet objects, it will arbitrarily return the Term from one of the TermSet objects.
Public method GetTerms Gets Term objects for the current TaxonomySession object.
Public method GetTermsById Gets a set of Term objects based on Term IDs. If a Term is part of more than one TermSet object, it will arbitrarily return the Term object from one of the TermSet objects.
Public method GetTermSetsByName Gets all TermSet objects from all TermStore objects that have a name in the specified language.
Public method GetTermSetsByTermLabel Gets all of the TermSet objects from all of the TermStore objects that contain Term objects with matching LCID specific labels for all specified strings.
Public method GetTermsInDefaultLanguage Searches Label objects in the Microsoft.SharePoint.Client.Taxonomy.TermStore objects’ default language, and returns Term objects that are not scoped to a Site object from all TermSet objects, in all TermStore objects that contain a Label object that matches the provided string.
Public method GetTermsInWorkingLocale Searches Label objects in the TermStore working language, and returns Term objects from all TermSet objects, which are not scoped to a Site object, from all TermStore objects with a Label matching the provided string.
Public method GetTermsWithCustomProperty Gets Term objects with custom properties for the current TaxonomySession object.
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitOnePropertyFromJson (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method ToString (Inherited from Object.)
Public method UpdateCache Forces the taxonomy cache to communicate with the Managed Metadata Service to check for changes to any taxonomy objects.
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)

Top

See also

Reference

TaxonomySession class

Microsoft.SharePoint.Client.Taxonomy namespace