Try our conversational search powered by Generative AI!

Interface IPermanentLinkMapper

Specifies methods for mapping between url/Guid/ContentReference

Namespace: EPiServer.Web
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public interface IPermanentLinkMapper

Methods

Clear()

Clear any cached data from this instance.

Declaration
void Clear()

Find(ContentReference)

Finds a PermanentContentLinkMap for a given ContentReference

Declaration
PermanentContentLinkMap Find(ContentReference contentReference)
Parameters
Type Name Description
ContentReference contentReference

The content reference.

Returns
Type Description
PermanentContentLinkMap

A PermanentContentLinkMap if exist, else null is returned

Find(UrlBuilder)

Finds a PemanentLinkMap for a given Url

Declaration
PermanentLinkMap Find(UrlBuilder url)
Parameters
Type Name Description
UrlBuilder url

The URL.

Returns
Type Description
PermanentLinkMap

A PermanentLinkMap if exist, else null is returned

Find(Guid)

Finds a PemanentLinkMap for a given Guid

Declaration
PermanentLinkMap Find(Guid guid)
Parameters
Type Name Description
System.Guid guid

The GUID.

Returns
Type Description
PermanentLinkMap

A PermanentLinkMap if exist, else null is returned

Initialize(IContentEvents, IContentLoader)

Initializes the mapper.

Declaration
void Initialize(IContentEvents contentEvents, IContentLoader contentLoader)
Parameters
Type Name Description
IContentEvents contentEvents

The content events.

IContentLoader contentLoader

The content loader.

TryToMapped(String, out String)

Tries to find a mapped url from a permenent link represetation

Declaration
bool TryToMapped(string url, out string mappedUrl)
Parameters
Type Name Description
System.String url

The URL.

System.String mappedUrl

The mapped URL.

Returns
Type Description
System.Boolean

true if permanent link was found, else false

TryToPermanent(String, out String)

Tries to find the permanent link representation of a 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 permanent link was found, else false

Extension Methods