Finnear 0.1.3
dotnet add package Finnear --version 0.1.3
NuGet\Install-Package Finnear -Version 0.1.3
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="Finnear" Version="0.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Finnear" Version="0.1.3" />
<PackageReference Include="Finnear" />
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 Finnear --version 0.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Finnear, 0.1.3"
#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 Finnear@0.1.3
#: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=Finnear&version=0.1.3
#tool nuget:?package=Finnear&version=0.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Finnear .NET SDK
Official .NET SDK for Finnear - Push notification platform for founders & developers.
Installation
dotnet add package Finnear
Quick Start
using Finnear;
var finnear = new FinnearClient(new FinnearConfig { ApiKey = "pk_..." });
var response = await finnear.TrackAsync(new EventPayload
{
Channel = "signups",
Title = "New user signed up",
Description = "user@example.com",
Emoji = "🙋",
Metadata = new Dictionary<string, string> { ["plan"] = "pro" }
});
API
new FinnearClient(config)
| Option | Type | Required | Description |
|---|---|---|---|
ApiKey |
string |
Yes | Your Finnear API key |
You can optionally pass an HttpClient as the second parameter for custom configuration or testing.
TrackAsync(eventPayload)
Send an event to Finnear. Returns a Task<EventResponse>.
| Field | Type | Required | Description |
|---|---|---|---|
Channel |
string |
Yes | Event channel |
Title |
string |
Yes | Event title |
Description |
string? |
No | Event description |
Emoji |
string? |
No | Event emoji icon |
UserId |
string? |
No | Associated user ID |
Metadata |
Dictionary<string, string> |
No | Key-value metadata |
Error Handling
using Finnear;
try
{
await finnear.TrackAsync(new EventPayload { Channel = "test", Title = "test" });
}
catch (AuthenticationException)
{
// Invalid API key (401)
}
catch (ValidationException ex)
{
// Invalid payload (400)
}
catch (ApiException ex)
{
// Other HTTP error
Console.WriteLine($"{ex.StatusCode}: {ex.Message}");
}
Requirements
- .NET 8.0+
License
MIT
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. 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.
-
net10.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.