CoreStone.SDK.Dotnet.Notifications 1.5.0

CoreStone.SDK.Dotnet.Notifications

In-app notification inbox for the CoreStone .NET SDK.

Installation

dotnet add package CoreStone.SDK.Dotnet.Notifications

Setup

builder.Services
    .AddCoreStoneConfiguration(o =>
    {
        o.BaseUrl   = "https://api.yourapp.com";
        o.ProjectKey = "your-project-slug";
    })
    .AddCoreStoneAuth()
    .AddCoreStoneNotifications();   // ← add this

Usage

public class NotificationsController : ControllerBase
{
    private readonly INotificationInboxClient _inbox;

    public NotificationsController(INotificationInboxClient inbox)
        => _inbox = inbox;

    // List all notifications (paginated)
    [HttpGet]
    public async Task<IActionResult> List([FromQuery] int page = 1, [FromQuery] bool? unreadOnly = null)
    {
        var result = await _inbox.ListAsync(new ListNotificationsRequest
        {
            Page       = page,
            PageSize   = 20,
            UnreadOnly = unreadOnly,
        });
        return Ok(result);
    }

    // Get unread badge count
    [HttpGet("unread-count")]
    public async Task<IActionResult> UnreadCount()
    {
        var count = await _inbox.GetUnreadCountAsync();
        return Ok(new { count });
    }

    // Get a single notification (marks it readable on client side)
    [HttpGet("{id:guid}")]
    public async Task<IActionResult> GetById(Guid id)
    {
        var n = await _inbox.GetByIdAsync(id);
        return Ok(n);
    }

    // Mark one notification as read
    [HttpPatch("{id:guid}/read")]
    public async Task<IActionResult> MarkRead(Guid id)
    {
        var n = await _inbox.MarkReadAsync(id);
        return Ok(n);
    }

    // Mark one notification as unread
    [HttpPatch("{id:guid}/unread")]
    public async Task<IActionResult> MarkUnread(Guid id)
    {
        var n = await _inbox.MarkUnreadAsync(id);
        return Ok(n);
    }

    // Mark all notifications as read
    [HttpPatch("read-all")]
    public async Task<IActionResult> MarkAllRead()
    {
        var count = await _inbox.MarkAllReadAsync();
        return Ok(new { markedCount = count });
    }
}

Models

NotificationListItem

NotificationDetail

Includes all NotificationListItem fields plus:

Error Handling

All methods throw CoreStoneException on API errors:

try
{
    var count = await _inbox.GetUnreadCountAsync();
}
catch (CoreStoneException ex) when (ex.Code == "UNAUTHORIZED")
{
    // User is not authenticated
}

Links

• NuGet
• GitHub