Interface IAnalyticsGoalStore

Represents a store for analytics goals, providing methods for retrieving and setting goal data.

Namespace: DataWeb.Analytics

Assembly: DataWeb.Core.dll

Syntax

public interface IAnalyticsGoalStore

Properties

Name

Gets the name of the analytics goal store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetGoalAsync(AnalyticsGoalFilter, CancellationToken)

Retrieves a single analytics goal based on the provided AnalyticsGoalFilter.

Declaration

Task<AnalyticsGoal> GetGoalAsync(AnalyticsGoalFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AnalyticsGoalFilter	filter	The filter to apply when retrieving the goal.
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalyticsGoal>	A task representing the asynchronous operation, with a result containing the matching analytics goal, or null if not found.

GetGoalCountAsync(AnalyticsGoalFilter, CancellationToken)

Retrieves the count of analytics goals based on the provided AnalyticsGoalFilter.

Declaration

Task<long> GetGoalCountAsync(AnalyticsGoalFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AnalyticsGoalFilter	filter	The filter to apply when counting goals.
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	A task representing the asynchronous operation, with a result containing the count of matching analytics goals.

GetGoalTotalValueAsync(AnalyticsGoalFilter, CancellationToken)

Retrieves the total value of analytics goals based on the provided AnalyticsGoalFilter.

Declaration

Task<decimal> GetGoalTotalValueAsync(AnalyticsGoalFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AnalyticsGoalFilter	filter	The AnalyticsGoalFilter to apply when calculating the total value of goals.
CancellationToken	cancellationToken

Returns

Type	Description
Task<decimal>	A task representing the asynchronous operation, with a result containing the total value of matching analytics goals.

GetGoalsAsync(AnalyticsGoalFilter, CancellationToken)

Retrieves a collection of analytics goals based on the provided AnalyticsGoalFilter.

Declaration

Task<IEnumerable<AnalyticsGoal>> GetGoalsAsync(AnalyticsGoalFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AnalyticsGoalFilter	filter	The AnalyticsGoalFilter to apply when retrieving goals.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<AnalyticsGoal>>	A task representing the asynchronous operation, with a result containing an enumerable set of matching analytics goals.

SetAsync(AnalyticsGoal, CancellationToken)

Sets the specified AnalyticsGoal.

Declaration

Task SetAsync(AnalyticsGoal goal, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AnalyticsGoal	goal	The AnalyticsGoal to set.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.