Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IPublishedSnapshot

    Specifies a published snapshot.

    Namespace: Umbraco.Cms.Core.PublishedCache
    Assembly: Umbraco.Core.dll
    Syntax
    public interface IPublishedSnapshot
    Remarks

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

    Properties

    View Source

    Content

    Gets the IPublishedContentCache.

    Declaration
    IPublishedContentCache Content { get; }
    Property Value
    Type Description
    IPublishedContentCache
    View Source

    Domains

    Gets the IDomainCache.

    Declaration
    IDomainCache Domains { get; }
    Property Value
    Type Description
    IDomainCache
    View Source

    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.

    View Source

    Media

    Gets the IPublishedMediaCache.

    Declaration
    IPublishedMediaCache Media { get; }
    Property Value
    Type Description
    IPublishedMediaCache
    View Source

    Members

    Gets the IPublishedMemberCache.

    Declaration
    IPublishedMemberCache Members { get; }
    Property Value
    Type Description
    IPublishedMemberCache
    View Source

    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

    View Source

    ForcedPreview(Boolean, Nullable<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.Nullable<Action<System.Boolean>> callback

    A callback to execute when reverting to previous preview.

    Returns
    Type Description
    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.

    • Improve this Doc
    • View Source
    In This Article
    • Properties
      • Content
      • Domains
      • ElementsCache
      • Media
      • Members
      • SnapshotCache
    • Methods
      • ForcedPreview(Boolean, Nullable<Action<Boolean>>)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX