Interface ITermRelationCollection

Collection of terms

Inherited Members

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface ITermRelationCollection : IDataModelCollection<ITermRelation>, IDataModelParent, IDataModelWithContext, IRequestableCollection, ISupportModules<ITermRelationCollection>

Methods

Add(TermRelationType, ITermSet, ITerm)

Adds a new term relation

Declaration

ITermRelation Add(TermRelationType relationship, ITermSet targetSet, ITerm fromTerm = null)

Parameters

TermRelationType relationship Type of relation to be created. Possible values are: pin, reuse.

ITermSet targetSet The set where the relationship needs to be created.

ITerm fromTerm The term with which the relationship needs to be created.

Returns

ITermRelation Newly added term relation ship

AddAsync(TermRelationType, ITermSet, ITerm)

Adds a new term relation

Declaration

Task<ITermRelation> AddAsync(TermRelationType relationship, ITermSet targetSet, ITerm fromTerm = null)

Parameters

TermRelationType relationship Type of relation to be created. Possible values are: pin, reuse.

ITermSet targetSet The set where the relationship needs to be created.

ITerm fromTerm The term with which the relationship needs to be created.

Returns

Task<ITermRelation> Newly added term relation ship

AddBatch(TermRelationType, ITermSet, ITerm)

Adds a new term relation via a batch request

Declaration

ITermRelation AddBatch(TermRelationType relationship, ITermSet targetSet, ITerm fromTerm = null)

Parameters

TermRelationType relationship Type of relation to be created. Possible values are: pin, reuse.

ITermSet targetSet The set where the relationship needs to be created.

ITerm fromTerm The term with which the relationship needs to be created.

Returns

ITermRelation Newly added term relation ship

AddBatch(Batch, TermRelationType, ITermSet, ITerm)

Adds a new term relation via a batch request

Declaration

ITermRelation AddBatch(Batch batch, TermRelationType relationship, ITermSet targetSet, ITerm fromTerm = null)

Parameters

Batch batch Batch to use

TermRelationType relationship Type of relation to be created. Possible values are: pin, reuse.

ITermSet targetSet The set where the relationship needs to be created.

ITerm fromTerm The term with which the relationship needs to be created.

Returns

ITermRelation Newly added term relation ship

AddBatchAsync(TermRelationType, ITermSet, ITerm)

Adds a new term relation via a batch request

Declaration

Task<ITermRelation> AddBatchAsync(TermRelationType relationship, ITermSet targetSet, ITerm fromTerm = null)

Parameters

TermRelationType relationship Type of relation to be created. Possible values are: pin, reuse.

ITermSet targetSet The set where the relationship needs to be created.

ITerm fromTerm The term with which the relationship needs to be created.

Returns

Task<ITermRelation> Newly added term relation ship

AddBatchAsync(Batch, TermRelationType, ITermSet, ITerm)

Adds a new term relation via a batch request

Declaration

Task<ITermRelation> AddBatchAsync(Batch batch, TermRelationType relationship, ITermSet targetSet, ITerm fromTerm = null)

Parameters

Batch batch Batch to use

TermRelationType relationship Type of relation to be created. Possible values are: pin, reuse.

ITermSet targetSet The set where the relationship needs to be created.

ITerm fromTerm The term with which the relationship needs to be created.

Returns

Task<ITermRelation> Newly added term relation ship

Extension Methods

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

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

QueryableExtensions.AsRequested<TSource>(IDataModelCollection<TSource>)