• Basics
  • Abyss
  • Web APIs
  • C# & Razor
  • .net API
  • JS & TS API

    Show / Hide Table of Contents

    Class Api12

    Base Class for modern Api Controllers in Dnn

    Class Custom.Dnn.Api12 for Dnn ☢️

    This is the Dnn specific base class. It's the very same as Custom.Hybrid.Api12 except for the additional Dnn Property.

    Because of this, the documentation here only shows Dnn - for all other properties go to Custom.Hybrid.Api12

    Tip

    If you don't need these special properties, we strongly suggest to move to the Hybrid implementation.

    Inheritance
    System.Object
    System.Web.Http.ApiController
    DotNetNuke.Web.Api.DnnApiController
    ToSic.Sxc.Dnn.WebApi.DnnApiControllerWithFixes<ToSic.Eav.WebApi.DummyControllerReal>
    ToSic.Sxc.WebApi.SxcApiControllerBase<ToSic.Eav.WebApi.DummyControllerReal>
    ToSic.Sxc.WebApi.DynamicApiController
    ApiCoreShim
    Api12
    Api12
    Implements
    IDynamicCode12
    IHasCodeLog
    IDynamicWebApi
    IDnnDynamicCode
    IDynamicCode
    ICreateInstance
    IHasLog
    IDnnDynamicCodeAdditions
    Inherited Members
    Api12.App
    Api12.Data
    Api12.AsDynamic(String, String)
    Api12.AsDynamic(IEntity)
    Api12.AsDynamic(Object)
    Api12.AsDynamic(Object[])
    Api12.AsEntity(Object)
    Api12.AsList(Object)
    Api12.Convert
    Api12.CreateSource<T>(IDataSource, Object)
    Api12.CreateSource<T>(IDataStream)
    Api12.Content
    Api12.Header
    Api12.AsAdam(IDynamicEntity, String)
    Api12.AsAdam(IEntity, String)
    Api12.SaveInAdam(String, Stream, String, String, Nullable<Guid>, String, String)
    Api12.Link
    Api12.Edit
    Api12.CmsContext
    Api12.Resources
    Api12.Settings
    Api12.Log
    ApiCoreShim.File(String, Nullable<Boolean>, String, String, String, Object)
    ApiCoreShim.Ok()
    ApiCoreShim.Ok(Object)
    ApiCoreShim.NoContent()
    ApiCoreShim.Redirect(String)
    ApiCoreShim.RedirectPermanent(String)
    ApiCoreShim.StatusCode(Int32)
    ApiCoreShim.StatusCode(Int32, Object)
    ApiCoreShim.Unauthorized()
    ApiCoreShim.Unauthorized(Object)
    ApiCoreShim.NotFound()
    ApiCoreShim.NotFound(Object)
    ApiCoreShim.BadRequest()
    ApiCoreShim.Conflict()
    ApiCoreShim.Conflict(Object)
    ApiCoreShim.Accepted()
    ApiCoreShim.Forbid()
    Namespace: Custom.Dnn
    Assembly: ToSic.Sxc.Dnn.WebApi.dll
    Syntax
    [PublicApi_Stable_ForUseInYourCode("This is the official base class for v12+")]
    public abstract class Api12 : Api12, IHttpController, IDisposable, IDynamicCodeBeforeV10, IDynamicCode12, ICompatibleToCode12, IHasDynamicCodeRoot, IHasCodeLog, IDnnDynamicWebApi, IDynamicWebApi, IDnnDynamicCode, IDynamicCode, ICreateInstance, ICompatibilityLevel, IHasLog, IDnnDynamicCodeAdditions

    Constructors

    | Improve this Doc View Source

    Api12()

    Declaration
    protected Api12()
    | Improve this Doc View Source

    Api12(String)

    Declaration
    protected Api12(string logSuffix)
    Parameters
    Type Name Description
    System.String logSuffix

    Properties

    | Improve this Doc View Source

    Dnn

    The DNN context.

    Declaration
    public IDnnContext Dnn { get; }
    Property Value
    Type Description
    IDnnContext

    The DNN context.

    Implements

    IDynamicCode12
    IHasCodeLog
    IDynamicWebApi
    IDnnDynamicCode
    IDynamicCode
    ICreateInstance
    IHasLog
    IDnnDynamicCodeAdditions
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX