Search Results for

    Show / Hide Table of Contents

    Interface ITermGroupCollection

    Collection of term groups

    Inherited Members
    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)
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public interface ITermGroupCollection : IDataModelCollection<ITermGroup>, 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
    System.String name

    Display name of the group

    System.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
    System.String name

    Display name of the group

    System.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

    System.String name

    Display name of the group

    System.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
    System.String name

    Display name of the group

    System.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

    System.String name

    Display name of the group

    System.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
    System.String name

    Display name of the group

    System.String description

    Optional description of the group

    TermGroupScope scope

    Optional scope of the group

    Returns
    Task<ITermGroup>

    Newly added group

    GetById(String, Expression<Func<ITermGroup, Object>>[])

    Method to select a term group by id

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

    The id to search for

    Expression<Func<ITermGroup, System.Object>>[] selectors

    The expressions declaring the fields to select

    Returns
    ITermGroup

    The resulting term group instance, if any

    GetByIdAsync(String, 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
    System.String id

    The id to search for

    Expression<Func<ITermGroup, System.Object>>[] selectors

    The expressions declaring the fields to select

    Returns
    Task<ITermGroup>

    The resulting term group instance, if any

    GetByName(String, Expression<Func<ITermGroup, Object>>[])

    Method to select a term group by name

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

    The name to search for

    Expression<Func<ITermGroup, System.Object>>[] selectors

    The expressions declaring the fields to select

    Returns
    ITermGroup

    The resulting term group instance, if any

    GetByNameAsync(String, 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
    System.String name

    The name to search for

    Expression<Func<ITermGroup, System.Object>>[] selectors

    The expressions declaring the fields to select

    Returns
    Task<ITermGroup>

    The resulting term group instance, if any

    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>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer