Interface ITermStore

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Microsoft 365 Term store

public interface ITermStore : IDataModel<ITermStore>, IDataModelParent, IDataModelWithContext, ISupportModules<ITermStore>, IDataModelGet<ITermStore>, IDataModelLoad<ITermStore>, IDataModelUpdate

Inherited Members

IDataModel<ITermStore>.Requested

IDataModel<ITermStore>.HasValue(string)

IDataModel<ITermStore>.HasChanged(string)

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

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

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

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

IDataModel<ITermStore>.ExecuteRequestAsync(ApiRequest)

IDataModel<ITermStore>.ExecuteRequest(ApiRequest)

IDataModel<ITermStore>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<ITermStore>.ExecuteRequestBatch(ApiRequest)

IDataModel<ITermStore>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<ITermStore>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

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

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

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

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

IDataModelUpdate.UpdateBatchAsync()

IDataModelUpdate.UpdateBatchAsync(Batch)

IDataModelUpdate.UpdateAsync()

IDataModelUpdate.UpdateBatch()

IDataModelUpdate.UpdateBatch(Batch)

IDataModelUpdate.Update()

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

DefaultLanguage

Default language of the termstore.

string DefaultLanguage { get; set; }

Property Value

string

Groups

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

ITermGroupCollection Groups { get; }

Property Value

ITermGroupCollection

Id

The Unique ID of the Term Store

string Id { get; }

Property Value

string

Languages

List of languages for the term store.

List<string> Languages { get; }

Property Value

List<string>

Methods

GetTermById(string, string, params Expression<Func<ITerm, object>>[])

Gets a term from this termstore via it's id and it's termset id

ITerm GetTermById(string termSetId, string termId, params Expression<Func<ITerm, object>>[] selectors)

Parameters

termSetId string

Termset id of the termset containing the term

termId string

Term id of the term to retrieve

selectors Expression<Func<ITerm, object>>[]

Properties to load for the term

Returns

ITerm

The loaded term

GetTermByIdAsync(string, string, params Expression<Func<ITerm, object>>[])

Gets a term from this termstore via it's id and it's termset id

Task<ITerm> GetTermByIdAsync(string termSetId, string termId, params Expression<Func<ITerm, object>>[] selectors)

Parameters

termSetId string

Termset id of the termset containing the term

termId string

Term id of the term to retrieve

selectors Expression<Func<ITerm, object>>[]

Properties to load for the term

Returns

Task<ITerm>

The loaded term

GetTermByIdBatch(Batch, string, string, params Expression<Func<ITerm, object>>[])

Gets a term from this termstore via it's id and it's termset id

ITerm GetTermByIdBatch(Batch batch, string termSetId, string termId, params Expression<Func<ITerm, object>>[] selectors)

Parameters

batch Batch

Batch to add this reques to

termSetId string

Termset id of the termset containing the term

termId string

Term id of the term to retrieve

selectors Expression<Func<ITerm, object>>[]

Properties to load for the term

Returns

ITerm

The loaded term

GetTermByIdBatch(string, string, params Expression<Func<ITerm, object>>[])

Gets a term from this termstore via it's id and it's termset id

ITerm GetTermByIdBatch(string termSetId, string termId, params Expression<Func<ITerm, object>>[] selectors)

Parameters

termSetId string

Termset id of the termset containing the term

termId string

Term id of the term to retrieve

selectors Expression<Func<ITerm, object>>[]

Properties to load for the term

Returns

ITerm

The loaded term

GetTermByIdBatchAsync(Batch, string, string, params Expression<Func<ITerm, object>>[])

Gets a term from this termstore via it's id and it's termset id

Task<ITerm> GetTermByIdBatchAsync(Batch batch, string termSetId, string termId, params Expression<Func<ITerm, object>>[] selectors)

Parameters

batch Batch

Batch to add this reques to

termSetId string

Termset id of the termset containing the term

termId string

Term id of the term to retrieve

selectors Expression<Func<ITerm, object>>[]

Properties to load for the term

Returns

Task<ITerm>

The loaded term

GetTermByIdBatchAsync(string, string, params Expression<Func<ITerm, object>>[])

Gets a term from this termstore via it's id and it's termset id

Task<ITerm> GetTermByIdBatchAsync(string termSetId, string termId, params Expression<Func<ITerm, object>>[] selectors)

Parameters

termSetId string

Termset id of the termset containing the term

termId string

Term id of the term to retrieve

selectors Expression<Func<ITerm, object>>[]

Properties to load for the term

Returns

Task<ITerm>

The loaded term

GetTermSetById(string, params Expression<Func<ITermSet, object>>[])

Gets a termset from this termstore via it's id

ITermSet GetTermSetById(string id, params Expression<Func<ITermSet, object>>[] selectors)

Parameters

id string

Termset id to retrieve

selectors Expression<Func<ITermSet, object>>[]

Properties to load for the termset

Returns

ITermSet

The loaded termset

GetTermSetByIdAsync(string, params Expression<Func<ITermSet, object>>[])

Gets a termset from this termstore via it's id

Task<ITermSet> GetTermSetByIdAsync(string id, params Expression<Func<ITermSet, object>>[] selectors)

Parameters

id string

Termset id to retrieve

selectors Expression<Func<ITermSet, object>>[]

Properties to load for the termset

Returns

Task<ITermSet>

The loaded termset

GetTermSetByIdBatch(Batch, string, params Expression<Func<ITermSet, object>>[])

Gets a termset from this termstore via it's id

ITermSet GetTermSetByIdBatch(Batch batch, string id, params Expression<Func<ITermSet, object>>[] selectors)

Parameters

batch Batch

Batch to add this reques to

id string

Termset id to retrieve

selectors Expression<Func<ITermSet, object>>[]

Properties to load for the termset

Returns

ITermSet

The loaded termset

GetTermSetByIdBatch(string, params Expression<Func<ITermSet, object>>[])

Gets a termset from this termstore via it's id

ITermSet GetTermSetByIdBatch(string id, params Expression<Func<ITermSet, object>>[] selectors)

Parameters

id string

Termset id to retrieve

selectors Expression<Func<ITermSet, object>>[]

Properties to load for the termset

Returns

ITermSet

The loaded termset

GetTermSetByIdBatchAsync(Batch, string, params Expression<Func<ITermSet, object>>[])

Gets a termset from this termstore via it's id

Task<ITermSet> GetTermSetByIdBatchAsync(Batch batch, string id, params Expression<Func<ITermSet, object>>[] selectors)

Parameters

batch Batch

Batch to add this reques to

id string

Termset id to retrieve

selectors Expression<Func<ITermSet, object>>[]

Properties to load for the termset

Returns

Task<ITermSet>

The loaded termset

GetTermSetByIdBatchAsync(string, params Expression<Func<ITermSet, object>>[])

Gets a termset from this termstore via it's id

Task<ITermSet> GetTermSetByIdBatchAsync(string id, params Expression<Func<ITermSet, object>>[] selectors)

Parameters

id string

Termset id to retrieve

selectors Expression<Func<ITermSet, object>>[]

Properties to load for the termset

Returns

Task<ITermSet>

The loaded termset