View Source

Interface IPublishedSnapshot

Specifies a published snapshot.

Namespace: Umbraco.Web.PublishedCache

Assembly: Umbraco.Web.dll

Syntax

public interface IPublishedSnapshot : IDisposable

Remarks

A published snapshot is a point-in-time capture of the current state of everything that is "published".

Properties

Content

Gets the IPublishedContentCache.

Declaration

IPublishedContentCache Content { get; }

Property Value

Type	Description
IPublishedContentCache

Domains

Gets the IDomainCache.

Declaration

IDomainCache Domains { get; }

Property Value

Type	Description
IDomainCache

ElementsCache

Gets the elements-level cache.

Declaration

IAppCache ElementsCache { get; }

Property Value

Type	Description
IAppCache

Remarks

The elements-level cache is shared by all snapshots relying on the same elements, ie all snapshots built on top of unchanging content / media / etc.

Media

Gets the IPublishedMediaCache.

Declaration

IPublishedMediaCache Media { get; }

Property Value

Type	Description
IPublishedMediaCache

Members

Gets the IPublishedMemberCache.

Declaration

IPublishedMemberCache Members { get; }

Property Value

Type	Description
IPublishedMemberCache

SnapshotCache

Gets the snapshot-level cache.

Declaration

IAppCache SnapshotCache { get; }

Property Value

Type	Description
IAppCache

Remarks

The snapshot-level cache belongs to this snapshot only.

Methods

ForcedPreview(Boolean, Action<Boolean>)

Forces the preview mode.

Declaration

IDisposable ForcedPreview(bool preview, Action<bool> callback = null)

Parameters

Type	Name	Description
System.Boolean	preview	The forced preview mode.
System.Action<System.Boolean>	callback	A callback to execute when reverting to previous preview.

Returns

Type	Description
System.IDisposable

Remarks

Forcing to false means no preview. Forcing to true means 'full' preview if the snapshot is not already previewing; otherwise the snapshot keeps previewing according to whatever settings it is using already.

Stops forcing preview when disposed.