Search Results for

    Show / Hide Table of Contents

    Namespace Umbraco.Cms.Core.Services

    Classes

    AuditEntryService

    Represents a service for handling audit entries.

    ContentService

    Implements the content service.

    ContentTypeBaseServiceProvider

    Provides the appropriate content type service based on the type of content base entity.

    ContentTypeService

    Represents the ContentType Service, which is an easy access to operations involving IContentType

    ContentTypeServiceBase

    Base class for content type services, providing common repository service functionality.

    ContentTypeServiceBase<TRepository, TItem>

    Generic base class for content type services that provides CRUD operations, validation, composition handling, and container management for content types.

    CultureImpactFactory

    Factory for creating CultureImpact instances that represent the impact of culture settings on content variations.

    CultureService

    Provides services for working with cultures and ISO codes.

    DataTypeUsageService

    Provides services for checking data type usage information.

    DefaultContentVersionCleanupPolicy

    Default implementation of the content version cleanup policy that determines which content versions should be cleaned up based on configuration settings and per-content-type overrides.

    DictionaryPermissionService

    Provides services for checking dictionary item culture permissions for users.

    DictionaryService

    Provides helper services for dictionary-related operations, such as path calculation.

    DocumentUrlAliasService

    Implements IDocumentUrlAliasService operations for handling document URL aliases.

    DocumentUrlAliasServiceInitializerNotificationHandler

    Notification handler to initialize the IDocumentUrlAliasService on application startup.

    DocumentUrlService

    Implements IDocumentUrlService operations for handling document URLs.

    DocumentUrlServiceContentTypeChangedNotificationHandler

    Handles content type changes to rebuild URL and alias caches when content type variation changes. This ensures that when a content type changes from variant to invariant (or vice versa), the URL cache is properly rebuilt with the correct languageId (NULL for invariant, specific ID for variant).

    DocumentUrlServiceInitializerNotificationHandler

    Handles the application starting notification to initialize the document URL service.

    DomainService

    Provides services for managing domains (hostnames and culture assignments for content).

    EntityService

    Provides entity-related operations for retrieving lightweight entity representations and managing entity identifiers.

    ExternalLoginService

    Provides services for managing external login providers and tokens for users and members.

    FileService

    Represents the File Service, which provides access to operations involving IFile objects like Scripts, Stylesheets, Templates, and Partial Views.

    FileServiceBase<TRepository, TEntity>

    Provides base functionality for file-based services that manage file entities like scripts, stylesheets, and partial views.

    FileServiceOperationBase<TRepository, TEntity, TOperationStatus>

    Provides base functionality for file services that support CRUD operations with notifications and auditing.

    IdKeyMap

    Provides bidirectional mapping between integer IDs and GUIDs (keys) for Umbraco entities.

    InstallationService

    Service for logging installation information.

    IsoCodeValidator

    LocalizedTextService

    LocalizedTextServiceFileSources

    Exposes the XDocument sources from files for the default localization text service and ensure caching is taken care of

    LocalizedTextServiceSupplementaryFileSource

    Represents a supplementary file source for localized text services, allowing plugins and extensions to provide additional or overriding localization keys.

    LogViewerService

    Represents a service for viewing logs in Umbraco.

    LogViewerServiceBase

    Base class for log viewer services that provides common functionality for managing log entries and queries.

    MediaService

    Represents the Media Service, which is an easy access to operations involving IMedia

    MediaTypeService

    Represents the Media Type Service, which provides operations for managing IMediaType entities.

    MemberService

    Represents the MemberService.

    MemberTypeService

    Provides services for managing member types in Umbraco.

    MetricsConsentService

    Service for managing telemetry consent levels for Umbraco analytics.

    NoopConflictingRouteService

    A default implementation of IConflictingRouteService that never reports conflicts.

    NoopSegmentService

    A no-operation implementation of ISegmentService that returns empty results. Used as a default when no segment provider is configured.

    NotificationService

    Provides functionality for managing and sending notifications to users when content is modified.

    OEmbedService

    Implements IOEmbedService for retrieving embeddable HTML markup using the oEmbed protocol.

    OperationResult

    Represents the result of a service operation.

    OperationResult.Attempt

    Provides factory methods for creating Attempt<TResult> instances wrapping OperationResult objects.

    OperationResult<TResultType>

    Represents the result of a service operation.

    OperationResult<TResultType, TEntity>

    Represents the result of a service operation.

    Ordering

    Represents ordering information.

    PartialViewService

    Provides services for managing partial view files in Umbraco.

    PreviewService

    Provides functionality for managing content preview mode.

    ProcessInstructionsResult

    Defines a result object for the ProcessInstructions(CacheRefresherCollection, CancellationToken, string, int) operation.

    PropertyTypeUsageService

    PropertyValidationService

    Provides property validation functionality for content, media, and member properties.

    PublishResult

    Represents the result of publishing a document.

    RelationService

    Provides functionality for managing relations and relation types between entities.

    RepositoryService

    Represents a service that works on top of repositories.

    ScriptService

    Provides services for managing JavaScript script files in Umbraco.

    ServerInformationService

    Default implementation of IServerInformationService.

    ServiceContext

    Represents the Umbraco Service context, which provides access to all services.

    StylesheetService

    Provides services for managing CSS stylesheet files in Umbraco.

    TagService

    Tag service to query for tags in the tags db table. The tags returned are only relevant for published content & saved media or members

    TemplateContentParserService

    Provides functionality for parsing template content to extract metadata such as the master template alias.

    TemplateService

    Provides functionality for managing templates (Razor views) including CRUD operations and master template relationships.

    TrackedReferencesService

    Provides services for tracking and querying references between entities in Umbraco.

    TreeEntitySortingService

    Provides functionality for sorting tree entities based on sorting models.

    TwoFactorLoginService

    UpgradeService

    Provides functionality for checking for available Umbraco upgrades.

    UserDataService

    Implements IUserDataService providing operations for managing user-specific data entries.

    WebhookLogFactory

    Implements IWebhookLogFactory to create webhook log entries.

    WebhookLogService

    Implements IWebhookLogService to manage webhook log entries.

    WebhookRequestService

    Provides functionality for managing webhook requests.

    WebhookService

    Implements IWebhookService to manage webhooks.

    Interfaces

    IAuditEntryService

    Represents a service for handling audit entries.

    IAuditService

    Represents a service for handling audit.

    IBasicAuthService

    Provides services for basic authentication operations.

    IBasicFileService<TEntity>

    Provides basic file operations for entities that implement IFile.

    ICacheInstructionService

    Provides services for managing cache instructions in distributed cache scenarios.

    IConflictingRouteService

    Provides services for detecting conflicting routes in the application.

    IConsentService

    A service for handling lawful data processing requirements

    IContentBlueprintContainerService

    Provides container (folder) management services for content blueprints.

    IContentBlueprintEditingService

    Provides editing services for content blueprints.

    IContentEditingService

    Provides editing services for content items.

    IContentListViewService

    Provides services for retrieving content items in a list view format.

    IContentPermissionService

    Manages permissions for content access.

    IContentPublishingService

    Provides methods for publishing and unpublishing content.

    IContentSearchService

    Provides search services for content items.

    IContentSearchService<TContent>

    Provides search services for content items of a specific type.

    IContentService

    Defines the ContentService, which is an easy access to operations involving IContent

    IContentServiceBase

    Placeholder for sharing logic between the content, media (and member) services TODO: Start sharing the logic!

    IContentServiceBase<TItem>

    Provides a generic base interface for content services.

    IContentTypeBaseService

    Provides a common base interface for IContentTypeBase.

    IContentTypeBaseServiceProvider

    Provides the IContentTypeBaseService corresponding to an IContentBase object.

    IContentTypeBaseService<TItem>

    Provides a common base interface for IContentTypeService, IMediaTypeService and IMemberTypeService.

    IContentTypeContainerService

    Provides container (folder) management services for content types (document types).

    IContentTypeSchemaService

    Service to get content type schema information for schema generation.

    IContentTypeSearchService

    Provides search services for content types (document types).

    IContentTypeService

    Manages IContentType objects.

    IContentVersionCleanupPolicy

    Used to filter historic content versions for cleanup.

    IContentVersionService

    Provides services for managing content versions.

    ICultureImpactFactory

    Provides methods for creating CultureImpact instances that represent the impact of culture variations on content operations.

    ICultureService

    Provides services for retrieving culture information.

    IDataTypeContainerService

    Provides container (folder) management services for data types.

    IDataTypeService

    Defines the DataType Service, which is an easy access to operations involving IDataType

    IDataTypeUsageService

    Provides methods for querying data type usage across the application.

    IDictionaryItemService

    Provides methods for managing IDictionaryItem objects for localization.

    IDictionaryPermissionService

    Manages permissions for dictionary item access.

    IDictionaryService

    Provides utility services for dictionary items.

    IDocumentUrlAliasService

    Defines operations for handling document URL aliases (umbracoUrlAlias property).

    IDocumentUrlService

    Defines operations for handling document URLs.

    IDomainService

    Provides services for managing domains (hostnames) assigned to content items.

    IEntitySearchService

    Performs entity search directly against the database.

    IEntityService

    Provides methods for working with entities across Umbraco, including content, media, members, and other entity types.

    IEntityTypeContainerService<TTreeEntity>

    Provides methods for managing EntityContainer objects for entity types.

    IEntityXmlSerializer

    Serializes entities to XML

    IExamineIndexCountService

    Provides functionality to retrieve counts from Examine search indexes.

    IExternalLoginWithKeyService

    Provides methods for managing external login providers and tokens for users and members.

    IFileService

    Defines the File Service, which is an easy access to operations involving IFile objects like Scripts, Stylesheets and Templates

    IIdKeyMap

    Provides a mapping between integer IDs, GUIDs (keys), and UDIs for Umbraco entities.

    IIndexedEntitySearchService

    Performs entity search against search indexes.

    IInstallationService

    Provides functionality for logging Umbraco installation events and telemetry.

    IIpAddressUtilities

    Provides utility methods for working with IP addresses.

    IIsoCodeValidator

    A validator for validating if an ISO code string can be is valid.

    IKeyValueService

    Manages the simplified key/value store.

    ILanguageService

    Provides methods for managing ILanguage objects for localization.

    ILocalizationService

    Defines the Localization Service, which is an easy access to operations involving Languages and Dictionary

    ILocalizedTextService

    The entry point to localize any key in the text storage source for a given culture

    ILogViewerRepository

    Represents a repository for viewing logs in Umbraco.

    ILogViewerService

    Provides methods for viewing and managing application log entries.

    ILongRunningOperationService

    A service for managing long-running operations that can be executed in the background.

    IMediaEditingService

    Defines the Media Editing Service, which provides operations for creating, updating, deleting, and managing IMedia items through the editing API.

    IMediaImportService

    Provides methods for importing media files into Umbraco.

    IMediaListViewService

    Provides methods for retrieving media items in a list view format with paging and filtering support.

    IMediaPermissionService

    Manages permissions for media access.

    IMediaSearchService

    Provides search functionality for media items.

    IMediaService

    Defines the Media Service, which is an easy access to operations involving IMedia

    IMediaTypeContainerService

    Provides functionality for managing media type containers (folders).

    IMediaTypeService

    Manages IMediaType objects.

    IMemberContentEditingService

    Provides content editing operations for members.

    IMemberEditingService

    Defines the member editing service, which provides operations for creating, updating, and deleting members.

    IMemberGroupService

    Defines the MemberGroupService, which provides operations for managing IMemberGroup objects.

    IMemberService

    Defines the MemberService, which is an easy access to operations involving (umbraco) members.

    IMemberTwoFactorLoginService

    A member specific Two factor service, that ensures the member exists before doing the job.

    IMemberTypeContainerService

    Provides functionality for managing member type containers (folders).

    IMemberTypeService

    Manages IMemberType objects.

    IMembershipMemberService

    Defines part of the MemberService, which is specific to methods used by the membership provider.

    IMembershipMemberService<T>

    Defines part of the UserService/MemberService, which is specific to methods used by the membership provider. The generic type is restricted to IMembershipUser. The implementation of this interface uses either IMember for the MemberService or IUser for the UserService.

    IMembershipRoleService<T>

    Defines the MembershipRoleService, which provides role management operations for membership users.

    IMembershipUserService

    Defines part of the UserService, which is specific to methods used by the membership provider.

    IMetricsConsentService

    Provides operations for managing telemetry metrics consent.

    INodeCountService

    Provides functionality to retrieve counts of nodes in the Umbraco content tree.

    INotificationService

    Provides operations for managing user notifications related to content changes.

    IOEmbedService

    Defines a service for asynchronously retrieving embeddable HTML markup for a specified resource using the oEmbed protocol.

    IPackageDataInstallation

    Defines the PackageDataInstallation service, which provides operations for installing package data such as content types, data types, dictionary items, languages, and templates.

    IPackagingService

    Provides operations for installing, exporting, and managing Umbraco packages.

    IPartialViewService

    Defines the Partial View Service, which provides operations for managing IPartialView files.

    IPreviewService

    Provides functionality for managing content preview mode.

    IPropertyTypeUsageService

    Defines service methods for querying property type usage.

    IPropertyValidationService

    Provides validation services for content properties.

    IPublicAccessService

    Provides operations for managing public access restrictions on content.

    IRedirectUrlService

    Provides operations for managing URL redirects for content items.

    IRelationService

    Provides functionality for managing relations and relation types between entities.

    IReservedFieldNamesService

    Provides access to reserved field names that cannot be used for custom properties.

    IRuntime

    Defines the Umbraco runtime.

    IRuntimeState

    Represents the state of the Umbraco runtime.

    IScriptService

    Defines the Script Service, which provides operations for managing IScript files.

    ISegmentService

    Provides operations for managing content segments.

    IServerInformationService

    Provides server information about the current Umbraco instance.

    IServerRegistrationService

    Provides operations for managing server registrations in a load-balanced environment.

    IService

    Marker interface for services, which is used to store difference services in a list or dictionary

    IStylesheetService

    Defines the Stylesheet Service, which provides operations for managing IStylesheet files.

    ISystemTroubleshootingInformationService

    Service for retrieving system troubleshooting information.

    ITagService

    Tag service to query for tags in the tags db table. The tags returned are only relevant for published content & saved media or members

    ITemplateContentParserService

    Service for parsing template content to extract layout information.

    ITemplateService

    Provides methods for managing templates (views) used for rendering content.

    ITemporaryFileService

    Provides functionality for managing temporary files used during uploads and other operations.

    ITrackedReferencesService

    Service for tracking references between entities in Umbraco.

    ITreeEntitySortingService

    Provides functionality for sorting tree entities based on sorting models.

    ITwoFactorLoginService

    Service handling 2FA logins.

    IUpgradeService

    Provides functionality for checking available Umbraco upgrades.

    IUsageInformationService

    Service for retrieving usage information about the Umbraco installation.

    IUserDataService

    Defines the user data service, which provides operations for managing user-specific data entries.

    IUserGroupPermissionService

    Manages permissions for user group access.

    IUserGroupService

    Manages user groups.

    IUserIdKeyResolver

    Defines methods for resolving user keys to user IDs and vice versa without retrieving full user details.

    IUserPermissionService

    Manages permissions for user access.

    IUserService

    Defines the UserService, which is an easy access to operations involving IProfile and eventually Users.

    IUserTwoFactorLoginService

    A user specific Two factor service, that ensures the user exists before doing the job.

    IWebProfilerService

    Service for managing the web profiler (MiniProfiler) status.

    IWebhookFiringService

    Service for firing webhooks in response to events.

    IWebhookLogFactory

    Factory for creating webhook log entries.

    IWebhookLogService

    Service for managing webhook log entries.

    IWebhookRequestService

    Provides functionality for managing webhook requests.

    IWebhookService

    Service for managing webhooks.

    Enums

    MoveOperationStatusType

    A status type of the result of moving an item

    OperationResultType

    A value indicating the result of an operation.

    PublishResultType

    A value indicating the result of publishing or unpublishing a document.

    In this article
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX