This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IUrl>()
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| CurrentContext | PageContext | Exposes the current contextual information about the incoming url |
Methods
string Absolute(string url);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required |
Return Type
string Adjust(string url, string queryStringAdjustment = null, string targetAdjustment = null);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required | ||
| queryStringAdjustment | string | Query String Adjustment | Optional | ||
| targetAdjustment | string | Target Adjustment | Optional |
Return Type
string ApplicationEscape(string url);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required |
Return Type
string ApplicationUnescape(string url);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required |
Return Type
string BuildUrl(string urlName, int groupId, IDictionary<string,string> parameters = null);
Generates a relative url based on the given parameters including the group path
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| urlName | string | Url Name | Required | ||
| groupId | int | Group Id | Required | ||
| parameters | IDictionary<string,string> | Parameters | Optional |
Return Type
string BuildUrl(string urlName, IDictionary<string,string> parameters = null);
Generates a relative url based on the given parameters
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| urlName | string | Url Name | Required | ||
| parameters | IDictionary<string,string> | Parameters | Optional |
Return Type
string ConvertQueryStringToHash(string url);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required |
Return Type
string Decode(string text);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required |
Return Type
string DecodeFileComponent(string text);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required |
Return Type
string DecodePathComponent(string text);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required |
Return Type
string Encode(string text);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required |
Return Type
string EncodeFileComponent(string text);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required |
Return Type
string EncodePathComponent(string text);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| text | string | Text | Required |
Return Type
bool IsSafe(string url);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required |
Return Type
bool IsSafe(Guid contentTypeId, string url);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentTypeId | Guid | Content Type Id | Required | ||
| url | string | Url | Required |
Return Type
SafeUrlValidation IsSafe(string url, SafeUrlOptions options);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required | ||
| options | SafeUrlOptions | Options | Required |
Return Type
string MakeQueryString(NameValueCollection queryStringValues);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| queryStringValues | NameValueCollection | Query String Values | Required |
Return Type
PageContext ParsePageContext(string url);
Extracts contextual information for a given local Community URL
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required |
Return Type
NameValueCollection ParseQueryString(string queryString);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| queryString | string | Query String | Required |
Return Type
ApiList<UrlEntity> ParseUrl(string url);
Extracts contextual information for a given URL
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| url | string | Url | Required |