Click or drag to resize

BaseController Class

The base class for all Api Controllers.
Inheritance Hierarchy
SystemObject
  ApiController
    NetQuarry.Web.APIBaseController

Namespace:  NetQuarry.Web.API
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public abstract class BaseController : ApiController

The BaseController type exposes the following members.

Constructors
  NameDescription
Public methodBaseController
standard ctor
Top
Properties
  NameDescription
Public propertyActionContext
Gets the action context.
(Inherited from ApiController.)
Protected propertyAppKey
Returns the application key for this application.
Public propertyConfiguration
Gets the HttpConfiguration of the current ApiController.
(Inherited from ApiController.)
Public propertyControllerContext
Gets the HttpConfiguration of the current ApiController.
(Inherited from ApiController.)
Public propertyModelState
Gets the model state after the model binding process.
(Inherited from ApiController.)
Public propertyRequest
Gets or sets the HttpRequestMessage of the current ApiController.
(Inherited from ApiController.)
Public propertyRequestContext
Gets the request context.
(Inherited from ApiController.)
Public propertyUrl
Gets an instance of a UrlHelper, which is used to generate URLs to other APIs.
(Inherited from ApiController.)
Public propertyUser
Returns the current principal associated with this request.
(Inherited from ApiController.)
Top
Methods
  NameDescription
Protected methodBadRequest
Creates a BadRequestResult.
(Inherited from ApiController.)
Protected methodBadRequest(String)
Creates an ErrorMessageResult (400 Bad Request) with the specified error message.
(Inherited from ApiController.)
Protected methodBadRequest(ModelStateDictionary)
Creates an InvalidModelStateResult with the specified model state.
(Inherited from ApiController.)
Protected methodConflict
Creates a ConflictResult (409 Conflict).
(Inherited from ApiController.)
Protected methodContent``1(HttpStatusCode, UMP)
Creates a <see cref="T:System.Web.Http.NegotiatedContentResult`1" /> with the specified values.
(Inherited from ApiController.)
Protected methodContent``1(HttpStatusCode, UMP, MediaTypeFormatter)
Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values.
(Inherited from ApiController.)
Protected methodContent``1(HttpStatusCode, UMP, MediaTypeFormatter, String)
Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values.
(Inherited from ApiController.)
Protected methodContent``1(HttpStatusCode, UMP, MediaTypeFormatter, MediaTypeHeaderValue)
Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values.
(Inherited from ApiController.)
Protected methodCreated``1(String, UMP)
Creates a CreatedNegotiatedContentResult (201 Created) with the specified values.
(Inherited from ApiController.)
Protected methodCreated``1(Uri, UMP)
Creates a CreatedNegotiatedContentResult (201 Created) with the specified values.
(Inherited from ApiController.)
Protected methodCreatedAtRoute``1(String, Object, UMP)
Creates a CreatedAtRouteNegotiatedContentResult (201 Created) with the specified values.
(Inherited from ApiController.)
Protected methodCreatedAtRoute``1(String, IDictionaryString, Object, UMP)
Creates a CreatedAtRouteNegotiatedContentResult (201 Created) with the specified values.
(Inherited from ApiController.)
Protected methodCreateResponse
Creates an HttpResponseMessage response for the specified object. Typically expects a result object implementing the IResponseMessage interface in which the object will be used to create its own response. Any other object will be give a status of OK.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from ApiController.)
Protected methodDispose(Boolean)
Releases the unmanaged resources that are used by the object and, optionally, releases the managed resources.
(Inherited from ApiController.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecuteAsync
Executes asynchronously a single HTTP operation.
(Inherited from ApiController.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFireEvent
Fires an application web service event.
Protected methodGetAuthTokenFromHeader
Extracts the one or two-part token from the header.
Protected methodGetClientIp
Returns the current client IP address.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInitialize
Initializes the ApiController instance with the specified controllerContext.
(Inherited from ApiController.)
Protected methodInternalServerError
Creates an InternalServerErrorResult (500 Internal Server Error).
(Inherited from ApiController.)
Protected methodInternalServerError(Exception)
Creates an ExceptionResult (500 Internal Server Error) with the specified exception.
(Inherited from ApiController.)
Protected methodIsCacheableDomain
Should be used to control caching for certain domains (e.g. jobs.staffgarden.com).
Protected methodJson``1(UMP)
Creates a JsonResult (200 OK) with the specified value.
(Inherited from ApiController.)
Protected methodJson``1(UMP, JsonSerializerSettings)
Creates a JsonResult (200 OK) with the specified values.
(Inherited from ApiController.)
Protected methodJson``1(UMP, JsonSerializerSettings, Encoding)
Creates a JsonResult (200 OK) with the specified values.
(Inherited from ApiController.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNotFound
Creates a NotFoundResult.
(Inherited from ApiController.)
Protected methodOk
Creates an OkResult (200 OK).
(Inherited from ApiController.)
Protected methodOk``1(UMP)
Creates an OkNegotiatedContentResult with the specified values.
(Inherited from ApiController.)
Protected methodRedirect(String)
Creates a redirect result (302 Found) with the specified value.
(Inherited from ApiController.)
Protected methodRedirect(Uri)
Creates a redirect result (302 Found) with the specified value.
(Inherited from ApiController.)
Protected methodRedirectToRoute(String, Object)
Creates a redirect to route result (302 Found) with the specified values.
(Inherited from ApiController.)
Protected methodRedirectToRoute(String, IDictionaryString, Object)
Creates a redirect to route result (302 Found) with the specified values.
(Inherited from ApiController.)
Protected methodRelatedValueInResponse
Should return true if the related value for logging purposes is in the response vs. the request object.
Protected methodRequiresToken
Returns true if the request requires a 2-part token.
Protected methodResponseMessage
Creates a ResponseMessageResult with the specified response.
(Inherited from ApiController.)
Protected methodStatusCode
Creates a StatusCodeResult with the specified status code.
(Inherited from ApiController.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Protected methodUnauthorized(AuthenticationHeaderValue)
Creates an UnauthorizedResult (401 Unauthorized) with the specified values.
(Inherited from ApiController.)
Protected methodUnauthorized(IEnumerableAuthenticationHeaderValue)
Creates an UnauthorizedResult (401 Unauthorized) with the specified values.
(Inherited from ApiController.)
Public methodValidate``1(UMP)
Validates the given entity and adds the validation errors to the model state under the empty prefix, if any.
(Inherited from ApiController.)
Public methodValidate``1(UMP, String)
Validates the given entity and adds the validation errors to the model state, if any.
(Inherited from ApiController.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also