IUrlController Plugin Supplementary Type

Former Member — Fri, 13 May 2022 19:24:17 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:24:17

Provides access to add urls into the platform

IUrlController is defined in the Telligent.Evolution.Extensibility.Urls.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface IUrlController
{
	void AddCustomPage(string urlName, string url, Object parameterDefaults, Object parameterConstraints, string pageNameParameter, [[PageDefinitionOptions Plugin Supplementary Type|PageDefinitionOptions]] options);
	void AddPage(string urlName, string url, Object parameterDefaults, Object parameterConstraints, string pageName, [[PageDefinitionOptions Plugin Supplementary Type|PageDefinitionOptions]] options);
	void AddRaw(string urlName, string url, Object parameterDefaults, Object parameterConstraints, Action<HttpContextBase,[[PageContext Plugin Supplementary Type|PageContext]]> action, [[RawDefinitionOptions Plugin Supplementary Type|RawDefinitionOptions]] options);
	void AddRaw(string urlName, string url, Object parameterDefaults, Object parameterConstraints, Func<HttpContextBase,[[PageContext Plugin Supplementary Type|PageContext]],Task> action, [[RawDefinitionOptions Plugin Supplementary Type|RawDefinitionOptions]] options);
}

Methods

void AddCustomPage(string urlName, string url, Object parameterDefaults, Object parameterConstraints, string pageNameParameter, PageDefinitionOptions options);

Adds a custom page to the platform

Parameters

Name	Type	Description	Required
urlName	`string`	The name used to identify the url	Required
url	`string`	The local url of the page.	Required
parameterDefaults	`Object`	Allows the ability to define default values for any url tokens	Required
parameterConstraints	`Object`	Adds additional constraints when identifying the url	Required
pageNameParameter	`string`	The token used to identify the custom page in the url	Required
options	`[[PageDefinitionOptions Plugin Supplementary Type\|PageDefinitionOptions]]`	Allows for additional non-required page information	Required

void AddPage(string urlName, string url, Object parameterDefaults, Object parameterConstraints, string pageName, PageDefinitionOptions options);

Adds a standard page to the platform

Parameters

Name	Type	Description	Required
urlName	`string`	Url Name	Required
url	`string`	The local url of the page	Required
parameterDefaults	`Object`	Allows the ability to define default values for any url tokens	Required
parameterConstraints	`Object`	Adds additional constraints when identifying the url	Required
pageName	`string`	The identifier of the page itself	Required
options	`[[PageDefinitionOptions Plugin Supplementary Type\|PageDefinitionOptions]]`	Allows for additional non-required page information	Required

void AddRaw(string urlName, string url, Object parameterDefaults, Object parameterConstraints, Action<HttpContextBase,PageContext> action, RawDefinitionOptions options);

Adds a url where there is no page and the response is modified directly, similar to an IHttpHandler

Parameters

Name	Type	Description	Required
urlName	`string`	Url Name	Required
url	`string`	The local url	Required
parameterDefaults	`Object`	Allows the ability to define default values for any url tokens	Required
parameterConstraints	`Object`	Adds additional constraints when identifying the url	Required
action	`Action<HttpContextBase,[[PageContext Plugin Supplementary Type\|PageContext]]>`	This is the action where the response is modified, similar to IHttpHandler.ProcessRequest()	Required
options	`[[RawDefinitionOptions Plugin Supplementary Type\|RawDefinitionOptions]]`	Allows for additional non-required url information	Required

void AddRaw(string urlName, string url, Object parameterDefaults, Object parameterConstraints, Func<HttpContextBase,PageContext,Task> action, RawDefinitionOptions options);

Adds a url where there is no page and the response is modified directly, similar to an IHttpHandler

Parameters

Name	Type	Description	Required
urlName	`string`	Url Name	Required
url	`string`	The local url	Required
parameterDefaults	`Object`	Allows the ability to define default values for any url tokens	Required
parameterConstraints	`Object`	Adds additional constraints when identifying the url	Required
action	`Func<HttpContextBase,[[PageContext Plugin Supplementary Type\|PageContext]],Task>`	This is the action where the response is modified, similar to IHttpHandler.ProcessRequest()	Required
options	`[[RawDefinitionOptions Plugin Supplementary Type\|RawDefinitionOptions]]`	Allows for additional non-required url information	Required