Interface ITermGroupCollection

Collection of term groups

Inherited Members
Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface ITermGroupCollection : IQueryable<ITermGroup>, IQueryable, IAsyncEnumerable<ITermGroup>, IDataModelCollection<ITermGroup>, IEnumerable<ITermGroup>, IEnumerable, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionDeleteByStringId, ISupportModules<ITermGroupCollection>

Methods

Add(string, string, TermGroupScope)

Adds a new term group

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

Display name of the group
string description

Optional description of the group
TermGroupScope scope

Optional scope of the group
Returns
ITermGroup

Newly added group

AddAsync(string, string, TermGroupScope)

Adds a new term group

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

Display name of the group
string description

Optional description of the group
TermGroupScope scope

Optional scope of the group
Returns
Task<ITermGroup>

Newly added group

AddBatch(Batch, string, string, TermGroupScope)

Adds a new term group

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

Batch to use
string name

Display name of the group
string description

Optional description of the group
TermGroupScope scope

Optional scope of the group
Returns
ITermGroup

Newly added group

AddBatch(string, string, TermGroupScope)

Adds a new term group

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

Display name of the group
string description

Optional description of the group
TermGroupScope scope

Optional scope of the group
Returns
ITermGroup

Newly added group

AddBatchAsync(Batch, string, string, TermGroupScope)

Adds a new term group

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

Batch to use
string name

Display name of the group
string description

Optional description of the group
TermGroupScope scope

Optional scope of the group
Returns
Task<ITermGroup>

Newly added group

AddBatchAsync(string, string, TermGroupScope)

Adds a new term group

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

Display name of the group
string description

Optional description of the group
TermGroupScope scope

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

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

The id to search for
Expression<Func<ITermGroup, object>>[] selectors

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

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

The id to search for
Expression<Func<ITermGroup, object>>[] selectors

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

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

The name to search for
Expression<Func<ITermGroup, object>>[] selectors

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

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

The name to search for
Expression<Func<ITermGroup, object>>[] selectors

The expressions declaring the fields to select
Returns
Task<ITermGroup>

The resulting term group instance, if any

Extension Methods