View Source

Interface IUrlProvider

Provides URLs.

Namespace: Umbraco.Web.Routing
Assembly: Umbraco.Web.dll
Syntax
public interface IUrlProvider

Methods

View Source

GetOtherUrls(UmbracoContext, Int32, Uri)

Gets the other URLs of a published content.

Declaration
IEnumerable<UrlInfo> GetOtherUrls(UmbracoContext umbracoContext, int id, Uri current)
Parameters
Type Name Description
UmbracoContext umbracoContext

The Umbraco context.
System.Int32 id

The published content id.
System.Uri current

The current absolute URL.
Returns
Type Description
System.Collections.Generic.IEnumerable<UrlInfo>

The other URLs for the published content.
Remarks

Other URLs are those that GetUrl would not return in the current context, but would be valid URLs for the node in other contexts (different domain for current request, umbracoUrlAlias...).

View Source

GetUrl(UmbracoContext, IPublishedContent, UrlMode, String, Uri)

Gets the URL of a published content.

Declaration
UrlInfo GetUrl(UmbracoContext umbracoContext, IPublishedContent content, UrlMode mode, string culture, Uri current)
Parameters
Type Name Description
UmbracoContext umbracoContext

The Umbraco context.
IPublishedContent content

The published content.
UrlMode mode

The URL mode.
System.String culture

A culture.
System.Uri current

The current absolute URL.
Returns
Type Description
UrlInfo

The URL for the published content.
Remarks

The URL is absolute or relative depending on mode and on current.

If the published content is multi-lingual, gets the URL for the specified culture or, when no culture is specified, the current culture.

If the provider is unable to provide a URL, it should return null.