Shaunebu.MAUI.SessionManager 1.0.0

Shaunebu.MAUI.SessionManager📘

Overview

Shaunebu.MAUI.SessionManager is a lightweight session management utility for .NET MAUI applications.
It provides automatic session tracking, expiration events, and alert notifications before timeout, making it ideal for apps that require login sessions, inactivity timeouts, or custom session handling.

✨ Features

• 🔒 Session start, extension, and expiration handling.

• ⏳ Configurable session duration.

• ⚠️ Configurable alert trigger before expiration.

• 📡 Event-based API (SessionExpired, SessionAlert) using WeakEventManager (prevents memory leaks).

• 📱 Cross-platform (iOS auto-wired, Android requires a small MainActivity override).

• ✅ Simple integration into any MAUI project.

🚀 Getting Started

1. Install the Package

Add the library reference to your project:

dotnet add package Shaunebu.MAUI.SessionManager

2. Starting a Session

// Start a new session with default duration
await SessionManager.Instance.StartTrackSessionAsync();

By default, the session lasts ~1.3 minutes (for demo purposes). You can change this:

SessionManager.Instance.SessionDuration = TimeSpan.FromMinutes(10); // total duration
SessionManager.Instance.AlertBeforeExpiration = TimeSpan.FromMinutes(2); // alert before expiration

3. Subscribing to Events

You can subscribe to SessionAlert and SessionExpired events anywhere in your app (e.g., in AppShell, a Page, or a ViewModel):

SessionManager.Instance.SessionAlert += (s, e) =>
{
    // Show warning to the user (e.g., popup, toast, dialog)
    Console.WriteLine("⚠️ Session will expire soon!");
};

SessionManager.Instance.SessionExpired += (s, e) =>
{
    // Redirect to login or lock screen
    Console.WriteLine("⏹️ Session expired!");
};

4. Extending or Ending the Session

• Extend the session manually (e.g., on login success, user interaction, API call):

SessionManager.Instance.ExtendSession();

• End the session manually:

SessionManager.Instance.EndTrackSession();

📱 Platform Notes

✅ iOS

On iOS, the session is automatically extended via gesture recognizers attached to the root window. No extra configuration required.

⚠️ Android

On Android, SessionManager cannot intercept user interactions automatically because OnUserInteraction is part of MainActivity. To extend sessions when the user interacts with the UI, add the following override in your MainActivity.cs:

public override void OnUserInteraction()
{
    base.OnUserInteraction();
    SessionManager.Instance.ExtendSession();
}

This ensures that any tap, swipe, or interaction resets the session timer.

🔧 Example: Using in a Login Page

private async void OnLoginSuccess()
{
    // Configure session
    SessionManager.Instance.SessionDuration = TimeSpan.FromMinutes(30);
    SessionManager.Instance.AlertBeforeExpiration = TimeSpan.FromMinutes(5);

    // Subscribe to session events
    SessionManager.Instance.SessionAlert += async (s, e) =>
    {
        await DisplayAlert("Warning", "Your session will expire in 5 minutes.", "OK");
    };

    SessionManager.Instance.SessionExpired += async (s, e) =>
    {
        await DisplayAlert("Session Expired", "Please log in again.", "OK");
        await Shell.Current.GoToAsync("//LoginPage");
    };

    // Start tracking session
    await SessionManager.Instance.StartTrackSessionAsync();
}

📖 API Reference

Properties

• SessionDuration : TimeSpan → Total length of the session.

• AlertBeforeExpiration : TimeSpan → Time before expiration to trigger an alert.

• IsSessionActive : bool → Indicates if a session is running.

• HasShownAlert : bool → Whether the alert event has been triggered.

Events

• SessionExpired : EventHandler → Raised when the session expires.

• SessionAlert : EventHandler → Raised when the alert time is reached.

Methods

• Task StartTrackSessionAsync() → Starts session tracking asynchronously.

• void EndTrackSession() → Stops session tracking.

• void ExtendSession() → Extends the session expiration from now.

✅ Best Practices

• Start session after successful authentication.

• Use SessionAlert to warn users before expiration.

• Use SessionExpired to force logout or lock screen.

• Always implement the Android OnUserInteraction override if you need automatic extension.