Search Results for

    Show / Hide Table of Contents
    View Source

    Class ContentApiControllerBase

    Inheritance
    System.Object
    DeliveryApiControllerBase
    Namespace: Umbraco.Cms.Api.Delivery.Controllers
    Assembly: Umbraco.Cms.Api.Delivery.dll
    Syntax
    public abstract class ContentApiControllerBase : DeliveryApiControllerBase

    Constructors

    View Source

    ContentApiControllerBase(IApiPublishedContentCache, IApiContentResponseBuilder)

    Declaration
    protected ContentApiControllerBase(IApiPublishedContentCache apiPublishedContentCache, IApiContentResponseBuilder apiContentResponseBuilder)
    Parameters
    Type Name Description
    IApiPublishedContentCache apiPublishedContentCache
    IApiContentResponseBuilder apiContentResponseBuilder

    Properties

    View Source

    ApiContentResponseBuilder

    Declaration
    protected IApiContentResponseBuilder ApiContentResponseBuilder { get; }
    Property Value
    Type Description
    IApiContentResponseBuilder
    View Source

    ApiPublishedContentCache

    Declaration
    protected IApiPublishedContentCache ApiPublishedContentCache { get; }
    Property Value
    Type Description
    IApiPublishedContentCache

    Methods

    View Source

    ApiContentQueryOperationStatusResult(ApiContentQueryOperationStatus)

    Declaration
    protected IActionResult ApiContentQueryOperationStatusResult(ApiContentQueryOperationStatus status)
    Parameters
    Type Name Description
    ApiContentQueryOperationStatus status
    Returns
    Type Description
    IActionResult
    View Source

    Forbidden()

    Creates a 403 Forbidden result.

    Declaration
    protected IActionResult Forbidden()
    Returns
    Type Description
    IActionResult
    Remarks

    Use this method instead of on the controller base. The latter will yield a redirect to an access denied URL because of the default cookie auth scheme. This method ensures that a proper 403 Forbidden status code is returned to the client.

    • Improve this Doc
    • View Source
    In This Article
    • Constructors
      • ContentApiControllerBase(IApiPublishedContentCache, IApiContentResponseBuilder)
    • Properties
      • ApiContentResponseBuilder
      • ApiPublishedContentCache
    • Methods
      • ApiContentQueryOperationStatusResult(ApiContentQueryOperationStatus)
      • Forbidden()
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX