Search Results for

    Show / Hide Table of Contents

    Interface ITeamChannelCollection

    Public interface to define a collection of Team Channels

    Inherited Members
    IDataModelParent.Parent
    IDataModelWithContext.PnPContext
    IRequestableCollection.Requested
    IRequestableCollection.Length
    IRequestableCollection.RequestedItems
    IRequestableCollection.Clear()
    IDataModelCollectionLoad<ITeamChannel>.LoadAsync(Expression<Func<ITeamChannel, Object>>[])
    IDataModelCollectionLoad<ITeamChannel>.LoadBatchAsync(Batch, Expression<Func<ITeamChannel, Object>>[])
    IDataModelCollectionDeleteByStringId.DeleteById(String)
    IDataModelCollectionDeleteByStringId.DeleteByIdAsync(String)
    IDataModelCollectionDeleteByStringId.DeleteByIdBatch(String)
    IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(String)
    IDataModelCollectionDeleteByStringId.DeleteByIdBatch(Batch, String)
    IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(Batch, String)
    Namespace: PnP.Core.Model.Teams
    Assembly: PnP.Core.dll
    Syntax
    public interface ITeamChannelCollection : IDataModelCollection<ITeamChannel>, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<ITeamChannel>, IDataModelCollectionDeleteByStringId, ISupportModules<ITeamChannelCollection>

    Methods

    Add(String, TeamChannelOptions)

    Adds a new channel

    Declaration
    ITeamChannel Add(string name, TeamChannelOptions options)
    Parameters
    System.String name

    Display name of the channel

    TeamChannelOptions options

    Options for creating the channel

    Returns
    ITeamChannel

    Newly added channel

    Add(String, String)

    Adds a new channel

    Declaration
    ITeamChannel Add(string name, string description = null)
    Parameters
    System.String name

    Display name of the channel

    System.String description

    Optional description of the channel

    Returns
    ITeamChannel

    Newly added channel

    AddAsync(String, TeamChannelOptions)

    Adds a new channel

    Declaration
    Task<ITeamChannel> AddAsync(string name, TeamChannelOptions options)
    Parameters
    System.String name

    Display name of the channel

    TeamChannelOptions options

    Options for creating the channel

    Returns
    Task<ITeamChannel>

    Newly added channel

    AddAsync(String, String)

    Adds a new channel

    Declaration
    Task<ITeamChannel> AddAsync(string name, string description = null)
    Parameters
    System.String name

    Display name of the channel

    System.String description

    Optional description of the channel

    Returns
    Task<ITeamChannel>

    Newly added channel

    AddBatch(Batch, String, TeamChannelOptions)

    Adds a new channel

    Declaration
    ITeamChannel AddBatch(Batch batch, string name, TeamChannelOptions options)
    Parameters
    Batch batch

    Batch to use

    System.String name

    Display name of the channel

    TeamChannelOptions options

    Options for creating the channel

    Returns
    ITeamChannel

    Newly added channel

    AddBatch(Batch, String, String)

    Adds a new channel

    Declaration
    ITeamChannel AddBatch(Batch batch, string name, string description = null)
    Parameters
    Batch batch

    Batch to use

    System.String name

    Display name of the channel

    System.String description

    Optional description of the channel

    Returns
    ITeamChannel

    Newly added channel

    AddBatch(String, TeamChannelOptions)

    Adds a new channel

    Declaration
    ITeamChannel AddBatch(string name, TeamChannelOptions options)
    Parameters
    System.String name

    Display name of the channel

    TeamChannelOptions options

    Options for creating the channel

    Returns
    ITeamChannel

    Newly added channel

    AddBatch(String, String)

    Adds a new channel

    Declaration
    ITeamChannel AddBatch(string name, string description = null)
    Parameters
    System.String name

    Display name of the channel

    System.String description

    Optional description of the channel

    Returns
    ITeamChannel

    Newly added channel

    AddBatchAsync(Batch, String, TeamChannelOptions)

    Adds a new channel

    Declaration
    Task<ITeamChannel> AddBatchAsync(Batch batch, string name, TeamChannelOptions options)
    Parameters
    Batch batch

    Batch to use

    System.String name

    Display name of the channel

    TeamChannelOptions options

    Options for creating the channel

    Returns
    Task<ITeamChannel>

    Newly added channel

    AddBatchAsync(Batch, String, String)

    Adds a new channel

    Declaration
    Task<ITeamChannel> AddBatchAsync(Batch batch, string name, string description = null)
    Parameters
    Batch batch

    Batch to use

    System.String name

    Display name of the channel

    System.String description

    Optional description of the channel

    Returns
    Task<ITeamChannel>

    Newly added channel

    AddBatchAsync(String, TeamChannelOptions)

    Adds a new channel

    Declaration
    Task<ITeamChannel> AddBatchAsync(string name, TeamChannelOptions options)
    Parameters
    System.String name

    Display name of the channel

    TeamChannelOptions options

    Options for creating the channel

    Returns
    Task<ITeamChannel>

    Newly added channel

    AddBatchAsync(String, String)

    Adds a new channel

    Declaration
    Task<ITeamChannel> AddBatchAsync(string name, string description = null)
    Parameters
    System.String name

    Display name of the channel

    System.String description

    Optional description of the channel

    Returns
    Task<ITeamChannel>

    Newly added channel

    GetByDisplayName(String, Expression<Func<ITeamChannel, Object>>[])

    Method to select a channel by displayName

    Declaration
    ITeamChannel GetByDisplayName(string displayName, params Expression<Func<ITeamChannel, object>>[] selectors)
    Parameters
    System.String displayName

    The displayName to search for

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

    The expressions declaring the fields to select

    Returns
    ITeamChannel

    The resulting channel instance, if any

    GetByDisplayNameAsync(String, Expression<Func<ITeamChannel, Object>>[])

    Method to select a channel by displayName asynchronously

    Declaration
    Task<ITeamChannel> GetByDisplayNameAsync(string displayName, params Expression<Func<ITeamChannel, object>>[] selectors)
    Parameters
    System.String displayName

    The displayName to search for

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

    The expressions declaring the fields to select

    Returns
    Task<ITeamChannel>

    The resulting channel instance, if any

    Extension Methods

    DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelCollectionLoadExtensions.Load<TModel>(IDataModelCollectionLoad<TModel>, 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>>)
    QueryableExtensions.AsRequested<TSource>(IDataModelCollection<TSource>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer