posh-kentico.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>posh-kentico</name> </assembly> <members> <member name="T:PoshKentico.Cmdlets.Configuration.Settings.GetCmsSettingValueCmdlet"> <summary> <para type="synopsis">Gets the setting values by the provided setting key.</para> <para type="description">Gets the setting values by the provided setting key. </para> /// <example> <para>Get all setting values with a site, and setting key "key".</para> <code>$site | Get-CMSSettingValue -Key "my key"</code> </example> <example> <para>Get all setting values with a site name "site", and setting key "key".</para> <code>Get-CMSSettingValue -SiteName "my site" -Key "my key"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.GetCmsSettingValueCmdlet.Site"> <summary> <para type="description">A reference to the site to get setting from.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.GetCmsSettingValueCmdlet.SiteName"> <summary> <para type="description">The site name of the site to get setting from.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.GetCmsSettingValueCmdlet.Key"> <summary> <para type="description">The key of the setting to get value from.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.GetCmsSettingValueCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this setting service. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Settings.GetCmsSettingValueCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Settings.GetCmsWebConfigValueCmdlet"> <summary> <para type="synopsis">Gets the web.config setting value by the provided setting key.</para> <para type="description">Gets the web.config setting values by the provided setting key or default value if not. </para> /// <example> <para>Get web.config setting values with a key.</para> <code>Get-CMSSettingValue -Key "my key"</code> </example> <example> <para>Get web.config setting values with a key and a culture.</para> <code>Get-CMSSettingValue -Key "my key" -Default "the default value"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.GetCmsWebConfigValueCmdlet.Key"> <summary> <para type="description">The key of the web.config setting to retrive value from.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.GetCmsWebConfigValueCmdlet.Default"> <summary> <para type="description">The default value for the setting.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.GetCmsWebConfigValueCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this setting service. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Settings.GetCmsWebConfigValueCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Settings.SetCmsSettingValueCmdlet"> <summary> <para type="synopsis">Sets the setting values by the provided setting key.</para> <para type="description">Sets the setting values by the provided setting key. </para> /// <example> <para>Set setting values with a new value "new val", for setting with a site, and setting key "key".</para> <code>$site | Set-CMSSettingValue -Key "my key" -Value "new val"</code> </example> <example> <para>Set setting values with a new value "new val", for setting with site name "site", and setting key "key".</para> <code>Set-CMSSettingValue -SiteName "my site" -Key "my key" -Value "new val"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.SetCmsSettingValueCmdlet.Site"> <summary> <para type="description">A reference to the site to set setting for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.SetCmsSettingValueCmdlet.SiteName"> <summary> <para type="description">The site name of the site to set setting for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.SetCmsSettingValueCmdlet.Key"> <summary> <para type="description">The key of the setting to set value for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.SetCmsSettingValueCmdlet.Value"> <summary> <para type="description">The new value of the setting to set value for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Settings.SetCmsSettingValueCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this setting service. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Settings.SetCmsSettingValueCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet"> <summary> <para type="synopsis">Adds a culture to a specified site.</para> <para type="description">Adds a culture to a specified site based off of the provided input.</para> <para type="description">This cmdlet returns the newly modified site when the -PassThru switch is used.</para> <example> <para>Add a culture with culture code "cul" to a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</para> <code>Add-CMSSiteCulture -SiteName "*bas*" -CultureCode "cul"</code> </example> <example> <para>Add a culture with culture code "cul" to a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Add-CMSSiteCulture -SiteName "basic" -EXACT -CultureCode "cul"</code> </example> <example> <para>Add a culture with culture code "cul" to a site.</para> <code>$site | Add-CMSSiteCulture -CultureCode "cul"</code> </example> <example> <para>Add a culture with culture code "cul" with the specified site IDs.</para> <code>Add-CMSSiteCulture -ID 1,2,3 -CultureCode "cul"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.SiteName"> <summary> <para type="description">The site name for the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.SiteToAdd"> <summary> <para type="description">A reference to the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for site name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.ID"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.CultureCode"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for adding culture to this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet"> <summary> <para type="synopsis">Adds a domain alias to a specified site.</para> <para type="description">Adds a domain alias to a specified site based off of the provided input.</para> <example> <para>Add a domain alias with alias name "alias" to a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</para> <code>Add-CMSSiteDomainAlias -SiteName "*bas*" -AliasName "alias"</code> </example> <example> <para>Add a domain alias with alias name "alias" to a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Add-CMSSiteDomainAlias -SiteName "basic" -EXACT -AliasName "alias"</code> </example> <example> <para>Add a domain alias with alias name "alias" to a site.</para> <code>$site | Add-CMSSiteDomainAlias -AliasName "alias"</code> </example> <example> <para>Add a domain alias with alias name "alias" with the specified site IDs.</para> <code>Add-CMSSiteDomainAlias -ID 1,2,3 -AliasName "alias"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.SiteToAdd"> <summary> <para type="description">A reference to the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.SiteName"> <summary> <para type="description">The site name for the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for site name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.ID"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.AliasName"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for adding domain alias to this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet"> <summary> <para type="synopsis">Gets the sites selected by the provided input.</para> <para type="description">Gets the sites selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <para type="description">Without parameters, this command returns all sites.</para> <para type="description">With parameters, this command returns the sites that match the criteria.</para> <example> <para>Get all the sites.</para> <code>Get-CMSSite</code> </example> <example> <para>Get all sites with a display name "*bas*", site name "*bas*", or a domain name "bas*".</para> <code>Get-CMSSite bas</code> </example> <example> <para>Get all sites with a display name "basic", site name "basic", or domain name "basic"</para> <code>Get-CMSSite basic -Exact</code> </example> <example> <para>Get all the sites with the specified IDs.</para> <code>Get-CMSSite -ID 5,304,5</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.DisplayName"> <summary> <para type="description">The display name of the site to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for display name and category name and starts with for path.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.ID"> <summary> <para type="description">The IDs of the site to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCultureCmdlet"> <summary> <para type="synopsis">Gets the cultures of the specified site.</para> <para type="description">Gets the cultures of the specified site based off of the provided input.</para> <example> <para>Gets the cultures of a site specifying the site name "basic".</para> <code>Get-CMSSiteCulture -SiteName "basic" </code> </example> <example> <para>Gets the cultures of a site passing the site to the cmdlet.</para> <code>$site | Get-CMSSiteCulture</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCultureCmdlet.SiteName"> <summary> <para type="description">The site name for the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCultureCmdlet.SiteToWork"> <summary> <para type="description">A reference to the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCultureCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for adding culture to this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCultureCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteDomainAliasCmdlet"> <summary> <para type="synopsis">Gets the domain aliases of the specified site.</para> <para type="description">Gets the domain aliases of the specified site based off of the provided input.</para> <example> <para>Gets the domain aliases of a site specifying the site name "basic".</para> <code>Get-CMSSiteDomainAlias -SiteName "basic" </code> </example> <example> <para>Gets the domain aliases of a site passing the site to the cmdlet.</para> <code>$site | Get-CMSSiteDomainAlias</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteDomainAliasCmdlet.SiteName"> <summary> <para type="description">The site name for the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteDomainAliasCmdlet.SiteToWork"> <summary> <para type="description">A reference to the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteDomainAliasCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for adding culture to this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteDomainAliasCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.NewCmsSiteCmdlet"> <summary> <para type="synopsis">Creates a new site.</para> <para type="description">Creates a new site based off of the provided input.</para> <para type="description">This cmdlet returns the newly created site when the -PassThru switch is used.</para> <example> <para>Create a new site specifying the display name and domain name.</para> <code>New-CMSSite -DisplayName "My Test Name" -DomainName "My Domain Name"</code> </example> <example> <para>Create a new site specifying the display name, site name, status, and domain name.</para> <code>New-CMSSite -DisplayName "My Test Name" -SiteName "My Site Name" -Status "Running or Stopped" -DomainName "My Domain Name"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.NewCmsSiteCmdlet.DisplayName"> <summary> <para type="description">The display name for the newly created site.</para> <para type="description">Site display name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.NewCmsSiteCmdlet.SiteName"> <summary> <para type="description">The site name for the newly created site.</para> <para type="description">If null, then the display name is used for the site name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.NewCmsSiteCmdlet.Status"> <summary> <para type="description">The status for the newly created site. </para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.NewCmsSiteCmdlet.DomainName"> <summary> <para type="description">The domain name for the newly created site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.NewCmsSiteCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.NewCmsSiteCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.NewCmsSiteCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCmdlet"> <summary> <para type="synopsis">Deletes a site.</para> <para type="description">Deletes a site.</para> <example> <para>Deletes all sites contains a site name "*bas*", display name "*bas*", or a domain name "*bas*".</para> <code>Remove-CMSSite -SiteName "bas"</code> </example> <example> <para>Deletes all sites with a site name "basic", display name "basic", or a domain name "basic".</para> <code>Remove-CMSSite -SiteName "basic" -Exact</code> </example> <example> <para>Deletes a site.</para> <code>$site | Remove-CMSSite</code> </example> <example> <para>Delete all the sites with the specified IDs.</para> <code>Remove-CMSSite -ID 1,2,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCmdlet.SiteToRemove"> <summary> <para type="description">A reference to the site to remove.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCmdlet.SiteName"> <summary> <para type="description">The site name for the site to remove.</para> <para type="description">Site name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for site name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCmdlet.ID"> <summary> <para type="description">The IDs of the web part category to delete.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet"> <summary> <para type="synopsis">Removes a culture to a specified site.</para> <para type="description">Removes a culture to a specified site based off of the provided input.</para> <example> <para>Remove a culture with culture code "cul" from a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</para> <code>Remove-CMSSiteCulture -SiteName "*bas*" -CultureCode "cul"</code> </example> <example> <para>Remove a culture with culture code "cul" from a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Remove-CMSSiteCulture -SiteName "basic" -EXACT -CultureCode "cul"</code> </example> <example> <para>Remove a culture with culture code "cul" from a site.</para> <code>$site | Remove-CMSSiteCulture</code> </example> <example> <para>Remove a culture with culture code "cul" with the specified IDs.</para> <code>Remove-CMSSiteCulture -ID 1,2,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.SiteName"> <summary> <para type="description">The site name for the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.SiteToRemove"> <summary> <para type="description">A reference to the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for site name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.ID"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.CultureCode"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for adding culture to this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet"> <summary> <para type="synopsis">Removes a domain alias to a specified site.</para> <para type="description">Removes a domain alias to a specified site based off of the provided input.</para> <example> <para>Remove a domain alias with alias name "alias" to a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</para> <code>Remove-CMSSiteDomainAlias -SiteName "*bas*" -AliasName "alias"</code> </example> <example> <para>Remove a domain alias with alias name "alias" to a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Remove-CMSSiteDomainAlias -SiteName "basic" -EXACT -AliasName "alias"</code> </example> <example> <para>Remove a domain alias with alias name "alias" to a site.</para> <code>$site | Remove-CMSSiteDomainAlias -AliasName "alias"</code> </example> <example> <para>Remove a domain alias with alias name "alias" with the specified site IDs.</para> <code>Remove-CMSSiteDomainAlias -ID 1,2,3 -AliasName "alias"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.SiteToRemove"> <summary> <para type="description">A reference to the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.SiteName"> <summary> <para type="description">The site name for the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for site name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.ID"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.AliasName"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for removing domain alias to this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet"> <summary> <para type="synopsis">Sets a site.</para> <para type="description">Sets a new site based off of the provided input.</para> <para type="description">This cmdlet returns the site to update when the -PassThru switch is used.</para> <example> <para>Set site specifying an existing site.</para> <code>Set-CMSSite -Site $site</code> </example> <example> <para>Set site specifying an existing site.</para> <code>$site | Set-CMSSite</code> </example> <example> <para>Set site specifying the display name, site name, status, and domain name.</para> <code>Set-CMSSite -DisplayName "My Test Name" -SiteName "My Site Name" -Status "Running or Stopped" -DomainName "My Domain Name"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet.SiteToSet"> <summary> <para type="description">A reference to the site to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet.DisplayName"> <summary> <para type="description">The display name for the site to update.</para> <para type="description">Site display name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet.SiteName"> <summary> <para type="description">The site name for the site to update.</para> <para type="description">Site name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet.Status"> <summary> <para type="description">The status for the site to update. </para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet.DomainName"> <summary> <para type="description">The domain name for the site to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the site to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.SetCmsSiteCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.StartCmsSiteCmdlet"> <summary> <para type="synopsis">Starts a site.</para> <para type="description">Starts a site.</para> <example> <para>Starts a site contains a site name "*bas*", display name "*bas*", or a domain name "bas*".</para> <code>Start-CMSSite -SiteName "bas"</code> </example> <example> <para>Starts a site with a site name "basic", display name "basic", or a domain name "basic".</para> <code>Start-CMSSite -Site "basic" -EXACT</code> </example> <example> <para>Starts a site.</para> <code>$site| Start-CMSSite</code> </example> <example> <para>Starts all the sites with the specified IDs.</para> <code>Start-CMSSite -ID 1,2,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StartCmsSiteCmdlet.SiteToStart"> <summary> <para type="description">A reference to the site to start.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StartCmsSiteCmdlet.SiteName"> <summary> <para type="description">The site name for the site to start.</para> <para type="description">Site name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StartCmsSiteCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for site name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StartCmsSiteCmdlet.ID"> <summary> <para type="description">The IDs of the web part category to start.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StartCmsSiteCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.StartCmsSiteCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet"> <summary> <para type="synopsis">Stops a site.</para> <para type="description">Stops a site.</para> <example> <para>Stops a site contains a site name "*bas*", display name "*bas*", or a domain name "bas*".</para> <code>Stop-CMSSite -SiteName "bas"</code> </example> <example> <para>Stops a site with a site name "basic", display name "basic", or a domain name "basic".</para> <code>Stop-CMSSite -Site "basic" -EXACT</code> </example> <example> <para>Stops a site.</para> <code>$site| Stop-CMSSite</code> </example> <example> <para>Stops all the sites with the specified IDs.</para> <code>Stop-CMSSite -ID 1,2,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.SiteToStart"> <summary> <para type="description">A reference to the site to stop.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.SiteName"> <summary> <para type="description">The site name for the site to stop.</para> <para type="description">Site name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for site name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.ID"> <summary> <para type="description">The IDs of the web part category to stop.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet"> <summary> <para type="synopsis">Gets the servers selected by the provided input.</para> <para type="description">Gets the servers selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <para type="description">Without parameters, this command returns all servers.</para> <para type="description">With parameters, this command returns the servers that match the criteria.</para> <example> <para>Get all the servers.</para> <code>Get-CMSServer</code> </example> <example> <para>Get all servers with a display name "*bas*", or server name "*bas*".</para> <code>Get-CMSServer bas</code> </example> <example> <para>Get all servers with a site id 5, and a display name "*bas*" or server name "*bas*".</para> <code>Get-CMSServer -SiteID 5 -ServerName "bas"</code> </example> <example> <para>Get all servers associalted with site $site with a display name "*bas*", or server name "*bas*"</para> <code>$site | Get-CMSServer bas</code> </example> <example> <para>Get all servers with a display name "basic", or server name "basic"</para> <code>Get-CMSServer basic -Exact</code> </example> <example> <para>Get all servers with a site id 5, and a display name "basic" or server name "basic"</para> <code>Get-CMSServer 5 basic -Exact</code> </example> <example> <para>Get all servers associalted with site $site with a display name "basic", or server name "basic"</para> <code>$site | Get-CMSServer basic -Exact</code> </example> <example> <para>Get all the servers with the specified IDs.</para> <code>Get-CMSServer -ID 5,304,5</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.SiteID"> <summary> <para type="description">The server site id for the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.DisplayName"> <summary> <para type="description">The display name of the server to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for display name and category name and starts with for path.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.Site"> <summary> <para type="description">The associalted site for the server to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.ID"> <summary> <para type="description">The IDs of the server to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this server. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet"> <summary> <para type="synopsis">Creates a new server.</para> <para type="description">Creates a new server based off of the provided input.</para> <para type="description">This cmdlet returns the newly created server when the -PassThru switch is used.</para> <example> <para>Create a new server specifying the display name and Url, and associated site id.</para> <code>New-CMSServer -DisplayName "My Test Name" -URL "My Server Url" -SiteID 5</code> </example> <example> <para>Create a new server specifying the display name and Url, and associate it to $site.</para> <code>$site | New-CMSServer -DisplayName "My Test Name" -URL "My Server Url"</code> </example> <example> <para>Create a new server specifying the display name, server name, url, authentication, enabled, user name and password, and associated site id.</para> <code>New-CMSServer -DisplayName "My Test Name" -ServerName "My Server Name" -URL "My Server Url" -Authentication UserName -Enabled True -UserName "My User Name" -Password "My Password" -SiteID 5</code> </example> <example> <para>Create a new server specifying the display name, server name, url, authentication, enabled, user name and password, and associate it to $site.</para> <code>$site | New-CMSServer -DisplayName "My Test Name" -ServerName "My Server Name" -URL "My Server Url" -Authentication UserName -Enabled True -UserName "My User Name" -Password "My Password"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.Site"> <summary> <para type="description">The associalted site for the newly created server.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.SiteID"> <summary> <para type="description">The server site id for the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.DisplayName"> <summary> <para type="description">The display name for the newly created server.</para> <para type="description">Server display name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.ServerName"> <summary> <para type="description">The server name for the newly created server.</para> <para type="description">If null, then the display name is used for the server name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.URL"> <summary> <para type="description">The server url for the newly created server.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.Authentication"> <summary> <para type="description">The authentication for the newly created server. </para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.Enabled"> <summary> <para type="description">The enabled status for the newly created server.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.UserName"> <summary> <para type="description">The user name for the newly created server.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.Password"> <summary> <para type="description">The password for the newly created server.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created server.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this server. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Staging.NewCmsServerCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet"> <summary> <para type="synopsis">Removes the servers selected by the provided input.</para> <para type="description">Removes the servers selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Remove all servers with a display name "*bas*", or server name "*bas*".</para> <code>Remove-CMSServer bas</code> </example> <example> <para>Remove all servers with a site id 5, and a display name "*bas*" or server name "*bas*".</para> <code>Remove-CMSServer -SiteID 5 -ServerName "bas"</code> </example> <example> <para>Remove all servers associalted with site $site with a display name "*bas*", or server name "*bas*"</para> <code>$site | Remove-CMSServer bas</code> </example> <example> <para>Remove all servers with a display name "basic", or server name "basic"</para> <code>Remove-CMSServer basic -Exact</code> </example> <example> <para>Remove all servers with a site id 5, and a display name "basic" or server name "basic"</para> <code>Remove-CMSServer -SiteID 5 -ServerName "basic" -Exact</code> </example> <example> <para>Remove all servers associalted with site $site with a display name "basic", or server name "basic"</para> <code>$site | Remove-CMSServer basic -Exact</code> </example> <example> <para>Remove all the servers with the specified IDs.</para> <code>Remove-CMSServer -ID 5,304,5</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.SiteID"> <summary> <para type="description">The server site id for the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.Site"> <summary> <para type="description">The associalted site for the server to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.DisplayName"> <summary> <para type="description">The display name of the server to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for display name and category name and starts with for path.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.ID"> <summary> <para type="description">The IDs of the server to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.BusinessLayer"> <summary> Gets or sets the Business layer for this server. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsStagingTaskCmdlet"> <summary> <para type="synopsis">Remove the staging tasks that target the given server.</para> <para type="description">Removes the staging tasks that target the given server.</para> <example> <para>Given an existing server and synchronize all related staging tasks.</para> <code>Remove-CMSStagingTask -Server $server</code> </example> <example> <para>Given an existing server and synchronize all related staging tasks.</para> <code>$server | Remove-CMSStagingTask</code> </example> <example> <para>Get a server by ServerName and SiteID, and synchronize all related staging tasks.</para> <code>Remove-CMSStagingTask -ServerName "Server Name to Find" -SiteID "Site Id to Find"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsStagingTaskCmdlet.ServerToRemove"> <summary> <para type="description">A reference to the server to remove all related staging tasks.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsStagingTaskCmdlet.ServerName"> <summary> <para type="description">The server name for the server to remove all related staging tasks.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsStagingTaskCmdlet.SiteID"> <summary> <para type="description">The server site id for the server to remove all related staging tasks.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsStagingTaskCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this server. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsStagingTaskCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet"> <summary> <para type="synopsis">Set a new role to log staging tasks under specific task groups.</para> <para type="description">Set a new role to log staging tasks under specific task groups.</para> <example> <para>Set a new role to log staging tasks under specific task groups.</para> <code>Set-CMSRoleLog -Role $role -TaskGroupName "Group_Name"</code> </example> <example> <para>Set a new role to log staging tasks under specific task groups.</para> <code>$role | Set-CMSRoleLog -TaskGroupName "Group_Name"</code> </example> <example> <para>Set a new role to log staging tasks under specific task groups.</para> <code>Set-CMSRoleLog -RoleDisplayName "Role Display Name" -RoleName "Role Name" -SiteID "Site Id" -TaskGroupName "Group_Name"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet.RoleToSet"> <summary> <para type="description">A reference to the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet.RoleName"> <summary> <para type="description">The role name for the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet.SiteID"> <summary> <para type="description">The role site id for the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet.DisplayName"> <summary> <para type="description">The display name for the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet.TaskGroupName"> <summary> <para type="description">The task group name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleLogCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleNoLogCmdlet"> <summary> <para type="synopsis">Sets a new role without logging any staging tasks.</para> <para type="description">Sets a new role without logging any staging tasks.</para> <example> <para>Sets a new role without logging any staging tasks.</para> <code>Set-CMSRoleNoLog -Role $role</code> </example> <example> <para>Set a new role without logging any staging tasks.</para> <code>$role | Set-CMSRoleNoLog</code> </example> <example> <para>Set a new role without logging any staging tasks.</para> <code>Set-CMSRoleNoLog -RoleDisplayName "Role Display Name" -RoleName "Role Name" -SiteID "Site Id"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleNoLogCmdlet.RoleToSet"> <summary> <para type="description">A reference to the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleNoLogCmdlet.RoleName"> <summary> <para type="description">The role name for the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleNoLogCmdlet.SiteID"> <summary> <para type="description">The role site id for the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleNoLogCmdlet.DisplayName"> <summary> <para type="description">The display name for the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleNoLogCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the role to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleNoLogCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Staging.SetCmsRoleNoLogCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Staging.SyncCmsStagingTaskCmdlet"> <summary> <para type="synopsis">Synchronize the staging tasks that target the given server.</para> <para type="description">Synchronize the staging tasks that target the given server.</para> <example> <para>Given an existing server and synchronize all related staging tasks.</para> <code>Sync-CMSStagingTask -Server $server</code> </example> <example> <para>Given an existing server and synchronize all related staging tasks.</para> <code>$server | Sync-CMSStagingTask</code> </example> <example> <para>Get a server by ServerName and SiteID, and synchronize all related staging tasks.</para> <code>Sync-CMSStagingTask -ServerName "Server Name to Find" -SiteID "Site Id to Find"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SyncCmsStagingTaskCmdlet.ServerToSync"> <summary> <para type="description">A reference to the server to sync all related staging tasks.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SyncCmsStagingTaskCmdlet.ServerName"> <summary> <para type="description">The server name for the server to sync all related staging tasks.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SyncCmsStagingTaskCmdlet.SiteID"> <summary> <para type="description">The server site id for the server to sync all related staging tasks.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.SyncCmsStagingTaskCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this server. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Staging.SyncCmsStagingTaskCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet"> <summary> <para type="synopsis">Sets a server.</para> <para type="description">Sets a new server based off of the provided input.</para> <para type="description">This cmdlet returns the server to update when the -PassThru switch is used.</para> <example> <para>Set server specifying an existing server.</para> <code>Set-CMSServer -Server $server</code> </example> <example> <para>Set server specifying an existing server.</para> <code>$server | Set-CMSServer</code> </example> <example> <para>Get server specifying the ServerName and SiteID, Set its DisplayName, URL, Authentication, Enabled, UserName, Password.</para> <code>Set-CMSServer -ServerName "Server Name to find" -SiteID "Site ID to find" -DisplayName "New Display Name" -URL "New URL" -Authentication "UserName or X509" -Enabled "True or False" -UserName "New User Name" -Password "New Password"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.ServerToSet"> <summary> <para type="description">A reference to the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.ServerName"> <summary> <para type="description">The server name for the server to update.</para> <para type="description">If null, then the display name is used for the server name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.SiteID"> <summary> <para type="description">The server site id for the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.DisplayName"> <summary> <para type="description">The display name for the server to update.</para> <para type="description">Server display name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.URL"> <summary> <para type="description">The server url for the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.Authentication"> <summary> <para type="description">The authentication for the server to update. </para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.Enabled"> <summary> <para type="description">The enabled status for the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.UserName"> <summary> <para type="description">The user name for the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.Password"> <summary> <para type="description">The password for the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the server to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this server. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Servers.SetCmsServerCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.GetCMSWebPartCategoryCmdlet"> <summary> <para type="synopsis">Gets the web part categories selected by the provided input.</para> <para type="description">Gets the web part categories selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <para type="description">Without parameters, this command returns all webpart categories.</para> <para type="description">With parameters, this command returns the webpart categories that match the criteria.</para> <example> <para>Get all the webpart categories.</para> <code>Get-CMSWebPartCategory</code> </example> <example> <para>Get all webparts with a category name "*bas*", display name "*bas*", or a path "bas*".</para> <code>Get-CMSWebPartCategory bas</code> </example> <example> <para>Get all webparts with a category name "basic", display name "basic", or path "basic"</para> <code>Get-CMSWebPartCategory basic -Exact</code> </example> <example> <para>Get all the webparts with the specified IDs.</para> <code>Get-CMSWebPartCategory -ID 5,304,5</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.GetCMSWebPartCategoryCmdlet.CategoryName"> <summary> <para type="description">The category name, display name, or path of the webpart category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.GetCMSWebPartCategoryCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for display name and category name and starts with for path.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.GetCMSWebPartCategoryCmdlet.ID"> <summary> <para type="description">The IDs of the web part category to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.GetCMSWebPartCategoryCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.GetCMSWebPartCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.NewCMSWebPartCategoryCmdlet"> <summary> <para type="synopsis">Creates a new web part category.</para> <para type="description">Creates a new web part category based off of the provided input.</para> <para type="description">This cmdlet returns the newly created web part category when the -PassThru switch is used.</para> <example> <para>Create a new web part category implying the display name.</para> <code>New-CMSWebPartCategory -Path /Test/Test1</code> </example> <example> <para>Create a new web part category specifying the display name.</para> <code>New-CMSWebPartCategory -Path /Test/Test1 -DisplayName "My Test Category"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.NewCMSWebPartCategoryCmdlet.DisplayName"> <summary> <para type="description">The display name for the newly created web part category.</para> <para type="description">If null, then the name portion of the path is used for the display name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.NewCMSWebPartCategoryCmdlet.Path"> <summary> <para type="description">The path to create the new web part category at.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.NewCMSWebPartCategoryCmdlet.ImagePath"> <summary> <para type="description">The path for the icon for the newly created web part category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.NewCMSWebPartCategoryCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created web part category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.NewCMSWebPartCategoryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.NewCMSWebPartCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.RemoveCMSWebPartCategoryCmdlet"> <summary> <para type="synopsis">Deletes the web part categories selected by the provided input.</para> <para type="description">Deletes the web part categories selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <para type="description">This command deletes the webpart categories that match the criteria.</para> <example> <para>Delete all the webpart categories.</para> <code>Get-CMSWebPartCategory | Remove-CMSWebPartCategory</code> </example> <example> <para>Delete all webparts with a category name "*bas*", display name "*bas*", or a path "bas*".</para> <code>Remove-CMSWebPartCategory bas</code> </example> <example> <para>Delete all webparts with a category name "basic", display name "basic", or path "basic"</para> <code>Remove-CMSWebPartCategory basic -Exact</code> </example> <example> <para>Delete all the webparts with the specified IDs.</para> <code>Remove-CMSWebPartCategory -ID 5,304,5</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.RemoveCMSWebPartCategoryCmdlet.CategoryName"> <summary> <para type="description">The category name, display name, or path of the webpart category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.RemoveCMSWebPartCategoryCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,</para> <para type="description">else the match performs a contains for display name and category name and starts with for path.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.RemoveCMSWebPartCategoryCmdlet.ID"> <summary> <para type="description">The IDs of the web part category to delete.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.RemoveCMSWebPartCategoryCmdlet.WebPartCategory"> <summary> <para type="description">A reference to the WebPart category to delete.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.RemoveCMSWebPartCategoryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.RemoveCMSWebPartCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.SetCMSWebPartCategoryCmdlet"> <summary> <para type="synopsis">Sets a web part category.</para> <para type="description">Sets a web part category.</para> <example> <para>Sets a web part category.</para> <code>$webPartCategory | Set-CMSWebPartCategory</code> </example> <example> <para>Sets a web part category and returns the result.</para> <code>$webPartCategory | Set-CMSWebPartCategory -Passthru</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.SetCMSWebPartCategoryCmdlet.WebPartCategory"> <summary> <para type="description">A reference to the WebPart category to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.SetCMSWebPartCategoryCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created web part category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.SetCMSWebPartCategoryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.SetCMSWebPartCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet"> <summary> <para type="synopsis">Initializes a connection to the Kentico CMS Server.</para> <para type="description">The Initialize-CMSApplication cmdlet initializes a connection to the Kentico CMS server.</para> <para type="description"></para> <para type="description">If this cmdlet is run without parameters, then it requires administrator permissions to find the Kentico site.</para> <para type="description">It does so by performing the following steps:</para> <para type="description">1. Get a list of all the sites from IIS</para> <para type="description">2. Get a list of all applications from the sites</para> <para type="description">3. Get a list of all the virtual directories from the applications</para> <para type="description">4. Continue processing virtual directory if a web.config file exits</para> <para type="description">5. Parse the document and find an "add" node with name="CMSConnectionString"</para> <para type="description">6. If the connection string is valid, then stop processing</para> <example> <para>Initialize the Kentico CMS Application by searching for the Kentico site.</para> <para>This option requires administrator rights.</para> <code>Initialize-CMSApplication</code> </example> <example> <para>Initialize the Kentico CMS Application by using the specified connection string.</para> <para>This option does not require administrator rights.</para> <code>Initialize-CMSApplication -DatabaseServer KenticoServer -Database Kentico -WebRoot C:\kentico</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet.Cached"> <summary> <para type="description">Use the previous successful site and connection string information found.</para> <para type="description">If none, then this is the same as supplying no parameters.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet.ConnectionString"> <summary> <para type="description">The connection string for the database connection.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet.DatabaseServer"> <summary> <para type="description">The database server to use for generating the connection string.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet.Database"> <summary> <para type="description">The database to use for generating the connection string.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet.Timeout"> <summary> <para type="description">The timeout to use for generating the connection string.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet.WebRoot"> <summary> <para type="description">The root directory for the Kentico site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet.BusinessLayer"> <summary> Gets or sets a reference to the business layer for this cmdlet. Sett by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.General.InitializeCMSApplicationCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Extensions.TypeExtensions"> <summary> Extension Methods for the <see cref="T:System.Type"/> class. </summary> </member> <member name="M:PoshKentico.Extensions.TypeExtensions.InheritsFrom(System.Type,System.Type)"> <summary> Gets if the Type inherits from the specified base type somewhere in its inheritance chain. </summary> <param name="type">The child type.</param> <param name="baseType">The super or base type.</param> <returns>Returns true if type inherits from baseType, otherwise false.</returns> </member> <member name="T:PoshKentico.Extensions.DictionaryExtensions"> <summary> Extension methods for <see cref="T:System.Collections.Generic.Dictionary`2"/> objects. </summary> </member> <member name="M:PoshKentico.Extensions.DictionaryExtensions.ToPSObject(System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Converts a <see cref="T:System.Collections.Generic.Dictionary`2"/> into a <see cref="T:System.Management.Automation.PSObject"/>. </summary> <param name="dictionary"><see cref="T:System.Collections.Generic.Dictionary`2"/> to convert to a <see cref="T:System.Management.Automation.PSObject"/>.</param> <returns>A <see cref="T:System.Management.Automation.PSObject"/> containing the same properties as the <see cref="T:System.Collections.Generic.Dictionary`2"/>.</returns> </member> <member name="T:PoshKentico.Extensions.PSObjectExtensions"> <summary> Extension method for <see cref="T:System.Management.Automation.PSObject"/> objects. </summary> </member> <member name="M:PoshKentico.Extensions.PSObjectExtensions.ToDictionary(System.Management.Automation.PSObject)"> <summary> Converts a <see cref="T:System.Management.Automation.PSObject"/> into a <see cref="T:System.Collections.Generic.Dictionary`2"/>. </summary> <param name="psObject"><see cref="T:System.Management.Automation.PSObject"/> to convert to a <see cref="T:System.Collections.Generic.Dictionary`2"/>.</param> <returns>A <see cref="T:System.Collections.Generic.Dictionary`2"/> containing the same properties as the <see cref="T:System.Management.Automation.PSObject"/>.</returns> </member> <member name="T:PoshKentico.MefCmdlet"> <summary> Base class for MEF cmdlets which automatically fullfill their own dependencies. </summary> </member> <member name="M:PoshKentico.MefCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="T:PoshKentico.MefHost"> <summary> Hosts a shared MEF container which can be used by cmdlets and the navigation provider. </summary> </member> <member name="P:PoshKentico.MefHost.Container"> <summary> The MEF container used for DI. </summary> </member> <member name="M:PoshKentico.MefHost.Initialize"> <summary> Initialize the container. </summary> </member> <member name="T:PoshKentico.Navigation.DynamicParameters.NewWebPartCategoryDynamicParameter"> <summary> Dynamic parameter used for New-Item -ItemType WebPartCategory </summary> </member> <member name="P:PoshKentico.Navigation.DynamicParameters.NewWebPartCategoryDynamicParameter.DisplayName"> <summary> <para type="description">The display name for the webpart category.</para> </summary> </member> <member name="P:PoshKentico.Navigation.DynamicParameters.NewWebPartCategoryDynamicParameter.ImagePath"> <summary> <para type="description">The image to display for the webpart category.</para> </summary> </member> <member name="T:PoshKentico.Navigation.DynamicParameters.NewWebPartDynamicParameter"> <summary> Dynamic parameter used for New-Item -ItemType WebPart </summary> </member> <member name="P:PoshKentico.Navigation.DynamicParameters.NewWebPartDynamicParameter.DisplayName"> <summary> <para type="description">The display name for the webpart.</para> </summary> </member> <member name="P:PoshKentico.Navigation.DynamicParameters.NewWebPartDynamicParameter.FileName"> <summary> <para type="description">The file name for the webpart.</para> </summary> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem"> <summary> Base class for FileSystemItems. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.#ctor(PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem"/> class. </summary> <param name="parent">The parent file system item. Null if root.</param> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Children"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.IsContainer"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Item"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Name"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Parent"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Path"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Delete(System.Boolean)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Exists(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.FindPath(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.GetItemsFromRegex(System.Text.RegularExpressions.Regex)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.GetProperty(System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.NewItem(System.String,System.String,System.Object)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.SetProperty(System.Collections.Generic.Dictionary{System.String,System.Object})"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.DeleteChildren"> <summary> Deletes all children. </summary> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.PurgeUnwantedProperties(System.Collections.ObjectModel.Collection{System.String},System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Removes properties not specified from the provided dictionary. </summary> <param name="providerSpecificPickList">List of properties to keep in the dictionary.</param> <param name="properties">Dictionary which contains properties and values.</param> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem"> <summary> The root file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.#ctor"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem"/> class. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Children"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.IsContainer"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Item"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Path"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Delete(System.Boolean)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Exists(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.FindPath(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.NewItem(System.String,System.String,System.Object)"> <inheritdoc/> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem"> <summary> File system item representing a <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/>. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.#ctor(CMS.PortalEngine.WebPartCategoryInfo,PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem"/> class. </summary> <param name="webPartCategoryInfo">The <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/> for the file system to represent.</param> <param name="parent">The parent file system item. Null if root.</param> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Children"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.IsContainer"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Item"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Path"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Create(System.String,System.String,System.String,PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Creates a new <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/> under the specified parent. </summary> <param name="displayName">Display name for the new <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/>.</param> <param name="name">Name for the <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/>.</param> <param name="imagePath">Image Path for the <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/></param> <param name="parent">The parent of type <see cref="T:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem"/>.</param> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Delete(System.Boolean)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Exists(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.FindPath(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.GetProperty(System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.NewItem(System.String,System.String,System.Object)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.SetProperty(System.Collections.Generic.Dictionary{System.String,System.Object})"> <inheritdoc/> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.IFileSystemItem"> <summary> Interface for FileSystemItems. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Children"> <summary> Gets the Children of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.IsContainer"> <summary> Gets if the file system item is a container </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Item"> <summary> Gets the item that the file system item represents. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Name"> <summary> Gets the name of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Parent"> <summary> Gets the parent of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Path"> <summary> Gets the full path of the file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Delete(System.Boolean)"> <summary> Deletes the file system item. </summary> <param name="recurse">Indicates if the delete function should delete children.</param> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Exists(System.String)"> <summary> Checks if the path specified exists. </summary> <param name="path">File system path to check.</param> <returns>True if exists, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.FindPath(System.String)"> <summary> Finds the file system item representing the path specified. </summary> <param name="regex">File system path to find.</param> <returns>The file system item representing the path specified. Null if not found.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.GetProperty(System.Collections.ObjectModel.Collection{System.String})"> <summary> Gets the specified properties from the item. </summary> <param name="providerSpecificPickList">List of properties to retrieve.</param> <returns>A dictionary containing the requested properties.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.GetItemsFromRegex(System.Text.RegularExpressions.Regex)"> <summary> Gets a list of items under this item that matches the specified regex. </summary> <param name="regex">Regular expression to match.</param> <returns>An array of file system items matching the specified regular expression.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.NewItem(System.String,System.String,System.Object)"> <summary> Creates a new item under the current path. </summary> <param name="name">Name of the new item.</param> <param name="itemTypeName">Type of the new item. Specified as the -ItemType parameter.</param> <param name="newItemValue">Either the dynamic parameter or the value specified on the -Value parameter.</param> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.SetProperty(System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Sets the specified properties on the item. </summary> <param name="propertyValue">A dictionary containing the properties and their respective values.</param> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem"> <summary> File system item representing a <see cref="T:CMS.PortalEngine.WebPartInfo"/>. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.#ctor(CMS.PortalEngine.WebPartInfo,PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem"/> class. </summary> <param name="webPartInfo">The <see cref="T:CMS.PortalEngine.WebPartInfo"/> for the file system to represent.</param> <param name="parent">The parent file system item. Null if root.</param> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Children"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.IsContainer"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Item"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Path"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Create(System.String,System.String,System.String,PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Creates a new <see cref="T:CMS.PortalEngine.WebPartInfo"/> under the specified parent. </summary> <param name="displayName">Display name for the new <see cref="T:CMS.PortalEngine.WebPartInfo"/>.</param> <param name="name">Name for the <see cref="T:CMS.PortalEngine.WebPartInfo"/>.</param> <param name="fileName">File name for the new <see cref="T:CMS.PortalEngine.WebPartInfo"/>.</param> <param name="parent">The parent of type <see cref="T:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem"/>.</param> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Delete(System.Boolean)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Exists(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.FindPath(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.GetProperty(System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.NewItem(System.String,System.String,System.Object)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.SetProperty(System.Collections.Generic.Dictionary{System.String,System.Object})"> <inheritdoc/> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem"> <summary> File system item which represents items that are not actually part of Kentico. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.#ctor(System.String,PoshKentico.Navigation.FileSystemItems.IFileSystemItem,System.Collections.Generic.IEnumerable{PoshKentico.Navigation.FileSystemItems.IFileSystemItem})"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem"/> class. </summary> <param name="path">The path for the current <see cref="T:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem"/>.</param> <param name="parent">The parent <see cref="T:PoshKentico.Navigation.FileSystemItems.IFileSystemItem"/>.</param> <param name="children">The children <see cref="T:PoshKentico.Navigation.FileSystemItems.IFileSystemItem"/>s.</param> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Children"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.IsContainer"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Item"> <inheritdoc/> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Path"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Delete(System.Boolean)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Exists(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.FindPath(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.NewItem(System.String,System.String,System.Object)"> <inheritdoc/> </member> <member name="T:PoshKentico.Navigation.KenticoNavigationCmdletProvider"> <summary> Kentico CMS file system provider for PowerShell. Creates Kentico: by default. </summary> </member> <member name="P:PoshKentico.Navigation.KenticoNavigationCmdletProvider.CmsApplicationService"> <summary> CMS Application service used for interacting with a CMS Application. </summary> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.GetDirectory(System.String)"> <summary> Gets the parent directory of the file system path specified. </summary> <param name="path">The file system path to get the parent directory of.</param> <returns>The parent directory file system path.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.GetName(System.String)"> <summary> Gets the name of the file system path specified. </summary> <param name="path">The file system path to get the name of.</param> <returns>The name of the file system path specified.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.JoinPath(System.String[])"> <summary> Joins two items into a single path using the '\' character. </summary> <param name="items">Lists of items to join.</param> <returns>A single file system path.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.GetProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.GetPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.SetProperty(System.String,System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.SetPropertyDynamicParameters(System.String,System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.ClearProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.ClearPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.ExpandPath(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.IsValidPath(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.InitializeDefaultDrives"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.ItemExists(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.IsItemContainer(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.GetChildItems(System.String,System.Boolean)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.GetItem(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.HasChildItems(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.NewItem(System.String,System.String,System.Object)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.NewItemDynamicParameters(System.String,System.String,System.Object)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.NormalizeRelativePath(System.String,System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.RemoveItem(System.String,System.Boolean)"> <inheritdoc/> </member> </members> </doc> |