File: IPersistentComponentStateStore.cs
Web Access
Project: src\src\Components\Components\src\Microsoft.AspNetCore.Components.csproj (Microsoft.AspNetCore.Components)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
namespace Microsoft.AspNetCore.Components;
 
/// <summary>
/// Manages the storage for components and services that are part of a Blazor application.
/// </summary>
public interface IPersistentComponentStateStore
{
    /// <summary>
    /// Gets the persisted state from the store.
    /// </summary>
    /// <returns>The persisted state.</returns>
    Task<IDictionary<string, byte[]>> GetPersistedStateAsync();
 
    /// <summary>
    /// Persists the serialized state into the storage.
    /// </summary>
    /// <param name="state">The serialized state to persist.</param>
    /// <returns>A <see cref="Task" /> that completes when the state is persisted to disk.</returns>
    Task PersistStateAsync(IReadOnlyDictionary<string, byte[]> state);
 
    /// <summary>
    /// Returns a value that indicates whether the store supports the given <see cref="IComponentRenderMode"/>.
    /// </summary>
    /// <param name="renderMode">The <see cref="IComponentRenderMode"/> in question.</param>
    /// <returns><c>true</c> if the render mode is supported by the store, otherwise <c>false</c>.</returns>
    bool SupportsRenderMode(IComponentRenderMode renderMode) => true;
}