Interface ITermSet

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Represents the set used in a term store. The set represents a unit which contains a collection of hierarchical terms. A group can contain multiple sets.

public interface ITermSet : IDataModel<ITermSet>, IDataModelParent, IDataModelWithContext, ISupportModules<ITermSet>, IDataModelGet<ITermSet>, IDataModelLoad<ITermSet>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel

Inherited Members

IDataModel<ITermSet>.Requested

IDataModel<ITermSet>.HasValue(string)

IDataModel<ITermSet>.HasChanged(string)

IDataModel<ITermSet>.IsPropertyAvailable(Expression<Func<ITermSet, object>>)

IDataModel<ITermSet>.ArePropertiesAvailable(params Expression<Func<ITermSet, object>>[])

IDataModel<ITermSet>.EnsureProperties(params Expression<Func<ITermSet, object>>[])

IDataModel<ITermSet>.EnsurePropertiesAsync(params Expression<Func<ITermSet, object>>[])

IDataModel<ITermSet>.ExecuteRequestAsync(ApiRequest)

IDataModel<ITermSet>.ExecuteRequest(ApiRequest)

IDataModel<ITermSet>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<ITermSet>.ExecuteRequestBatch(ApiRequest)

IDataModel<ITermSet>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<ITermSet>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IDataModelGet<ITermSet>.GetBatchAsync(Batch, params Expression<Func<ITermSet, object>>[])

IDataModelGet<ITermSet>.GetAsync(params Expression<Func<ITermSet, object>>[])

IDataModelLoad<ITermSet>.LoadBatchAsync(Batch, params Expression<Func<ITermSet, object>>[])

IDataModelLoad<ITermSet>.LoadAsync(params Expression<Func<ITermSet, object>>[])

IDataModelUpdate.UpdateBatchAsync()

IDataModelUpdate.UpdateBatchAsync(Batch)

IDataModelUpdate.UpdateAsync()

IDataModelUpdate.UpdateBatch()

IDataModelUpdate.UpdateBatch(Batch)

IDataModelUpdate.Update()

IDataModelDelete.DeleteBatchAsync()

IDataModelDelete.DeleteBatchAsync(Batch)

IDataModelDelete.DeleteAsync()

IDataModelDelete.DeleteBatch()

IDataModelDelete.DeleteBatch(Batch)

IDataModelDelete.Delete()

Extension Methods

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<string, string>, Action<Dictionary<string, string>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<string, string>>)

Properties

CreatedDateTime

Date and time of term set creation. Read-only.

DateTimeOffset CreatedDateTime { get; }

Property Value

DateTimeOffset

Description

Description giving details on the term set.

string Description { get; set; }

Property Value

string

Group

The parent group for this termset

ITermGroup Group { get; }

Property Value

ITermGroup

Id

The Unique ID of the term set.

string Id { get; }

Property Value

string

LocalizedNames

Name of the term set for each language.

ITermSetLocalizedNameCollection LocalizedNames { get; }

Property Value

ITermSetLocalizedNameCollection

Properties

Properties on this term set

ITermSetPropertyCollection Properties { get; }

Property Value

ITermSetPropertyCollection

Relations

Collection of terms relations

ITermRelationCollection Relations { get; }

Property Value

ITermRelationCollection

Terms

Collection of term in this term set Implements IQueryable<T>.
See Requesting model collections and IQueryable performance considerations to learn more.

ITermCollection Terms { get; }

Property Value

ITermCollection

Methods

AddLocalizedName(string, string)

Adds a new localized termset name. Call update to persist this change.

void AddLocalizedName(string name, string languageTag)

Parameters

name string

Termset label

languageTag string

Language the label is in

AddProperty(string, string)

Adds a property to the term set's property collection. Call update to persist this change.

void AddProperty(string key, string value)

Parameters

key string

Property key

value string

Property value

AddPropertyAsync(string, string)

Adds a property to the term set's property collection. Call update to persist this change.

Task AddPropertyAsync(string key, string value)

Parameters

key string

Property key

value string

Property value

Returns

Task

GetTermsByCustomProperty(string, string, bool)

Gets all terms with this property.

IList<ITerm> GetTermsByCustomProperty(string key, string value, bool trimUnavailable = false)

Parameters

key string

Property key

value string

Property value

trimUnavailable bool

Trim unavailable terms

Returns

IList<ITerm>

GetTermsByCustomPropertyAsync(string, string, bool)

Gets all terms with this property.

Task<IList<ITerm>> GetTermsByCustomPropertyAsync(string key, string value, bool trimUnavailable = false)

Parameters

key string

Property key

value string

Property value

trimUnavailable bool

Trim unavailable terms

Returns

Task<IList<ITerm>>