Table of Contents

Class ApiController

Namespace
ToSic.Sxc.Dnn
Assembly
ToSic.Sxc.Dnn.WebApi.dll

This is the base class for all custom API Controllers.
With this, your code receives the full context incl. the current App, DNN, Data, etc.

Tip

We strongly suggest you check out the tutorials and guidance for custom WebAPIs here

[PublicApi("This was the official base class before v12. Try to move away from it, go to the latest base class on Custom.Dnn.Api12")]
[Obsolete("This will continue to work, but you should use the Custom.Hybrid.Api14 or Custom.Dnn.Api12 instead.")]
public abstract class ApiController : DnnSxcCustomControllerBase, IDnnDynamicCode, IHasDnn, IHasLog
Inheritance
DnnApiController
ApiController
Implements

Properties

App

A fully prepared IApp object letting you access all the data and queries in the current app.

You'll usually want to access the data, like App.Data["Categories"] or the queries App.Query["AllPosts"].

foreach(var cat in AsList(App.Data["Categories"])) {
	@cat.Name
}

public IApp App { get; }

Property Value

IApp

The current app

CmsContext

This Context tells you about the environment, such as

  • the current User
  • the Page
  • the View
  • the Site

It's supposed to replace direct access to Dnn or Oqtane object in Razor and WebAPI code, allowing hybrid code that works everywhere.

public ICmsContext CmsContext { get; }

Property Value

ICmsContext

Remarks

New in v11.11

Content

The content object of the current razor view - IF the current view has content. If the view is a list, it will return the first item. Will be null otherwise. To tell if it's the demo/default item, use IsDemoItem.

public dynamic Content { get; }

Property Value

dynamic

A IDynamicEntity object with the current content - or null.

Data

The data prepared for the current Code. Usually user data which was manually added to the instance, but can also be a query.

You'll usually want to access the "Default" stream like Data["Default"].

foreach(var person in AsList(Data["Default"])) {
	@person.Name
}

public IBlockInstance Data { get; }

Property Value

IBlockInstance

An IBlockInstance which is as IDataSource.

Dnn

The DNN context. Has various objects to access the Dnn Page, etc.

public IDnnContext Dnn { get; }

Property Value

IDnnContext

Edit

Helper commands to enable in-page editing functionality Use it to check if edit is enabled, generate context-json infos and provide toolbar buttons

public IEditService Edit { get; }

Property Value

IEditService

An IEditService object.

Header

The header object of the current razor view, if it's a list and has a header object. If it's a list and doesn't have a header (and no default), it will return null. To tell if it's the demo/default item, use IsDemoItem.

public dynamic Header { get; }

Property Value

dynamic

A IDynamicEntity object with the current content.

Remarks

Introduced in 2sxc 10.10 - previously it was called ListContent, now deprecated.

Link helper object to create the correct links

public ILinkService Link { get; }

Property Value

ILinkService

A ILinkService object.

Log

The logger for the current Razor / WebApi which allows you to add logs to Insights.

public ICodeLog Log { get; }

Property Value

ICodeLog

Methods

AsAdam(ICanBeEntity, string)

Provides an Adam instance for this item and field

public IFolder AsAdam(ICanBeEntity item, string fieldName)

Parameters

item ICanBeEntity

The item - an IEntity, IDynamicEntity, ITypedItem etc. often Content or similar

fieldName string

The field name, like "Gallery" or "Pics"

Returns

IFolder

An Adam object for navigating the assets

AsDynamic(object)

Convert a dynamic entity and return itself again. This is so coders don't have to worry if the original object was an IEntity or a IDynamicEntity in the first place.

public dynamic AsDynamic(object dynamicEntity)

Parameters

dynamicEntity object

the original object

Returns

dynamic

a dynamic object for easier coding

AsDynamic(string, string)

Take a json and provide it as a dynamic object to the code

public dynamic AsDynamic(string json, string fallback = null)

Parameters

json string

the original json string

fallback string

Alternate string to use, if the original json can't parse. Can also be null or the word "error" if you would prefer an error to be thrown.

Returns

dynamic

A dynamic object representing the original json. If it can't be parsed, it will parse the fallback, which by default is an empty empty dynamic object. If you provide null for the fallback, then you will get null back.

Remarks

Added in 2sxc 10.22.00

AsDynamic(IEntity)

Wraps an entity into a IDynamicEntity

public dynamic AsDynamic(IEntity entity)

Parameters

entity IEntity

the original object

Returns

dynamic

a dynamic object for easier coding

AsEntity(object)

Convert one or many Entities and Dynamic entities into an IDynamicStack

public IEntity AsEntity(object dynamicEntity)

Parameters

dynamicEntity object

Returns

IEntity

a dynamic object for easier coding

Remarks

New in 12.05

AsList(object)

Converts a list of IEntity objects into a list of IDynamicEntity objects.

public IEnumerable<dynamic> AsList(object list)

Parameters

list object

typically a List/IEnumerable of Entities or DynamicEntities.
Can also be a IDataSource in which case it uses the default stream.

Returns

IEnumerable<dynamic>

a list of IDynamicEntity objects

Remarks

Added in 2sxc 10.21.00

CreateInstance(string, NoParamOrder, string, string, bool)

Create an instance of code lying in a file near this

public dynamic CreateInstance(string virtualPath, NoParamOrder noParamOrder = default, string name = null, string relativePath = null, bool throwOnError = true)

Parameters

virtualPath string

path to the other code file to compile

noParamOrder NoParamOrder

see Convention: Named Parameters

name string

Override the class name to compile - usually not required as it should match the file name

relativePath string

optional relative path, will usually use the ToSic.Sxc.Code.Internal.IGetCodePath.CreateInstancePath

throwOnError bool

throw errors if compiling fails, recommended

Returns

dynamic

An object of the class in the file

Remarks

Note that the C# code which we are creating inherits from a standard base class such as Code12 or ToSic.Sxc.Code.DynamicCode then it will automatically be initialized to support App, AsDynamic etc.

CreateSource<T>(IDataSource, ILookUpEngine)

Create a IDataSource which will process data from the given stream.

public T CreateSource<T>(IDataSource inSource = null, ILookUpEngine configurationProvider = null) where T : IDataSource

Parameters

inSource IDataSource

The data source which will be the default In of the new data-source.

configurationProvider ILookUpEngine

An alternate configuration provider for the DataSource

Returns

T

A typed DataSource object

Type Parameters

T

A data-source type - must be inherited from IDataSource

CreateSource<T>(IDataStream)

Create a IDataSource which will process data from the given stream.

public T CreateSource<T>(IDataStream source) where T : IDataSource

Parameters

source IDataStream

The stream which will be the default In of the new data-source.

Returns

T

A typed DataSource object

Type Parameters

T

A data-source type - must be inherited from IDataSource

File(NoParamOrder, bool?, string, string, string, object)

Create a File-result to stream to the client

Typical use: return File(download: true, contentType: "text/xml", contents: ...);

public dynamic File(NoParamOrder noParamOrder = default, bool? download = null, string virtualPath = null, string contentType = null, string fileDownloadName = null, object contents = null)

Parameters

noParamOrder NoParamOrder

see Convention: Named Parameters

download bool?

If a download should be enforced (otherwise the file may just be displayed - like an image)

virtualPath string

Path in the website to get the file from. Provide either virtualPath or contents

contentType string

Mime Content-type. Will try to auto-detect from virtualPath or fileDownloadName if not provided.

fileDownloadName string

Download name. If provided, it will try to force download/save on the browser.

contents object

Content of the result - a string, byte[] or stream to include.

Returns

dynamic

Remarks

Added in 2sxc 12.05

GetService<TService>()

Get a service from the Dependency Injection. The service can come from 2sxc, EAV or the underlying platform (Dnn, Oqtane).

public TService GetService<TService>() where TService : class

Returns

TService

An object of the type or interface requested, or null if not found in the DI.

Type Parameters

TService

Interface (preferred) or Class which is needed

SaveInAdam(NoParamOrder, Stream, string, string, Guid?, string, string)

Save a file from a stream (usually an upload from the browser) into an adam-field of an item. Read more about this in the WebAPI docs for SaveInAdam

public IFile SaveInAdam(NoParamOrder noParamOrder = default, Stream stream = null, string fileName = null, string contentType = null, Guid? guid = null, string field = null, string subFolder = "")

Parameters

noParamOrder NoParamOrder

see Convention: Named Parameters

stream Stream

the stream

fileName string

file name to save to

contentType string

content-type of the target item (important for security checks)

guid Guid?
field string
subFolder string

Returns

IFile
Edit this page