@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/read-variable.md

@@ -0,0 +1,252 @@
+# Read-Variable
+
+Prompts user to provide values for variables required by the script to perform its operation.
+
+## Syntax
+
+```powershell
+Read-Variable [-Parameters <Object[]>] [-Description <String>] [-CancelButtonName <String>] [-OkButtonName <String>] [-ShowHints] [-Validator <ScriptBlock>] [-Title <String>] [-Width <Int32>] [-Height <Int32>]
+```
+
+## Detailed Description
+
+Prompts user to provide values for variables required by the script to perform its operation. If user selects the "OK" button the command will return 'ok' as its value. If user selects the "Cancel" button or closes the window with the "x" button at the top-right corner of the dialog the command will return 'cancel' as its value.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Parameters  &lt;Object\[\]&gt;
+
+Specifies the variables that value should be provided by the user. Each variable definition can have the following structure:
+
+* Name - the name of the PowerShell variable - without the $ sign
+* Value - the initial value of the variable - if the variable have not been created prior to launching the dialog - this will be its value unless the user changes it. if Value is not specified - the existing variable name will be used.
+* Title - The title for the variable shown above the variable editor.
+* Tooltip - The hint describing the parameter further - if the -ShowHints parameter is provided this value will show between the Variable Title and the variable editor.
+* Editor - If the default editor selected does not provide the functionality expected - you can specify this value to customize it \(see examples\)
+* Tab - if this parameter is specified on any Variable the multi-tab dialog will be used instead of a simple one. Provide the tab name on which the variable editor should appear.
+
+Variable type specific:
+
+* Root - for some Item selecting editors you can provide this to limit the selection to only part of the tree
+* Source - for some Item selecting editors you can provide this to parametrize the item selection editor. \(Refer to examples for some sample usages\)
+* Lines - for String variable you can select this parameter if you want to present the user with the multiline editor. The for this parameter is the number of lines that the editor will be configured with.
+* Domain - for user and role selectors you can limit the users & roles presented to only the domain - specified\) 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Description  &lt;String&gt;
+
+Dialog description displayed below the dialog title.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -CancelButtonName  &lt;String&gt;
+
+Text shown on the cancel button.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -OkButtonName  &lt;String&gt;
+
+Text shown on the OK button.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ShowHints  &lt;SwitchParameter&gt;
+
+Specifies whether the variable hints should be displayed. Hints are shown below each the variable title but above the variable editing control.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Validator  &lt;ScriptBlock&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Title  &lt;String&gt;
+
+Dialog title - shown at the top of the dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  &lt;Int32&gt;
+
+Dialog width.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  &lt;Int32&gt;
+
+Dialog width.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Data.Items.Item 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* System.String 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+The following provides a dialog with a dropdown of options, and how to read the selected value.
+
+```powershell
+$options = @{
+    "A"="a"
+    "B"="b"
+}
+
+$props = @{
+    Parameters = @(
+        @{Name="selectedOption"; Title="Choose an option"; Options=$options; Tooltip="Choose one."}
+    )
+    Title = "Option selector"
+    Description = "Choose the right option."
+    Width = 300
+    Height = 300
+    ShowHints = $true
+}
+
+$result = Read-Variable @props
+
+if($result -eq "ok")
+{
+    Write-Host "You chose: $($selectedOption)"
+}
+```
+
+### EXAMPLE 2
+
+Following is an example of a simple dialog asking user for various variable types.
+
+The type of some of the controls displayed to the user are iferred from the variable type \(like the $item variable or DateTime\) The editors for some other are set by providing the "editor" value
+
+```powershell
+$item = Get-Item master:\content\home
+$result = Read-Variable -Parameters `
+    @{ Name = "someText"; Value="Some Text"; Title="Single Line Text"; Tooltip="Tooltip for singleline"; Placeholder="You see this when text box is empty"}, 
+    @{ Name = "multiText"; Value="Multiline Text"; Title="Multi Line Text"; lines=3; Tooltip="Tooltip for multiline"; Placeholder="You will see this when text box is empty"}, 
+    @{ Name = "from"; Value=[System.DateTime]::Now.AddDays(-5); Title="Start Date"; Tooltip="Date since when you want the report to run"; Editor="date time"}, 
+    @{ Name = "user"; Value=$me; Title="Select User"; Tooltip="Tooltip for user"; Editor="user multiple"},
+    @{ Name = "item"; Title="Start Item"; Root="/sitecore/content/"} `
+    -Description "This Dialog shows less editors, it doesn't need tabs as there is less of the edited variables" `
+    -Title "Initialise various variable types (without tabs)" -Width 500 -Height 480 -OkButtonName "Proceed" -CancelButtonName "Abort"
+```
+
+### EXAMPLE 3
+
+Following is an example of a multi tabbed dialog asking user for various variable types.
+
+The type of some of the controls displayed to the user are inferred from the variable type \(like the $item variable or DateTime\) The editors for some other are set by providing the "editor" value
+
+```powershell
+$item = Get-Item master:\content\home
+$result = Read-Variable -Parameters `
+    @{ Name = "silent"; Value=$true; Title="Proceed Silently"; Tooltip="Check this if you don't want to be interrupted"; Tab="Simple"}, 
+    @{ Name = "someText"; Value="Some Text"; Title="Text"; Tooltip="Just a single line of Text"; Tab="Simple"; Placeholder="You see this when text box is empty"}, 
+    @{ Name = "multiText"; Value="Multiline Text"; Title="Longer Text"; lines=3; Tooltip="You can put multi line text here"; Tab="Simple"; Placeholder="You see this when text box is empty"}, 
+    @{ Name = "number"; Value=110; Title="Integer"; Tooltip="I need this number too"; Tab="Simple"}, 
+    @{ Name = "fraction"; Value=1.1; Title="Float"; Tooltip="I'm just a bit over 1"; Tab="Simple"}, 
+    @{ Name = "from"; Value=[System.DateTime]::Now.AddDays(-5); Title="Start Date"; Tooltip="Date since when you want the report to run"; Editor="date time"; Tab="Time"}, 
+    @{ Name = "fromDate"; Value=[System.DateTime]::Now.AddDays(-5); Title="Start Date"; Tooltip="Date since when you want the report to run"; Editor="date"; Tab="Time"}, 
+    @{ Name = "item"; Title="Start Item"; Root="/sitecore/content/"; Tab="Items"}, 
+    @{ Name = "items"; Title="Bunch of Templates"; 
+        Source="DataSource=/sitecore/templates&DatabaseName=master&IncludeTemplatesForDisplay=Node,Folder,Template,Template Folder&IncludeTemplatesForSelection=Template"; 
+        editor="treelist"; Tab="Items"}, 
+    @{ Name = "items2"; Title="Bunch of Templates"; 
+        Source="DataSource=/sitecore/templates&DatabaseName=master&IncludeTemplatesForDisplay=Node,Folder,Template,Template Folder&IncludeTemplatesForSelection=Template"; 
+        editor="multilist"; Tab="More Items"}, 
+    @{ Name = "items3"; Title="Pick One Template"; 
+        Source="DataSource=/sitecore/templates&DatabaseName=master&IncludeTemplatesForDisplay=Node,Folder,Template,Template Folder&IncludeTemplatesForSelection=Template"; 
+        editor="droplist"; Tab="More Items"}, 
+    @{ Name = "user"; Value=$me; Title="Select User"; Tooltip="Tooltip for user"; Editor="user multiple"; Tab="Rights"}, 
+    @{ Name = "role"; Title="Select Role"; Tooltip="Tooltip for role"; Editor="role multiple"; Domain="sitecore"; Tab="Rights"}, `
+    @{ Name = "userOrRole"; Title="Select User or Role"; Tooltip="Tooltip for role"; Editor="user role multiple"; Domain="sitecore"; Tab="Rights" } `
+    -Description "This Dialog shows all available editors in some configurations, the properties are groupped into tabs" `
+    -Title "Initialise various variable types (with tabs)" -Width 600 -Height 640 -OkButtonName "Proceed" -CancelButtonName "Abort" -ShowHints
+if($result -ne "ok")
+{
+    Exit
+}
+```
+
+## Related Topics
+
+* [Show-Alert](show-alert.md)
+* [Show-Application](show-application.md)
+* [Show-Confirm](show-confirm.md)
+* [Show-FieldEditor](show-fieldeditor.md)
+* [Show-Input](show-input.md)
+* [Show-ListView](show-listview.md)
+* [Show-ModalDialog](show-modaldialog.md)
+* [Show-YesNoCancel](show-yesnocancel.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/receive-file.md

@@ -0,0 +1,244 @@
+# Receive-File
+
+Shows a dialog to users allowing to upload files to either server file system or items in media library.
+
+## Syntax
+
+Receive-File \[-Description <String>\] \[-ParentItem\] <Item> \[-Title <String>\] \[-CancelButtonName <String>\] \[-OkButtonName <String>\] \[-Versioned\] \[-Language <String>\] \[-Overwrite\] \[-Unpack\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+Receive-File \[-Description <String>\] \[-Path\] <String> \[-Title <String>\] \[-CancelButtonName <String>\] \[-OkButtonName <String>\] \[-Overwrite\] \[-Unpack\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+Receive-File \[-ParentItem\] <Item> -AdvancedDialog \[-Width <Int32>\] \[-Height <Int32>\]
+
+## Detailed Description
+
+Executing this command with file path on the server \(provided as -Path parameter\) provides script users with means to upload a file from their computer. Executing it for an Item located in Sitecore Media library \(provided as -ParentItem\) allows the user to upload the file as a child to that item. If the file has been uploaded the dialog returns path to the file \(in case of file system storage\) or Item that has been created if the file was uplaoded to media library.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Description  <String>
+
+Dialog description displayed below the dialog title.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ParentItem  <Item>
+
+The item under which the uploaded media items should be stored.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the folder where uploaded file should be stored.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Title  <String>
+
+Dialog title - shown at the top of the dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -CancelButtonName  <String>
+
+Text shown on the cancel button.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -OkButtonName  <String>
+
+Text shown on the OK button.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Versioned  <SwitchParameter>
+
+Indicates that the Media item should be created as a Versioned media item.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  <String>
+
+Specifies the language in which the media item should be created. if not specified - context language is selected.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Overwrite  <SwitchParameter>
+
+indicates that the upload should overwrite a file or a media item if that one exists. Otherwise a file with a non-confilicting name or a sibling media item is created.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Unpack  <SwitchParameter>
+
+Indicates that the uplaod is expected to be a ZIP file which should be unpacked when it's received.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -AdvancedDialog  <SwitchParameter>
+
+Shows advanced dialog where user can upload multiple media items and select if the uploaded items are versioned, overwritten and unpacked.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  <Int32>
+
+Dialog width.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  <Int32>
+
+Dialog width.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Data.Items.Item
+
+  System.String
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Items.Item
+
+  System.String
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Upload text.txt file to server disk drive. A new file is created with a non-conflicting name and the path to it is returned
+
+```powershell
+PS master:\> Receive-File -Path "C:\temp\upload"
+C:\temp\upload\text_029.txt
+```
+
+### EXAMPLE 2
+
+Upload text.txt file to media library under the 'master:\media library\Files' item A new media item is created and returned
+
+```powershell
+PS master:\> Receive-File -ParentItem (get-item "master:\media library\Files") 
+Name Children Languages Id                                     TemplateName
+---- -------- --------- --                                     ------------
+text False    {en}      {7B11CE12-C0FC-4650-916C-2FC76F3DCAAF} File
+```
+
+### EXAMPLE 3
+
+Upload text.txt file to media library under the 'master:\media library\Files' item using advanced dialog. A new media item is created but "undetermined" is returned as the dialog does not return the results.
+
+```powershell
+PS master:\> Receive-File (get-item "master:\media library\Files") -AdvancedDialog
+undetermined
+```
+
+### EXAMPLE 4
+
+Upload text.txt file to media library under the 'master:\media library\Files' item. A new versioned media item in Danish language is created and returned. If the media item existed - it will be overwritten.
+
+```powershell
+PS master:\> Receive-File -ParentItem (get-item "master:\media library\Files") -Overwrite -Language "da" -Versioned
+Name Children Languages Id                                     TemplateName
+---- -------- --------- --                                     ------------
+text False    {en, da}  {307BCF7D-27FD-46FC-BE83-D9ED640CB09F} File
+```
+
+## Related Topics
+
+* [Send-File](send-file.md)
+* [Out-Download](out-download.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/receive-itemclonenotification.md

@@ -0,0 +1,116 @@
+# Receive-ItemCloneNotification
+
+## Syntax
+
+```powershell
+Receive-ItemCloneNotification [-Notification <Notification>] -Notification <Notification> -Action <None | Accept | Reject | Dismiss> [-NotificationType <Notification | ChildCreatedNotification | FieldChangedNotification | FirstVersionAddedNotification | ItemMovedChildCreatedNotification | ItemMovedChildRemovedNotification | ItemMovedNotification | ItemTreeMovedNotification | ItemVersionNotification | OriginalItemChangedTemplateNotification | VersionAddedNotification>] [-Language <String[]>]
+Receive-ItemCloneNotification [-Item] <Item> -Notification <Notification> -Action <None | Accept | Reject | Dismiss> [-NotificationType <Notification | ChildCreatedNotification | FieldChangedNotification | FirstVersionAddedNotification | ItemMovedChildCreatedNotification | ItemMovedChildRemovedNotification | ItemMovedNotification | ItemTreeMovedNotification | ItemVersionNotification | OriginalItemChangedTemplateNotification | VersionAddedNotification>] [-Language <String[]>]
+Receive-ItemCloneNotification [-Path] <String> -Notification <Notification> -Action <None | Accept | Reject | Dismiss> [-NotificationType <Notification | ChildCreatedNotification | FieldChangedNotification | FirstVersionAddedNotification | ItemMovedChildCreatedNotification | ItemMovedChildRemovedNotification | ItemMovedNotification | ItemTreeMovedNotification | ItemVersionNotification | OriginalItemChangedTemplateNotification | VersionAddedNotification>] [-Language <String[]>]
+Receive-ItemCloneNotification -Id <String> [-Database <String>] -Notification <Notification> -Action <None | Accept | Reject | Dismiss> [-NotificationType <Notification | ChildCreatedNotification | FieldChangedNotification | FirstVersionAddedNotification | ItemMovedChildCreatedNotification | ItemMovedChildRemovedNotification | ItemMovedNotification | ItemTreeMovedNotification | ItemVersionNotification | OriginalItemChangedTemplateNotification | VersionAddedNotification>] [-Language <String[]>]
+```
+
+## Detailed Description
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Notification  &lt;Notification&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Action  &lt;NotificationAction&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -NotificationType  &lt;NotificationType&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  &lt;String\[\]&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  &lt;Item&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  &lt;String&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Examples
+
+### EXAMPLE 1
+
+The following gets the cloned `Item`, returns the available notifications, and finally accepts the notifications.
+
+```powershell
+$clonedItem = Get-Item -Path "master:" -ID "{9F158637-52C2-4005-8329-21527685CB71}"
+$clonedItem  | Get-ItemCloneNotification | Receive-ItemCloneNotification -Action Accept
+```
+
+### EXAMPLE 2
+
+The following gets the cloned `Item`, returns the available notifications, and finally rejects the notifications.
+
+```powershell
+$clonedItem = Get-Item -Path "master:" -ID "{9F158637-52C2-4005-8329-21527685CB71}"
+$clonedItem  | Get-ItemCloneNotification | Receive-ItemCloneNotification -Action Reject
+```