Interface ITermRelation

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Represents the relationship between terms in a term store.Currently two types of relationships are supported: pin and reuse.

In a pin relationship, a term can be pinned under a different term in a different term set.In a pinned relationship, new children to the term can only be added in the term set in which the term was created.Any change in the hierarchy under the term is reflected across the sets in which the term was pinned.

The reuse relationship is similar to the pinned relationship except that changes to the reused term can be made from any hierarchy in which the term is reused.Also, a change in hierarchy made to the reused term does not get reflected in the other term sets in which the term is reused.

public interface ITermRelation : IDataModel<ITermRelation>, IDataModelParent, IDataModelWithContext, ISupportModules<ITermRelation>, IDataModelGet<ITermRelation>, IDataModelLoad<ITermRelation>, IQueryableDataModel

Inherited Members

IDataModel<ITermRelation>.Requested

IDataModel<ITermRelation>.HasValue(string)

IDataModel<ITermRelation>.HasChanged(string)

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

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

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

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

IDataModel<ITermRelation>.ExecuteRequestAsync(ApiRequest)

IDataModel<ITermRelation>.ExecuteRequest(ApiRequest)

IDataModel<ITermRelation>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<ITermRelation>.ExecuteRequestBatch(ApiRequest)

IDataModel<ITermRelation>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<ITermRelation>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

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

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

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

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

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

FromTerm

The from term of the relation. The term from which the relationship is defined. A null value would indicate the relation is directly with the set.

ITerm FromTerm { get; }

Property Value

ITerm

Id

The Unique ID of the term relation.

string Id { get; }

Property Value

string

Relationship

The type of relation. Possible values are: pin, reuse.

TermRelationType Relationship { get; set; }

Property Value

TermRelationType

Set

The set in which the relation is relevant.

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

Property Value

ITermSet

ToTerm

The to term of the relation. The term to which the realtionship is defined.

ITerm ToTerm { get; }

Property Value

ITerm