Class PermanentLinkMapStore

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Given an permanent link representation, find an appropriate mapping object instance if possible

Inheritance

System.Object

PermanentLinkMapStore

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Web.Internal

Assembly: EPiServer.dll

Version: 10.10.4

Syntax

[Obsolete("Use IPermanentLinkMapper instead")]
public static class PermanentLinkMapStore

Fields

ChangeInPLMS

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. ID for the Permanent Link Map Store event "Changed exising item"

Declaration

public static readonly Guid ChangeInPLMS

Field Value

Type	Description
System.Guid

ClearPLMS

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. ID for the Permanent Link Map Store event "Clear store"

Declaration

public static readonly Guid ClearPLMS

Field Value

Type	Description
System.Guid

RemoveFromPLMS

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. ID for the Permanent Link Map Store event "Item removed"

Declaration

public static readonly Guid RemoveFromPLMS

Field Value

Type	Description
System.Guid

Properties

CacheCount

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the number of items in the cache.

Declaration

public static int CacheCount { get; }

Property Value

Type	Description
System.Int32	The cache count.

PerformanceCounters

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the collection of performance counters

Declaration

public static PermanentLinkMapStore.Counters PerformanceCounters { get; }

Property Value

Type	Description
PermanentLinkMapStore.Counters

Methods

Clear()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Clears the cache.

Declaration

public static void Clear()

ClearCache(Boolean)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Clears the cache. Optionally this event is broadcasted.

Declaration

public static void ClearCache(bool raiseEvent)

Parameters

Type	Name	Description
System.Boolean	raiseEvent	if set to `true`Raise the event for other clients

ClearItemFromCache(Guid, Boolean)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Removes the item with specified id from cache. If raiseEvent is true the cache removal is broadcasted.

Declaration

public static void ClearItemFromCache(Guid itemId, bool raiseEvent)

Parameters

Type	Name	Description
System.Guid	itemId	The item id.
System.Boolean	raiseEvent	if set to `true` [raise event].

Find(ContentReference)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Finds a PermanentLinkMap-derived instance from the specified page reference.

Declaration

public static PermanentLinkMap Find(ContentReference contentReference)

Parameters

Type	Name	Description
ContentReference	contentReference	The content reference.

Returns

Type	Description
PermanentLinkMap	A link map, or null if not found

Find(UrlBuilder)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Finds an PermanentLinkMap-derived instance from the provided url, if possible.

Declaration

public static PermanentLinkMap Find(UrlBuilder url)

Parameters

Type	Name	Description
UrlBuilder	url	The URL, which may be in permanent link format, or mapped format

Returns

Type	Description
PermanentLinkMap	The mapping object or null

Find(Guid)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Creates an PermanentLinkMap-derived instance from the provided Guid, if possible.

Declaration

public static PermanentLinkMap Find(Guid guid)

Parameters

Type	Name	Description
System.Guid	guid	The Guid

Returns

Type	Description
PermanentLinkMap	The mapping object or null

RemovePageFromCache(PageReference)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Removes link information about the page from link store cache.

Declaration

public static void RemovePageFromCache(PageReference pageLink)

Parameters

Type	Name	Description
PageReference	pageLink	The page link.

Save(PermanentContentLinkMap)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Saves the specified PermanentLinkMap to the repository, making it available for lookup.

Declaration

public static void Save(PermanentContentLinkMap plm)

Parameters

Type	Name	Description
PermanentContentLinkMap	plm	The PermanentLinkMap

Remarks

This method must be called whenever a new mapping is created, or an existing one has some aspect modified to save it to the backing store (actually an in-memory cache in this implementation).

ToPermanent(UrlBuilder)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Converts the provided URL to the permanent link representation, if possible.

Declaration

public static bool ToPermanent(UrlBuilder url)

Parameters

Type	Name	Description
UrlBuilder	url	The URL. It may be permanent or mapped to begin with.

Returns

Type	Description
System.Boolean	true if a permanent link representation is provided after the call

TryToPermanent(String, out String)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Converts the provided URL to the permanent link representation, if possible.

Declaration

public static bool TryToPermanent(string url, out string permanentUrl)

Parameters

Type	Name	Description
System.String	url	The URL. It may be permanent or mapped to begin with.
System.String	permanentUrl	The resulting permanent link URL, if the conversion was possible (or unnecessary)

Returns

Type	Description
System.Boolean	true if a permanent link representation is provided after the call.