feat(teams): more options for creating channel

src/sdk/PnP.Core/Model/Teams/Internal/TeamChannelCollection.cs

@@ -17,6 +17,18 @@ public TeamChannelCollection(PnPContext context, IDataModelParent parent, string
 
         #region Add methods
 
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public async Task<ITeamChannel> AddAsync(string name, TeamChannelOptions options)
+        {
+            var newChannel = CreateNewAndAdd(name, options);
+            return await newChannel.AddAsync().ConfigureAwait(false) as TeamChannel;
+        }
+
         /// <summary>
         /// Adds a new channel
         /// </summary>
@@ -25,20 +37,18 @@ public TeamChannelCollection(PnPContext context, IDataModelParent parent, string
         /// <returns>Newly added channel</returns>
         public async Task<ITeamChannel> AddAsync(string name, string description = null)
         {
-            if (string.IsNullOrEmpty(name))
-            {
-                throw new ArgumentNullException(nameof(name));
-            }
-
-            // TODO: validate name restrictions
-
-            var newChannel = CreateNewAndAdd() as TeamChannel;
-
-            // Assign field values
-            newChannel.DisplayName = name;
-            newChannel.Description = description;
+            return await AddAsync(name, new TeamChannelOptions(description)).ConfigureAwait(false);
+        }
 
-            return await newChannel.AddAsync().ConfigureAwait(false) as TeamChannel;
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public ITeamChannel Add(string name, TeamChannelOptions options)
+        {
+            return AddAsync(name, options).GetAwaiter().GetResult();
         }
 
         /// <summary>
@@ -52,6 +62,19 @@ public ITeamChannel Add(string name, string description = null)
             return AddAsync(name, description).GetAwaiter().GetResult();
         }
 
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="batch">Batch to use</param>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public async Task<ITeamChannel> AddBatchAsync(Batch batch, string name, TeamChannelOptions options)
+        {
+            var newChannel = CreateNewAndAdd(name, options);
+            return await newChannel.AddBatchAsync(batch).ConfigureAwait(false) as TeamChannel;
+        }
+
         /// <summary>
         /// Adds a new channel
         /// </summary>
@@ -61,18 +84,19 @@ public ITeamChannel Add(string name, string description = null)
         /// <returns>Newly added channel</returns>
         public async Task<ITeamChannel> AddBatchAsync(Batch batch, string name, string description = null)
         {
-            if (string.IsNullOrEmpty(name))
-            {
-                throw new ArgumentNullException(nameof(name));
-            }
-
-            var newChannel = CreateNewAndAdd() as TeamChannel;
-
-            // Assign field values
-            newChannel.DisplayName = name;
-            newChannel.Description = description;
+            return await AddBatchAsync(name, new TeamChannelOptions(description)).ConfigureAwait(false);
+        }
 
-            return await newChannel.AddBatchAsync(batch).ConfigureAwait(false) as TeamChannel;
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="batch">Batch to use</param>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public ITeamChannel AddBatch(Batch batch, string name, TeamChannelOptions options)
+        {
+            return AddBatchAsync(batch, name, options).GetAwaiter().GetResult();
         }
 
         /// <summary>
@@ -87,6 +111,17 @@ public ITeamChannel AddBatch(Batch batch, string name, string description = null
             return AddBatchAsync(batch, name, description).GetAwaiter().GetResult();
         }
 
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public async Task<ITeamChannel> AddBatchAsync(string name, TeamChannelOptions options)
+        {
+            return await AddBatchAsync(PnPContext.CurrentBatch, name, options).ConfigureAwait(false);
+        }
+
         /// <summary>
         /// Adds a new channel
         /// </summary>
@@ -98,6 +133,17 @@ public async Task<ITeamChannel> AddBatchAsync(string name, string description =
             return await AddBatchAsync(PnPContext.CurrentBatch, name, description).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public ITeamChannel AddBatch(string name, TeamChannelOptions options)
+        {
+            return AddBatchAsync(name, options).GetAwaiter().GetResult();
+        }
+
         /// <summary>
         /// Adds a new channel
         /// </summary>
@@ -109,6 +155,32 @@ public ITeamChannel AddBatch(string name, string description = null)
             return AddBatchAsync(name, description).GetAwaiter().GetResult();
         }
 
+        /// <summary>
+        /// Creates a new `TeamChannel` instance,
+        /// adds it to the collection and configures it.
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentNullException">Missing name argument</exception>
+        private TeamChannel CreateNewAndAdd(string name, TeamChannelOptions options)
+        {
+            if (string.IsNullOrEmpty(name))
+            {
+                throw new ArgumentNullException(nameof(name));
+            }
+
+            // TODO: validate name restrictions
+
+            var newChannel = CreateNewAndAdd() as TeamChannel;
+
+            newChannel.DisplayName = name;
+            newChannel.Description = options.Description;
+            if(options.MembershipType.HasValue) newChannel.MembershipType = options.MembershipType.Value;
+
+            return newChannel;
+        }
+
         #endregion
 
         #region GetByDisplayName methods

src/sdk/PnP.Core/Model/Teams/Public/ITeamChannelCollection.cs

@@ -14,6 +14,14 @@ namespace PnP.Core.Model.Teams
     public interface ITeamChannelCollection : IQueryable<ITeamChannel>, IAsyncEnumerable<ITeamChannel>, IDataModelCollection<ITeamChannel>, IDataModelCollectionLoad<ITeamChannel>, IDataModelCollectionDeleteByStringId, ISupportModules<ITeamChannelCollection>
     {
         #region Add methods
+
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public Task<ITeamChannel> AddAsync(string name, TeamChannelOptions options);
 
         /// <summary>
         /// Adds a new channel
@@ -22,6 +30,14 @@ public interface ITeamChannelCollection : IQueryable<ITeamChannel>, IAsyncEnumer
         /// <param name="description">Optional description of the channel</param>
         /// <returns>Newly added channel</returns>
         public Task<ITeamChannel> AddAsync(string name, string description = null);
+
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public ITeamChannel Add(string name, TeamChannelOptions options);
 
         /// <summary>
         /// Adds a new channel
@@ -31,6 +47,15 @@ public interface ITeamChannelCollection : IQueryable<ITeamChannel>, IAsyncEnumer
         /// <returns>Newly added channel</returns>
         public ITeamChannel Add(string name, string description = null);
 
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="batch">Batch to use</param>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public Task<ITeamChannel> AddBatchAsync(Batch batch, string name, TeamChannelOptions options);
+
         /// <summary>
         /// Adds a new channel
         /// </summary>
@@ -39,6 +64,15 @@ public interface ITeamChannelCollection : IQueryable<ITeamChannel>, IAsyncEnumer
         /// <param name="description">Optional description of the channel</param>
         /// <returns>Newly added channel</returns>
         public Task<ITeamChannel> AddBatchAsync(Batch batch, string name, string description = null);
+
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="batch">Batch to use</param>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public ITeamChannel AddBatch(Batch batch, string name, TeamChannelOptions options);
 
         /// <summary>
         /// Adds a new channel
@@ -48,6 +82,14 @@ public interface ITeamChannelCollection : IQueryable<ITeamChannel>, IAsyncEnumer
         /// <param name="description">Optional description of the channel</param>
         /// <returns>Newly added channel</returns>
         public ITeamChannel AddBatch(Batch batch, string name, string description = null);
+
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public Task<ITeamChannel> AddBatchAsync(string name, TeamChannelOptions options);
 
         /// <summary>
         /// Adds a new channel
@@ -56,6 +98,14 @@ public interface ITeamChannelCollection : IQueryable<ITeamChannel>, IAsyncEnumer
         /// <param name="description">Optional description of the channel</param>
         /// <returns>Newly added channel</returns>
         public Task<ITeamChannel> AddBatchAsync(string name, string description = null);
+
+        /// <summary>
+        /// Adds a new channel
+        /// </summary>
+        /// <param name="name">Display name of the channel</param>
+        /// <param name="options">Options for creating the channel</param>
+        /// <returns>Newly added channel</returns>
+        public ITeamChannel AddBatch(string name, TeamChannelOptions options);
 
         /// <summary>
         /// Adds a new channel

src/sdk/PnP.Core/Model/Teams/Public/Options/TeamChannelOptions.cs

@@ -0,0 +1,30 @@
+namespace PnP.Core.Model.Teams
+{
+    /// <summary>
+    /// Available options for Teams channel
+    /// </summary>
+    public class TeamChannelOptions 
+    {
+        /// <summary>
+        /// Gets or sets the channel description.
+        /// </summary>
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the channel membership type.
+        ///
+        /// The membership type cannot be changed for existing channels.
+        /// </summary>
+        public TeamChannelMembershipType? MembershipType { get; set; }
+
+        /// <summary>
+        /// Creates a new `TeamChannelOptions` instance
+        /// with the provided description. 
+        /// </summary>
+        /// <param name="description">The channel description.</param>
+        public TeamChannelOptions(string description = null)
+        {
+            Description = description;
+        }
+    }
+}