Commit ad273a47: #595 initial impl

#595 initial impl

ad273a47

Michael Schmitz

committed Jun 11, 2024

main

failed

Files

Details



	WPE.App.Analytics
	wwwroot
	referrer.ts +
	_Imports.razor +
	IAnalyticsService.cs +
	InteractionType.cs +
	ISiteMetadataService.cs +
	NoOpAnalyticsService.cs +
	ServiceCollectionExtensions.cs +
	SiteMetadataService.cs +
	tsconfig.json +
	WPE.App.Analytics.csproj +
	WPE.App.Analytics.Native
	AppConfiguration.cs +
	ILifecycleService.cs +
	NoOpLifecycleService.cs +
	ServiceCollectionExtensions.cs +
	WPE.App.Analytics.Maui.csproj +
	.gitignore +
	azure-pipelines.yml +
	icon.png +
	LICENSE +
	ReadMe.md +
	version.props +
	WPE.App.Analytics.sln +

referrer.ts

/WPE.App.Analytics/wwwroot/referrer.ts

View

export function getReferrer(): string {

const url = new URL(document.referrer);

return url.origin + url.pathname;

}

_Imports.razor

/WPE.App.Analytics/_Imports.razor

View

@using Microsoft.AspNetCore.Components.Web

IAnalyticsService.cs

+66

/WPE.App.Analytics/IAnalyticsService.cs

View

using Infsoft.WPE.DTO.AppConfig;

using Infsoft.WPE.DTO.Base;

using Microsoft.AspNetCore.Components;

using System.Net;

namespace Infsoft.WPE.App.Analytics

{

/// <summary>

/// Provides a common interface to send analytic events

/// </summary>

public interface IAnalyticsService

{

/// <summary>

/// Method to call on startup, to perform necessary initialization

/// </summary>

Task Init();

/// <summary>

/// Call this to track a page change

/// </summary>

/// <param name="title">Page title (e.g. document.title)</param>

/// <param name="name">Page name, should never change over time</param>

/// <param name="tab">Current app tab (from navbar)</param>

/// <param name="lcid">User language</param>

/// <param name="env">Environment app is running in</param>

/// <param name="user">User mail, <see langword="null"/> when not logged in</param>

Task OnPageView(string title, string name, string tab, LanguageId lcid, AppEnvironment env, string? user);

/// <summary>

/// Call this, when given consent is updated (or on startup)

/// </summary>

/// <param name="givenConsents">Consents defined and if they are accepted</param>

Task OnConsentUpdate(Dictionary<string, bool> givenConsents);

/// <summary>

/// Register a click on an element

/// </summary>

/// <param name="name">Name of button, should not change over time</param>

/// <param name="text">Displayed text shown to user</param>

/// <param name="interactionType">What type of click this belongs to</param>

/// <param name="location">Location of button, e.g. NavBar, Tile</param>

Task OnClick(string name, string text, InteractionType interactionType, string location);

/// <summary>

/// Call, when a search is performed

/// </summary>

/// <param name="numberOfResults">Result count of search</param>

/// <param name="searchLocation">Where the search is located, e.g. NavBar, PeopleSearch</param>

/// <param name="term">Search term entered by user</param>

/// <param name="Filters">Any filters set for properties</param>

/// <param name="startingDate">Date restriction for search</param>

/// <param name="endDate">End date restriction for search, only set with <paramref name="startingDate"/> set as well</param>

Task OnSearch(int numberOfResults, string searchLocation, string? term = null, Dictionary<string, List<string>>? Filters = null, DateTime? startingDate = null, DateTime? endDate = null);

/// <summary>

/// Call after a successfull interactive login

/// </summary>

Task OnLogin();

/// <summary>

/// Call after a successfull silent login

/// </summary>

Task OnSilentLogin();

}