Interface ITeamChannelCollection

Public interface to define a collection of Team Channels

Inherited Members

IQueryable.ElementType

IQueryable.Expression

IQueryable.Provider

IAsyncEnumerable<ITeamChannel>.GetAsyncEnumerator(CancellationToken)

IEnumerable<ITeamChannel>.GetEnumerator()

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

IDataModelCollectionLoad<ITeamChannel>.LoadAsync(params Expression<Func<ITeamChannel, object>>[])

IDataModelCollectionLoad<ITeamChannel>.LoadBatchAsync(Batch, params 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 : IQueryable<ITeamChannel>, IQueryable, IAsyncEnumerable<ITeamChannel>, IDataModelCollection<ITeamChannel>, IEnumerable<ITeamChannel>, IEnumerable, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<ITeamChannel>, IDataModelCollectionDeleteByStringId, ISupportModules<ITeamChannelCollection>

Methods

Add(string, TeamChannelOptions)

Adds a new channel

Declaration

ITeamChannel Add(string name, TeamChannelOptions options)

Parameters

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

string name Display name of the channel

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

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

string name Display name of the channel

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

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

string name Display name of the channel

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

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

string name Display name of the channel

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

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

string name Display name of the channel

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

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

string name Display name of the channel

string description Optional description of the channel

Returns

Task<ITeamChannel> Newly added channel

GetByDisplayName(string, params Expression<Func<ITeamChannel, object>>[])

Method to select a channel by displayName

Declaration

ITeamChannel GetByDisplayName(string displayName, params Expression<Func<ITeamChannel, object>>[] selectors)

Parameters

string displayName The displayName to search for

Expression<Func<ITeamChannel, object>>[] selectors The expressions declaring the fields to select

Returns

ITeamChannel The resulting channel instance, if any

GetByDisplayNameAsync(string, params 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

string displayName The displayName to search for

Expression<Func<ITeamChannel, 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>, Batch, params Expression<Func<TModel, object>>[])

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelCollectionLoadExtensions.Load<TModel>(IDataModelCollectionLoad<TModel>, params Expression<Func<TModel, object>>[])

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)