PoshKentico.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>PoshKentico</name> </assembly> <members> <member name="T:PoshKentico.Bootstrapper"> <summary> A singleton used for initialization. </summary> </member> <member name="F:PoshKentico.Bootstrapper.instance"> <summary> The instance. </summary> </member> <member name="P:PoshKentico.Bootstrapper.Instance"> <summary> The instance. </summary> </member> <member name="P:PoshKentico.Bootstrapper.OutputService"> <summary> Gets or sets the output service. </summary> </member> <member name="M:PoshKentico.Bootstrapper.Initialize(PoshKentico.ICmdlet)"> <summary> Cmdlet initialization logic. </summary> <param name="cmdlet">The. </param> </member> <member name="T:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter"> <summary> Used by providers for reading and writing content. </summary> </member> <member name="P:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter.ReadWriteService"> <summary> <see cref="T:PoshKentico.Core.Services.Resource.IResourceReaderWriter"/>. </summary> </member> <member name="M:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter.#ctor(PoshKentico.Core.Services.Resource.IResourceReaderWriter)"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter"/> class. </summary> <param name="readWriteService">The <see cref="T:PoshKentico.Core.Services.Resource.IResourceReaderWriter"/>.</param> </member> <member name="M:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter.Close"> <inheritdoc/> </member> <member name="M:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter.Dispose"> <inheritdoc/> </member> <member name="M:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter.Read(System.Int64)"> <inheritdoc/> </member> <member name="M:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter.Seek(System.Int64,System.IO.SeekOrigin)"> <inheritdoc/> </member> <member name="M:PoshKentico.CmdletProviders.Resource.ResourceContentReaderWriter.Write(System.Collections.IList)"> <inheritdoc/> </member> <member name="T:PoshKentico.CmdletProviders.Resource.ResourceProvider"> <summary> Kentico CMS resource provider for PowerShell. Creates KenticoResource by default. </summary> </member> <member name="P:PoshKentico.CmdletProviders.Resource.ResourceProvider.ProviderName"> <inheritdoc/> </member> <member name="P:PoshKentico.CmdletProviders.Resource.ResourceProvider.DriveName"> <inheritdoc/> </member> <member name="P:PoshKentico.CmdletProviders.Resource.ResourceProvider.DriveRootPath"> <inheritdoc/> </member> <member name="P:PoshKentico.CmdletProviders.Resource.ResourceProvider.DriveDescription"> <inheritdoc/> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.AddCmsPermissionToRoleCmdlet"> <summary> <para type="synopsis">Adds module permissions to specified roles.</para> <para type="description">Adds module permissions to specified roles based off of the provided input.</para> <example> <para>Add module permissions to all roles with role name "role".</para> <code>Add-CmsPermissionToRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleName "Rolename"</code> </example> <example> <para>Add module permissions to all roles with role name "*role*".</para> <code>Add-CmsPermissionToRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleName "role" -RegularExpression</code> </example> <example> <para>Add module permissions to all roles with role name "role", site is 2.</para> <code>Add-CmsPermissionToRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleName "role" -SiteID 2</code> </example> <example> <para>Add module permissions to all roles with role name "*role*", site is 2.</para> <code>Add-CmsPermissionToRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleName "role" -SiteID 2 -RegularExpression</code> </example> <example> <para>Add module permissions with the specified role IDs.</para> <code>Add-CmsPermissionToRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleIds 1,2,3</code> </example> <example> <para>Add module permissions with the specified role IDs.</para> <code>Add-CmsPermissionToRole -PermissionNames Read,Write -ResourceName "CMS.Content" -UserName "Username"</code> </example> <example> <para>Add module permissions to all roles with a role name "role".</para> <code>$role | Add-CmsPermissionToRole -PermissionNames Read,Write -ResourceName "CMS.Content"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsPermissionToRoleCmdlet.PermissionNames"> <summary> <para type="description">The permission names of the module to add to the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsPermissionToRoleCmdlet.ResourceName"> <summary> <para type="description">The resource name of the module to add to the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsPermissionToRoleCmdlet.ClassName"> <summary> <para type="description">The class name of the module to add to the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsPermissionToRoleCmdlet.Role"> <summary> <para type="description">The role to add the permissions to.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsPermissionToRoleCmdlet.AddBusinessLayer"> <summary> Gets or sets the Business layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.AddCmsPermissionToRoleCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.AddCmsPermissionToRoleCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Roles.IRole)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUIElementToRoleCmdlet"> <summary> <para type="synopsis">Adds Ui Element to specified roles.</para> <para type="description">Adds Ui Element to specified roles based off of the provided input.</para> <example> <para>Add Ui Element to all roles with role name "role".</para> <code>Add-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleName "Rolename"</code> </example> <example> <para>Add Ui Element to all roles with role name "*role*".</para> <code>Add-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleName "role" -RegularExpression</code> </example> <example> <para>Add Ui Element to all roles with role name "role", site is 2.</para> <code>Add-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleName "role" -SiteID 2</code> </example> <example> <para>Add Ui Element to all roles with role name "*role*", site is 2.</para> <code>Add-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleName "role" -SiteID 2 -RegularExpression</code> </example> <example> <para>Add Ui Element with the specified role IDs.</para> <code>Add-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleIds 1,2,3</code> </example> <example> <para>Add Ui Element with the specified role IDs.</para> <code>Add-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -UserName "Username"</code> </example> <example> <para>Add Ui Element to all roles with a role name "role".</para> <code>$role | Add-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUIElementToRoleCmdlet.ElementName"> <summary> <para type="description">The element name of the Ui element to add to the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUIElementToRoleCmdlet.ResourceName"> <summary> <para type="description">The resource name of the Ui element to add to the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUIElementToRoleCmdlet.Role"> <summary> <para type="description">The role to add a Ui element to.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUIElementToRoleCmdlet.AddBusinessLayer"> <summary> Gets or sets the Business layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUIElementToRoleCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUIElementToRoleCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Roles.IRole)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUserToRoleCmdlet"> <summary> <para type="synopsis">Adds a user to specified roles.</para> <para type="description">Adds a user to specified roles based off of the provided input.</para> <example> <para>Add a user with username "Username" to all roles with role name "role".</para> <code>Add-CMSUserToRole -UserNameToAdd "Username" -RoleName "Rolename"</code> </example> <example> <para>Add a user with username "Username" to all roles with role name "*role*".</para> <code>Add-CMSUserToRole -UserNameToAdd "Username" -RoleName "role" -RegularExpression</code> </example> <example> <para>Add a user with username "Username" to all roles with role name "role", site is 2.</para> <code>Add-CMSUserToRole -UserNameToAdd "Username" -RoleName "role" -SiteID 2</code> </example> <example> <para>Add a user with username "Username" to all roles with role name "*role*", site is 2.</para> <code>Add-CMSUserToRole -UserNameToAdd "Username" -RoleName "role" -SiteID 2 -RegularExpression</code> </example> <example> <para>Add a user with username "Username" with the specified role IDs.</para> <code>Add-CMSUserToRole -UserNameToAdd "Username" -RoleIds 1,2,3</code> </example> <example> <para>Add a user with username "Username" with the specified role IDs.</para> <code>Add-CMSUserToRole -UserNameToAdd "Username" -UserName "Username"</code> </example> <example> <para>Add a user with username "Username" to all roles with a role name "role".</para> <code>$role | Add-CMSUserToRole -UserNameToAdd "Username"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUserToRoleCmdlet.UserNameToAdd"> <summary> <para type="description">The user name of the user to add to the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUserToRoleCmdlet.Role"> <summary> <para type="description">The role to add a user to.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUserToRoleCmdlet.AddBusinessLayer"> <summary> Gets or sets the Business layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUserToRoleCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.AddCmsUserToRoleCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Roles.IRole)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet"> <summary> <para type="synopsis">Gets the roles selected by the provided input.</para> <para type="description"></para> <para type="description">Without parameters, this command returns all roles.</para> <para type="description">With parameters, this command returns the roles that match the criteria.</para> <example> <para>Get all the roles.</para> <code>Get-CMSRole</code> </example> <example> <para>Get all roles with a role name "role".</para> <code>Get-CMSRole -RoleName "role" </code> </example> <example> <para>Get all roles with role name "*role*".</para> <code>Get-CMSRole -RoleName "role" -RegularExpression</code> </example> <example> <para>Get all roles with role name "role", site is 2.</para> <code>Get-CMSRole -RoleName "role" -SiteID 2</code> </example> <example> <para>Get all roles with role name "role", site is 2.</para> <code>Get-CMSRole -RoleName "role" -SiteID 2 -RegularExpression</code> </example> <example> <para>Get all roles with the specified IDs.</para> <code>Get-CMSRole -RoleIds 1,3</code> </example> <example> <para>Get all roles with the specified user name.</para> <code>Get-CMSRole -UserName "Username"</code> </example> <example> <para>Get all roles with the specified user.</para> <code>$user | Get-CMSRole</code> </example> </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.NONE"> <summary> Represents no parameters. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.ROLENAME"> <summary> Represents role name is used in parameter. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.IDSETNAME"> <summary> Represents role id is used in parameter. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.USERNAME"> <summary> Represents user name is used in parameter. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.USEROBJECT"> <summary> Represents user object is used in parameter. </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.RoleName"> <summary> <para type="description">The role name of the role to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.SiteName"> <summary> <para type="description">The site name of the role to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.RoleIds"> <summary> <para type="description">The IDs of the role to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.UserName"> <summary> <para type="description">The user name of the user to retrive roles from.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.User"> <summary> <para type="description">The user to retrive roles from.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.RegularExpression"> <summary> <para type="description">If set, do a regex match, else the exact match.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.GetCmsRoleCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Roles.IRole)"> <summary> When overridden in a child class, operates on the specified action. </summary> <param name="role">The role to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.NewCmsRoleCmdlet"> <summary> <para type="synopsis">Creates a new role.</para> <para type="description">Creates a new role based off of the provided input.</para> <para type="description">This cmdlet returns the newly created role when the -PassThru switch is used.</para> <example> <para>Create a new role specifying the role display name.</para> <code>New-CMSRole -DisplayName "NewRole"</code> </example> <example> <para>Create a new role specifying the role name, full name, email, culture code and privilege level.</para> <code>New-CMSRole -DisplayName "New Role" -RoleName "NewRole" -SiteID 2</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.NewCmsRoleCmdlet.DisplayName"> <summary> <para type="description">The display name for the newly created role.</para> <para type="description">Role display name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.NewCmsRoleCmdlet.RoleName"> <summary> <para type="description">The Role name for the newly created role.</para> <para type="description">Role name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.NewCmsRoleCmdlet.SiteID"> <summary> <para type="description">The site id for the newly created role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.NewCmsRoleCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.NewCmsRoleCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.NewCmsRoleCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsPermissionFromRoleCmdlet"> <summary> <para type="synopsis">Adds module permissions to specified roles.</para> <para type="description">Adds module permissions to specified roles based off of the provided input.</para> <example> <para>Remove module permissions to all roles with role name "role".</para> <code>Remove-CmsPermissionFromRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleName "Rolename"</code> </example> <example> <para>Remove module permissions to all roles with role name "*role*".</para> <code>Remove-CmsPermissionFromRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleName "role" -RegularExpression</code> </example> <example> <para>Remove module permissions to all roles with role name "role", site is 2.</para> <code>Remove-CmsPermissionFromRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleName "role" -SiteID 2</code> </example> <example> <para>Remove module permissions to all roles with role name "*role*", site is 2.</para> <code>Remove-CmsPermissionFromRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleName "role" -SiteID 2 -RegularExpression</code> </example> <example> <para>Remove module permissions with the specified role IDs.</para> <code>Remove-CmsPermissionFromRole -PermissionNames Read,Write -ResourceName "CMS.Content" -RoleIds 1,2,3</code> </example> <example> <para>Remove module permissions with the specified role IDs.</para> <code>Remove-CmsPermissionFromRole -PermissionNames Read,Write -ResourceName "CMS.Content" -UserName "Username"</code> </example> <example> <para>Remove module permissions to all roles with a role name "role".</para> <code>$role | Remove-CmsPermissionFromRole -PermissionNames Read,Write -ResourceName "CMS.Content"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsPermissionFromRoleCmdlet.PermissionNames"> <summary> <para type="description">The permission names of the module to remove from the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsPermissionFromRoleCmdlet.ResourceName"> <summary> <para type="description">The resource name of the module to remove from the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsPermissionFromRoleCmdlet.ClassName"> <summary> <para type="description">The class name of the module to remove from the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsPermissionFromRoleCmdlet.Role"> <summary> <para type="description">The role to remove the permissions to.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsPermissionFromRoleCmdlet.AddBusinessLayer"> <summary> Gets or sets the Business layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsPermissionFromRoleCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsPermissionFromRoleCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Roles.IRole)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsRoleCmdlet"> <summary> <para type="synopsis">Removes the roles selected by the provided input.</para> <para type="description">Removes the roles 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 roles.</para> <para type="description">With parameters, this command returns the roles that match the criteria.</para> <example> <para>Remove all the roles.</para> <code>Remove-CMSRole</code> </example> <example> <para>Remove all roles with a role name "role".</para> <code>Remove-CMSRole -RoleName "role" </code> </example> <example> <para>Remove all roles with role name "*role*".</para> <code>Remove-CMSRole -RoleName "*role*" -RegularExpression</code> </example> <example> <para>Remove all roles with role name "role", site name "SiteName".</para> <code>Remove-CMSRole -RoleName "role" -SiteName "SiteName"</code> </example> <example> <para>Remove all roles with role name "*role*", site name "*SiteName*".</para> <code>Remove-CMSRole -RoleName "role" -SiteName "SiteName" -RegularExpression</code> </example> <example> <para>Remove all roles with role name "role", site id "2".</para> <code>Remove-CMSRole -RoleName "role" -SiteID 2</code> </example> <example> <para>Remove all roles with role name "role", site id "2".</para> <code>Remove-CMSRole -RoleName "*role*" -SiteID 2 -RegularExpression</code> </example> <example> <para>Remove all roles with the specified IDs.</para> <code>Remove-CMSRole -RoleIds 1,3</code> </example> <example> <para>Remove the specified roles from a user.</para> <code>Remove-CMSRole -UserName "userName"</code> </example> <example> <para>Remove the specified user.</para> <code>$user | Remove-CMSRole</code> </example> <example> <para>Remove the specified role.</para> <code>Remove-CMSRole -Role $role</code> </example> <example> <para>Remove the specified role.</para> <code>$role | Remove-CMSRole</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsRoleCmdlet.Role"> <summary> <para type="description">The the role to remove.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsRoleCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for removing the role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsRoleCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsRoleCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Roles.IRole)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUIElementFromRoleCmdlet"> <summary> <para type="synopsis">Adds Ui Element to specified roles.</para> <para type="description">Adds Ui Element to specified roles based off of the provided input.</para> <example> <para>Remove Ui Element to all roles with role name "role".</para> <code>Remove-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleName "Rolename"</code> </example> <example> <para>Remove Ui Element to all roles with role name "*role*".</para> <code>Remove-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleName "role" -RegularExpression</code> </example> <example> <para>Remove Ui Element to all roles with role name "role", site is 2.</para> <code>Remove-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleName "role" -SiteID 2</code> </example> <example> <para>Remove Ui Element to all roles with role name "*role*", site is 2.</para> <code>Remove-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleName "role" -SiteID 2 -RegularExpression</code> </example> <example> <para>Remove Ui Element with the specified role IDs.</para> <code>Remove-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -RoleIds 1,2,3</code> </example> <example> <para>Remove Ui Element with the specified role IDs.</para> <code>Remove-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design" -UserName "Username"</code> </example> <example> <para>Remove Ui Element to all roles with a role name "role".</para> <code>$role | Remove-CmsUiElementToRole -ResourceName "CMS.Design" -ElementName "Design"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUIElementFromRoleCmdlet.ElementName"> <summary> <para type="description">The element name of the module to remove from the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUIElementFromRoleCmdlet.ResourceName"> <summary> <para type="description">The resource name of the Ui element to remove from the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUIElementFromRoleCmdlet.Role"> <summary> <para type="description">The role to remove a Ui element to.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUIElementFromRoleCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUIElementFromRoleCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUIElementFromRoleCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Roles.IRole)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUserFromRoleCmdlet"> <summary> <para type="synopsis">Removes a user to a specified role.</para> <para type="description">Removes a user to a specified role based off of the provided input.</para> <para type="description">This cmdlet returns the newly modified role when the -PassThru switch is used.</para> <example> <para>Remove a user with username "Username" to all roles with a role name "role".</para> <code>Remove-CMSUserFromRole -UserNameToRemove "Username" -RoleName "Rolename"</code> </example> <example> <para>Remove a user with username "Username" to all roles with role name "*role*".</para> <code>Remove-CMSUserFromRole -UserNameToRemove "Username" -RoleName "role" -RegularExpression</code> </example> <example> <para>Remove a user with username "Username" to all roles with role name "role", site is 2.</para> <code>Remove-CMSUserFromRole -UserNameToRemove "Username" -RoleName "role" -SiteID 2</code> </example> <example> <para>Remove a user with username "Username" to all roles with role name "*role*", site is 2.</para> <code>Remove-CMSUserFromRole -UserNameToRemove "Username" -RoleName "role" -SiteID 2 -RegularExpression</code> </example> <example> <para>Remove a user with username "Username" with the specified role IDs.</para> <code>Remove-CMSUserFromRole -UserNameToRemove "Username" -RoleIds 1,2,3</code> </example> <example> <para>Remove a user with username "Username" with the specified role IDs.</para> <code>Remove-CMSUserFromRole -UserNameToRemove "Username" -UserName "Username"</code> </example> <example> <para>Remove a user with username "Username" to all roles with a role name "role".</para> <code>$role | Remove-CMSUserFromRole -UserNameToRemove "Username"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUserFromRoleCmdlet.UserNameToRemove"> <summary> <para type="description">The user name of the user to add to the specified role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUserFromRoleCmdlet.Role"> <summary> <para type="description">The role to add a user to.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUserFromRoleCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUserFromRoleCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.RemoveCmsUserFromRoleCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Roles.IRole)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Roles.SetCmsRoleCmdlet"> <summary> <para type="synopsis">Sets a role.</para> <para type="description">Sets a role based off of the provided input.</para> <para type="description">This cmdlet returns the updated role when the -PassThru switch is used.</para> <example> <para>Set a role specifying the role.</para> <code>Set-CMSRole -Role $role</code> </example> <example> <para>Set a role specifying the role name.</para> <code>$role | Set-CMSRole</code> </example> <example> <para>Find a role by the role name and site id, and set its display name.</para> <code>Set-CMSRole -RoleName "NewRole" -SiteID 2 -DisplayName "New Role"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.SetCmsRoleCmdlet.Role"> <summary> <para type="description">A reference to the role to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.SetCmsRoleCmdlet.RoleName"> <summary> <para type="description">The role name for the role.</para> <para type="description">Role name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.SetCmsRoleCmdlet.SiteID"> <summary> <para type="description">The Site ID for the role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.SetCmsRoleCmdlet.DisplayName"> <summary> <para type="description">The display name for the role.</para> <para type="description">Role display name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.SetCmsRoleCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the role.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Roles.SetCmsRoleCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this role. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Roles.SetCmsRoleCmdlet.ProcessRecord"> <inheritdoc /> </member> <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 cultures to specified sites.</para> <para type="description">Adds cultures to specified sites 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 cultures with culture code "en-US, en-AU" to specified sites specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Add-CMSSiteCulture -SiteName "basic" -CultureCodes "en-US, en-AU"</code> </example> <example> <para>Add cultures with culture code "en-US, en-AU" to specified sites specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Add-CMSSiteCulture -SiteName "*basic*" -CultureCodes "en-US, en-AU" -RegularExpression</code> </example> <example> <para>Add cultures with culture code "en-US, en-AU" to a site.</para> <code>$site | Add-CMSSiteCulture -CultureCodes "en-US, en-AU"</code> </example> <example> <para>Add cultures with culture code "en-US, en-AU" with the specified site IDs.</para> <code>Add-CMSSiteCulture -SiteIds 1,2,3 -CultureCodes "en-US, en-AU"</code> </example> </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.CultureCodes"> <summary> <para type="description">The Culture codes to add to the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.AddBusinessLayer"> <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="M:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteCultureCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet"> <summary> <para type="synopsis">Adds domain aliases to a specified site.</para> <para type="description">Adds domain aliases to a specified site based off of the provided input.</para> <example> <para>Add domain aliases 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*" -AliasNames "alias"</code> </example> <example> <para>Add domain aliases 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" -AliasNames "alias" -RegularExpression </code> </example> <example> <para>Add domain aliases with alias name "alias" to a site.</para> <code>$site | Add-CMSSiteDomainAlias -AliasNames "alias"</code> </example> <example> <para>Add domain aliases with alias name "alias" with the specified site IDs.</para> <code>Add-CMSSiteDomainAlias -SiteIds 1,2,3 -AliasNames "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.AliasNames"> <summary> <para type="description">The alias to add to the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.AddBusinessLayer"> <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="M:PoshKentico.Cmdlets.Configuration.Sites.AddCmsSiteDomainAliasCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <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 "basic", site name "basic", or a domain name "basic".</para> <code>Get-CMSSite basic</code> </example> <example> <para>Get all sites with a display name "basic", site name "basic", or domain name "basic"</para> <code>Get-CMSSite *basic* -RegularExpression</code> </example> <example> <para>Get all the sites with the specified IDs.</para> <code>Get-CMSSite -SiteIds 5,304,5</code> </example> <example> <para>Get all the sites with the specified user.</para> <code>Get-CMSSite -User $user</code> </example> </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.NONE"> <summary> Represents no parameters. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.DISPLAYNAME"> <summary> Represents site name or display name is used in parameter. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.IDSETNAME"> <summary> Represents site id is used in parameter. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.USEROBJECT"> <summary> Represents user object is used in parameter. </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.RegularExpression"> <summary> <para type="description">If set, do a regex match, else the exact match.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.SiteIds"> <summary> <para type="description">The IDs of the site to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.User"> <summary> <para type="description">The user that the sites are assigned to.</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="M:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <summary> When overridden in a child class, operates on the specified action. </summary> <param name="site">The site to operate on.</param> </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>Get all the sites.</para> <code>Get-CMSSiteCulture</code> </example> <example> <para>Get all sites with a display name "basic", site name "basic", or a domain name "basic".</para> <code>Get-CMSSiteCulture basic</code> </example> <example> <para>Get all sites with a display name "basic", site name "basic", or domain name "basic"</para> <code>Get-CMSSiteCulture *basic* -RegularExpression</code> </example> <example> <para>Get all the sites with the specified IDs.</para> <code>Get-CMSSiteCulture -SiteIds 5,304,5</code> </example> <example> <para>Get all the sites with the specified user.</para> <code>Get-CMSSiteCulture -User $user</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteCultureCmdlet.GetBusinessLayer"> <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.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <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>Get all the sites.</para> <code>Get-CMSSiteDomainAlias</code> </example> <example> <para>Get all sites with a display name "basic", site name "basic", or a domain name "basic".</para> <code>Get-CMSSiteDomainAlias basic</code> </example> <example> <para>Get all sites with a display name "basic", site name "basic", or domain name "basic"</para> <code>Get-CMSSiteDomainAlias *basic* -RegularExpression</code> </example> <example> <para>Get all the sites with the specified IDs.</para> <code>Get-CMSSiteDomainAlias -SiteIds 5,304,5</code> </example> <example> <para>Get all the sites with the specified user.</para> <code>Get-CMSSiteDomainAlias -User $user</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.GetCmsSiteDomainAliasCmdlet.GetBusinessLayer"> <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.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <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 "basic", display name "basic", or a domain name "basic".</para> <code>Remove-CMSSite -SiteName "basic"</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*" -RegularExpression</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 -SiteIds 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.RemoveBusinessLayer"> <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="M:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet"> <summary> <para type="synopsis">Removes site cultures from specified sites.</para> <para type="description">Removes site cultures from specified sites based off of the provided input.</para> <example> <para>Remove cultures with culture code "en-US, en-AU" from specified sites specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Remove-CMSSiteCulture -SiteName "basic" -CultureCodes "en-US, en-AU"</code> </example> <example> <para>Remove cultures with culture code "en-US, en-AU" from specified sites specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Remove-CMSSiteCulture -SiteName "*basic*" -CultureCodes "en-US, en-AU" -RegularExpression</code> </example> <example> <para>Remove cultures with culture code "en-US, en-AU" to a specified site.</para> <code>$site | Remove-CMSSiteCulture -CultureCodes "en-US, en-AU"</code> </example> <example> <para>Remove cultures with culture code "en-US, en-AU" with the specified site IDs.</para> <code>Remove-CMSSiteCulture -SiteIds 1,2,3 -CultureCodes "en-US, en-AU"</code> </example> </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.CultureCodes"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business Layer for Removeing culture to this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteCultureCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet"> <summary> <para type="synopsis">Removes domain aliases from a specified site.</para> <para type="description">Removes domain aliases from a specified site based off of the provided input.</para> <example> <para>Remove domain aliases with alias name "alias" from a specified site specifying the site name "*bas*", display name "*bas*", or a domain name "*bas*".</para> <code>Remove-CMSSiteDomainAlias -SiteName "*bas*" -AliasNames "alias"</code> </example> <example> <para>Remove domain aliases with alias name "alias" from a specified site specifying the site name "basic", display name "basic", or a domain name "basic".</para> <code>Remove-CMSSiteDomainAlias -SiteName "basic" -AliasNames "alias" -RegularExpression </code> </example> <example> <para>Remove domain aliases with alias name "alias" from a site.</para> <code>$site | Remove-CMSSiteDomainAlias -AliasNames "alias"</code> </example> <example> <para>Remove domain aliases with alias name "alias" with the specified site IDs.</para> <code>Remove-CMSSiteDomainAlias -SiteIds 1,2,3 -AliasNames "alias"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.SiteToRemove"> <summary> <para type="description">A reference from the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.AliasNames"> <summary> <para type="description">The IDs of the site.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business Layer for removing domain alias from this site. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Sites.RemoveCmsSiteDomainAliasCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <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" -RegularExpression</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 -SiteIds 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.StartBusinessLayer"> <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="M:PoshKentico.Cmdlets.Configuration.Sites.StartCmsSiteCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <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 "basic", display name "basic", or a domain name "basic".</para> <code>Stop-CMSSite -SiteName "bas"</code> </example> <example> <para>Stops a site with a site name "*bas*", display name "*bas*", or a domain name "bas*".</para> <code>Stop-CMSSite -Site "*bas*" -RegularExpression</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 -SiteIds 1,2,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.SiteToStop"> <summary> <para type="description">A reference to the site to stop.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.StopBusinessLayer"> <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="M:PoshKentico.Cmdlets.Configuration.Sites.StopCmsSiteCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <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 "basic", or server name "basic".</para> <code>Get-CMSServer basic</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 -SiteID 5 -ServerName "basic"</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</code> </example> <example> <para>Get all servers with a display name "*basic*", or server name "*basic*"</para> <code>Get-CMSServer *basic* -RegularExpression</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* -RegularExpression</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* -RegularExpression</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="F:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.NONE"> <summary> Represents no parameters. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.OBJECTSET"> <summary> Represents site object is used in parameter. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.DISPLAYNAME"> <summary> Represents server name or display name is used in parameter. </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.IDSETNAME"> <summary> Represents server id is used in parameter. </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.RegularExpression"> <summary> <para type="description">If set, do a regex match, else the exact match.</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="M:PoshKentico.Cmdlets.Configuration.Staging.GetCmsServerCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Staging.IServer)"> <summary> When overridden in a child class, operates on the specified action. </summary> <param name="server">The server to operate on.</param> </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 a server.</para> <code>$server | Remove-CMSServer</code> </example> <example> <para>Remove all servers with a display name "basic", or server name "basic".</para> <code>Remove-CMSServer basic </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"</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</code> </example> <example> <para>Remove all servers with a display name "*basic*", or server name "*basic*"</para> <code>Remove-CMSServer *basic* -RegularExpression</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 5 *basic* -RegularExpression</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* -RegularExpression</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.ServerToRemove"> <summary> <para type="description">A reference to the site to remove.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.RemoveBusinessLayer"> <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="M:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsServerCmslet.ActOnObject(PoshKentico.Core.Services.Configuration.Staging.IServer)"> <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>Remove all related staging tasks for a given server.</para> <code>Remove-CMSStagingTask -Server $server</code> </example> <example> <para>Remove all related staging tasks for a given server.</para> <code>$server | Remove-CMSStagingTask</code> </example> <example> <para>Remove all related staging tasks for servers with a display name "basic", or server name "basic".</para> <code>Remove-CMSServer basic </code> </example> <example> <para>Remove all related staging tasks for all servers with a display name "*basic*", or server name "*basic*"</para> <code>Remove-CMSServer *basic* -RegularExpression</code> </example> <example> <para>Remove all related staging tasks for all servers with a site id 5, and a display name "basic" or server name "basic".</para> <code>Remove-CMSServer -SiteID 5 -ServerName "basic"</code> </example> <example> <para>Remove all related staging tasks for servers associalted with site $site with a display name "basic", or server name "basic"</para> <code>$site | Remove-CMSServer basic</code> </example> <example> <para>Remove all related staging tasks for all servers with a site id 5, and a display name "*basic*" or server name "*basic*"</para> <code>Remove-CMSServer 5 *basic* -RegularExpression</code> </example> <example> <para>Remove all related staging tasks for all servers associalted with site $site with a display name "*basic*", or server name "*basic*"</para> <code>$site | Remove-CMSServer *basic* -RegularExpression</code> </example> <example> <para>Remove all related staging tasks for 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.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.RemoveBusinessLayer"> <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="M:PoshKentico.Cmdlets.Configuration.Staging.RemoveCmsStagingTaskCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Staging.IServer)"> <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>Synchronize all related staging tasks for a given server.</para> <code>Remove-CMSStagingTask -Server $server</code> </example> <example> <para>Synchronize all related staging tasks for a given server.</para> <code>$server | Remove-CMSStagingTask</code> </example> <example> <para>Synchronize all related staging tasks for servers with a display name "basic", or server name "basic".</para> <code>Remove-CMSServer basic </code> </example> <example> <para>Synchronize all related staging tasks for all servers with a display name "*basic*", or server name "*basic*"</para> <code>Remove-CMSServer *basic* -RegularExpression</code> </example> <example> <para>Synchronize all related staging tasks for all servers with a site id 5, and a display name "basic" or server name "basic".</para> <code>Remove-CMSServer -SiteID 5 -ServerName "basic"</code> </example> <example> <para>Synchronize all related staging tasks for servers associalted with site $site with a display name "basic", or server name "basic"</para> <code>$site | Remove-CMSServer basic</code> </example> <example> <para>Synchronize all related staging tasks for all servers with a site id 5, and a display name "*basic*" or server name "*basic*"</para> <code>Remove-CMSServer 5 *basic* -RegularExpression</code> </example> <example> <para>Synchronize all related staging tasks for all servers associalted with site $site with a display name "*basic*", or server name "*basic*"</para> <code>$site | Remove-CMSServer *basic* -RegularExpression</code> </example> <example> <para>Synchronize all related staging tasks for 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.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.SyncBusinessLayer"> <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="M:PoshKentico.Cmdlets.Configuration.Staging.SyncCmsStagingTaskCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Staging.IServer)"> <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.Configuration.Users.AddUserToSiteCmdlet"> <summary> <para type="synopsis">Adds the user to the site selected by the provided input.</para> <para type="description">Adds the user user to the site selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <example> <para>Add the specified user to the site.</para> <code>$user | Add-CMSUserToSite -Site $site</code> </example> <example> <para>Add the specified user to the site.</para> <code>$user | Add-CMSUserToSite -SiteName "MySite"</code> </example> <example> <para>Add the specified user to the site.</para> <code>Add-CMSUserToSite -User $user -Site $site</code> </example> <example> <para>Add the specified user to the site.</para> <code>Add-CMSUserToSite -User $user -SiteName "MySite"</code> </example> </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Users.AddUserToSiteCmdlet.NONE"> <summary> Represents no parameters. </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.AddUserToSiteCmdlet.User"> <summary> <para type="description">The display name of the user to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.AddUserToSiteCmdlet.SiteName"> <summary> <para type="description">The display name of the user to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.AddUserToSiteCmdlet.Site"> <summary> <para type="description">The IDs of the user to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.AddUserToSiteCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this user. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Users.AddUserToSiteCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet"> <summary> <para type="synopsis">Gets the users selected by the provided input.</para> <para type="description">Gets the users 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 users.</para> <para type="description">With parameters, this command returns the users that match the criteria.</para> <example> <para>Get all the users.</para> <code>Get-CMSUser</code> </example> <example> <para>Get all users with a user name "*user*".</para> <code>Get-CMSUser user</code> </example> <example> <para>Get all users with user name "NewUser".</para> <code>Get-CMSUser -UserName "NewUser" -Exact</code> </example> <example> <para>Get all users with the specified IDs.</para> <code>Get-CMSUser -ID 1,3</code> </example> <example> <para>Get all users with the specified role.</para> <code>Get-CMSUser -RoleName "roleName" -SiteID 2</code> </example> </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.NONE"> <summary> Represents no parameters. </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.UserName"> <summary> <para type="description">The display name of the user to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.ID"> <summary> <para type="description">The IDs of the user to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.RoleName"> <summary> <para type="description">The role name of the role which all users belong to.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.SiteID"> <summary> <para type="description">The IDs of the user to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.Role"> <summary> <para type="description">The IDs of the user to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.RegularExpression"> <summary> <para type="description">If set, do a regex match, else the exact match.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this user. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Users.GetCmsUserCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Users.IUser)"> <summary> When overridden in a child class, operates on the specified action. </summary> <param name="user">The user to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet"> <summary> <para type="synopsis">Creates a new user.</para> <para type="description">Creates a new user based off of the provided input.</para> <para type="description">This cmdlet returns the newly created user when the -PassThru switch is used.</para> <example> <para>Create a new user specifying the user name.</para> <code>New-CMSUser -UserName "NewUser"</code> </example> <example> <para>Create a new user specifying the user name, full name, email, culture code and privilege level.</para> <code>New-CMSUser -UserName "NewUser" -FullName "New user" -Email "new.user@domain.com" -PreferredCultureCode "en-us" -SiteIndependentPrivilegeLevel UserPrivilegeLevelEnum.Editor</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet.UserName"> <summary> <para type="description">The User name for the newly created user.</para> <para type="description">User name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet.FullName"> <summary> <para type="description">The full name for the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet.Email"> <summary> <para type="description">The email for the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet.PreferredCultureCode"> <summary> <para type="description">The preferred culture code for the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet.SiteIndependentPrivilegeLevel"> <summary> <para type="description">The preferred culture code for the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this user. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Users.NewCmsUserCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Users.RemoveCmsUserCmdlet"> <summary> <para type="synopsis">Removes the users selected by the provided input.</para> <para type="description">Removes the users 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 removes all users.</para> <para type="description">With parameters, this command removes the users that match the criteria.</para> <example> <para>Remove all the users.</para> <code>Remove-CMSUser</code> </example> <example> <para>Remove all users with a user name "*user*".</para> <code>Remove-CMSUser user</code> </example> <example> <para>Remove all users with user name "NewUser".</para> <code>Remove-CMSUser -UserName "NewUser" -Exact</code> </example> <example> <para>Remove all users with the specified IDs.</para> <code>Remove-CMSUser -ID 1,3</code> </example> <example> <para>Remove the specified user.</para> <code>Remove-CMSUser -User $user</code> </example> <example> <para>Remove the specified user.</para> <code>$user | Remove-CMSUser</code> </example> <example> <para>Remove the specified users from a role.</para> <code>Remove-CMSUser -RoleName "roleName" -SiteID 4</code> </example> <example> <para>Remove the specified users from a role.</para> <code>$role | Remove-CMSUser</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.RemoveCmsUserCmdlet.User"> <summary> <para type="description">The display name of the user to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.RemoveCmsUserCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for this user. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Users.RemoveCmsUserCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Users.RemoveCmsUserCmdlet.ActOnObject(PoshKentico.Core.Services.Configuration.Users.IUser)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Users.RemoveUserFromSiteCmdlet"> <summary> <para type="synopsis">Removes the users from the site selected by the provided input.</para> <para type="description">Removes the users from the site selected by the provided input. This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <example> <para>Remove the specified user from the site.</para> <code>$user | Remove-CMSUserFromSite -Site $site</code> </example> <example> <para>Remove the specified user from the site.</para> <code>$user | Remove-CMSUserFromSite -SiteName "MySite"</code> </example> <example> <para>Remove the specified user from the site.</para> <code>Remove-CMSUserFromSite -User $user -Site $site</code> </example> <example> <para>Remove the specified user from the site.</para> <code>Remove-CMSUserFromSite -User $user -SiteName "MySite"</code> </example> </summary> </member> <member name="F:PoshKentico.Cmdlets.Configuration.Users.RemoveUserFromSiteCmdlet.NONE"> <summary> Represents no parameters. </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.RemoveUserFromSiteCmdlet.User"> <summary> <para type="description">The display name of the user to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.RemoveUserFromSiteCmdlet.SiteName"> <summary> <para type="description">The display name of the user to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.RemoveUserFromSiteCmdlet.Site"> <summary> <para type="description">The IDs of the user to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.RemoveUserFromSiteCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this user. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Users.RemoveUserFromSiteCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet"> <summary> <para type="synopsis">Sets a user.</para> <para type="description">Sets a user based off of the provided input.</para> <para type="description">This cmdlet returns the updated user when the -PassThru switch is used.</para> <example> <para>Set a user specifying the user name.</para> <code>Set-CMSUser -User $user</code> </example> <example> <para>Set a user specifying the user name.</para> <code>$user | Set-CMSUser</code> </example> <example> <para>Set a user specifying the user name, full name, email, culture code and privilege level.</para> <code>Set-CMSUser -UserName "NewUser" -FullName "New user" -Email "new.user@domain.com" -PreferredCultureCode "en-us" -SiteIndependentPrivilegeLevel UserPrivilegeLevelEnum.Editor</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.User"> <summary> <para type="description">A reference to the user to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.UserName"> <summary> <para type="description">The User name for the newly created user.</para> <para type="description">User name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.FullName"> <summary> <para type="description">The full name for the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.Email"> <summary> <para type="description">The email for the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.PreferredCultureCode"> <summary> <para type="description">The preferred culture code for the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.SiteIndependentPrivilegeLevel"> <summary> <para type="description">The preferred culture code for the newly created user.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the user to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this user. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Configuration.Users.SetCmsUserCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet"> <summary> <para type="synopsis">Gets the media libraries by the provided input.</para> <para type="description">Gets the media libraries by the provided input. </para> <para type="description">Without parameters, this command returns all libraries.</para> <para type="description">With parameters, this command returns the libraries that match the criteria.</para> <example> <para>Get all the libraries.</para> <code>Get-CMSMediaLibrary</code> </example> <example> <para>Get all libraries with a site ID 1 and library name "*tes*".</para> <code>Get-CMSMediaLibrary -SiteID 1 -LibraryName bas</code> </example> <example> <para>Get all libraries with a site ID 1 and library name "test"</para> <code>Get-CMSMediaLibrary -SiteID 1 -LibraryName "test" -Exact</code> </example> <example> <para>Get all libraries with a site $site and library name "*tes*".</para> <code>$site | Get-CMSMediaLibrary -LibraryName bas</code> </example> <example> <para>Get all libraries with a site $site and library name "test"</para> <code>$site | Get-CMSMediaLibrary -LibraryName "test" -Exact</code> </example> <example> <para>Get all the libraries with the specified IDs.</para> <code>Get-CMSMediaLibrary -ID 1,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet.Site"> <summary> <para type="description">The associalted site for the server to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet.SiteID"> <summary> <para type="description">The site name of the library to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet.LibraryName"> <summary> <para type="description">The library name of the library to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet.Exact"> <summary> <para type="description">If set, the match is exact,else the match performs a contains for library name and category name and starts with for path.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet.ID"> <summary> <para type="description">The IDs of the library to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this media library service. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryCmdlet.ActOnObject(PoshKentico.Core.Services.ContentManagement.MediaLibraries.IMediaLibrary)"> <summary> When overridden in a child class, operates on the specified action. </summary> <param name="library">The media library to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet"> <summary> <para type="synopsis">Gets a list of library files.</para> <para type="description">Gets a list of library files based off of the provided input.</para> <example> <para>Get the list of library files specifying an existing library, and with '*.png*' file extension and from folder "*NewFolder*".</para> <code>Get-CMSMediaLibraryFile -MediaLibrary $library -Extension ".png" -FilePath "NewFolder"</code> </example> <example> <para>Get the list of library files specifying an existing library, and with '.png' file extension and from folder "NewFolder". </para> <code>Get-CMSMediaLibraryFile -MediaLibrary $library -FilePath "NewFolder/Image.png" -EXACT</code> </example> <example> <para>Get the list of library files specifying an existing library, and with '*.png*' file extension and from folder "*NewFolder*".</para> <code>$library | Get-CMSMediaLibraryFile -Extension ".png" -FilePath "NewFolder"</code> </example> <example> <para>Get the list of library files specifying an existing library, and with '.png' file extension and from folder "NewFolder". </para> <code>$library | Get-CMSMediaLibraryFile -FilePath "NewFolder/Image.png" -EXACT</code> </example> <example> <para>Get the list of library files specifying an existing library, and with '*.png*' file extension and from folder "*NewFolder*".</para> <code>Get-CMSMediaLibraryFile -LibraryID 1 -Extension ".png" -FilePath "NewFolder"</code> </example> <example> <para>Get the list of library files specifying an existing library, and with '.png' file extension and from folder "NewFolder". </para> <code>Get-CMSMediaLibraryFile -LibraryID 1 -FilePath "NewFolder/Image.png" -EXACT</code> </example> <example> <para>Get all the library files with the specified IDs.</para> <code>Get-CMSMediaLibraryFile -ID 1,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.MediaLibrary"> <summary> <para type="description">The associalted library for the library files to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.LibraryID"> <summary> <para type="description">The library ID of the library files to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.Extension"> <summary> <para type="description">The file extension of the library files to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.FilePath"> <summary> <para type="description">The file path of the library files to retrive.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.Exact"> <summary> <para type="description">If set, the match is exact, else the match performs a contains for file extension and file path.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.ID"> <summary> <para type="description">The IDs of the library file to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this media library service. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.GetCmsMediaLibraryFileCmdlet.ActOnObject(PoshKentico.Core.Services.ContentManagement.MediaLibraries.IMediaFile)"> <summary> When overridden in a child class, operates on the specified action. </summary> <param name="file">The media library file to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet"> <summary> <para type="synopsis">Creates a new library.</para> <para type="description">Creates a new library based off of the provided input.</para> <para type="description">This cmdlet returns the newly created library when the -PassThru switch is used.</para> <example> <para>Create a new library specifying the associated site id, display name, library name, description, and folder name.</para> <code>New-CMSMediaLibrary -SiteID 1 -DisplayName "My Test Name" -LibraryName "Name" -Description "Library description" -Folder "Images"</code> </example> <example> <para>Create a new library specifying the associated site $site, display name, library name, description, and folder name.</para> <code>$site | New-CMSMediaLibrary -DisplayName "My Test Name" -LibraryName "Name" -Description "Library description" -Folder "Images"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.Site"> <summary> <para type="description">The associalted site for the newly created library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.SiteID"> <summary> <para type="description">The library site id for the library to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.DisplayName"> <summary> <para type="description">The display name for the newly created library.</para> <para type="description">The Media Library display name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.LibraryName"> <summary> <para type="description">The library name for the newly created library.</para> <para type="description">The library name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.Description"> <summary> <para type="description">The library description for the newly created library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.Folder"> <summary> <para type="description">The library folder for the newly created library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this library. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet"> <summary> <para type="synopsis">Creates a media library file.</para> <para type="description">Creates a media library file based off of the provided input.</para> <example> <para>Create a new media library file specifying the associated site id and library name for the library, and the new media file name.</para> <code>New-CMSMediaLibraryFile -SiteID 1 -LibraryName "Name" -LocalFile $file -FileName "Image" -FileTitle "File title" -FilePath "NewFolder/Image/" -FileDescription "Description"</code> </example> <example> <para>Create a new media library file specifying the associated library $library and the new media file name.</para> <code>$file | New-CMSMediaLibraryFile -Library $library -FileName "Image" -FileTitle "File title" -FilePath "NewFolder/Image/" -FileDescription "Description"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.Library"> <summary> <para type="description">The associalted library for the new media file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.SiteID"> <summary> <para type="description">The associalted library site id for the new media file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.LibraryName"> <summary> <para type="description">The library name for the new media file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.LocalFile"> <summary> <para type="description">The file name for the new media file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.FileName"> <summary> <para type="description">The file name for the new media file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.FileTitle"> <summary> <para type="description">The file title for the new media file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.FilePath"> <summary> <para type="description">The file path for the new media file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.FileDescription"> <summary> <para type="description">The file description for the new media file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this library. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFileCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFolderCmdlet"> <summary> <para type="synopsis">Creates a media library folder.</para> <para type="description">Creates a media library folder based off of the provided input.</para> <example> <para>Create a new media library folder specifying the associated site id and library name for the library, and the new folder name.</para> <code>New-CMSMediaLibraryFolder -SiteID 1 -LibraryName "Name" -Folder "Images"</code> </example> <example> <para>Create a new media library folder specifying the associated library $library and the new folder name.</para> <code>$library | New-CMSMediaLibraryFolder -Folder "Images"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFolderCmdlet.Library"> <summary> <para type="description">The associalted library for the new folder.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFolderCmdlet.SiteID"> <summary> <para type="description">The associalted library site id for the new folder.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFolderCmdlet.LibraryName"> <summary> <para type="description">The library name for the new folder.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFolderCmdlet.Folder"> <summary> <para type="description">The folder name for the new folder.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFolderCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this library. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.NewCmsMediaLibraryFolderCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryCmdlet"> <summary> <para type="synopsis">Deletes a library.</para> <para type="description">Deletes a library.</para> <example> <para>Deletes all libraries with a site ID 1 and display name "*tes*".</para> <code>Remove-CMSMediaLibrary -SiteID 1 -LibraryName tes</code> </example> <example> <para>Deletes all libraries with a site ID 1 and display name "test"</para> <code>Remove-CMSMediaLibrary -SiteID 1 -LibraryName test -Exact</code> </example> <example> <para>Deletes a library.</para> <code>$library | Remove-CMSMediaLibrary</code> </example> <example> <para>Delete all the libraries with the specified IDs.</para> <code>Remove-CMSMediaLibrary -ID 1,2,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryCmdlet.MediaLibrary"> <summary> <para type="description">The associalted site for the library to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for this media library service. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryCmdlet.ActOnObject(PoshKentico.Core.Services.ContentManagement.MediaLibraries.IMediaLibrary)"> <inheritdoc/> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFileCmdlet"> <summary> <para type="synopsis">Removes a list of library files.</para> <para type="description">Removes a list of library files based off of the provided input.</para> <example> <para>Remove the specified library file.</para> <code>$libraryFile | Remove-CMSMediaLibraryFile</code> </example> <example> <para>Remove the specified library file.</para> <code>Remove-CMSMediaLibraryFile -MediaFile $libraryFile</code> </example> <example> <para>Remove the list of library files specifying an existing library, and with '*.png*' file extension and from folder "*NewFolder*".</para> <code>Remove-CMSMediaLibraryFile -MediaLibrary $library -Extension ".png" -FilePath "NewFolder"</code> </example> <example> <para>Remove the list of library files specifying an existing library, and with '.png' file extension and from folder "NewFolder". </para> <code>Remove-CMSMediaLibraryFile -MediaLibrary $library -Extension ".png" -FilePath "NewFolder" -EXACT</code> </example> <example> <para>Remove the list of library files specifying an existing library, and with '*.png*' file extension and from folder "*NewFolder*".</para> <code>$library | Remove-CMSMediaLibraryFile -Extension ".png" -FilePath "NewFolder"</code> </example> <example> <para>Remove the list of library files specifying an existing library, and with '.png' file extension and from folder "NewFolder". </para> <code>$library | Remove-CMSMediaLibraryFile -Extension ".png" -FilePath "NewFolder" -EXACT</code> </example> <example> <para>Remove the list of library files specifying an existing library, and with '*.png*' file extension and from folder "*NewFolder*".</para> <code>Remove-CMSMediaLibraryFile -LibraryID 1 -Extension ".png" -FilePath "NewFolder"</code> </example> <example> <para>Remove the list of library files specifying an existing library, and with '.png' file extension and from folder "NewFolder". </para> <code>Remove-CMSMediaLibraryFile -LibraryID 1 -Extension ".png" -FilePath "NewFolder" -EXACT</code> </example> <example> <para>Remove all the library files with the specified IDs.</para> <code>Remove-CMSMediaLibraryFile -ID 1,3</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFileCmdlet.MediaFile"> <summary> <para type="description">The field to remove from Kentico.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFileCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFileCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFileCmdlet.ActOnObject(PoshKentico.Core.Services.ContentManagement.MediaLibraries.IMediaFile)"> <inheritdoc/> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFolderCmdlet"> <summary> <para type="synopsis">Removes a media library folder.</para> <para type="description">Removes a media library folder based off of the provided input.</para> <example> <para>Remove a media library folder specifying the associated site id and library name for the library, and the folder name.</para> <code>Remove-CMSMediaLibraryFolder -SiteID 1 -LibraryName "Name" -Folder "Images"</code> </example> <example> <para>Remove a media library folder specifying the associated library $library and the folder name.</para> <code>$library | Remove-CMSMediaLibraryFolder -Folder "Images"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFolderCmdlet.Library"> <summary> <para type="description">The associalted library for the folder.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFolderCmdlet.SiteID"> <summary> <para type="description">The associalted library site id for the folder.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFolderCmdlet.LibraryName"> <summary> <para type="description">The library name for the folder.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFolderCmdlet.Folder"> <summary> <para type="description">The folder name for the folder.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFolderCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this library. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.RemoveCmsMediaLibraryFolderCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet"> <summary> <para type="synopsis">Sets a library.</para> <para type="description">Sets a library based off of the provided input.</para> <para type="description">This cmdlet returns the updated library when the -PassThru switch is used.</para> <example> <para>Set library specifying an existing library.</para> <code>Set-CMSMediaLibrary -MediaLibrary $library</code> </example> <example> <para>Set library specifying an existing library.</para> <code>$library | Set-CMSMediaLibrary</code> </example> <example> <para>Get library specifying the SiteID and DisplayName, set its LibraryName, Description and Folder.</para> <code>Set-CMSMediaLibrary -SiteID 1 -LibraryName "Name" -DisplayName "My Test Name" -Description "Library description" -Folder "Images"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.LibraryToSet"> <summary> <para type="description">A reference to the updated library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.SiteID"> <summary> <para type="description">The site id for the updated library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.LibraryName"> <summary> <para type="description">The library name for the updated library.</para> <para type="description">The library name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.DisplayName"> <summary> <para type="description">The display name for the updated library.</para> <para type="description">The Media Library display name cannot be blank.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.Description"> <summary> <para type="description">The library description for the updated library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.Folder"> <summary> <para type="description">The library folder for the updated library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the updated library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this library. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryFileCmdlet"> <summary> <para type="synopsis">Sets a media file.</para> <para type="description">Sets a media file based off of the provided input.</para> <para type="description">This cmdlet returns the updated library file when the -PassThru switch is used.</para> <example> <para>Set library specifying an existing library.</para> <code>Set-CMSMediaLibraryFile -MediaFile $libraryFile</code> </example> <example> <para>Set library specifying an existing library.</para> <code>$libraryFile | Set-CMSMediaLibraryFile</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryFileCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the media library file.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryFileCmdlet.MediaFile"> <summary> <para type="description">The media library file to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryFileCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this media library file. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibraryFileCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibrarySecurityOptionCmdlet"> <summary> <para type="synopsis">Sets the media libraries security option by the provided input.</para> <para type="description">Sets the media libraries security option by the provided input. </para> <para type="description">Without parameters, this command sets all libraries.</para> <para type="description">With parameters, this command sets the libraries that match the criteria.</para> <example> <para>Set the security option of all the libraries.</para> <code>Set-CMSMediaLibrarySecurityOption -SecurityProperty Access -SecurityAccess AllUsers</code> </example> <example> <para>Set the security option of all libraries with a site ID 1 and display name "*tes*".</para> <code>Set-CMSMediaLibrarySecurityOption -SiteID 1 -DisplayName bas -SecurityProperty Access -SecurityAccess AllUsers</code> </example> <example> <para>Set the security option of all libraries with a site ID 1 and display name "test"</para> <code>Set-CMSMediaLibrarySecurityOption -SiteID 1 -DisplayName "test" -Exact -SecurityProperty Access -SecurityAccess AllUsers</code> </example> <example> <para>Set the security option of all libraries with a site $site and display name "*tes*".</para> <code>Set-CMSMediaLibrarySecurityOption -Site $site -DisplayName bas -SecurityProperty Access -SecurityAccess AllUsers</code> </example> <example> <para>Set the security option of all libraries with a site $site and display name "test"</para> <code>Set-CMSMediaLibrarySecurityOption -Site $site -DisplayName "test" -Exact -SecurityProperty Access -SecurityAccess AllUsers</code> </example> <example> <para>Set the security option of all the libraries with the specified IDs.</para> <code>Set-CMSMediaLibrarySecurityOption -ID 1,3 -SecurityProperty Access -SecurityAccess AllUsers</code> </example> <example> <para>Set the security option of all the libraries with the specified IDs.</para> <code>Set-CMSMediaLibrarySecurityOption -MediaLibrary $library -SecurityProperty Access -SecurityAccess AllUsers</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibrarySecurityOptionCmdlet.MediaLibrary"> <summary> <para type="description">The field to remove from Kentico.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibrarySecurityOptionCmdlet.SecurityProperty"> <summary> <para type="description">The security property enum for the media library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibrarySecurityOptionCmdlet.SecurityAccess"> <summary> <para type="description">The security access enum for the media library.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibrarySecurityOptionCmdlet.SetOptionBusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibrarySecurityOptionCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.ContentManagement.MediaLibraries.SetCmsMediaLibrarySecurityOptionCmdlet.ActOnObject(PoshKentico.Core.Services.ContentManagement.MediaLibraries.IMediaLibrary)"> <inheritdoc/> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdlet"> <summary> <para type="synopsis">Gets the page template categories selected by the provided input.</para> <para type="description">Gets the page template 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 pagetemplate categories.</para> <para type="description">With parameters, this command returns the pagetemplate categories that match the criteria.</para> <example> <para>Get all the pagetemplate categories.</para> <code>Get-CMSPageTemplateCategory</code> </example> <example> <para>Get all page template categories with a category name "*bas*", display name "*bas*".</para> <code>Get-CMSPageTemplateCategory *bas*</code> </example> <example> <para>Get all page template categories with a category name "basic", display name "basic"</para> <code>Get-CMSPageTemplateCategory basic</code> </example> <example> <para>Get all the page template categories with the specified IDs.</para> <code>Get-CMSPageTemplateCategory -ID 5,304,5</code> </example> <example> <para>Get all the page template categories under the basic category.</para> <code>Get-CMSPageTemplateCategory basic -Recurse</code> </example> <example> <para>Get the page template category associated with the page template.</para> <code>$pageTemplate | Get-PageTemplateCategory</code> </example> <example> <para>Get the page template categories under a parent category.</para> <code>$pageTemplateCategory | Get-PageTemplateCategory</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdlet.ParentPageTemplateCategory"> <summary> <para type="description">The pagetemplate category that contains the pagetemplate categories.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdlet.Recurse"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase"> <summary> Base class for cmdlets that need to Get a list of <see cref="T:CMS.PortalEngine.PageTemplateCategoryInfo"/>. </summary> </member> <member name="F:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.NONE"> <summary> Represents no parameters. </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.CategoryName"> <summary> <para type="description">The category name or display name the pagetemplate category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.CategoryPath"> <summary> <para type="description">The path to get the page template category at.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.ID"> <summary> <para type="description">The IDs of the page template category to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.Recurse"> <summary> <para type="description">Indiciates if the cmdlet should look recursively for page template categories.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.RegularExpression"> <summary> <para type="description">Indicates if the CategoryName supplied is a regular expression.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.PageTemplate"> <summary> <para type="description">The pagetemplate to get the page template category for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.BusinessLayer"> <summary> Gets or sets the Business layer for this page template. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCategoryCmdletBase.ActOnObject(PoshKentico.Core.Services.Development.PageTemplates.IPageTemplateCategory)"> <summary> When overridden in a child class, operates on the specified page template category. </summary> <param name="pageTemplateCategory">The page template category to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet"> <summary> <para type="synopsis">Gets the page templates selected by the provided input.</para> <para type="description">Gets the page templates selected by the provided input.</para> <para type="description">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 pagetemplates.</para> <para type="description">With parameters, this command returns the pagetemplates that match the criteria.</para> <example> <para>Get all the pagetemplates.</para> <code>Get-CMSPageTemplate</code> </example> <example> <para>Get page templates by category.</para> <code>Get-CMSPageTemplateCategory | Get-CMSPageTemplate</code> </example> <example> <para>Get page templates by category name.</para> <code>Get-CMSPageTemplate -Category *test*</code> </example> <example> <para>Get page templates by name.</para> <code>Get-CMSPageTemplate -PageTemplateName *pagetemplatename*</code> </example> <example> <para>Get page templates by path</para> <code>Get-CMSPageTemplate -Path /path/to/pagetemplate</code> </example> </summary> </member> <member name="F:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.NONE"> <summary> Represents no parameters. </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.CategoryName"> <summary> <para type="description">The category name or display name of the pagetemplate category that contains the pagetemplates.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.RegularExpression"> <summary> <para type="description">Indicates if the CategoryName or Name supplied is a regular expression.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.PageTemplateName"> <summary> <para type="description">The name or display name of the pagetemplate.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.PageTemplatePath"> <summary> <para type="description">The path to the pagetemplate.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.PageTemplateCategory"> <summary> <para type="description">An object that represents the pagetemplate category that contains the pagetemplates.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this page template. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.GetCMSPageTemplateCmdlet.ActOnObject(PoshKentico.Core.Services.Development.PageTemplates.IPageTemplate)"> <summary> When overridden in a child class, operates on the specified page template. </summary> <param name="pageTemplate">The page template to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet"> <summary> <para type="synopsis">Creates a new page template.</para> <para type="description">Creates a new page template category based off of the provided input.</para> <para type="description">This cmdlet returns the newly created page template when the -PassThru switch is used.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Create a new page template implying the display name from the path.</para> <code>New-CMSPageTemplate -Path /TestCategory/TestPageTemplate -FileName Test.ascx</code> </example> <example> <para>Create a new page template using the path.</para> <code>New-CMSPageTemplate -Path /TestCategory/TestPageTemplate -FileName Test.ascx -DisplayName TestDisplayName</code> </example> <example> <para>Create a new page template implying the display name from the name.</para> <code>$category | New-CMSPageTemplate -Name TestPageTemplate -FileName Test.ascx</code> </example> <example> <para>Create a new page template using the category and name.</para> <code>$category | New-CMSPageTemplate -Name TestPageTemplate -FileName Test.ascx -DisplayName TestDisplayName</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.ShowAsMasterTemplate"> <summary> <para type="description">Show as master template..</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.PageTemplateForAllPages"> <summary> <para type="description">Page template for all pages.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.IconClass"> <summary> <para type="description">Page template icon class defining the page template thumbnail.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.CSS"> <summary> <para type="description">Page template CSS.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.IsReusable"> <summary> <para type="description">Gets or sets flag whether page template is reusable.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.Description"> <summary> <para type="description">The description for the newly created pagetemplate.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.FileName"> <summary> <para type="description">The file name for the pagetemplate code behind.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.Layout"> <summary> <para type="description">Page template layout.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.LayoutType"> <summary> <para type="description">Page template layout type.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.DisplayName"> <summary> <para type="description">The display name for the newly created pagetemplate.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.Name"> <summary> <para type="description">The Code Name for the pagetemplate.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.Path"> <summary> <para type="description">The path to the pagetemplate.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created page template.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.PageTemplateCategory"> <summary> <para type="description">The pagetemplate category to add the pagetemplate under.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this page template. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.NewCMSPageTemplateCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCategoryCmdlet"> <summary> <para type="synopsis">Deletes the page template categories selected by the provided input.</para> <para type="description">Deletes the page template categories selected by the provided input.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <para type="description">This command deletes the pagetemplate categories that match the criteria.</para> <example> <para>Remove all the pagetemplate categories.</para> <code>Remove-CMSPageTemplateCategory</code> </example> <example> <para>Remove all page template categories with a category name "*bas*", display name "*bas*".</para> <code>Remove-CMSPageTemplateCategory *bas*</code> </example> <example> <para>Remove all page template categories with a category name "basic", display name "basic"</para> <code>Remove-CMSPageTemplateCategory basic</code> </example> <example> <para>Remove all the page template categories with the specified IDs.</para> <code>Remove-CMSPageTemplateCategory -ID 5,304,5</code> </example> <example> <para>Remove all the page template categories under the basic category.</para> <code>Remove-CMSPageTemplateCategory basic -Recurse</code> </example> <example> <para>Remove the page template category associated with the page template.</para> <code>$pageTemplate | Remove-PageTemplateCategory</code> </example> <example> <para>Remove the page template category from Kentico.</para> <code>$pageTemplateCategory | Remove-PageTemplateCategory</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCategoryCmdlet.PageTemplateCategory"> <summary> <para type="description">The page template category to remove from the system.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCategoryCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business Layer for this page template. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCategoryCmdlet.ActOnObject(PoshKentico.Core.Services.Development.PageTemplates.IPageTemplateCategory)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCmdlet"> <summary> <para type="synopsis">Removes the page templates selected by the provided input.</para> <para type="description">Removes the page templates selected by the provided input.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <para type="description">Without parameters, this command removes all pagetemplates.</para> <para type="description">With parameters, this command removes the pagetemplates that match the criteria.</para> <example> <para>Remove all the pagetemplates.</para> <code>Remove-CMSPageTemplate</code> </example> <example> <para>Remove page templates by category.</para> <code>Get-CMSPageTemplateCategory | Remove-CMSPageTemplate</code> </example> <example> <para>Remove page templates by category name.</para> <code>Remove-CMSPageTemplate -Category *test*</code> </example> <example> <para>Remove page templates by name.</para> <code>Remove-CMSPageTemplate -PageTemplateName *pagetemplatename*</code> </example> <example> <para>Remove page templates by path</para> <code>Remove-CMSPageTemplate -Path /path/to/pagetemplate</code> </example> <example> <code>Remove page templates through the pipeline.</code> <code>$pageTemplate | Remove-CMSPageTemplate</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCmdlet.PageTemplate"> <summary> <para type="description">The page template to remove from the system.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for this page template. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.RemoveCMSPageTemplateCmdlet.ActOnObject(PoshKentico.Core.Services.Development.PageTemplates.IPageTemplate)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCategoryCmdlet"> <summary> <para type="synopsis">Sets a page template category.</para> <para type="description">Sets a page template category.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Sets a page template category.</para> <code>$pageTemplateCategory | Set-CMSPageTemplateCategory</code> </example> <example> <para>Sets a page template category and returns the result.</para> <code>$pageTemplateCategory | Set-CMSPageTemplateCategory -PassThru</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCategoryCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the page template category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCategoryCmdlet.PageTemplateCategory"> <summary> <para type="description">A reference to the PageTemplate category to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCategoryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this page template. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCmdlet"> <summary> <para type="synopsis">Sets a page template.</para> <para type="description">Sets a page template.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Sets a page template.</para> <code>$pageTemplate | Set-CMSPageTemplate</code> </example> <example> <para>Sets a page template and returns the result.</para> <code>$pageTemplate | Set-CMSPageTemplate -PassThru</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the page template.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCmdlet.PageTemplate"> <summary> <para type="description">The page template to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this page template. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplates.SetCMSPageTemplateCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.PageTemplate.NewCMSPageTemplateCategoryCmdlet"> <summary> <para type="synopsis">Creates a new page template category.</para> <para type="description">Creates a new page template category based off of the provided input.</para> <para type="description">This cmdlet returns the newly created page template category when the -PassThru switch is used.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Create a new page template category implying the display name.</para> <code>New-CMSPageTemplateCategory -Path /Test/Test1</code> </example> <example> <para>Create a new page template category specifying the display name.</para> <code>New-CMSPageTemplateCategory -Path /Test/Test1 -DisplayName "My Test Category" -CodeName "MyCodeName"</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplate.NewCMSPageTemplateCategoryCmdlet.CodeName"> <summary> <para type="description">The code name for the newly created page template category.</para> <para type="description">If null, then the name portion of the path is used for the code name.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplate.NewCMSPageTemplateCategoryCmdlet.DisplayName"> <summary> <para type="description">The display name for the newly created page template category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplate.NewCMSPageTemplateCategoryCmdlet.Path"> <summary> <para type="description">The path to create the new page template category at.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplate.NewCMSPageTemplateCategoryCmdlet.ImagePath"> <summary> <para type="description">The path for the icon for the newly created page template category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplate.NewCMSPageTemplateCategoryCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created page template category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.PageTemplate.NewCMSPageTemplateCategoryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this page template. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.PageTemplate.NewCMSPageTemplateCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet"> <summary> <para type="synopsis">Adds a field to a web part.</para> <para type="description">Adds a field to the web part and then immediately saves the additional field in Kentico.</para> <para type="description">This cmdlet returns the newly created web part field when the -PassThru switch is used.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Add field to web part.</para> <code>$webPart | Add-CMSWebPartField -DataType Text -Name TestProp -required -size 150 -defaultvalue TestValue</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.Caption"> <summary> <para type="description">The caption for the new field.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.DataType"> <summary> <para type="description">The data type for the new field.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.DefaultValue"> <summary> <para type="description">The default value for the new field.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.Name"> <summary> <para type="description">The default value for the new field.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created web part field.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.Required"> <summary> <para type="description">Indicates if a value is required for the field.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.Size"> <summary> <para type="description">The size to make the new field.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.WebPart"> <summary> <para type="description">The web part to add the field to.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.AddCMSWebPartFieldCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.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 web part categories with a category name "*bas*", display name "*bas*".</para> <code>Get-CMSWebPartCategory *bas*</code> </example> <example> <para>Get all web part categories with a category name "basic", display name "basic"</para> <code>Get-CMSWebPartCategory basic</code> </example> <example> <para>Get all the web part categories with the specified IDs.</para> <code>Get-CMSWebPartCategory -ID 5,304,5</code> </example> <example> <para>Get all the web part categories under the basic category.</para> <code>Get-CMSWebPartCategory basic -Recurse</code> </example> <example> <para>Get the web part category associated with the web part.</para> <code>$webPart | Get-WebPartCategory</code> </example> <example> <para>Get the web part categories under a parent category.</para> <code>$webPartCategory | Get-WebPartCategory</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdlet.ParentWebPartCategory"> <summary> <para type="description">The webpart category that contains the webpart categories.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdlet.Recurse"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase"> <summary> Base class for cmdlets that need to Get a list of <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/>. </summary> </member> <member name="F:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.NONE"> <summary> Represents no parameters. </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.CategoryName"> <summary> <para type="description">The category name or display name the webpart category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.CategoryPath"> <summary> <para type="description">The path to get the web part category at.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.ID"> <summary> <para type="description">The IDs of the web part category to retrieve.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.Recurse"> <summary> <para type="description">Indiciates if the cmdlet should look recursively for web part categories.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.RegularExpression"> <summary> <para type="description">Indicates if the CategoryName supplied is a regular expression.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.WebPart"> <summary> <para type="description">The webpart to get the web part category for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.BusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCategoryCmdletBase.ActOnObject(PoshKentico.Core.Services.Development.WebParts.IWebPartCategory)"> <summary> When overridden in a child class, operates on the specified web part category. </summary> <param name="webPartCategory">The web part category to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet"> <summary> <para type="synopsis">Gets the web parts selected by the provided input.</para> <para type="description">Gets the web parts selected by the provided input.</para> <para type="description">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 webparts.</para> <para type="description">With parameters, this command returns the webparts that match the criteria.</para> <example> <para>Get all the webparts.</para> <code>Get-CMSWebPart</code> </example> <example> <para>Get web parts by category.</para> <code>Get-CMSWebPartCategory | Get-CMSWebPart</code> </example> <example> <para>Get web parts by category name.</para> <code>Get-CMSWebPart -Category *test*</code> </example> <example> <para>Get web parts by name.</para> <code>Get-CMSWebPart -WebPartName *webpartname*</code> </example> <example> <para>Get web parts by path</para> <code>Get-CMSWebPart -Path /path/to/webpart</code> </example> </summary> </member> <member name="F:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.NONE"> <summary> Represents no parameters. </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.CategoryName"> <summary> <para type="description">The category name or display name of the webpart category that contains the webparts.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.Field"> <summary> <para type="description">The field to get the associated web part for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.RegularExpression"> <summary> <para type="description">Indicates if the CategoryName or Name supplied is a regular expression.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.WebPartName"> <summary> <para type="description">The name or display name of the webpart.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.WebPartPath"> <summary> <para type="description">The path to the webpart.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.WebPartCategory"> <summary> <para type="description">An object that represents the webpart category that contains the webparts.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartCmdlet.ActOnObject(PoshKentico.Core.Services.Development.WebParts.IWebPart)"> <summary> When overridden in a child class, operates on the specified web part. </summary> <param name="webPart">The web part to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartFieldCmdlet"> <summary> <para type="synopsis">Gets the web part fields selected by the provided input.</para> <para type="description">Gets the web part fields selected by the provided input.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Gets all the web part fields associated with a web part.</para> <code>$webPart | Get-CMSWebPartField</code> </example> <example> <para>Gets the web part fields associated with a web part that match the specified name.</para> <code>$webPart | Get-CMSWebPartField -Name Test*</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartFieldCmdlet.Name"> <summary> <para type="description">The name for the field to search for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartFieldCmdlet.RegularExpression"> <summary> <para type="description">Indicates if the CategoryName supplied is a regular expression.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartFieldCmdlet.WebPart"> <summary> <para type="description">The web part to get the fields for.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartFieldCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartFieldCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.GetCMSWebPartFieldCmdlet.ActOnObject(PoshKentico.Core.Services.Development.WebParts.IWebPartField)"> <summary> When overridden in a child class, operates on the specified field. </summary> <param name="field">The field to operate on.</param> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet"> <summary> <para type="synopsis">Creates a new web part.</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 when the -PassThru switch is used.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Create a new web part implying the display name from the path.</para> <code>New-CMSWebPart -Path /TestCategory/TestWebPart -FileName Test.ascx</code> </example> <example> <para>Create a new web part using the path.</para> <code>New-CMSWebPart -Path /TestCategory/TestWebPart -FileName Test.ascx -DisplayName TestDisplayName</code> </example> <example> <para>Create a new web part implying the display name from the name.</para> <code>$category | New-CMSWebPart -Name TestWebPart -FileName Test.ascx</code> </example> <example> <para>Create a new web part using the category and name.</para> <code>$category | New-CMSWebPart -Name TestWebPart -FileName Test.ascx -DisplayName TestDisplayName</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet.DisplayName"> <summary> <para type="description">The display name for the newly created webpart.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet.FileName"> <summary> <para type="description">The file name for the webpart code behind.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet.Name"> <summary> <para type="description">The Code Name for the webpart.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet.Path"> <summary> <para type="description">The path to the webpart.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the newly created web part.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet.WebPartCategory"> <summary> <para type="description">The webpart category to add the webpart under.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.NewCMSWebPartCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.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.</para> <para type="description">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>Remove all the webpart categories.</para> <code>Remove-CMSWebPartCategory</code> </example> <example> <para>Remove all web part categories with a category name "*bas*", display name "*bas*".</para> <code>Remove-CMSWebPartCategory *bas*</code> </example> <example> <para>Remove all web part categories with a category name "basic", display name "basic"</para> <code>Remove-CMSWebPartCategory basic</code> </example> <example> <para>Remove all the web part categories with the specified IDs.</para> <code>Remove-CMSWebPartCategory -ID 5,304,5</code> </example> <example> <para>Remove all the web part categories under the basic category.</para> <code>Remove-CMSWebPartCategory basic -Recurse</code> </example> <example> <para>Remove the web part category associated with the web part.</para> <code>$webPart | Remove-WebPartCategory</code> </example> <example> <para>Remove the web part category from Kentico.</para> <code>$webPartCategory | Remove-WebPartCategory</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCategoryCmdlet.WebPartCategory"> <summary> <para type="description">The web part category to remove from the system.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCategoryCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business Layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCategoryCmdlet.ActOnObject(PoshKentico.Core.Services.Development.WebParts.IWebPartCategory)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCmdlet"> <summary> <para type="synopsis">Removes the web parts selected by the provided input.</para> <para type="description">Removes the web parts selected by the provided input.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <para type="description"></para> <para type="description">Without parameters, this command removes all webparts.</para> <para type="description">With parameters, this command removes the webparts that match the criteria.</para> <example> <para>Remove all the webparts.</para> <code>Remove-CMSWebPart</code> </example> <example> <para>Remove web parts by category.</para> <code>Get-CMSWebPartCategory | Remove-CMSWebPart</code> </example> <example> <para>Remove web parts by category name.</para> <code>Remove-CMSWebPart -Category *test*</code> </example> <example> <para>Remove web parts by name.</para> <code>Remove-CMSWebPart -WebPartName *webpartname*</code> </example> <example> <para>Remove web parts by path</para> <code>Remove-CMSWebPart -Path /path/to/webpart</code> </example> <example> <code>Remove web parts through the pipeline.</code> <code>$webPart | Remove-CMSWebPart</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCmdlet.WebPart"> <summary> <para type="description">The web part to remove from the system.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartCmdlet.ActOnObject(PoshKentico.Core.Services.Development.WebParts.IWebPart)"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartFieldCmdlet"> <summary> <para type="synopsis">Remove the web part fields selected by the provided input.</para> <para type="description">Remove the web part fields selected by the provided input.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Remove all the web part fields associated with a web part.</para> <code>$webPart | Remove-CMSWebPartField</code> </example> <example> <para>Remove the web part fields associated with a web part that match the specified name.</para> <code>$webPart | Remove-CMSWebPartField -Name Test*</code> </example> <example> <para>Remove the web part field from Kentico.</para> <code>$webPartField | Remove-WebPartField</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartFieldCmdlet.Field"> <summary> <para type="description">The field to remove from Kentico.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartFieldCmdlet.RemoveBusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartFieldCmdlet.ProcessRecord"> <inheritdoc/> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.RemoveCMSWebPartFieldCmdlet.ActOnObject(PoshKentico.Core.Services.Development.WebParts.IWebPartField)"> <inheritdoc/> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCategoryCmdlet"> <summary> <para type="synopsis">Sets a web part category.</para> <para type="description">Sets a web part category.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</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.WebParts.SetCMSWebPartCategoryCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the web part category.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCategoryCmdlet.WebPartCategory"> <summary> <para type="description">A reference to the WebPart category to update.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCategoryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCategoryCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCmdlet"> <summary> <para type="synopsis">Sets a web part.</para> <para type="description">Sets a web part.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Sets a web part.</para> <code>$webPart | Set-CMSWebPart</code> </example> <example> <para>Sets a web part and returns the result.</para> <code>$webPart | Set-CMSWebPart -PassThru</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the web part.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCmdlet.WebPart"> <summary> <para type="description">The web part to set.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartFieldCmdlet"> <summary> <para type="synopsis">Sets a web part field.</para> <para type="description">Sets a web part field.</para> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</para> <example> <para>Sets a web part field.</para> <code>$webPartField | Set-CMSWebPartField</code> </example> <example> <para>Sets a web part field and returns the result.</para> <code>$webPartField | Set-CMSWebPartField -PassThru</code> </example> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartFieldCmdlet.Field"> <summary> <para type="description">The field to set in Kentico.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartFieldCmdlet.PassThru"> <summary> <para type="description">Tell the cmdlet to return the web part.</para> </summary> </member> <member name="P:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartFieldCmdlet.BusinessLayer"> <summary> Gets or sets the Business layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebParts.SetCMSWebPartFieldCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:PoshKentico.Cmdlets.Development.WebPart.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> <para type="description">This command automatically initializes the connection to Kentico if not already initialized.</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.WebPart.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.WebPart.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.WebPart.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.WebPart.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.WebPart.NewCMSWebPartCategoryCmdlet.BusinessLayer"> <summary> Gets or sets the Business Layer for this web part. Populated by MEF. </summary> </member> <member name="M:PoshKentico.Cmdlets.Development.WebPart.NewCMSWebPartCategoryCmdlet.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.Cmdlets.General.InitializeCMSDatabaseCmdlet"> <summary> Initialize-CMSDatabase Cmdlet for initializing the database for CMS Application. </summary> </member> <member name="P:PoshKentico.Cmdlets.General.InitializeCMSDatabaseCmdlet.BusinessLayer"> <summary> Gets or sets the business layer for initializing the database for CMS Application. </summary> </member> <member name="M:PoshKentico.Cmdlets.General.InitializeCMSDatabaseCmdlet.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.ICmdlet"> <summary> Represents a commandlet. </summary> </member> <member name="M:PoshKentico.ICmdlet.WriteDebug(System.String)"> <summary> Writes a debug log entry. </summary> <param name="text">The entry to log.</param> </member> <member name="M:PoshKentico.ICmdlet.WriteError(System.Management.Automation.ErrorRecord)"> <summary> Writes a debug error entry. </summary> <param name="errorRecord">The error to log.</param> </member> <member name="M:PoshKentico.ICmdlet.WriteProgress(System.Management.Automation.ProgressRecord)"> <summary> Writes a progress log entry. </summary> <param name="progressRecord">The progress to log.</param> </member> <member name="M:PoshKentico.ICmdlet.WriteVerbose(System.String)"> <summary> Writes a verbose log entry. </summary> <param name="text">The entry to log.</param> </member> <member name="M:PoshKentico.ICmdlet.WriteWarning(System.String)"> <summary> Writes a warning log entry. </summary> <param name="text">The warning to log.</param> </member> <member name="M:PoshKentico.ICmdlet.ShouldProcess(System.String,System.String)"> <summary> Confirms the operation with the user, sending the name of the resource to be changed and the action to be performed to the user for confirmation before the operation is performed. </summary> <param name="target">Name of the target resource being acted upon. This will potentially be displayed to the user.</param> <param name="action">Name of the action which is being performed. This will potentially be displayed to the user. (default is Cmdlet name).</param> <returns>If ShouldProcess returns true, the operation should be performed. If ShouldProcess returns false, the operation should not be performed, and the Cmdlet should move on to the next target resource.</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.MefCmdletProvider`1"> <summary> Base class for navigation cmdlet providers. </summary> <typeparam name="TBusinessProvider">The Business provider to use for accessing Kentico resources. Must inherit from <see cref="T:PoshKentico.Business.CmdletProviderBusinessBase"/>.</typeparam> </member> <member name="P:PoshKentico.MefCmdletProvider`1.CmsApplicationService"> <summary> <see cref="T:PoshKentico.Core.Services.General.ICmsApplicationService"/>. </summary> </member> <member name="P:PoshKentico.MefCmdletProvider`1.Business"> <summary> Gets or sets the business provider/> for this provider. </summary> </member> <member name="P:PoshKentico.MefCmdletProvider`1.ProviderName"> <summary> The name of the provider. </summary> </member> <member name="P:PoshKentico.MefCmdletProvider`1.DriveName"> <summary> The provider drive name. </summary> </member> <member name="P:PoshKentico.MefCmdletProvider`1.DriveRootPath"> <summary> The root path of the drive. </summary> </member> <member name="P:PoshKentico.MefCmdletProvider`1.DriveDescription"> <summary> The drive description. </summary> </member> <member name="M:PoshKentico.MefCmdletProvider`1.GetProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.GetPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.SetProperty(System.String,System.Management.Automation.PSObject)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.SetPropertyDynamicParameters(System.String,System.Management.Automation.PSObject)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.ClearProperty(System.String,System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.ClearPropertyDynamicParameters(System.String,System.Collections.ObjectModel.Collection{System.String})"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.GetContentReader(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.GetContentReaderDynamicParameters(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.GetContentWriter(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.GetContentWriterDynamicParameters(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.ClearContent(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.ClearContentDynamicParameters(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.ExpandPath(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.IsValidPath(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.InitializeDefaultDrives"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.NormalizeRelativePath(System.String,System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.ItemExists(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.IsItemContainer(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.GetChildItems(System.String,System.Boolean)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.GetItem(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.HasChildItems(System.String)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.NewItem(System.String,System.String,System.Object)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.RemoveItem(System.String,System.Boolean)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.CopyItem(System.String,System.String,System.Boolean)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.CopyItemDynamicParameters(System.String,System.String,System.Boolean)"> <inheritdoc /> </member> <member name="M:PoshKentico.MefCmdletProvider`1.WriteItemObject(PoshKentico.Core.Services.Resource.IResourceInfo,System.Boolean)"> <summary> Writes the <see cref="T:PoshKentico.Core.Services.Resource.IResourceInfo"/> to the output. </summary> <param name="resource">The <see cref="T:PoshKentico.Core.Services.Resource.IResourceInfo"/> to be written to the output.</param> <param name="recurse">When set to true, will recurse through all child containers of <paramref name="resource"/>.</param> and write them to the output. </member> <member name="M:PoshKentico.MefCmdletProvider`1.Initialize"> <summary> Performs the necessary initialization for this provider. </summary> </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> </members> </doc> |