IRestEndpointController (v2) Plugin Supplementary Type

Ben Tiedt — Tue, 19 Nov 2019 19:37:51 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 19:37:51

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 (v2) Plugin Supplementary Type|HttpMethod]] method, Func<[[IRestRequest (v2) Plugin Supplementary Type|IRestRequest]],[[IRestResponse (v2) Plugin Supplementary Type|IRestResponse]]> handler);
	void Add(int version, string relativeUrl, [[HttpMethod (v2) Plugin Supplementary Type|HttpMethod]] method, Func<[[IRestRequest (v2) Plugin Supplementary Type|IRestRequest]],[[IRestResponse (v2) Plugin Supplementary Type|IRestResponse]]> handler, [[RestEndpointDocumentation (v2) Plugin Supplementary Type|RestEndpointDocumentation]] documentation);
	void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, [[HttpMethod (v2) Plugin Supplementary Type|HttpMethod]] method, Func<[[IRestRequest (v2) Plugin Supplementary Type|IRestRequest]],[[IRestResponse (v2) Plugin Supplementary Type|IRestResponse]]> handler);
	void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, [[HttpMethod (v2) Plugin Supplementary Type|HttpMethod]] method, Func<[[IRestRequest (v2) Plugin Supplementary Type|IRestRequest]],[[IRestResponse (v2) Plugin Supplementary Type|IRestResponse]]> handler, [[RestEndpointDocumentation (v2) Plugin Supplementary Type|RestEndpointDocumentation]] documentation);
	void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, [[HttpMethod (v2) Plugin Supplementary Type|HttpMethod]] method, Action<[[IRestRequest (v2) Plugin Supplementary Type|IRestRequest]],HttpResponse> handler);
	void Add(int version, string relativeUrl, Object parameterDefaults, Object parameterConstraints, [[HttpMethod (v2) Plugin Supplementary Type|HttpMethod]] method, Action<[[IRestRequest (v2) Plugin Supplementary Type|IRestRequest]],HttpResponse> handler, [[RestEndpointDocumentation (v2) Plugin Supplementary Type|RestEndpointDocumentation]] documentation);
}

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 (v2) Plugin Supplementary Type\|HttpMethod]]`	Method	Required
handler	`Func<[[IRestRequest (v2) Plugin Supplementary Type\|IRestRequest]],[[IRestResponse (v2) Plugin Supplementary Type\|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 (v2) Plugin Supplementary Type\|HttpMethod]]`	Method	Required
handler	`Func<[[IRestRequest (v2) Plugin Supplementary Type\|IRestRequest]],[[IRestResponse (v2) Plugin Supplementary Type\|IRestResponse]]>`	Handler	Required
documentation	`[[RestEndpointDocumentation (v2) Plugin Supplementary Type\|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 (v2) Plugin Supplementary Type\|HttpMethod]]`	Method	Required
handler	`Func<[[IRestRequest (v2) Plugin Supplementary Type\|IRestRequest]],[[IRestResponse (v2) Plugin Supplementary Type\|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 (v2) Plugin Supplementary Type\|HttpMethod]]`	Method	Required
handler	`Func<[[IRestRequest (v2) Plugin Supplementary Type\|IRestRequest]],[[IRestResponse (v2) Plugin Supplementary Type\|IRestResponse]]>`	Handler	Required
documentation	`[[RestEndpointDocumentation (v2) Plugin Supplementary Type\|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 (v2) Plugin Supplementary Type\|HttpMethod]]`	Method	Required
handler	`Action<[[IRestRequest (v2) Plugin Supplementary Type\|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 (v2) Plugin Supplementary Type\|HttpMethod]]`	Method	Required
handler	`Action<[[IRestRequest (v2) Plugin Supplementary Type\|IRestRequest]],HttpResponse>`	Handler	Required
documentation	`[[RestEndpointDocumentation (v2) Plugin Supplementary Type\|RestEndpointDocumentation]]`	Documentation	Required