PoshKentico.Core.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>PoshKentico.Core</name> </assembly> <members> <member name="T:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService"> <summary> Implementation of <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISiteService"/> that uses Kentico. </summary> </member> <member name="P:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.Sites"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.Create(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.GetSite(System.Int32)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.GetSite(System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.Delete(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.Update(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.Start(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.Stop(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.AddSiteCulture(PoshKentico.Core.Services.Configuration.Sites.ISite,System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.RemoveSiteCulture(PoshKentico.Core.Services.Configuration.Sites.ISite,System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.GetSiteCultures(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc /> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.AddSiteDomainAlias(PoshKentico.Core.Services.Configuration.Sites.ISite,System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.RemoveSiteDomainAlias(PoshKentico.Core.Services.Configuration.Sites.ISite,System.String)"> <inheritdoc/> </member> <member name="M:PoshKentico.Core.Providers.Configuration.Sites.KenticoSiteService.GetDomainAliases(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <inheritdoc/> </member> <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.Create(PoshKentico.Core.Services.Development.IWebPartCategory)"> <summary> Creates the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>. </summary> <param name="webPartCategory">The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to create.</param> <returns>The newly created <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>.</returns> </member> <member name="M:PoshKentico.Core.Providers.Development.KenticoWebPartService.Delete(PoshKentico.Core.Services.Development.IWebPartCategory)"> <summary> Deletes the specified <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>. </summary> <param name="webPartCategory">The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to delete.</param> </member> <member name="M:PoshKentico.Core.Providers.Development.KenticoWebPartService.GetWebPartCategory(System.Int32)"> <summary> Gets the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> which matches the supplied ID. </summary> <param name="id">The ID of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to return.</param> <returns>The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> which matches the ID, else null.</returns> </member> <member name="M:PoshKentico.Core.Providers.Development.KenticoWebPartService.Update(PoshKentico.Core.Services.Development.IWebPartCategory)"> <summary> Updates the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>. </summary> <param name="webPartCategory">The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to update.</param> </member> <member name="T:PoshKentico.Core.Services.Configuration.Localization.ICulture"> <summary> Represents a Culture Object. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Localization.ICulture.CultureID"> <summary> Gets culture ID. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Localization.ICulture.CultureName"> <summary> Gets culture name. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Localization.ICulture.CultureCode"> <summary> Gets culture code. </summary> </member> <member name="T:PoshKentico.Core.Services.Configuration.Sites.ISite"> <summary> Represents a Site Object. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Sites.ISite.DisplayName"> <summary> Gets the display name for the site. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Sites.ISite.SiteName"> <summary> Gets the site name. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Sites.ISite.Status"> <summary> Gets the site status. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Sites.ISite.DomainName"> <summary> Gets the domain name for the site. </summary> </member> <member name="T:PoshKentico.Core.Services.Configuration.Sites.ISiteDomainAlias"> <summary> Represents a Site Domain Alias Object. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Sites.ISiteDomainAlias.SiteDomainAliasID"> <summary> Gets the site domain alias id. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Sites.ISiteDomainAlias.SiteDomainAliasName"> <summary> Gets the site domain alias name. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Sites.ISiteDomainAlias.SiteID"> <summary> Gets the site id. </summary> </member> <member name="T:PoshKentico.Core.Services.Configuration.Sites.ISiteService"> <summary> Service for providing access to a CMS sites. </summary> </member> <member name="P:PoshKentico.Core.Services.Configuration.Sites.ISiteService.Sites"> <summary> Gets a list of all of the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> provided by the CMS System. </summary> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.Create(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <summary> Creates the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/>. </summary> <param name="site">The <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to create.</param> <returns>The newly created <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/>.</returns> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.Delete(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <summary> Deletes the specified <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/>. </summary> <param name="site">The <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to delete.</param> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.GetSite(System.Int32)"> <summary> Gets the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> which matches the supplied ID. </summary> <param name="id">The ID of the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to return.</param> <returns>The <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> which matches the ID, else null.</returns> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.GetSite(System.String)"> <summary> Gets the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> which matches the supplied site name. </summary> <param name="siteName">The Site Name of the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to return.</param> <returns>The <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> which matches the site name, else null.</returns> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.Update(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <summary> Updates the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/>. </summary> <param name="site">The <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to update.</param> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.Start(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <summary> Starts the specified <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/>. </summary> <param name="site">The <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to start.</param> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.Stop(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <summary> Stops the specified <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/>. </summary> <param name="site">The <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to stop.</param> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.AddSiteCulture(PoshKentico.Core.Services.Configuration.Sites.ISite,System.String)"> <summary> Assigns the culture to the site. </summary> <param name="site">the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to assign a culture to. </param> <param name="cultureCode">the culture code of <see cref="T:PoshKentico.Core.Services.Configuration.Localization.ICulture"/>.</param> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.RemoveSiteCulture(PoshKentico.Core.Services.Configuration.Sites.ISite,System.String)"> <summary> Removes the culture from the site </summary> <param name="site">the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to remove a culture from. </param> <param name="cultureCode">the culture code of <see cref="T:PoshKentico.Core.Services.Configuration.Localization.ICulture"/>. </param> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.GetSiteCultures(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <summary> Get the cultures of the specified site. </summary> <param name="site">the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to get a culture from. </param> <returns>the list of <see cref="T:PoshKentico.Core.Services.Configuration.Localization.ICulture"/> that the site has.</returns> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.AddSiteDomainAlias(PoshKentico.Core.Services.Configuration.Sites.ISite,System.String)"> <summary> Adds the domain alias to the site. </summary> <param name="site">the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to assign a alias to.</param> <param name="aliasName">the alias name of domain alias</param> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.RemoveSiteDomainAlias(PoshKentico.Core.Services.Configuration.Sites.ISite,System.String)"> <summary> Deletes the domain alias for the site. </summary> <param name="site">the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to delete the alias from.</param> <param name="aliasName">the alias name of domain alias</param> </member> <member name="M:PoshKentico.Core.Services.Configuration.Sites.ISiteService.GetDomainAliases(PoshKentico.Core.Services.Configuration.Sites.ISite)"> <summary> Gets all site domain aliases assigned to the selected site. </summary> <param name="site">the <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISite"/> to get the aliases from.</param> <returns>the list of <see cref="T:PoshKentico.Core.Services.Configuration.Sites.ISiteDomainAlias"/> that the site has.</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.Create(PoshKentico.Core.Services.Development.IWebPartCategory)"> <summary> Creates the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>. </summary> <param name="webPartCategory">The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to create.</param> <returns>The newly created <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>.</returns> </member> <member name="M:PoshKentico.Core.Services.Development.IWebPartService.Delete(PoshKentico.Core.Services.Development.IWebPartCategory)"> <summary> Deletes the specified <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>. </summary> <param name="webPartCategory">The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to delete.</param> </member> <member name="M:PoshKentico.Core.Services.Development.IWebPartService.GetWebPartCategory(System.Int32)"> <summary> Gets the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> which matches the supplied ID. </summary> <param name="id">The ID of the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to return.</param> <returns>The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> which matches the ID, else null.</returns> </member> <member name="M:PoshKentico.Core.Services.Development.IWebPartService.Update(PoshKentico.Core.Services.Development.IWebPartCategory)"> <summary> Updates the <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/>. </summary> <param name="webPartCategory">The <see cref="T:PoshKentico.Core.Services.Development.IWebPartCategory"/> to update.</param> </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> |