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 options); void AddPage(string urlName, string url, Object parameterDefaults, Object parameterConstraints, string pageName, PageDefinitionOptions options); void AddRaw(string urlName, string url, Object parameterDefaults, Object parameterConstraints, Action<HttpContextBase,PageContext> action, RawDefinitionOptions options); void AddRaw(string urlName, string url, Object parameterDefaults, Object parameterConstraints, Func<HttpContextBase,PageContext,Task> action, 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 | Default | Options |
---|---|---|---|---|---|
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 | 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 | Default | Options |
---|---|---|---|---|---|
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 | 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 | Default | Options |
---|---|---|---|---|---|
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> | This is the action where the response is modified, similar to IHttpHandler.ProcessRequest() | Required | ||
options | 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 | Default | Options |
---|---|---|---|---|---|
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,Task> | This is the action where the response is modified, similar to IHttpHandler.ProcessRequest() | Required | ||
options | RawDefinitionOptions | Allows for additional non-required url information | Required |