Refactor navigation node and sharing links commands to remove obsolete parameters and improve code clarity (#4561)

gautamdsheth · Gautam Sheth · web-flow · commit 449069c5ea33 · 2024-11-20T21:13:16.000+02:00
Co-authored-by: Gautam Sheth &lt;gautam.sheth@staffbase.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -85,7 +85,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Removed `Get-PnPPowerPlatformConnector` alias. You need to use `Get-PnPPowerPlatformCustomConnector`. [#4387](https://github.com/pnp/powershell/pull/4387)
 - Removed `-IsFavoriteByDefault` parameter from `Add-PnPTeamsChannel` cmdlet. It was obsolete and not supported by Graph API. [#4387](https://github.com/pnp/powershell/pull/4387)
 - Removed `Get-PnPAppAuthAccessToken` , `Remove-PnPGraphAccessToken` and `Request-PnPAccessToken` cmdlets. Use `Get-PnPAccessToken` instead. [#4398](https://github.com/pnp/powershell/pull/4398)
-- Removed support for sending mail via SMTP. It's usage is not recommended by .NET due to its lack of support for modern protocols.
+- Removed support for sending mail via SMTP in `Send-PnPMail`. It's usage is not recommended by .NET due to its lack of support for modern protocols.
+- Removed `-Title` and `-Header` parameters from `Remove-PnPNavigationNode`. They were marked obsolete.
+- Removed `-FileUrl` parameter from `Get-PnPSharingLink`. It was marked obsolete.
  
 ### Contributors
 
diff --git a/MIGRATE-2.0-to-3.0.md b/MIGRATE-2.0-to-3.0.md
@@ -57,6 +57,8 @@ Recommend referring to these 2 links:
 | Send-PnPMail | It now throws a warning about the [retirement of SharePoint SendEmail API](https://devblogs.microsoft.com/microsoft365dev/retirement-of-the-sharepoint-sendemail-api/), if you are sending mails via SharePoint. To ignore the warning, use `-ErrorAction SilentlyContinue` along side the cmdlet. Recommendation is to use `Send-PnPMail` with [Microsoft Graph](https://pnp.github.io/powershell/cmdlets/Send-PnPMail.html#send-through-microsoft-graph) |
 | Send-PnPMail | The support for sending mails via SMTP servers is now removed. It is the recommendation of .NET as SMTP doesn't support modern protocols. So, the parameters `-EnableSSL` , `-UserName`, `-Password`, `-Server ` and `-ServerPort` are now removed. Use `Send-PnPMail` with [Microsoft Graph](https://pnp.github.io/powershell/cmdlets/Send-PnPMail.html#send-through-microsoft-graph) |
 | Invoke-PnPTransformation | It has been removed. Was never supported. |
+| Get-PnPSharingLink | The parameter `-FileUrl` has been removed. It was marked obsolete. Use `-Identity` instead. |
+| Remove-PnPNavigationNode | The parameters `-Title` and `-Header` have been removed. They were marked obsolete. Use `-Identity` instead. |
 
 
 ## Other notable changes
diff --git a/src/Commands/Navigation/RemoveNavigationNode.cs b/src/Commands/Navigation/RemoveNavigationNode.cs
@@ -1,9 +1,7 @@
-﻿using System;
-using System.Management.Automation;
-using Microsoft.SharePoint.Client;
+﻿using Microsoft.SharePoint.Client;
 using PnP.Framework.Enums;
-
 using PnP.PowerShell.Commands.Base.PipeBinds;
+using System.Management.Automation;
 using Resources = PnP.PowerShell.Commands.Properties.Resources;
 
 namespace PnP.PowerShell.Commands.Branding
@@ -19,18 +17,9 @@ public class RemoveNavigationNode : PnPWebCmdlet
         [Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_BYID)]
         public NavigationNodePipeBind Identity;
 
-        [Obsolete("Use -Identity with an Id instead.")]
         [Parameter(Mandatory = true, Position = 0, ParameterSetName = ParameterSet_BYNAME)]
         public NavigationType Location;
 
-        [Obsolete("Use -Identity with an Id instead.")]
-        [Parameter(Mandatory = true, ParameterSetName = ParameterSet_BYNAME)]
-        public string Title;
-
-        [Obsolete("Use -Identity with an Id instead.")]
-        [Parameter(Mandatory = false, ParameterSetName = ParameterSet_BYNAME)]
-        public string Header;
-
         [Parameter(Mandatory = true, ParameterSetName = ParameterSet_REMOVEALLNODES)]
         public SwitchParameter All;
 
@@ -41,12 +30,10 @@ protected override void ExecuteCmdlet()
         {
             if (ParameterSetName == ParameterSet_REMOVEALLNODES)
             {
-#pragma warning disable CS0618 // Type or member is obsolete
                 if (Force || ShouldContinue(string.Format(Resources.RemoveNavigationNodeInLocation, Location), Resources.Confirm))
                 {
                     CurrentWeb.DeleteAllNavigationNodes(Location);
                 }
-#pragma warning restore CS0618 // Type or member is obsolete
             }
             else
             {
@@ -58,12 +45,6 @@ protected override void ExecuteCmdlet()
                         node.DeleteObject();
                         ClientContext.ExecuteQueryRetry();
                     }
-                    else
-                    {
-#pragma warning disable CS0618 // Type or member is obsolete
-                        CurrentWeb.DeleteNavigationNode(Title, Header, Location);
-#pragma warning restore CS0618 // Type or member is obsolete
-                    }
                 }
             }
         }
diff --git a/src/Commands/Security/GetFileSharingLink.cs b/src/Commands/Security/GetFileSharingLink.cs
@@ -1,53 +1,20 @@
 ﻿using PnP.Core.Model.Security;
 using PnP.Core.Model.SharePoint;
-using PnP.Framework.Utilities;
-using System;
-using System.Management.Automation;
 using PnP.PowerShell.Commands.Base.PipeBinds;
+using System.Management.Automation;
 
 namespace PnP.PowerShell.Commands.Security
 {
     [Cmdlet(VerbsCommon.Get, "PnPFileSharingLink")]
     [OutputType(typeof(IGraphPermissionCollection))]
     public class GetFileSharingLink : PnPWebCmdlet
     {
-        private const string ParameterSet_BYFILEURL = "By file url";
-        private const string ParameterSet_BYIDENTITY = "By identity";
-
-        [Obsolete("Use Identity parameter instead")]
-        [Parameter(Mandatory = true, ParameterSetName = ParameterSet_BYFILEURL)]
-        public string FileUrl;
-
-        [Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = ParameterSet_BYIDENTITY)]
+        [Parameter(Mandatory = true, ValueFromPipeline = true)]
         public FilePipeBind Identity;
 
         protected override void ExecuteCmdlet()
         {
-            IFile file;
-
-            if (ParameterSpecified(nameof(Identity)))
-            {
-                file = Identity.GetCoreFile(Connection.PnPContext, this);
-            }
-            else
-            {
-                var serverRelativeUrl = string.Empty;
-                var ctx = Connection.PnPContext;
-
-                ctx.Web.EnsureProperties(w => w.ServerRelativeUrl);
-
-#pragma warning disable CS0618
-                if (!FileUrl.ToLower().StartsWith(ctx.Web.ServerRelativeUrl.ToLower()))
-                {
-                    serverRelativeUrl = UrlUtility.Combine(ctx.Web.ServerRelativeUrl, FileUrl);
-                }
-                else
-                {
-                    serverRelativeUrl = FileUrl;
-                }
-#pragma warning restore CS0618
-                file = ctx.Web.GetFileByServerRelativeUrl(serverRelativeUrl);
-            }
+            IFile file = Identity.GetCoreFile(Connection.PnPContext, this);
 
             WriteVerbose("Retrieving file sharing details from Microsoft Graph");
             var sharingLinks = file?.GetShareLinks();
diff --git a/src/Commands/Teams/AddTeamsChannel.cs b/src/Commands/Teams/AddTeamsChannel.cs
@@ -4,7 +4,6 @@
 using PnP.PowerShell.Commands.Enums;
 using PnP.PowerShell.Commands.Model.Graph;
 using PnP.PowerShell.Commands.Utilities;
-using System;
 using System.Management.Automation;
 
 namespace PnP.PowerShell.Commands.Teams
@@ -30,7 +29,7 @@ public class AddTeamsChannel : PnPGraphCmdlet
         [Parameter(Mandatory = false, ParameterSetName = ParameterSET_STANDARD)]
         [Parameter(Mandatory = false, ParameterSetName = ParameterSET_PRIVATE)]
         [Parameter(Mandatory = false, ParameterSetName = ParameterSET_SPECIFIC)]
-        public string Description;        
+        public string Description;
 
         [Parameter(Mandatory = false, ParameterSetName = ParameterSET_STANDARD)]
         [Parameter(Mandatory = true, ParameterSetName = ParameterSET_SPECIFIC)]
@@ -48,16 +47,14 @@ protected override void ExecuteCmdlet()
                 throw new PSArgumentException("Group not found");
             }
 
-            if(ChannelType != TeamsChannelType.Standard && !ParameterSpecified(nameof(OwnerUPN)))
+            if (ChannelType != TeamsChannelType.Standard && !ParameterSpecified(nameof(OwnerUPN)))
             {
                 throw new PSArgumentException("OwnerUPN is required when using the non standard channel type", nameof(OwnerUPN));
             }
 
             try
             {
-#pragma warning disable CS0618 // Type or member is obsolete
                 var channel = TeamsUtility.AddChannel(this, AccessToken, Connection, groupId, DisplayName, Description, ChannelType, OwnerUPN, false);
-#pragma warning restore CS0618 // Type or member is obsolete
                 WriteObject(channel);
             }
             catch (GraphException ex)

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,7 @@`
`1`		`-using System;`
`2`		`-using System.Management.Automation;`
`3`		`-using Microsoft.SharePoint.Client;`
	`1`	`+using Microsoft.SharePoint.Client;`
`4`	`2`	`using PnP.Framework.Enums;`
`5`		`-`
`6`	`3`	`using PnP.PowerShell.Commands.Base.PipeBinds;`
	`4`	`+using System.Management.Automation;`
`7`	`5`	`using Resources = PnP.PowerShell.Commands.Properties.Resources;`
`8`	`6`
`9`	`7`	`namespace PnP.PowerShell.Commands.Branding`
`@@ -19,18 +17,9 @@ public class RemoveNavigationNode : PnPWebCmdlet`
`19`	`17`	`[Parameter(Mandatory = true, Position = 0, ValueFromPipeline = true, ParameterSetName = ParameterSet_BYID)]`
`20`	`18`	`public NavigationNodePipeBind Identity;`
`21`	`19`
`22`		`- [Obsolete("Use -Identity with an Id instead.")]`
`23`	`20`	`[Parameter(Mandatory = true, Position = 0, ParameterSetName = ParameterSet_BYNAME)]`
`24`	`21`	`public NavigationType Location;`
`25`	`22`
`26`		`- [Obsolete("Use -Identity with an Id instead.")]`
`27`		`- [Parameter(Mandatory = true, ParameterSetName = ParameterSet_BYNAME)]`
`28`		`- public string Title;`
`29`		`-`
`30`		`- [Obsolete("Use -Identity with an Id instead.")]`
`31`		`- [Parameter(Mandatory = false, ParameterSetName = ParameterSet_BYNAME)]`
`32`		`- public string Header;`
`33`		`-`
`34`	`23`	`[Parameter(Mandatory = true, ParameterSetName = ParameterSet_REMOVEALLNODES)]`
`35`	`24`	`public SwitchParameter All;`
`36`	`25`
`@@ -41,12 +30,10 @@ protected override void ExecuteCmdlet()`
`41`	`30`	`{`
`42`	`31`	`if (ParameterSetName == ParameterSet_REMOVEALLNODES)`
`43`	`32`	`{`
`44`		`-#pragma warning disable CS0618 // Type or member is obsolete`
`45`	`33`	`if (Force \|\| ShouldContinue(string.Format(Resources.RemoveNavigationNodeInLocation, Location), Resources.Confirm))`
`46`	`34`	`{`
`47`	`35`	`CurrentWeb.DeleteAllNavigationNodes(Location);`
`48`	`36`	`}`
`49`		`-#pragma warning restore CS0618 // Type or member is obsolete`
`50`	`37`	`}`
`51`	`38`	`else`
`52`	`39`	`{`
`@@ -58,12 +45,6 @@ protected override void ExecuteCmdlet()`
`58`	`45`	`node.DeleteObject();`
`59`	`46`	`ClientContext.ExecuteQueryRetry();`
`60`	`47`	`}`
`61`		`- else`
`62`		`- {`
`63`		`-#pragma warning disable CS0618 // Type or member is obsolete`
`64`		`- CurrentWeb.DeleteNavigationNode(Title, Header, Location);`
`65`		`-#pragma warning restore CS0618 // Type or member is obsolete`
`66`		`- }`
`67`	`48`	`}`
`68`	`49`	`}`
`69`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`	`using PnP.PowerShell.Commands.Enums;`
`5`	`5`	`using PnP.PowerShell.Commands.Model.Graph;`
`6`	`6`	`using PnP.PowerShell.Commands.Utilities;`
`7`		`-using System;`
`8`	`7`	`using System.Management.Automation;`
`9`	`8`
`10`	`9`	`namespace PnP.PowerShell.Commands.Teams`
`@@ -30,7 +29,7 @@ public class AddTeamsChannel : PnPGraphCmdlet`
`30`	`29`	`[Parameter(Mandatory = false, ParameterSetName = ParameterSET_STANDARD)]`
`31`	`30`	`[Parameter(Mandatory = false, ParameterSetName = ParameterSET_PRIVATE)]`
`32`	`31`	`[Parameter(Mandatory = false, ParameterSetName = ParameterSET_SPECIFIC)]`
`33`		`- public string Description;`
	`32`	`+ public string Description;`
`34`	`33`
`35`	`34`	`[Parameter(Mandatory = false, ParameterSetName = ParameterSET_STANDARD)]`
`36`	`35`	`[Parameter(Mandatory = true, ParameterSetName = ParameterSET_SPECIFIC)]`
`@@ -48,16 +47,14 @@ protected override void ExecuteCmdlet()`
`48`	`47`	`throw new PSArgumentException("Group not found");`
`49`	`48`	`}`
`50`	`49`
`51`		`- if(ChannelType != TeamsChannelType.Standard && !ParameterSpecified(nameof(OwnerUPN)))`
	`50`	`+ if (ChannelType != TeamsChannelType.Standard && !ParameterSpecified(nameof(OwnerUPN)))`
`52`	`51`	`{`
`53`	`52`	`throw new PSArgumentException("OwnerUPN is required when using the non standard channel type", nameof(OwnerUPN));`
`54`	`53`	`}`
`55`	`54`
`56`	`55`	`try`
`57`	`56`	`{`
`58`		`-#pragma warning disable CS0618 // Type or member is obsolete`
`59`	`57`	`var channel = TeamsUtility.AddChannel(this, AccessToken, Connection, groupId, DisplayName, Description, ChannelType, OwnerUPN, false);`
`60`		`-#pragma warning restore CS0618 // Type or member is obsolete`
`61`	`58`	`WriteObject(channel);`
`62`	`59`	`}`
`63`	`60`	`catch (GraphException ex)`