Class DashboardWidgetStore

Inheritance

object

DashboardWidgetStore

Implements

IDashboardWidgetStore

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Dashboard.SqlServer

Assembly: DataWeb.Data.SqlServer.dll

Syntax

public class DashboardWidgetStore : IDashboardWidgetStore

Constructors

DashboardWidgetStore(ISqlHelper, ICacheService)

Declaration

public DashboardWidgetStore(ISqlHelper sqlHelper, ICacheService cacheService)

Parameters

Type	Name	Description
ISqlHelper	sqlHelper
ICacheService	cacheService

Properties

Name

Gets the name of the store implementation.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Methods

GetWidgetAsync(WidgetFilter, CancellationToken)

Retrieves the first dashboard widget matching the specified filter, or null if none is found.

Declaration

public Task<DashboardWidgetData> GetWidgetAsync(WidgetFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
WidgetFilter	filter	The filter criteria used to query the dashboard widget.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task<DashboardWidgetData>	The first matching DashboardWidgetData, or null.

GetWidgetCachedAsync(string, CancellationToken)

Retrieves a dashboard widget by name, using the cache when available.

Declaration

public Task<DashboardWidgetData> GetWidgetCachedAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the dashboard widget to retrieve.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task<DashboardWidgetData>	The cached or freshly loaded DashboardWidgetData, or null if not found.

GetWidgetsAsync(WidgetFilter, CancellationToken)

Retrieves a collection of dashboard widgets matching the specified filter.

Declaration

public Task<IEnumerable<DashboardWidgetData>> GetWidgetsAsync(WidgetFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
WidgetFilter	filter	The filter criteria used to query dashboard widgets.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task<IEnumerable<DashboardWidgetData>>	A collection of DashboardWidgetData matching the filter.

Implements

IDashboardWidgetStore