Interface ITerm

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Represents a term used in a term store. A term can be used to represent an object which can then be used as a metadata to tag conent. Multiple terms can be organized in a hierarchical manner within a set.

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

Inherited Members

IDataModel<ITerm>.Requested

IDataModel<ITerm>.HasValue(string)

IDataModel<ITerm>.HasChanged(string)

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

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

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

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

IDataModel<ITerm>.ExecuteRequestAsync(ApiRequest)

IDataModel<ITerm>.ExecuteRequest(ApiRequest)

IDataModel<ITerm>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<ITerm>.ExecuteRequestBatch(ApiRequest)

IDataModel<ITerm>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<ITerm>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

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

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

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

IDataModelLoad<ITerm>.LoadAsync(params Expression<Func<ITerm, 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

Descriptions

Name of the term set for each language.

ITermLocalizedDescriptionCollection Descriptions { get; }

Property Value

ITermLocalizedDescriptionCollection

Id

The Unique ID of the term.

string Id { get; }

Property Value

string

Labels

Name of the term set for each language.

ITermLocalizedLabelCollection Labels { get; }

Property Value

ITermLocalizedLabelCollection

LastModifiedDateTime

Last date and time of term modification. Read-only.

DateTimeOffset LastModifiedDateTime { get; }

Property Value

DateTimeOffset

Properties

Properties on this term set

ITermPropertyCollection Properties { get; }

Property Value

ITermPropertyCollection

Relations

Collection of terms relations

ITermRelationCollection Relations { get; }

Property Value

ITermRelationCollection

Set

The term set of this term

[SuppressMessage("Naming", "CA1716:Identifiers should not match keywords", Justification = "<Pending>")]
ITermSet Set { get; }

Property Value

ITermSet

Terms

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

ITermCollection Terms { get; }

Property Value

ITermCollection

Methods

AddLabelAndDescription(string, string, bool, string)

Adds a term label and optional description for a given language. Call update to persist this change.

void AddLabelAndDescription(string label, string languageTag, bool isDefault = false, string description = null)

Parameters

label string

Label for the term

languageTag string

Language tag for the label and description

isDefault bool

Will this be the default label?

description string

Optional description to set

AddProperty(string, string)

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

void AddProperty(string key, string value)

Parameters

key string

Property key

value string

Property value