@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/new-usingblock.md

@@ -0,0 +1,95 @@
+# New-UsingBlock
+
+New-UsingBlock.
+
+## Syntax
+
+New-UsingBlock \[-InputObject\] <IDisposable> \[-ScriptBlock\] <ScriptBlock>
+
+## Detailed Description
+
+The `New-UsingBlock` command disposes of the provided input object after the specified scriptblock completes execution. You may find the data returned by the scriptblock is contained within the following object `System.Collections.ObjectModel.Collection`1[[System.Management.Automation.PSObject, System.Management.Automation, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]`. This helps when multiple objects are returned and is [known behavior](https://stackoverflow.com/questions/9028804/why-does-invoking-a-powershell-script-block-with-invoke-return-a-collection).
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -InputObject  <IDisposable>
+
+Object that should be disposed after the Script block is executed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ScriptBlock  <ScriptBlock>
+
+Script to be executed within the "Using" context.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 2 |
+| 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.
+
+* System.IDisposable 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* void 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Assuming all items under /sitecore/content/home have both 'Title' and 'MetaTitle' fields... Using New-UsingBlock to bulk update items under /sitecore/Content/ to have their 'MetaTitle' field to be equal to the 'Title' field
+
+```powershell
+New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext) {
+foreach ( $item in (Get-ChildItem -Path master:\Content\Home -Recurse -WithParent) ) {
+        $item."MetaTitle" = $item.Title
+    }
+}
+```
+
+### EXAMPLE 2
+
+Using New-UsingBlock to perform a test with UserSwitcher - checking whether an anonymous user can change a field The test should end up showing the error as below and the Title should not be changed!
+
+```powershell
+$anonymous = Get-User -Identity "extranet\Anonymous"
+$testItem = Get-Item -Path master:\Content\Home
+
+New-UsingBlock (New-Object Sitecore.Security.Accounts.UserSwitcher $anonymous) {
+    $testItem.Title = "If you can see this title it means that anonymous users can change this item!"
+}
+
+
+New-UsingBlock : Exception setting "Title": "Exception calling "Modify" with "3" argument(s): "The current user does not have write access to this item. User: extranet\Anonymous, Item: Home ({110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9})""
+At line:3 char:1
++ New-UsingBlock (New-Object Sitecore.Security.Accounts.UserSwitcher $a ...
++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    + CategoryInfo          : NotSpecified: (:) [New-UsingBlock], SetValueInvocationException
+    + FullyQualifiedErrorId : ScriptSetValueRuntimeException,Spe.Commands.Data.NewUsingBlockCommand
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/out-download.md

@@ -0,0 +1,123 @@
+# Out-Download
+
+Send an object content to the client
+
+## Syntax
+
+Out-Download -InputObject <Object> \[-ContentType <String>\] \[-Name <String>\]
+
+## Detailed Description
+
+The cmdlet allows to send content of an object \(FileInfo, Stream, String, String\[\] or Byte\[\]\) to the client. This is used for example by report scripts to send the report in HTML, Json or Excel without saving the content of the object to the disk drive. You can specify an object type and file name to make sure the downloaded file is interpreted properly by the browser.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -InputObject  <Object>
+
+Object content to be sent to the client. Object must be of one of the following types:
+
+* FileInfo, 
+* Stream, 
+* String, 
+* String\[\], 
+* Byte\[\] 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -ContentType  <String>
+
+The MIME content type of the object. In most cases you can skip this parameter and still have the content type be deduced by the browser from the
+
+Common examples \(after Wikipedia\)
+
+* application/json
+* application/x-www-form-urlencoded
+* application/pdf
+* application/octet-stream
+* multipart/form-data
+* text/html
+* image/png
+* image/jpg 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Name  <String>
+
+Name of the file you want the user browser to save the object as.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* System.Object 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* System.Boolea 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Send first log file to the user
+
+```powershell
+Get-Item "$SitecoreLogFolder\*.*" | select -first 1 | Out-Download
+```
+
+### EXAMPLE 2
+
+Send Hello World text file to the user
+
+```powershell
+"Hello World!" | Out-Download -Name hello-world.txt
+```
+
+### EXAMPLE 3
+
+Get a list of sitecore branches under root item in the master database and send the list to user as excel file
+
+```powershell
+Import-Function -Name ConvertTo-Xlsx
+
+[byte[]]$outobject = Get-ChildItem master:\ | 
+    Select-Object -Property Name, ProviderPath, Language, Varsion | 
+    ConvertTo-Xlsx 
+
+Out-Download -Name "report-$datetime.xlsx" -InputObject $outobject
+```
+
+## Related Topics
+
+* [Send-File](send-file.md)
+* [Receive-File](receive-file.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/protect-item.md

@@ -0,0 +1,120 @@
+# Protect-Item
+
+Protects the Sitecore item.
+
+## Syntax
+
+Protect-Item \[-Item\] <Item> \[-PassThru\]
+
+Protect-Item \[-Path\] <String> \[-PassThru\]
+
+Protect-Item -Id <String> \[-Database <String>\] \[-PassThru\]
+
+## Detailed Description
+
+The Protect-Item command protects the item by making it read-only.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -PassThru  <SwitchParameter>
+
+Passes the processed item back into the pipeline.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be processed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to be processed - can work with Language parameter to specify the language other than current session language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item to be processed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the item to be fetched with Id parameter.
+
+| 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.
+
+* can be piped from another cmdlet\* Sitecore.Data.Items.Item 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Only if -PassThru is used\* Sitecore.Data.Items.Item 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Protect-Item -Path master:\content\home
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-Item -Path master:\content\home | Protect-Item -PassThru
+
+Name                             Children Languages                Id                                     TemplateName
+----                             -------- ---------                --                                     ------------
+Home                             False    {en, ja-JP, de-DE, da}   {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Unprotect-Item](unprotect-item.md)
+* Get-Item
+

package/dist/tools/powershell/documentation/publish-item.md

@@ -0,0 +1,224 @@
+# Publish-Item
+
+Publishes a Sitecore item.
+
+## Syntax
+
+Publish-Item \[-Item\] <Item> \[-Recurse\] \[-Target <String\[\]>\] \[-PublishMode <Unknown \| Full \| Incremental \| SingleItem \| Smart>\] \[-PublishRelatedItems\] \[-RepublishAll\] \[-CompareRevisions\] \[-FromDate <DateTime>\] \[-AsJob\] \[-Language <String\[\]>\]
+
+Publish-Item \[-Path\] <String> \[-Recurse\] \[-Target <String\[\]>\] \[-PublishMode <Unknown \| Full \| Incremental \| SingleItem \| Smart>\] \[-PublishRelatedItems\] \[-RepublishAll\] \[-CompareRevisions\] \[-FromDate <DateTime>\] \[-AsJob\] \[-Language <String\[\]>\]
+
+Publish-Item -Id <String> \[-Database <String>\] \[-Recurse\] \[-Target <String\[\]>\] \[-PublishMode <Unknown \| Full \| Incremental \| SingleItem \| Smart>\] \[-PublishRelatedItems\] \[-RepublishAll\] \[-CompareRevisions\] \[-FromDate <DateTime>\] \[-AsJob\] \[-Language <String\[\]>\]
+
+## Detailed Description
+
+The Publish-Item command publishes the Sitecore item and optionally subitems. Allowing for granular control over languages and modes of publishing.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Recurse  <SwitchParameter>
+
+Specifies that subitems should also get published with the root item.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Target  <String\[\]>
+
+Specifies one or many publishing targets. The default target database is "web".
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PublishMode  <PublishMode>
+
+Specified the Publish mode. Valid values are:
+
+* Full
+* Incremental
+* SingleItem
+* Smart 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PublishRelatedItems  <SwitchParameter>
+
+Turns publishing of related items on. Works only on Sitecore 7.2 or newer
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -RepublishAll  <SwitchParameter>
+
+Republishes all items provided to the publishing job.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -CompareRevisions  <SwitchParameter>
+
+Turns revision comparison on.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FromDate  <DateTime>
+
+Publishes items newer than the date provided only.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -AsJob  <SwitchParameter>
+
+The Sitecore API called to perform the publish is different with this switch. You may find that events fire as expected using this.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  <String\[\]>
+
+Language of the item that should be published. Supports globbing/wildcards. Allows for more than one language to be provided at once. e.g. "en\*", "pl-pl"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item that should be published - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item that should be published - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+| 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.
+
+* None. 
+
+## Notes
+
+Help Author: Michael West, Adam Najmanowicz
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Publish-Item -Path master:\content\home -Target Internet
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-Item -Path master:\content\home | Publish-Item -Recurse -PublishMode Incremental
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-Item -Path master:\content\home | Publish-Item -Recurse -Language "en*"
+```
+
+### EXAMPLE 4
+Publish to many databases
+```text
+PS master:\> $targets = [string[]]@('web','internet')
+PS master:\> Publish-Item -Path master:\content\home -Target $targets
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+