BaseController Class |
Namespace: NetQuarry.Web.API
The BaseController type exposes the following members.
Name | Description | |
---|---|---|
![]() | BaseController |
standard ctor
|
Name | Description | |
---|---|---|
![]() | ActionContext | Gets the action context. (Inherited from ApiController.) |
![]() | AppKey |
Returns the application key for this application.
|
![]() | Configuration | Gets the HttpConfiguration of the current ApiController. (Inherited from ApiController.) |
![]() | ControllerContext | Gets the HttpConfiguration of the current ApiController. (Inherited from ApiController.) |
![]() | ModelState | Gets the model state after the model binding process. (Inherited from ApiController.) |
![]() | Request | Gets or sets the HttpRequestMessage of the current ApiController. (Inherited from ApiController.) |
![]() | RequestContext | Gets the request context. (Inherited from ApiController.) |
![]() | Url | Gets an instance of a UrlHelper, which is used to generate URLs to other APIs. (Inherited from ApiController.) |
![]() | User | Returns the current principal associated with this request. (Inherited from ApiController.) |
Name | Description | |
---|---|---|
![]() | BadRequest | Creates a BadRequestResult. (Inherited from ApiController.) |
![]() | BadRequest(String) | Creates an ErrorMessageResult (400 Bad Request) with the specified error message. (Inherited from ApiController.) |
![]() | BadRequest(ModelStateDictionary) | Creates an InvalidModelStateResult with the specified model state. (Inherited from ApiController.) |
![]() | Conflict | Creates a ConflictResult (409 Conflict). (Inherited from ApiController.) |
![]() | Content``1(HttpStatusCode, UMP) | Creates a <see cref="T:System.Web.Http.NegotiatedContentResult`1" /> with the specified values. (Inherited from ApiController.) |
![]() | Content``1(HttpStatusCode, UMP, MediaTypeFormatter) | Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values. (Inherited from ApiController.) |
![]() | Content``1(HttpStatusCode, UMP, MediaTypeFormatter, String) | Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values. (Inherited from ApiController.) |
![]() | Content``1(HttpStatusCode, UMP, MediaTypeFormatter, MediaTypeHeaderValue) | Creates a <see cref="T:System.Web.Http.FormattedContentResult`1" /> with the specified values. (Inherited from ApiController.) |
![]() | Created``1(String, UMP) | Creates a CreatedNegotiatedContentResult (201 Created) with the specified values. (Inherited from ApiController.) |
![]() | Created``1(Uri, UMP) | Creates a CreatedNegotiatedContentResult (201 Created) with the specified values. (Inherited from ApiController.) |
![]() | CreatedAtRoute``1(String, Object, UMP) | Creates a CreatedAtRouteNegotiatedContentResult (201 Created) with the specified values. (Inherited from ApiController.) |
![]() | CreatedAtRoute``1(String, IDictionaryString, Object, UMP) | Creates a CreatedAtRouteNegotiatedContentResult (201 Created) with the specified values. (Inherited from ApiController.) |
![]() | CreateResponse |
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.
|
![]() | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ApiController.) |
![]() | Dispose(Boolean) | Releases the unmanaged resources that are used by the object and, optionally, releases the managed resources. (Inherited from ApiController.) |
![]() | Equals | (Inherited from Object.) |
![]() | ExecuteAsync | Executes asynchronously a single HTTP operation. (Inherited from ApiController.) |
![]() | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
![]() | FireEvent |
Fires an application web service event.
|
![]() | GetAuthTokenFromHeader |
Extracts the one or two-part token from the header.
|
![]() | GetClientIp |
Returns the current client IP address.
|
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Initialize | Initializes the ApiController instance with the specified controllerContext. (Inherited from ApiController.) |
![]() | InternalServerError | Creates an InternalServerErrorResult (500 Internal Server Error). (Inherited from ApiController.) |
![]() | InternalServerError(Exception) | Creates an ExceptionResult (500 Internal Server Error) with the specified exception. (Inherited from ApiController.) |
![]() | IsCacheableDomain |
Should be used to control caching for certain domains (e.g. jobs.staffgarden.com).
|
![]() | Json``1(UMP) | Creates a JsonResult (200 OK) with the specified value. (Inherited from ApiController.) |
![]() | Json``1(UMP, JsonSerializerSettings) | Creates a JsonResult (200 OK) with the specified values. (Inherited from ApiController.) |
![]() | Json``1(UMP, JsonSerializerSettings, Encoding) | Creates a JsonResult (200 OK) with the specified values. (Inherited from ApiController.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | NotFound | Creates a NotFoundResult. (Inherited from ApiController.) |
![]() | Ok | Creates an OkResult (200 OK). (Inherited from ApiController.) |
![]() | Ok``1(UMP) | Creates an OkNegotiatedContentResult with the specified values. (Inherited from ApiController.) |
![]() | Redirect(String) | Creates a redirect result (302 Found) with the specified value. (Inherited from ApiController.) |
![]() | Redirect(Uri) | Creates a redirect result (302 Found) with the specified value. (Inherited from ApiController.) |
![]() | RedirectToRoute(String, Object) | Creates a redirect to route result (302 Found) with the specified values. (Inherited from ApiController.) |
![]() | RedirectToRoute(String, IDictionaryString, Object) | Creates a redirect to route result (302 Found) with the specified values. (Inherited from ApiController.) |
![]() | RelatedValueInResponse |
Should return true if the related value for logging purposes is in the response vs. the request object.
|
![]() | RequiresToken |
Returns true if the request requires a 2-part token.
|
![]() | ResponseMessage | Creates a ResponseMessageResult with the specified response. (Inherited from ApiController.) |
![]() | StatusCode | Creates a StatusCodeResult with the specified status code. (Inherited from ApiController.) |
![]() | ToString | (Inherited from Object.) |
![]() | Unauthorized(AuthenticationHeaderValue) | Creates an UnauthorizedResult (401 Unauthorized) with the specified values. (Inherited from ApiController.) |
![]() | Unauthorized(IEnumerableAuthenticationHeaderValue) | Creates an UnauthorizedResult (401 Unauthorized) with the specified values. (Inherited from ApiController.) |
![]() | Validate``1(UMP) | Validates the given entity and adds the validation errors to the model state under the empty prefix, if any. (Inherited from ApiController.) |
![]() | Validate``1(UMP, String) | Validates the given entity and adds the validation errors to the model state, if any. (Inherited from ApiController.) |
Name | Description | |
---|---|---|
![]() | EqualValue |
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.) |