Interface ITermGroupCollection

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Collection of term groups

public interface ITermGroupCollection : IQueryable<ITermGroup>, IQueryable, IAsyncEnumerable<ITermGroup>, IDataModelCollection<ITermGroup>, IEnumerable<ITermGroup>, IEnumerable, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionDeleteByStringId, ISupportModules<ITermGroupCollection>

Inherited Members

IQueryable.ElementType

IQueryable.Expression

IQueryable.Provider

IAsyncEnumerable<ITermGroup>.GetAsyncEnumerator(CancellationToken)

IEnumerable<ITermGroup>.GetEnumerator()

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

IDataModelCollectionDeleteByStringId.DeleteById(string)

IDataModelCollectionDeleteByStringId.DeleteByIdAsync(string)

IDataModelCollectionDeleteByStringId.DeleteByIdBatch(string)

IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(string)

IDataModelCollectionDeleteByStringId.DeleteByIdBatch(Batch, string)

IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(Batch, string)

Extension Methods

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

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

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

QueryableExtensions.AsAsyncEnumerable<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatchAsync<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatchAsync<TSource>(IQueryable<TSource>, Batch)

QueryableExtensions.AsBatch<TSource>(IQueryable<TSource>)

QueryableExtensions.AsBatch<TSource>(IQueryable<TSource>, Batch)

QueryableExtensions.FirstAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource, bool>>, CancellationToken)

QueryableExtensions.FirstAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.FirstOrDefaultAsync<TSource>(IQueryable<TSource>, Expression<Func<TSource, bool>>, CancellationToken)

QueryableExtensions.FirstOrDefaultAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.ForEachAsync<T>(IQueryable<T>, Action<T>, CancellationToken)

QueryableExtensions.QueryProperties<TResult>(IQueryable<TResult>, params Expression<Func<TResult, object>>[])

QueryableExtensions.ToArrayAsync<TSource>(IQueryable<TSource>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey>(IQueryable<TSource>, Func<TSource, TKey>, IEqualityComparer<TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey>(IQueryable<TSource>, Func<TSource, TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IQueryable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, IEqualityComparer<TKey>, CancellationToken)

QueryableExtensions.ToDictionaryAsync<TSource, TKey, TElement>(IQueryable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>, CancellationToken)

QueryableExtensions.ToListAsync<TSource>(IQueryable<TSource>, CancellationToken)

Methods

Add(string, string, TermGroupScope)

Adds a new term group

ITermGroup Add(string name, string description = null, TermGroupScope scope = TermGroupScope.Global)

Parameters

name string

Display name of the group

description string

Optional description of the group

scope TermGroupScope

Optional scope of the group

Returns

ITermGroup

Newly added group

AddAsync(string, string, TermGroupScope)

Adds a new term group

Task<ITermGroup> AddAsync(string name, string description = null, TermGroupScope scope = TermGroupScope.Global)

Parameters

name string

Display name of the group

description string

Optional description of the group

scope TermGroupScope

Optional scope of the group

Returns

Task<ITermGroup>

Newly added group

AddBatch(Batch, string, string, TermGroupScope)

Adds a new term group

ITermGroup AddBatch(Batch batch, string name, string description = null, TermGroupScope scope = TermGroupScope.Global)

Parameters

batch Batch

Batch to use

name string

Display name of the group

description string

Optional description of the group

scope TermGroupScope

Optional scope of the group

Returns

ITermGroup

Newly added group

AddBatch(string, string, TermGroupScope)

Adds a new term group

ITermGroup AddBatch(string name, string description = null, TermGroupScope scope = TermGroupScope.Global)

Parameters

name string

Display name of the group

description string

Optional description of the group

scope TermGroupScope

Optional scope of the group

Returns

ITermGroup

Newly added group

AddBatchAsync(Batch, string, string, TermGroupScope)

Adds a new term group

Task<ITermGroup> AddBatchAsync(Batch batch, string name, string description = null, TermGroupScope scope = TermGroupScope.Global)

Parameters

batch Batch

Batch to use

name string

Display name of the group

description string

Optional description of the group

scope TermGroupScope

Optional scope of the group

Returns

Task<ITermGroup>

Newly added group

AddBatchAsync(string, string, TermGroupScope)

Adds a new term group

Task<ITermGroup> AddBatchAsync(string name, string description = null, TermGroupScope scope = TermGroupScope.Global)

Parameters

name string

Display name of the group

description string

Optional description of the group

scope TermGroupScope

Optional scope of the group

Returns

Task<ITermGroup>

Newly added group

GetById(string, params Expression<Func<ITermGroup, object>>[])

Method to select a term group by id

ITermGroup GetById(string id, params Expression<Func<ITermGroup, object>>[] selectors)

Parameters

id string

The id to search for

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

The expressions declaring the fields to select

Returns

ITermGroup

The resulting term group instance, if any

GetByIdAsync(string, params Expression<Func<ITermGroup, object>>[])

Method to select a term group by id

Task<ITermGroup> GetByIdAsync(string id, params Expression<Func<ITermGroup, object>>[] selectors)

Parameters

id string

The id to search for

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

The expressions declaring the fields to select

Returns

Task<ITermGroup>

The resulting term group instance, if any

GetByName(string, params Expression<Func<ITermGroup, object>>[])

Method to select a term group by name

ITermGroup GetByName(string name, params Expression<Func<ITermGroup, object>>[] selectors)

Parameters

name string

The name to search for

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

The expressions declaring the fields to select

Returns

ITermGroup

The resulting term group instance, if any

GetByNameAsync(string, params Expression<Func<ITermGroup, object>>[])

Method to select a term group by name

Task<ITermGroup> GetByNameAsync(string name, params Expression<Func<ITermGroup, object>>[] selectors)

Parameters

name string

The name to search for

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

The expressions declaring the fields to select

Returns

Task<ITermGroup>

The resulting term group instance, if any