Class PluginEndPoint
Represents a base type for plugin end points to be targeted by the PluginsModule
Inheritance
PluginEndPoint
Namespace: Artemis.Core.Services
Assembly: Artemis.Core.dll
Syntax
public abstract class PluginEndPointProperties
Accepts
Gets the mime type of the input this end point accepts
Declaration
public string? Accepts { get; protected set; }Property Value
| Type | Description |
|---|---|
| string |
Name
Gets the name of the end point
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
PluginFeature
Gets the plugin the end point is associated with
Declaration
[JsonIgnore]
public PluginFeature PluginFeature { get; }Property Value
| Type | Description |
|---|---|
| PluginFeature |
PluginInfo
Gets the plugin info of the plugin the end point is associated with
Declaration
public PluginInfo PluginInfo { get; }Property Value
| Type | Description |
|---|---|
| PluginInfo |
Returns
Gets the mime type of the output this end point returns
Declaration
public string? Returns { get; protected set; }Property Value
| Type | Description |
|---|---|
| string |
Url
Gets the full URL of the end point
Declaration
public string Url { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
OnProcessedRequest(IHttpContext)
Invokes the ProcessedRequest event
Declaration
protected virtual void OnProcessedRequest(IHttpContext context)Parameters
| Type | Name | Description |
|---|---|---|
| IHttpContext | context |
OnProcessingRequest(IHttpContext)
Invokes the ProcessingRequest event
Declaration
protected virtual void OnProcessingRequest(IHttpContext context)Parameters
| Type | Name | Description |
|---|---|---|
| IHttpContext | context |
OnRequestException(Exception)
Invokes the RequestException event
Declaration
protected virtual void OnRequestException(Exception e)Parameters
| Type | Name | Description |
|---|---|---|
| Exception | e | The exception that occurred during the request |
ProcessRequest(IHttpContext)
Called whenever the end point has to process a request
Declaration
protected abstract Task ProcessRequest(IHttpContext context)Parameters
| Type | Name | Description |
|---|---|---|
| IHttpContext | context | The HTTP context of the request |
Returns
| Type | Description |
|---|---|
| Task |
Events
ProcessedRequest
Occurs whenever a request was processed
Declaration
public event EventHandler<EndpointRequestEventArgs>? ProcessedRequestEvent Type
| Type | Description |
|---|---|
| EventHandler<EndpointRequestEventArgs> |
ProcessingRequest
Occurs whenever a request is about to be processed
Declaration
public event EventHandler<EndpointRequestEventArgs>? ProcessingRequestEvent Type
| Type | Description |
|---|---|
| EventHandler<EndpointRequestEventArgs> |
RequestException
Occurs whenever a request threw an unhandled exception
Declaration
public event EventHandler<EndpointExceptionEventArgs>? RequestExceptionEvent Type
| Type | Description |
|---|---|
| EventHandler<EndpointExceptionEventArgs> |