Search Results for

    Show / Hide Table of Contents

    Namespace Umbraco.Cms.Core.DeliveryApi

    Classes

    ApiContentBuilder

    Default implementation of IApiContentBuilder that builds API content objects for the Delivery API.

    ApiContentBuilderBase<T>

    Base class for building IApiContent instances from published content.

    ApiContentNameProvider

    Default implementation of IApiContentNameProvider that provides content names for the Delivery API.

    ApiContentPathProvider

    Default implementation of IApiContentPathProvider that provides content paths for the Delivery API.

    ApiContentPathResolver

    Default implementation of IApiContentPathResolver that resolves content by URL path for the Delivery API.

    ApiContentResponseBuilder

    Default implementation of IApiContentResponseBuilder that builds content response objects for the Delivery API.

    ApiContentRouteBuilder

    Default implementation of IApiContentRouteBuilder that builds content routes for the Delivery API.

    ApiDocumentUrlService

    Default implementation of IApiDocumentUrlService that retrieves document information by URL route.

    ApiElementBuilder

    Default implementation of IApiElementBuilder that builds API element objects for the Delivery API.

    ApiMediaBuilder

    Default implementation of IApiMediaBuilder that builds API media objects for the Delivery API.

    ApiMediaUrlProvider

    Default implementation of IApiMediaUrlProvider that provides media URLs for the Delivery API.

    ApiPropertyRenderer

    Default implementation of IApiPropertyRenderer that renders property values for the Delivery API.

    ApiPublishedContentCache

    Default implementation of IApiPublishedContentCache that provides access to published content for the Delivery API.

    ContentIndexHandlerCollection

    A collection of IContentIndexHandler implementations for the Delivery API.

    ContentIndexHandlerCollectionBuilder

    A collection builder for IContentIndexHandler implementations.

    DeliveryApiCompositeIdHandler

    Default implementation of IDeliveryApiCompositeIdHandler that handles composite ID creation and decomposition.

    DeliveryApiIndexCompositeIdModel

    Represents the decomposed components of a composite ID used in the Delivery API index.

    FilterHandlerCollection

    A collection of IFilterHandler implementations for the Delivery API.

    FilterHandlerCollectionBuilder

    A collection builder for IFilterHandler implementations.

    FilterOption

    Represents a filter option used for filtering query results in the Delivery API.

    IncludeInApiVersionAttribute

    Specifies that the property should be included in the Delivery API response based on API version constraints.

    IndexField

    Represents a field definition for the Delivery API content index.

    IndexFieldValue

    Represents a field value for the Delivery API content index.

    NoopApiAccessService

    A no-operation implementation of IApiAccessService that denies all access.

    NoopApiContentQueryService

    A no-operation implementation of IApiContentQueryService that always returns an empty result.

    NoopApiMediaQueryService

    A no-operation implementation of IApiMediaQueryService that always returns empty results.

    NoopCurrentMemberClaimsProvider

    A no-operation implementation of ICurrentMemberClaimsProvider that returns empty claims.

    NoopRequestCultureService

    A no-operation implementation of IRequestCultureService that does not track or return cultures.

    NoopRequestMemberAccessService

    A no-operation implementation of IRequestMemberAccessService that always grants access.

    NoopRequestPreviewService

    A no-operation implementation of IRequestPreviewService that always returns false for preview mode.

    NoopRequestRedirectService

    A no-operation implementation of IRequestRedirectService that never returns redirects.

    NoopRequestRoutingService

    A no-operation implementation of IRequestRoutingService that returns the requested path as-is.

    SelectorHandlerCollection

    A collection of ISelectorHandler implementations for the Delivery API.

    SelectorHandlerCollectionBuilder

    A collection builder for ISelectorHandler implementations.

    SelectorOption

    Represents a selector option used for content querying in the Delivery API.

    SortHandlerCollection

    A collection of ISortHandler implementations for the Delivery API.

    SortHandlerCollectionBuilder

    A collection builder for ISortHandler implementations.

    SortOption

    Represents a sort option used for ordering query results in the Delivery API.

    Interfaces

    IApiAccessService

    Defines a service that determines access permissions for the Delivery API.

    IApiContentBuilder

    Defines a builder that creates IApiContent instances from published content.

    IApiContentNameProvider

    Defines a provider that retrieves the name of content items for the Delivery API.

    IApiContentPathProvider

    Defines a provider that retrieves the URL path of content items for the Delivery API.

    IApiContentPathResolver

    Defines a resolver that finds published content by its URL path.

    IApiContentQueryProvider

    Concrete implementation of content querying (e.g. based on Examine)

    IApiContentQueryService

    Service that handles querying of the Delivery API.

    IApiContentResponseBuilder

    Defines a builder that creates IApiContentResponse instances from published content.

    IApiContentRouteBuilder

    Defines a builder that creates IApiContentRoute instances from published content.

    IApiDocumentUrlService

    Defines a service that retrieves document information by URL route for the Delivery API.

    IApiElementBuilder

    Defines a builder that creates IApiElement instances from published elements.

    IApiMediaBuilder

    Defines a builder that creates IApiMedia instances from published media.

    IApiMediaQueryService

    Service that handles querying of the Media APIs.

    IApiMediaUrlProvider

    Defines a provider that retrieves URLs for media items in the Delivery API.

    IApiPropertyRenderer

    Defines a renderer that converts published property values for Delivery API responses.

    IApiPublishedContentCache

    Defines a cache for accessing published content through the Delivery API.

    IApiRichTextElementParser

    Defines a parser that processes rich text content into structured elements for the Delivery API.

    IApiRichTextMarkupParser

    Defines a parser that processes rich text HTML markup for the Delivery API.

    IContentIndexHandler

    A handler that appends field values to the Delivery API content index.

    ICurrentMemberClaimsProvider

    Defines a provider that retrieves claims for the currently logged in member.

    IDeliveryApiCompositeIdHandler

    Defines a handler for creating and decomposing composite IDs used in the Delivery API index.

    IFilterHandler

    A handler that handles filter query parameters.

    IOutputExpansionStrategy

    Defines a strategy for mapping and expanding properties in Delivery API responses.

    IOutputExpansionStrategyAccessor

    Defines an accessor for retrieving the current IOutputExpansionStrategy.

    IQueryHandler

    Base interface for query handlers in the Delivery API.

    IRequestCultureService

    Defines a service that retrieves the requested culture from the current HTTP request.

    IRequestMemberAccessService

    Defines a service that handles member access checks for the Delivery API.

    IRequestPreviewService

    Defines a service that determines whether the current request is in preview mode.

    IRequestRedirectService

    Defines a service that handles redirects for Delivery API requests.

    IRequestRoutingService

    Defines a service that handles routing for Delivery API requests.

    IRequestSegmentService

    Defines a service that retrieves the requested segment from the current HTTP request.

    IRequestSegmmentService

    Defines a service that retrieves the requested segment from the current HTTP request.

    IRequestStartItemProvider

    Defines a provider that retrieves the start item for Delivery API requests.

    IRequestStartItemProviderAccessor

    Defines an accessor for retrieving the current IRequestStartItemProvider.

    ISelectorHandler

    A handler that handles fetch query parameter.

    ISortHandler

    A handler that handles sort query parameters.

    Enums

    FieldType

    Specifies the type of a field in the Delivery API content index.

    FilterOperation

    Specifies the type of filter operation to apply in Delivery API queries.

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