Merge pull request #2779 from reshmee011/dev

Adding VivaConnectionsDefaultStart option to SetHomeSite
pnp · Feb 7, 2023 · bb4328d · bb4328d
2 parents 6b4ab3f + 5a7294b
commit bb4328d
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 5 deletions.
diff --git a/documentation/Get-PnPHomeSite.md b/documentation/Get-PnPHomeSite.md
@@ -34,6 +34,13 @@ Get-PnPHomeSite
 
 Returns the home site url for your tenant
 
+### EXAMPLE 2
+```powershell
+Get-PnPHomeSite -IsVivaConnectionsDefaultStartForCompanyPortalSiteEnabled
+```
+
+Returns whether Viva Connections landing experience is set to the SharePoint home site.
+
 ## PARAMETERS
 
 ### -Connection
@@ -50,6 +57,19 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -IsVivaConnectionsDefaultStartForCompanyPortalSiteEnabled
+When specified, it retrieves whether Viva Connections landing experience is set to the SharePoint home site.
+
+```yaml
+Type: Boolean
+Parameter Sets: (All)
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ## RELATED LINKS
 
 [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

diff --git a/documentation/Set-PnPHomeSite.md b/documentation/Set-PnPHomeSite.md
@@ -36,6 +36,13 @@ Set-PnPHomeSite -HomeSiteUrl "https://yourtenant.sharepoint.com/sites/myhome"
 
 Sets the home site to the provided site collection url
 
+### EXAMPLE 2
+```powershell
+Set-PnPHomeSite -HomeSiteUrl "https://yourtenant.sharepoint.com/sites/myhome" -VivaConnectionsDefaultStart:$true
+```
+
+Sets the home site to the provided site collection url and keeps the Viva Connections landing experience to the SharePoint home site.
+
 ## PARAMETERS
 
 ### -Connection
@@ -66,7 +73,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -VivaConnectionsDefaultStart
+When set to $true, the VivaConnectionsDefaultStart parameter will keep the Viva Connections landing experience to the SharePoint home site. If set to $false the Viva Connections home experience will be used. 
+
+```yaml
+Type: Boolean
+Parameter Sets: (All)
+Required: False
+Position: Named
+Default value: true
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ## RELATED LINKS
 
 [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
 [Set up a home site for your organization](https://learn.microsoft.com/sharepoint/home-site)
+[Customize and edit the Viva Connections home experience](https://learn.microsoft.com/en-us/viva/connections/edit-viva-home)
diff --git a/src/Commands/Admin/GetHomeSite.cs b/src/Commands/Admin/GetHomeSite.cs
@@ -1,4 +1,5 @@
-using Microsoft.SharePoint.Client;
+using Microsoft.Extensions.Logging.Abstractions;
+using Microsoft.SharePoint.Client;
 
 using PnP.PowerShell.Commands.Base;
 using System.Management.Automation;
@@ -8,11 +9,24 @@ namespace PnP.PowerShell.Commands.Admin
     [Cmdlet(VerbsCommon.Get, "PnPHomeSite")]
     public class GetHomeSite : PnPAdminCmdlet
     {
+        [Parameter(Mandatory = false)]
+        public SwitchParameter IsVivaConnectionsDefaultStartForCompanyPortalSiteEnabled;
         protected override void ExecuteCmdlet()
         {
-            var results = Tenant.GetSPHSiteUrl();
-            ClientContext.ExecuteQueryRetry();
-            WriteObject(results.Value);
+            if (ParameterSpecified(nameof(IsVivaConnectionsDefaultStartForCompanyPortalSiteEnabled)))
+            {
+                var results  = Tenant.IsVivaConnectionsDefaultStartForCompanyPortalSiteEnabled();
+                ClientContext.ExecuteQueryRetry();
+                WriteObject(results.Value);
+            }
+            else 
+            {
+                var results = Tenant.GetSPHSiteUrl();
+                ClientContext.ExecuteQueryRetry();
+                WriteObject(results.Value);
+            }
+
+
         }
     }
 }
diff --git a/src/Commands/Admin/SetHomeSite.cs b/src/Commands/Admin/SetHomeSite.cs
@@ -12,9 +12,19 @@ public class SetHomeSite : PnPAdminCmdlet
         [Parameter(Mandatory = true)]
         public string HomeSiteUrl;
 
+        [Parameter(Mandatory = false)]
+        public SwitchParameter VivaConnectionsDefaultStart;
+
         protected override void ExecuteCmdlet()
         {
-            Tenant.SetSPHSite(HomeSiteUrl);
+            if (ParameterSpecified(nameof(VivaConnectionsDefaultStart)))
+            {
+                Tenant.SetSPHSiteWithConfigurations(HomeSiteUrl, VivaConnectionsDefaultStart);
+            }
+            else
+            {
+                Tenant.SetSPHSite(HomeSiteUrl);
+            }
             ClientContext.ExecuteQueryRetry();
         }
     }