PoshKentico.Core.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PoshKentico.Core</name>
    </assembly>
    <members>
        <member name="T:PoshKentico.Core.Providers.General.KenticoCmsApplicationService">
            <summary>
            Implementation of <see cref="T:PoshKentico.Core.Services.General.ICmsApplicationService"/> that uses Kentico.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Providers.General.KenticoCmsApplicationService.InitializationState">
            <summary>
            Gets the initialization state of the CMS Application.
            </summary>
        </member>
        <member name="M:PoshKentico.Core.Providers.General.KenticoCmsApplicationService.FindSite(System.Action{System.String},System.Action{System.String})">
             <summary>
             This method requires administrator access.
             
             Finds a Kentico website by performing the following steps:
             1. Get a list of all the sites from IIS
             2. Get a list of all applications from the sites
             3. Get a list of all the virtual directories from the applications
             4. Continue processing virtual directory if a web.config file exits
             5. Parse the document and find an "add" node with name="CMSConnectionString"
             6. If the connection string is valid, then stop processing. This is a Kentico site.
             </summary>
             <param name="writeDebug">A delegate for writing to the debug stream.</param>
             <param name="writeVerbose">A delegate for writing to the verbose stream.</param>
             <returns>The directory and the connection string for the Kentico site.</returns>
        </member>
        <member name="M:PoshKentico.Core.Providers.General.KenticoCmsApplicationService.Initialize(System.Boolean,System.Action{System.String},System.Action{System.String})">
            <summary>
            Initialize Kentico CMS Application using FindKenticoSite or a cached version to locate the site.
            </summary>
            <param name="useCached">Use the cached location for the Kentico Site. When true and have already found Kentico in a previous run, this method does not require admin.</param>
            <param name="writeDebug">A delegate for writing to the debug stream.</param>
            <param name="writeVerbose">A delegate for writing to the verbose stream.</param>
        </member>
        <member name="M:PoshKentico.Core.Providers.General.KenticoCmsApplicationService.Initialize(System.IO.DirectoryInfo,System.String,System.Action{System.String},System.Action{System.String})">
            <summary>
            Initialize Kentico CMS Application using the supplied parameters.
            </summary>
            <param name="siteLocation">The directory where the Kentico site resides.</param>
            <param name="connectionString">The connection string to use for initializing the CMS Application.</param>
            <param name="writeDebug">A delegate for writing to the debug stream.</param>
            <param name="writeVerbose">A delegate for writing to the verbose stream.</param>
        </member>
        <member name="T:PoshKentico.Core.Providers.General.KenticoSiteLocationCache">
            <summary>
            Model used for caching the Kentico site location.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Providers.General.KenticoSiteLocationCache.SiteLocation">
            <summary>
            Gets or sets the file path for the Kentico site.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Providers.General.KenticoSiteLocationCache.ConnectionString">
            <summary>
            Gets or sets the connection string for the Kentico database.
            </summary>
        </member>
        <member name="T:PoshKentico.Core.Providers.Development.KenticoWebPartService">
            <summary>
            Implementation of <see cref="T:PoshKentico.Core.Services.Development.IWebPartService"/> that uses Kentico.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Providers.Development.KenticoWebPartService.WebPartCategories">
            <summary>
            Gets a list of all of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> provided by Kentico.
            </summary>
        </member>
        <member name="M:PoshKentico.Core.Providers.Development.KenticoWebPartService.GetWebPartCategories(System.Int32[])">
            <summary>
            Gets a list of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> which match the supplied IDs.
            </summary>
            <param name="ids">The IDs of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to return.</param>
            <returns>A list of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> which match the supplied IDs.</returns>
        </member>
        <member name="M:PoshKentico.Core.Providers.Development.KenticoWebPartService.Save(PoshKentico.Core.Services.Development.IWebPartCategory)">
            <summary>
            Saves the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>.
            </summary>
            <param name="webPartCategory">The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to save.</param>
            <returns>The saved <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>.</returns>
        </member>
        <member name="T:PoshKentico.Core.Services.Development.IWebPartCategory">
            <summary>
            Represents a WebPart Category.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Services.Development.IWebPartCategory.CategoryDisplayName">
            <summary>
            Gets the display name for the WebPart category.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Services.Development.IWebPartCategory.CategoryID">
            <summary>
            Gets the ID for the WebPart category.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Services.Development.IWebPartCategory.CategoryImagePath">
            <summary>
            Gets the image path for the WebPart category.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Services.Development.IWebPartCategory.CategoryName">
            <summary>
            Gets the name for the WebPart category.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Services.Development.IWebPartCategory.CategoryParentID">
            <summary>
            Gets the parent ID for the WebPart category.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Services.Development.IWebPartCategory.CategoryPath">
            <summary>
            Gets the path for the WebPart category.
            </summary>
        </member>
        <member name="T:PoshKentico.Core.Services.Development.IWebPartService">
            <summary>
            Service for providing access to a CMS webparts.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Services.Development.IWebPartService.WebPartCategories">
            <summary>
            Gets a list of all of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> provided by the CMS System.
            </summary>
        </member>
        <member name="M:PoshKentico.Core.Services.Development.IWebPartService.GetWebPartCategories(System.Int32[])">
            <summary>
            Gets a list of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> which match the supplied IDs.
            </summary>
            <param name="ids">The IDs of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to return.</param>
            <returns>A list of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> which match the supplied IDs.</returns>
        </member>
        <member name="M:PoshKentico.Core.Services.Development.IWebPartService.Save(PoshKentico.Core.Services.Development.IWebPartCategory)">
            <summary>
            Saves the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>.
            </summary>
            <param name="webPartCategory">The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to save.</param>
            <returns>The saved <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>.</returns>
        </member>
        <member name="T:PoshKentico.Core.Services.General.ICmsApplicationService">
            <summary>
            Service for providing access to a CMS application.
            </summary>
        </member>
        <member name="P:PoshKentico.Core.Services.General.ICmsApplicationService.InitializationState">
            <summary>
            Gets the initialization state of the CMS Application.
            </summary>
        </member>
        <member name="M:PoshKentico.Core.Services.General.ICmsApplicationService.FindSite(System.Action{System.String},System.Action{System.String})">
            <summary>
            Locates the CMS Site.
            </summary>
            <param name="writeDebug">A delegate for writing to the debug stream.</param>
            <param name="writeVerbose">A delegate for writing to the verbose stream.</param>
            <returns>The directory and the connection string for the CMS site.</returns>
        </member>
        <member name="M:PoshKentico.Core.Services.General.ICmsApplicationService.Initialize(System.Boolean,System.Action{System.String},System.Action{System.String})">
            <summary>
            Locates and performs the necessary initialization for the CMS site.
            </summary>
            <param name="useCached">Use the cached location for the CMS application. When true and have already found Kentico in a previous run, this method does not require admin.</param>
            <param name="writeDebug">A delegate for writing to the debug stream.</param>
            <param name="writeVerbose">A delegate for writing to the verbose stream.</param>
        </member>
        <member name="M:PoshKentico.Core.Services.General.ICmsApplicationService.Initialize(System.IO.DirectoryInfo,System.String,System.Action{System.String},System.Action{System.String})">
            <summary>
            Performs the necessary initialization for the provided CMS site.
            </summary>
            <param name="siteLocation">The directory where the CMS site resides.</param>
            <param name="connectionString">The connection string to use for initializing the CMS Application.</param>
            <param name="writeDebug">A delegate for writing to the debug stream.</param>
            <param name="writeVerbose">A delegate for writing to the verbose stream.</param>
        </member>
        <member name="T:PoshKentico.Core.Services.General.InitializationState">
            <summary>
            Represents the initialization state of a CMS application.
            </summary>
        </member>
        <member name="F:PoshKentico.Core.Services.General.InitializationState.Uninitialized">
            <summary>
            Initialization has not yet occurred.
            </summary>
        </member>
        <member name="F:PoshKentico.Core.Services.General.InitializationState.Error">
            <summary>
            An error occurred during initialization.
            </summary>
        </member>
        <member name="F:PoshKentico.Core.Services.General.InitializationState.Initialized">
            <summary>
            Initialization was successful.
            </summary>
        </member>
    </members>
</doc>