IRestEndpointController (v2) Plugin Supplementary Type

IRestEndpointController is defined in the Telligent.Evolution.Extensibility.Rest.Version2 namespace of Telligent.Evolution.Platform.dll

Definition

interface IRestEndpointController
{
	void Add(int version, string relativeUrl, HttpMethod method, Func<IRestRequest,IRestResponse> handler);
	void Add(int version, string relativeUrl, HttpMethod method, Func<IRestRequest,IRestResponse> handler, RestEndpointDocumentation documentation);
	void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, HttpMethod method, Func<IRestRequest,IRestResponse> handler);
	void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, HttpMethod method, Func<IRestRequest,IRestResponse> handler, RestEndpointDocumentation documentation);
	void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, HttpMethod method, Action<IRestRequest,HttpResponse> handler);
	void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, HttpMethod method, Action<IRestRequest,HttpResponse> handler, RestEndpointDocumentation documentation);
	void Add(int version, string relativeUrl, HttpMethod method, Func<IRestRequest,IRestResponse> handler, RestRouteCreateOptions options);
	void Add(int version, string relativeUrl, HttpMethod method, Action<IRestRequest,HttpResponse> handler, RestRouteCreateOptions options = null);
}

Methods

void Add(int version, string relativeUrl, HttpMethod method, Func<IRestRequest,IRestResponse> handler);

Parameters

Name	Type	Description	Required
version	`int`	Version	Required
relativeUrl	`string`	Relative Url	Required
method	`HttpMethod`	Method	Required
handler	`Func<IRestRequest,IRestResponse>`	Handler	Required

void Add(int version, string relativeUrl, HttpMethod method, Func<IRestRequest,IRestResponse> handler, RestEndpointDocumentation documentation);

Parameters

Name	Type	Description	Required
version	`int`	Version	Required
relativeUrl	`string`	Relative Url	Required
method	`HttpMethod`	Method	Required
handler	`Func<IRestRequest,IRestResponse>`	Handler	Required
documentation	`RestEndpointDocumentation`	Documentation	Required

void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, HttpMethod method, Func<IRestRequest,IRestResponse> handler);

Parameters

Name	Type	Description	Required
version	`int`	Version	Required
relativeUrl	`string`	Relative Url	Required
parameterDefaults	`Object`	Parameter Defaults	Required
parameterConstraints	`Object`	Parameter Constraints	Required
method	`HttpMethod`	Method	Required
handler	`Func<IRestRequest,IRestResponse>`	Handler	Required

void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, HttpMethod method, Func<IRestRequest,IRestResponse> handler, RestEndpointDocumentation documentation);

Parameters

Name	Type	Description	Required
version	`int`	Version	Required
relativeUrl	`string`	Relative Url	Required
parameterDefaults	`Object`	Parameter Defaults	Required
parameterConstraints	`Object`	Parameter Constraints	Required
method	`HttpMethod`	Method	Required
handler	`Func<IRestRequest,IRestResponse>`	Handler	Required
documentation	`RestEndpointDocumentation`	Documentation	Required

void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, HttpMethod method, Action<IRestRequest,HttpResponse> handler);

Parameters

Name	Type	Description	Required
version	`int`	Version	Required
relativeUrl	`string`	Relative Url	Required
parameterDefaults	`Object`	Parameter Defaults	Required
parameterConstraints	`Object`	Parameter Constraints	Required
method	`HttpMethod`	Method	Required
handler	`Action<IRestRequest,HttpResponse>`	Handler	Required

void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, HttpMethod method, Action<IRestRequest,HttpResponse> handler, RestEndpointDocumentation documentation);

Parameters

Name	Type	Description	Required
version	`int`	Version	Required
relativeUrl	`string`	Relative Url	Required
parameterDefaults	`Object`	Parameter Defaults	Required
parameterConstraints	`Object`	Parameter Constraints	Required
method	`HttpMethod`	Method	Required
handler	`Action<IRestRequest,HttpResponse>`	Handler	Required
documentation	`RestEndpointDocumentation`	Documentation	Required

void Add(int version, string relativeUrl, HttpMethod method, Func<IRestRequest,IRestResponse> handler, RestRouteCreateOptions options);

Parameters

Name	Type	Description	Required
version	`int`	Version	Required
relativeUrl	`string`	Relative Url	Required
method	`HttpMethod`	Method	Required
handler	`Func<IRestRequest,IRestResponse>`	Handler	Required
options	`RestRouteCreateOptions`	Options	Required

void Add(int version, string relativeUrl, HttpMethod method, Action<IRestRequest,HttpResponse> handler, RestRouteCreateOptions options = null);

Parameters

Name	Type	Description	Required
version	`int`	Version	Required
relativeUrl	`string`	Relative Url	Required
method	`HttpMethod`	Method	Required
handler	`Action<IRestRequest,HttpResponse>`	Handler	Required
options	`RestRouteCreateOptions`	Options	Optional

Recommended