BolMiddleware API reference

This page lists every public type in BolMiddleware, including the view components and the Razor layouts, partials, and component views that consumers use.

Types

Type	Namespace	Kind	Summary
BolRazorLayoutStartup	BolMiddleware	Class	Startup base that registers BOL services and enables legacy authentication.
BolServiceExtensions	BolMiddleware	Static class	RegisterBolServices dependency injection extension.
BolServiceSessionExtensions	BolMiddleware	Static class	Session helpers for context, menu, and policy header.
SessionExtensions	BolMiddleware	Static class	Generic JSON session helpers.
HeaderExtensions	BolMiddleware.Extensions	Static class	Policy association dropdown builder.
BolContextModel	BolMiddleware.Models	Abstract class	Context resolution and saving page model.
BolMenuModel	BolMiddleware.Models	Abstract class	Menu loading and navigation page model.
BolPolicyModel	BolMiddleware.Models	Abstract class	Policy header and access page model.
ContextCookie	BolMiddleware.Models	Class	Payload of the BolContext cookie.
IAppMap	BolMiddleware.Models.MenuModels	Interface	Application menu mapping contract.
BasicAppMap	BolMiddleware.Models.MenuModels	Class	Options bound from the BasicAppMap section.
BolMenuViewModel	BolMiddleware.Models.MenuModels	Class	View model for the menu views.
BolNavItemViewModel	BolMiddleware.Models.MenuModels	Class	View model for one menu item.
Constants	BolMiddleware.Contracts	Class	Session, form, and query key names.
NavigationOptions	BolMiddleware.Contracts	Class	Navigation target and URL builder.
CurrentUserType	BolMiddleware.Enums	Enum	Internal, external, or unknown user.
CurrentUserState	BolMiddleware.Enums	Enum	New or validated external user state.
IBolServicesContainer	BolMiddleware.Services	Interface	Bundle of services for page models.
BolServicesContainer	BolMiddleware.Services	Class	Default services container.
ISecurityService	BolMiddleware.Services.Security	Interface	User, role, and policy access checks.
SecurityService	BolMiddleware.Services.Security	Class	Security checks through the platform clients.
UserType	BolMiddleware.Services.Security	Record	Unused user category flags.
IWebContextService	BolMiddleware.Services.Context	Interface	Web context persistence contract.
WebContextService	BolMiddleware.Services.Context	Class	BOL Context API facade.
WebContextExtensions	BolMiddleware.Services.Context	Static class	Content detection and logging text.
PolicyModelExtensions	BolMiddleware.Services.Context	Static class	Number parsing and header-to-context copy.
IPolicyHeaderService	BolMiddleware.Services.Headers.Policy	Interface	Policy header loading contract.
PolicyHeaderService	BolMiddleware.Services.Headers.Policy	Class	Policy Header API facade.
IMenuService	BolMiddleware.Services.Menu	Interface	Menu loading contract.
MenuService	BolMiddleware.Services.Menu	Class	BOL Menu API facade.
ICookieService	BolMiddleware.Services.CookieService	Interface	Cookie read and write contract.
CookieService	BolMiddleware.Services.CookieService	Class	Cookie implementation.
IRequestHelper	BolMiddleware.Services.Request	Interface	Request value reader contract.
RequestHelper	BolMiddleware.Services.Request	Class	Request value reader.
IContextCookieHelper	BolMiddleware.ContextCookieHelper	Interface	User setting contract for the context cookie.
ContextCookieHelperService	BolMiddleware.ContextCookieHelper	Class	User setting implementation.
BolPolicyHeaderViewComponent	BolMiddleware.Components	View component	Policy header bar.
BolSideMenuViewComponent	BolMiddleware.Components	View component	Side menu.
BolTopMenuViewComponent	BolMiddleware.Components	View component	Top menu.
_PolicyLayout	BolMiddleware.Pages.Shared	Layout	Full policy page layout.
_PolicyOnlyLayout	BolMiddleware.Pages.Shared	Layout	Policy header without menus.
_ContextOnlyLayout	BolMiddleware.Pages.Shared	Layout	Context form only.
_MenuOnlyLayout	BolMiddleware.Pages.Shared	Layout	Menus without policy header.
_BolCoreScriptsHeaderPartial	BolMiddleware.Pages.Shared	Partial view	Head scripts and analytics.
_BolCoreScriptsPartial	BolMiddleware.Pages.Shared	Partial view	Navigation script.
_BolMenuItemPartial	BolMiddleware.Pages.Shared	Partial view	One menu entry.
_BolPageHeaderPartial	BolMiddleware.Pages.Shared	Partial view	Header bar with profile links.
_SaifFooterPartial	BolMiddleware.Pages.Shared	Partial view	Footer.
Error	BolMiddleware.Pages.Shared	View	Error banner.
BolPolicyHeader	BolMiddleware.Pages.Components	Component view	Policy header default view.
BolSideMenu	BolMiddleware.Pages.Components	Component view	Side menu default view.
BolTopMenu	BolMiddleware.Pages.Components	Component view	Top menu default view.

Related documentation

• Index
• Overview
• Architecture
• Dependencies
• Configuration
• Operations and processes
• Business rules
• Security and authorization
• Service registration

Sources

• src/BolMiddleware/BolRazorLayoutStartup.cs
• src/BolMiddleware/Extensions/BolMiddlewareExtensions.cs
• src/BolMiddleware/Models/BolContextModel.cs
• src/BolMiddleware/Services/BolServicesContainer.cs
• src/BolMiddleware/ViewComponents/BolPolicyHeaderViewComponent.cs
• src/BolMiddleware/Pages/Shared/_PolicyLayout.cshtml