Interface IUrlResolver
Component that routes an url to the corresponding IContent instance or vice versa.
Namespace: EPiServer.Web.Routing
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public interface IUrlResolverMethods
GetUrl(ContentReference, String, UrlResolverArguments)
Gets the URL for a IContent instance that is given by argument urlResolverArguments.
Declaration
string GetUrl(ContentReference contentLink, string language, UrlResolverArguments urlResolverArguments)Parameters
| Type | Name | Description |
|---|---|---|
| ContentReference | contentLink | The content link. |
| System.String | language | The language. |
| UrlResolverArguments | urlResolverArguments | The arguments used at url resolving |
Returns
| Type | Description |
|---|---|
| System.String | A string representing the URL or |
Remarks
The returned url can be relative or absolute (including host) depending on if the contentLink is on current site
and current request matches host that matches content and language.
GetUrl(UrlBuilder, UrlResolverArguments)
Resolves the URL for an item from an URL with internal format.
Declaration
string GetUrl(UrlBuilder urlBuilderWithInternalUrl, UrlResolverArguments arguments)Parameters
| Type | Name | Description |
|---|---|---|
| UrlBuilder | urlBuilderWithInternalUrl | The URL with a internal format. |
| UrlResolverArguments | arguments | The UrlResolverArguments that determines the format of the link. |
Returns
| Type | Description |
|---|---|
| System.String | A URL in string representation or the passed in string if the url was not an internal content format. |
Remarks
The returned url can be relative or absolute (including host) depending on if the urlBuilderWithInternalUrl is on current site
and current request matches host that matches content and language.
Route(UrlBuilder, RouteArguments)
Routes the URL to the corresponding IContent instance.
Declaration
ContentRouteData Route(UrlBuilder urlBuilder, RouteArguments routeArguments)Parameters
| Type | Name | Description |
|---|---|---|
| UrlBuilder | urlBuilder | The URL builder. |
| RouteArguments | routeArguments | The ContextMode |
Returns
| Type | Description |
|---|---|
| ContentRouteData |
TryToPermanent(String, out String)
Tries to convert a URL with either a public, preview or permanent format to a permanent URL.
Declaration
bool TryToPermanent(string url, out string permanentUrl)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | url | The URL. |
| System.String | permanentUrl | The permanent URL. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the conversion succeded, otherwise; false. |
