Merge pull request #822 from SharePoint/dev

April 2017 Release

Author: erwinvanhunen

CONTRIBUTING.md

@@ -29,7 +29,7 @@ Please see following page for additional insights on the model.
 ---
 
 
-##Code contributions
+## Code contributions
 In order to succesfully compile the PnP PowerShell solution you will _also_ have to download *and build in Visual Studio* the [PnP-Sites-Core](https://github.com/OfficeDev/PnP-Sites-Core) repository and make the dev branch available. The PowerShell solution depends on it. In order to succesfully 
 compile it, make sure that PnP-Sites-Core is located at the same level as PnP-PowerShell.
 
@@ -42,7 +42,7 @@ c:\[YOUR REPO FOLDER]\PnP-PowerShell
 The reason for this is that the PnP-PowerShell library will have references to the release and debug builds of the PnP-Sites-Core library.
 
 A few notes:
-###Every new cmdlet should provide help and examples
+### Every new cmdlet should provide help and examples
 As documentation is autogenerated by building the solution, make sure that you include both help and examples, alike
 
 ```csharp
@@ -55,14 +55,14 @@ As documentation is autogenerated by building the solution, make sure that you i
   {
   }
 ```
-###Most cmdlets will extend SPOWebCmdlet which provides a few helper objects for you to use, like SelectedWeb and ClientContext
+### Most cmdlets will extend SPOWebCmdlet which provides a few helper objects for you to use, like SelectedWeb and ClientContext
 As most cmdlets are 'web sensitive' (e.g. you can specify a -Web parameter to point to a different subweb), make sure that you use the correct ClientContext. When a user specifies the -Web parameter
 in a cmdlet that extens SPOWebCmdlet, the cmdlet will switch it's internal context to that web, reusing credentials. It is important to use the right context, and the easiest way to do that is to use
 
 ```csharp
 var context = SelectedWeb.Context;
 ```
-###Cmdlets will have to work both on-premises and in the cloud
+### Cmdlets will have to work both on-premises and in the cloud
 You can use preprocessor variables ("ONPREMISES" or "SP2013" and "SP2016") to build different cmdlets for the different targets. In cases where it is not possible to provide functionality for either the 
 cloud or on-premises, make sure to remove the full cmdlet from the compiled solution by having #IF(!SP2013) or #IF(SP2013) as the _first line of the cmdlet, before using statements. 
 
@@ -82,11 +82,11 @@ public class MyCmdlet : SPOWebCmdlet
 
 If only parts of a cmdlet require different behaviour based upon the different version of the SDK, you are recommended to use the #ONPREMISES or other available preprocessor variable throughout your code to exclude or include certain code.
 
-###Cmdlets will have to use common verbs
+### Cmdlets will have to use common verbs
 
 The verb of a cmdlet (get-, add-, etc.) should follow acceptable cmdlet standards and should be part of one of the built in verbs classes (VerbsCommon, VerbsData, etc.):
 
-##Documentation contributions
+## Documentation contributions
 If you want to contribute to cmdlet documentation, please do not make a pull request to modify the actual files in the Documentation folder itself. Those files
 are automatically generated based upon comments in the actual classes. So if you want to modify documentation and or add an example of a cmdlet, navigate to the
 corresponding class where the cmdlet is being implemented and add the comments there. An example can for instance be found in

Commands/Admin/NewTenantSite.cs

@@ -85,9 +85,12 @@ protected override void ExecuteCmdlet()
             {
                 Uri uri = BaseUri;
                 Url = $"{uri.ToString().TrimEnd('/')}/{Url.TrimStart('/')}";
-                shouldContinue = ShouldContinue(string.Format(Resources.CreateSiteWithUrl0, Url), Resources.Confirm);
+                if (!Force)
+                {
+                    shouldContinue = ShouldContinue(string.Format(Resources.CreateSiteWithUrl0, Url), Resources.Confirm);
+                }
             }
-            if (Force || shouldContinue)
+            if (shouldContinue)
             {
 #if ONPREMISES
                 var entity = new SiteEntity();

Commands/Base/ConnectOnline.cs

@@ -51,7 +51,7 @@ namespace SharePointPnP.PowerShell.Commands.Base
         Remarks = @"This will prompt you for credentials and creates a context for the other PowerShell commands to use. It assumes your server is configured for Forms Based Authentication (FBA)",
         SortOrder = 7)]
     [CmdletExample(
-        Code = @"PS:> Connect-PnPOnline -Url https://contoso.sharepoint.de -AppId 344b8aab-389c-4e4a-8fa1-4c1ae2c0a60d -ClientSecret a3f3faf33f3awf3a3sfs3f3ss3f4f4a3fawfas3ffsrrffssfd -AzureEnvironment Germany",
+        Code = @"PS:> Connect-PnPOnline -Url https://contoso.sharepoint.de -AppId 344b8aab-389c-4e4a-8fa1-4c1ae2c0a60d -AppSecret a3f3faf33f3awf3a3sfs3f3ss3f4f4a3fawfas3ffsrrffssfd -AzureEnvironment Germany",
         Remarks = @"This will authenticate you to the German Azure environment using the German Azure endpoints for authentication",
         SortOrder = 8)]
     public class ConnectOnline : PSCmdlet

Commands/Lists/SetDefaultColumnValues.cs

@@ -92,7 +92,15 @@ protected override void ExecuteCmdlet()
                     if (field != null)
                     {
                         IDefaultColumnValue defaultColumnValue = null;
-                        if (field.TypeAsString == "Text" || field.TypeAsString == "Choice" || field.TypeAsString == "MultiChoice" || field.TypeAsString == "User")
+                        if (field.TypeAsString == "Text" ||
+                            field.TypeAsString == "Choice" ||
+                            field.TypeAsString == "MultiChoice" ||
+                            field.TypeAsString == "User" ||
+                            field.TypeAsString == "Boolean" ||
+                            field.TypeAsString == "DateTime" ||
+                            field.TypeAsString == "Number" ||
+                            field.TypeAsString == "Currency"
+                            )
                         {
                             var values = string.Join(";", Value);
                             defaultColumnValue = new DefaultColumnTextValue()

Commands/Properties/AssemblyInfo.cs

@@ -44,6 +44,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.13.1703.0")]
-[assembly: AssemblyFileVersion("2.13.1703.0")]
+[assembly: AssemblyVersion("2.14.1704.0")]
+[assembly: AssemblyFileVersion("2.14.1704.0")]
 [assembly: InternalsVisibleTo("SharePointPnP.PowerShell.Tests")]

Commands/Search/SubmitSearchQuery.cs

@@ -99,6 +99,9 @@ public class SubmitSearchQuery : PnPWebCmdlet
         [Parameter(Mandatory = false, HelpMessage = "Determines whether personal favorites data is processed or not.", ParameterSetName = ParameterAttribute.AllParameterSets)]
         public bool ProcessPersonalFavorites;
 
+        [Parameter(Mandatory = false, HelpMessage = "Specifies whether only relevant results are returned", ParameterSetName = ParameterAttribute.AllParameterSets)]
+        public SwitchParameter RelevantResults;
+
         protected override void ExecuteCmdlet()
         {
             int startRow = StartRow;
@@ -164,7 +167,29 @@ protected override void ExecuteCmdlet()
                 }
                 startRow += rowLimit;
             } while (currentCount == rowLimit && All.IsPresent);
-            WriteObject(finalResults, true);
+            if (!RelevantResults.IsPresent)
+            {
+                WriteObject(finalResults, true);
+            }
+            else
+            {
+                var results = finalResults.FirstOrDefault(t => t.TableType == "RelevantResults")?
+                    .ResultRows.Select(r => ConvertToPSObject(r));
+                WriteObject(results, true);
+            }
+        }
+
+        private object ConvertToPSObject(IDictionary<string, object> r)
+        {
+            PSObject res = new PSObject();
+            if(r != null)
+            {
+                foreach(var kvp in r)
+                {
+                    res.Properties.Add(new PSNoteProperty(kvp.Key, kvp.Value));
+                }
+            }
+            return res;
         }
 
         private KeywordQuery CreateKeywordQuery()

Documentation/AddPnPContentType.md

@@ -1,6 +1,6 @@
-#Add-PnPContentType
+# Add-PnPContentType
 Adds a new content type
-##Syntax
+## Syntax
 ```powershell
 Add-PnPContentType -Name <String>
                    [-ContentTypeId <String>]
@@ -11,10 +11,10 @@ Add-PnPContentType -Name <String>
 ```
 
 
-##Returns
+## Returns
 >[Microsoft.SharePoint.Client.ContentType](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.contenttype.aspx)
 
-##Parameters
+## Parameters
 Parameter|Type|Required|Description
 ---------|----|--------|-----------
 |Name|String|True|Specify the name of the new content type|
@@ -23,9 +23,9 @@ Parameter|Type|Required|Description
 |Group|String|False|Specifies the group of the new content type|
 |ParentContentType|ContentType|False|Specifies the parent of the new content type|
 |Web|WebPipeBind|False|The web to apply the command to. Omit this parameter to use the current web.|
-##Examples
+## Examples
 
-###Example 1
+### Example 1
 ```powershell
 PS:> Add-PnPContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ParentContentType $ct
 ```

Documentation/AddPnPContentTypeToDocumentSet.md

@@ -1,36 +1,36 @@
-#Add-PnPContentTypeToDocumentSet
+# Add-PnPContentTypeToDocumentSet
 Adds a content type to a document set
-##Syntax
+## Syntax
 ```powershell
 Add-PnPContentTypeToDocumentSet -ContentType <ContentTypePipeBind[]>
                                 -DocumentSet <DocumentSetPipeBind>
                                 [-Web <WebPipeBind>]
 ```
 
 
-##Parameters
+## Parameters
 Parameter|Type|Required|Description
 ---------|----|--------|-----------
 |ContentType|ContentTypePipeBind[]|True|The content type object, name or id to add. Either specify name, an id, or a content type object.|
 |DocumentSet|DocumentSetPipeBind|True|The document set object or id to add the content type to. Either specify a name, a document set template object, an id, or a content type object|
 |Web|WebPipeBind|False|The web to apply the command to. Omit this parameter to use the current web.|
-##Examples
+## Examples
 
-###Example 1
+### Example 1
 ```powershell
 PS:> Add-PnPContentTypeToDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set"
 ```
 This will add the content type called 'Test CT' to the document set called ''Test Document Set'
 
-###Example 2
+### Example 2
 ```powershell
 PS:> $docset = Get-PnPDocumentSetTemplate -Identity "Test Document Set"
 PS:> $ct = Get-SPOContentType -Identity "Test CT"
 PS:> Add-PnPContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset
 ```
 This will add the content type called 'Test CT' to the document set called ''Test Document Set'
 
-###Example 3
+### Example 3
 ```powershell
 PS:> Add-PnPContentTypeToDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B
 ```

Documentation/AddPnPContentTypeToList.md

@@ -1,6 +1,6 @@
-#Add-PnPContentTypeToList
+# Add-PnPContentTypeToList
 Adds a new content type to a list
-##Syntax
+## Syntax
 ```powershell
 Add-PnPContentTypeToList -List <ListPipeBind>
                          -ContentType <ContentTypePipeBind>
@@ -9,16 +9,16 @@ Add-PnPContentTypeToList -List <ListPipeBind>
 ```
 
 
-##Parameters
+## Parameters
 Parameter|Type|Required|Description
 ---------|----|--------|-----------
 |ContentType|ContentTypePipeBind|True|Specifies the content type that needs to be added to the list|
 |List|ListPipeBind|True|Specifies the list the content type needs to be added to|
 |DefaultContentType|SwitchParameter|False|Specify if the content type needs to be the default content type or not|
 |Web|WebPipeBind|False|The web to apply the command to. Omit this parameter to use the current web.|
-##Examples
+## Examples
 
-###Example 1
+### Example 1
 ```powershell
 PS:> Add-PnPContentTypeToList -List "Documents" -ContentType "Project Document" -DefaultContentType
 ```

Documentation/AddPnPCustomAction.md

@@ -1,6 +1,6 @@
-#Add-PnPCustomAction
+# Add-PnPCustomAction
 Adds a custom action to a web
-##Syntax
+## Syntax
 ```powershell
 Add-PnPCustomAction -Name <String>
                     -Title <String>
@@ -19,7 +19,7 @@ Add-PnPCustomAction -Name <String>
 ```
 
 
-##Parameters
+## Parameters
 Parameter|Type|Required|Description
 ---------|----|--------|-----------
 |Description|String|True|The description of the custom action|
@@ -36,9 +36,9 @@ Parameter|Type|Required|Description
 |Sequence|Int|False|Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page.|
 |Url|String|False|The URL, URI or ECMAScript (JScript, JavaScript) function associated with the action|
 |Web|WebPipeBind|False|The web to apply the command to. Omit this parameter to use the current web.|
-##Examples
+## Examples
 
-###Example 1
+### Example 1
 ```powershell
 $cUIExtn = "<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location=""Ribbon.List.Share.Controls._children""><Button Id=""Ribbon.List.Share.GetItemsCountButton"" Alt=""Get list items count"" Sequence=""11"" Command=""Invoke_GetItemsCountButtonRequest"" LabelText=""Get Items Count"" TemplateAlias=""o1"" Image32by32=""_layouts/15/images/placeholder32x32.png"" Image16by16=""_layouts/15/images/placeholder16x16.png"" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command=""Invoke_GetItemsCountButtonRequest"" CommandAction=""javascript: alert('Total items in this list: '+ ctx.TotalListItems);"" EnabledScript=""javascript: function checkEnable() { return (true);} checkEnable();""/></CommandUIHandlers></CommandUIExtension>"
 

Documentation/AddPnPDataRowsToProvisioningTemplate.md

@@ -1,6 +1,6 @@
-#Add-PnPDataRowsToProvisioningTemplate
+# Add-PnPDataRowsToProvisioningTemplate
 Adds datarows to a list inside a PnP Provisioning Template
-##Syntax
+## Syntax
 ```powershell
 Add-PnPDataRowsToProvisioningTemplate -List <ListPipeBind>
                                       -Query <String>
@@ -12,7 +12,7 @@ Add-PnPDataRowsToProvisioningTemplate -List <ListPipeBind>
 ```
 
 
-##Parameters
+## Parameters
 Parameter|Type|Required|Description
 ---------|----|--------|-----------
 |List|ListPipeBind|True|The list to query|
@@ -22,15 +22,15 @@ Parameter|Type|Required|Description
 |IncludeSecurity|SwitchParameter|False|A switch to include ObjectSecurity information.|
 |TemplateProviderExtensions|ITemplateProviderExtension[]|False|Allows you to specify ITemplateProviderExtension to execute while loading the template.|
 |Web|WebPipeBind|False|The web to apply the command to. Omit this parameter to use the current web.|
-##Examples
+## Examples
 
-###Example 1
+### Example 1
 ```powershell
 PS:> Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '<View></View>' -Fields 'Title','Choice'
 ```
 Adds datarows to a list in an in-memory PnP Provisioning Template
 
-###Example 2
+### Example 2
 ```powershell
 PS:> Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '<View></View>' -Fields 'Title','Choice' -IncludeSecurity
 ```

Documentation/AddPnPDocumentSet.md

@@ -1,6 +1,6 @@
-#Add-PnPDocumentSet
+# Add-PnPDocumentSet
 Creates a new document set in a library.
-##Syntax
+## Syntax
 ```powershell
 Add-PnPDocumentSet -List <ListPipeBind>
                    -Name <String>
@@ -9,19 +9,19 @@ Add-PnPDocumentSet -List <ListPipeBind>
 ```
 
 
-##Returns
+## Returns
 >System.String
 
-##Parameters
+## Parameters
 Parameter|Type|Required|Description
 ---------|----|--------|-----------
 |ContentType|ContentTypePipeBind|True|The name of the content type, its ID or an actual content object referencing to the document set.|
 |List|ListPipeBind|True|The name of the list, its ID or an actual list object from where the document set needs to be added|
 |Name|String|True|The name of the document set|
 |Web|WebPipeBind|False|The web to apply the command to. Omit this parameter to use the current web.|
-##Examples
+## Examples
 
-###Example 1
+### Example 1
 ```powershell
 PS:> Add-PnPDocumentSet -List "Documents" -ContentType "Test Document Set" -Name "Test"
 ```

Documentation/AddPnPEventReceiver.md

@@ -1,6 +1,6 @@
-#Add-PnPEventReceiver
+# Add-PnPEventReceiver
 Adds a new event receiver
-##Syntax
+## Syntax
 ```powershell
 Add-PnPEventReceiver -Name <String>
                      -Url <String>
@@ -13,10 +13,10 @@ Add-PnPEventReceiver -Name <String>
 ```
 
 
-##Returns
+## Returns
 >[Microsoft.SharePoint.Client.EventReceiverDefinition](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.eventreceiverdefinition.aspx)
 
-##Parameters
+## Parameters
 Parameter|Type|Required|Description
 ---------|----|--------|-----------
 |EventReceiverType|EventReceiverType|True|The type of the event receiver like ItemAdded, ItemAdding|
@@ -27,9 +27,9 @@ Parameter|Type|Required|Description
 |List|ListPipeBind|False|The list object or name where the event receiver needs to be added|
 |SequenceNumber|Int|False|The sequence number where this event receiver should be placed|
 |Web|WebPipeBind|False|The web to apply the command to. Omit this parameter to use the current web.|
-##Examples
+## Examples
 
-###Example 1
+### Example 1
 ```powershell
 PS:> Add-PnPEventReceiver -List "ProjectList" -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType ItemAdded -Synchronization Asynchronous
 ```