CoreStone.SDK.Dotnet.Announcement
1.5.0
dotnet add package CoreStone.SDK.Dotnet.Announcement --version 1.5.0
NuGet\Install-Package CoreStone.SDK.Dotnet.Announcement -Version 1.5.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CoreStone.SDK.Dotnet.Announcement" Version="1.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CoreStone.SDK.Dotnet.Announcement" Version="1.5.0" />
<PackageReference Include="CoreStone.SDK.Dotnet.Announcement" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CoreStone.SDK.Dotnet.Announcement --version 1.5.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CoreStone.SDK.Dotnet.Announcement, 1.5.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CoreStone.SDK.Dotnet.Announcement@1.5.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CoreStone.SDK.Dotnet.Announcement&version=1.5.0
#tool nuget:?package=CoreStone.SDK.Dotnet.Announcement&version=1.5.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
CoreStone.SDK.Dotnet.Announcement
Announcement management for CoreStone — fetch active announcements and track user views.
Installation
dotnet add package CoreStone.SDK.Dotnet.Configuration
dotnet add package CoreStone.SDK.Dotnet.Announcement
Note: Authentication is optional for announcements.
X-Project-Keyis sufficient.
Setup
builder.Services
.AddCoreStoneConfiguration(o => { o.BaseUrl = "..."; o.ProjectKey = "..."; })
.AddCoreStoneAnnouncement();
Usage
public class AnnouncementController(IAnnouncementClient announcements) : Controller
{
// List all active announcements
public async Task<IActionResult> ListAll()
{
var items = await announcements.ListActiveAsync();
return Ok(items);
}
// Filter by display location (e.g. home_banner, splash, popup)
public async Task<IActionResult> ListForBanner()
{
var banners = await announcements.ListActiveAsync(displayLocation: "home_banner");
return Ok(banners);
}
// Get a single announcement
public async Task<IActionResult> GetById(Guid id)
{
var item = await announcements.GetByIdAsync(id);
return Ok(item);
}
// Track that user viewed an announcement (fire-and-forget)
public async Task TrackView(Guid announcementId, string sessionId)
{
await announcements.TrackViewAsync(new TrackAnnouncementViewRequest
{
AnnouncementId = announcementId,
SessionId = sessionId,
Platform = "web",
AppVersion = "2.1.0"
});
}
}
AppAnnouncementResponse Properties
| Property | Description |
|---|---|
Title |
Announcement title |
Summary |
Short summary |
Content |
Full content (HTML or Markdown) |
Type |
info / warning / success / promotion |
Priority |
low / normal / high |
IsPinned |
Whether the announcement is pinned |
ActionText |
CTA button text |
ActionUrl |
CTA button URL |
ImageUrl |
Banner image URL |
DisplayLocation |
Where to show it (e.g. home_banner) |
Links
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- CoreStone.SDK.Dotnet.Auth (>= 1.5.0)
- CoreStone.SDK.Dotnet.Configuration (>= 1.5.0)
-
net9.0
- CoreStone.SDK.Dotnet.Auth (>= 1.5.0)
- CoreStone.SDK.Dotnet.Configuration (>= 1.5.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.