API Documentation

Nucleus.Abstractions

Nucleus.Abstractions includes models, base classes, interfaces and constants for use by both Nucleus Core and Extensions. Most extensions developed for Nucleus should reference this assembly.

Classes

Authentication.Constants Class
Constants for the Nucleus authentication implementation.
Authorization.Constants Class
Authorization constants
RoutingConstants Class
General constant values
LogFileConstants Class
Constants for text file logging components.
DataProviderException Class
Represents a parsed "friendly" error message derived from a DbException.
EventHandlers.EventHandlerExtensions Class
Extension methods for adding Nucleus system event handlers.
EventHandlers.IEventDispatcher Interface
Raises notification events. Internal and custom implementations can acquire a reference to EventDispatcher from the dependency injection services container and raise or consume events.
EventHandlers.IScopedSystemEventHandler<TModel, TEvent> Interface
System event handler abstract class. Event handlers implement this class, and are added to the dependency injection services collection with a call to AddTransient.
EventHandlers.ISingletonSystemEventHandler<TModel, TEvent> Interface
System event handler abstract class. Event handlers implement this class, and are added to the dependency injection services collection with a call to AddTransient.
EventHandlers.ISystemEventHandler<TModel, TEvent> Interface
System event handler abstract class. Event handlers implement this class, and are added to the dependency injection services collection with a call to AddTransient.
EventHandlers.SystemEventTypes.Create Class
Type representing a Create operation (event). This class has no methods or properties, it is used as a key for the EventHandlers.ISystemEventHandler<TModel, TEvent> class.
EventHandlers.SystemEventTypes.Update Class
Type representing an Update operation (event). This class has no methods or properties, it is used as a key for the EventHandlers.ISystemEventHandler<TModel, TEvent> class.
EventHandlers.SystemEventTypes.Delete Class
Type representing a Delete operation (event). This class has no methods or properties, it is used as a key for the EventHandlers.ISystemEventHandler<TModel, TEvent> class.
ExtensionAttribute Class
Attribute used to specify the extension name for a Nucleus extension.
FileSystemProviders.FileSystemProvider Class
Abstract class implemented by all file system providers.
FileSystemProviders.FileSystemProviderInfo Class
Represents a single configured file system provider.
FileSystemProviders.IFileSystemProviderFactory Interface
FileSystemProviderFactory creates and returns FileSystemProviders.FileSystemProvider instances.
IRestApiClient Interface
General-purpose Api client.
IScheduledTask Interface
Scheduled task class interface.
Layout.ContainerContext Class
Represents a module being rendered by Layout.IModuleContentRenderer and the module output.
Layout.IModuleContentRenderer Interface
Defines the interface for the module content renderer.
Mail.IMailClient Interface
Allows Nucleus core and extensions to sent email using SMTP.
Mail.IMailClientFactory Interface
Creates instances of IMailClient
Managers.IApiKeyManager Interface
Defines the interface for the ApiKey Manager class, which rovides functions to manage database data for Models.ApiKeys.
Managers.ICacheManager Interface
Data cache manager.
Managers.IContainerManager Interface
Defines the interface for the Container manager.
Managers.IContentManager Interface
Defines the interface for the content manager.
Managers.IExtensionManager Interface
Provides management functions for extensions.
Managers.IExtensionsStoreManager Interface
Provides functions to manage database data for Models.ExtensionsStoreSettingss.
Managers.IFileSystemManager Interface
Defines the interface for the File System manager.
Managers.ILayoutManager Interface
Provides functions to manage database data for Models.LayoutDefinitions.
Managers.IListManager Interface
Provides functions to manage database data for Models.Lists.
Managers.IMailTemplateManager Interface
Provides functions to manage database data for Models.Mail.MailTemplates.
Managers.IOrganizationManager Interface
Provides functions to manage database data for Models.Organizations.
Managers.IPageManager Interface
Provides functions to manage database data for Models.Pages.
Managers.IPageModuleManager Interface
Provides functions to manage database data for Models.PageModules.
Managers.IPermissionsManager Interface
Defines the interface for the permissions manager.
Managers.IRoleGroupManager Interface
Provides functions to manage database data for Models.RoleGroups.
Managers.IRoleManager Interface
Defines the interface for the role manager.
Managers.IScheduledTaskManager Interface
Defines the interface for the scheduled task manager.
Managers.ISessionManager Interface
Defines the interface for the session manager.
Managers.ISiteGroupManager Interface
Provides functions to manage database data for Models.SiteGroups.
Managers.ISiteManager Interface
Provides functions to manage database data for Models.Sites and Models.SiteAliases.
Managers.IUserManager Interface
Provides functions to manage database data for Models.Users.
Managers.CopyPermissionOperation Class
Copy permission operation types
Models.ApiKey Class
Represents an API key which is used for authentication by API clients.
Models.Application Class
Nucleus application information.
Models.Cache.ICacheCollection Interface
Non-generic interface for the Models.Cache.CacheCollection<TKey, TModel> class, used when retrieving items from the cache (when the full generic type is not known).
Models.Cache.CacheCollection<TKey, TModel> Class
Stores a collection of cached entities keys and values. Provides operations to populate and retrieve, remove and clear items the cache.
Models.Configuration.AllowedFileType Class
Represents the configurable options for a file type signature.
Models.Configuration.AuthenticationProtocol Class
Represents a configured authentication protocol.
Models.Configuration.AuthenticationProtocol.UserTypes Class
Values used to specify whether system admin, site admin or regular users can log in
Models.Configuration.AuthenticationProtocol.SyncOptions Class
Enumeration used to specify what data is copied to the Nucleus user from the authentication source when logging in.
Models.Configuration.AuthenticationProtocols Class
Class used to read authentication protocols from configuration files.
Models.Configuration.CacheOption Class
Represents the configurable options for a CacheCollection.
Models.Configuration.ClaimTypeOption Class
Class used to read extended data for claim types from the configuration file. Extended data is used when rendering controls for a UserProfileValue which represents a per-user value for the claim type.
Models.Configuration.ClaimTypeOptions Class
Collection type used to retrieve ClaimType settings from the configuration files.
Models.Configuration.DatabaseConnectionOption Class
Specifies configuration file options for a data provider.
Models.Configuration.DatabaseOptions Class
Represents database configuration options.
Models.Configuration.DatabaseSchema Class
Represents configuration items for a database schema.
Models.Configuration.FileSystemProviderFactoryOptions Class
Represents the configured file system providers.
Models.Configuration.FolderOptions Class
Represents application folders.
Models.Configuration.HtmlEditorConfig Class
Represents a Html editor script (javascript, css) defined in configuration.
Models.Configuration.HtmlEditorOptions Class
Represents Html editor options from configuration.
Models.Configuration.HtmlEditorScript Class
Represents a Html editor script (javascript, css) defined in configuration.
Models.Configuration.HtmlEditorScript.Types Class
Script type
Models.Configuration.PasswordComplexityRule Class
Represents a password validation rule.
Models.Configuration.PasswordOptions Class
Class used to retrieve password complexity rules from configuration files.
Models.Configuration.ResourceFileOptions Class
Class used to retrieve resource options from configuration files.
Models.Configuration.SecurityHeaderOption Class
Class used to read settings for security headers.
Models.Configuration.SecurityHeaderOptions Class
Represents security header options from configuration files.
Models.Configuration.SmtpMailOptions Class
Represents the default SMTP options from configuration files.
Models.Configuration.Store Class
Class used to read configuration data for the extension store(s).
Models.Configuration.StoreOptions Class
Collection type used to retrieve ClaimType settings from the configuration files.
Models.Configuration.TextFileLoggerOptions Class
Options for the text file logger.
Models.ContainerDefinition Class
Represents an installed container.
Models.Content Class
Represents a general-use list of items.
Models.Context Class
Encapsulates information about the current request.
Models.ControlPanelExtensionDefinition Class
Represents a control panel extension.
Models.ControlPanelExtensionDefinition.ControlPanelExtensionScopes Class
Specifies the control panel extension scope.
Models.Export.SiteTemplate Class
Site export wrapper class.
Models.ExtensionsStoreSettings Class
Represents the key/value for an instance setting.
Models.ExtensionsStoreSettings.PackageTracks Class
Specifies the type(s) of packages that can be installed.
Models.Extensions.package Class
Models.Extensions.PackageResult Class
Package validation result returned by the extension manager .ValidatePackage method.
Models.FileSystem.File Class
Represents a file stored in a file system.
Models.FileSystem.ItemTypes Interface
Specifies whether the file system item is a folder or file
Models.FileSystem.FileSystemItem Class
Represents an item (file or folder) stored in a file system.
Models.FileSystem.FileSystemItemCapabilities Class
Represents the operations which can be performed on a file system item.
Models.FileSystem.FileSystemValidationRule Class
Rule used to validate a file system item name.
Models.FileSystem.Folder Class
Represents a folder stored in a file system.
Models.Internal.Schema Class
Represents a schema and version which has been applied to the database.
Models.LayoutDefinition Class
Represents an installed Layout.
Models.List Class
Represents a general-use list of items.
Models.ListItem Class
Represents a general-use list of items.
Models.LocalPath Class
Provides an object representation of a the part of the request path that was not resolved to a page, and easy access to the parts of the path.
Models.Mail.MailSettings Class
Represents settings used to communicate with a SMTP (mail) server.
Models.Mail.MailTemplate Class
Represents an e-mail template.
Models.Mail.SiteTemplateSelections Class
Represents the email templates in use by a site.
Models.Mail.Template.UserMailTemplateData Class
Class used to send user information to the mail client - contains data used by a mail template.
Models.ModelBase Class
Base class for core model classes.
Models.ModuleDefinition Class
Represents an installed module.
Models.ModuleSetting Class
Key(name) / value pair representing a module setting.
Models.Organization Class
An organization is a collection of users
Models.OrganizationUser Class
A link between an organization and a user.
Models.OrganizationUser.UserTypes Class
Specifies the special rights for an organization user.
Models.Page Class
Represent a page in a site.
Models.Page.LinkTypes Class
Link Types
Models.PageMenu Class
Represents a page and its children, used by menu controls.
Models.PageModule Class
Represents a module on a page.
Models.PageRoute Class
Represents a route (path) for a page.
Models.PageRoute.PageRouteTypes Class
Represents a page route.
Models.Paging.PagedResult<TEntity> Class
Reprents a "page" of results, used to return information from functions which support paging.
Models.Paging.PagingSettings Class
Class used to submit paging data to functions which support paging.
Models.Permission Class
Represents access rights for Models.Page or Models.PageModule and Role.
Models.Permissions.PermissionsList Class
Represent a list of permissions, keyed by Id.
Models.Permissions.PermissionsListItem Class
Represents a permission entry in a PermissionList
Models.PermissionType Class
Represents permission types
Models.PermissionType.PermissionScopeNamespaces Class
Namespaces for core entity permission scopes
Models.PermissionType.PermissionScopeTypes Class
Constants for well-known permission scope types.
Models.PermissionType.PermissionScopes Class
Scope namespaces for operations on core entities
Models.FoundPage Class
This class is used to cache page route matches, including when a page route partly matched a route - along with the LocalPath (non-matching part of the path) for later use.
Models.Role Class
Represents a role.
Models.Role.RoleType Class
Role Type is used to configure restrictions on roles. The value is a flag, so the values can be combined.
Models.RoleGroup Class
Represents a role group. Role groups can be used to categorize roles.
Models.Site Class
Represents a site, which contains pages, users, roles, permissions and other data.
Models.Site.SiteUserRegistrationOptions Class
Bitwise flags enum specifying public signup options.
Models.Site.SiteMailSettingKeys Class
SiteSettings keys for mail server settings.
Models.Site.SiteSearchSettingsKeys Class
SiteSettings keys for search settings.
Models.Site.SiteTemplatesKeys Class
SiteSettings keys for mail template settings.
Models.Site.SiteFilesKeys Class
SiteSettings keys for image settings.
Models.Site.SitePagesKeys Class
SiteSettings keys for site pages settings.
Models.SiteAlias Class
Represents a site alias.
Models.SiteGroup Class
Represent a site group.
Models.Sitemap.Sitemap Class
Class used to generate an XML site map.
Models.Sitemap.SiteMapEntry Class
Represents an entry in a sitemap XML file, used by search crawlers.
Models.SitePages Class
Represents special pages within a site.
Models.SiteSetting Class
Represents the key/value for a site setting.
Models.TaskScheduler.RunningTask Class
Represents a scheduled task that is running.
Models.TaskScheduler.RunningTask.ProgressEvent Class
Delegate for the OnProgress event.
Models.TaskScheduler.RunningTaskQueue Class
Represents a collection of running tasks
Models.TaskScheduler.ScheduledTask Class
Represents the settings for a scheduled task.
Models.TaskScheduler.ScheduledTask.Intervals Interface
Internval types
Models.TaskScheduler.ScheduledTask.InstanceTypes Interface
Specifies whether the task runs per instance, or per server.
Models.TaskScheduler.ScheduledTaskHistory Class
Represents the settings for a scheduled task.
Models.TaskScheduler.ScheduledTaskProgress Class
Represents running task progress
Models.TaskScheduler.ScheduledTaskProgress.State Class
Running task state
Models.User Class
Represents a user of a Models.Site
Models.UserProfileProperty Class
Represents a Models.Sites User Profile Properties, which are the available values for a Models.User's profile.
Models.UserProfileValue Class
Represents the setting for a user profile value.
Models.UserSecrets Class
Represents password and other user-login information.
Models.UserSession Class
Represent the session for a logged-in user.
Portable.IPortable Interface
Module import/export interface.
Portable.PortableContent Class
Payload for import/export operations/implementations and users of the IPortable interface.
Portable.PortableExtensions Class
Extensions for implementations of the Portable.IPortable interface.
Search.ContentMetaData Class
The ContentMetaData class provides an entry to be submitted to a search index.
Search.IContentMetaDataProducer Interface
Specifies the contract for components which can supply meta-data.
Search.ISearchIndexHistoryManager Interface
Provides functions to manage search index history.
Search.ISearchIndexManager Interface
Defines the interface for a search index manager.
Search.ISearchProvider Interface
Defines the interface for a search provider.
Search.SearchIndexHistory Class
Represents the indexing history of a search content item.
Search.SearchQuery Class
Specifies search query parameters.
Search.SearchQuery.BoostSettings Class
Specifies boost settings.
Search.SearchResult Class
Represents a search result.
Search.SearchResults Class
Represents the search results for a search query.