Class UmbracoApiControllerBase
The base class for API controllers that expose Umbraco services - THESE ARE NOT AUTO ROUTED
Inheritance
System.Object
System.Web.Http.ApiController
Namespace:System.Dynamic.ExpandoObject
Assembly:umbraco.dll
Syntax
public abstract class UmbracoApiControllerBase : ApiController, IHttpController, IDisposable
Constructors
UmbracoApiControllerBase()
Declaration
protected UmbracoApiControllerBase()
UmbracoApiControllerBase(UmbracoContext)
Declaration
protected UmbracoApiControllerBase(UmbracoContext umbracoContext)
Parameters
Type | Name | Description |
---|---|---|
UmbracoContext | umbracoContext |
UmbracoApiControllerBase(UmbracoContext, UmbracoHelper)
Declaration
protected UmbracoApiControllerBase(UmbracoContext umbracoContext, UmbracoHelper umbracoHelper)
Parameters
Type | Name | Description |
---|---|---|
UmbracoContext | umbracoContext | |
UmbracoHelper | umbracoHelper |
Properties
ApplicationContext
Returns the current ApplicationContext
Declaration
public virtual ApplicationContext ApplicationContext { get; }
Property Value
Type | Description |
---|---|
ApplicationContext |
DatabaseContext
Returns a DatabaseContext
Declaration
public DatabaseContext DatabaseContext { get; }
Property Value
Type | Description |
---|---|
DatabaseContext |
Logger
Returns an ILogger
Declaration
public ILogger Logger { get; }
Property Value
Type | Description |
---|---|
ILogger |
Members
Returns the MemberHelper instance
Declaration
public MembershipHelper Members { get; }
Property Value
Type | Description |
---|---|
MembershipHelper |
ProfilingLogger
Returns a ProfilingLogger
Declaration
public virtual ProfilingLogger ProfilingLogger { get; }
Property Value
Type | Description |
---|---|
ProfilingLogger |
Security
Returns the WebSecurity instance
Declaration
public WebSecurity Security { get; }
Property Value
Type | Description |
---|---|
WebSecurity |
Services
Returns a ServiceContext
Declaration
public ServiceContext Services { get; }
Property Value
Type | Description |
---|---|
ServiceContext |
Umbraco
Returns an UmbracoHelper object
Declaration
public virtual UmbracoHelper Umbraco { get; }
Property Value
Type | Description |
---|---|
UmbracoHelper |
UmbracoContext
Returns the current UmbracoContext
Declaration
public virtual UmbracoContext UmbracoContext { get; }
Property Value
Type | Description |
---|---|
UmbracoContext |
Methods
TryGetHttpContext()
Tries to retrieve the current HttpContext if one exists.
Declaration
protected Attempt<HttpContextBase> TryGetHttpContext()
Returns
Type | Description |
---|---|
Attempt<System.Web.HttpContextBase> |
TryGetOwinContext()
Tries to retrieve the current HttpContext if one exists.
Declaration
protected Attempt<IOwinContext> TryGetOwinContext()
Returns
Type | Description |
---|---|
Attempt<Microsoft.Owin.IOwinContext> |