DataWeb
Search Results for

    Show / Hide Table of Contents

    Class AnalyticsService

    Service for managing analytics goals.

    Inheritance
    object
    AnalyticsService
    Implements
    IAnalyticsService
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: DataWeb.Analytics
    Assembly: DataWeb.Core.dll
    Syntax
    public class AnalyticsService : IAnalyticsService
    Remarks

    Initializes a new instance of the AnalyticsService class.

    Constructors

    AnalyticsService(IHttpService, IAnalyticsGoalStore)

    Service for managing analytics goals.

    Declaration
    public AnalyticsService(IHttpService httpService, IAnalyticsGoalStore goalStore)
    Parameters
    Type Name Description
    IHttpService httpService

    The HTTP service to use for retrieving request information.

    IAnalyticsGoalStore goalStore

    The goal store to use for managing analytics goals.

    Remarks

    Initializes a new instance of the AnalyticsService class.

    Methods

    GetGoalAsync(AnalyticsGoalFilter, CancellationToken)

    Gets an analytics goal matching the specified filter.

    Declaration
    public Task<AnalyticsGoal> GetGoalAsync(AnalyticsGoalFilter filter, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AnalyticsGoalFilter filter

    The AnalyticsGoalFilter to use when querying for the goal.

    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AnalyticsGoal>

    An analytics goal matching the specified filter.

    GetGoalCountAsync(AnalyticsGoalFilter, CancellationToken)

    Gets the count of analytics goals matching the specified filter.

    Declaration
    public Task<long> GetGoalCountAsync(AnalyticsGoalFilter filter, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AnalyticsGoalFilter filter

    The AnalyticsGoalFilter to use when counting goals.

    CancellationToken cancellationToken
    Returns
    Type Description
    Task<long>

    The count of analytics goals matching the specified filter.

    GetGoalTotalValueAsync(AnalyticsGoalFilter, CancellationToken)

    Gets the total value of analytics goals matching the specified filter.

    Declaration
    public Task<decimal> GetGoalTotalValueAsync(AnalyticsGoalFilter filter, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AnalyticsGoalFilter filter

    The AnalyticsGoalFilter to use when calculating the total value of goals.

    CancellationToken cancellationToken
    Returns
    Type Description
    Task<decimal>

    The total value of analytics goals matching the specified filter.

    GetGoalsAsync(AnalyticsGoalFilter, CancellationToken)

    Gets a collection of AnalyticsGoal objects that match the specified AnalyticsGoalFilter.

    Declaration
    public Task<IEnumerable<AnalyticsGoal>> GetGoalsAsync(AnalyticsGoalFilter filter, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AnalyticsGoalFilter filter

    The AnalyticsGoalFilter used to search for goals.

    CancellationToken cancellationToken
    Returns
    Type Description
    Task<IEnumerable<AnalyticsGoal>>

    A collection of AnalyticsGoal objects.

    SetGoalAsync(AnalyticsGoal, CancellationToken)

    Sets an analytics goal.

    Declaration
    public Task SetGoalAsync(AnalyticsGoal goal, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AnalyticsGoal goal

    The AnalyticsGoal to set.

    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    Implements

    IAnalyticsService
    In this article
    Back to top Generated by DocFX