ProfanityFilter.Client 9.0.7-alpha.0.2

This is a prerelease version of ProfanityFilter.Client.

dotnet add package ProfanityFilter.Client --version 9.0.7-alpha.0.2

NuGet\Install-Package ProfanityFilter.Client -Version 9.0.7-alpha.0.2

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="ProfanityFilter.Client" Version="9.0.7-alpha.0.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ProfanityFilter.Client" Version="9.0.7-alpha.0.2" />
                    

                            Directory.Packages.props

<PackageReference Include="ProfanityFilter.Client" />
                    

                            Project file

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 ProfanityFilter.Client --version 9.0.7-alpha.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ProfanityFilter.Client, 9.0.7-alpha.0.2"

#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.

#addin nuget:?package=ProfanityFilter.Client&version=9.0.7-alpha.0.2&prerelease
                    

                            Install ProfanityFilter.Client as a Cake Addin

#tool nuget:?package=ProfanityFilter.Client&version=9.0.7-alpha.0.2&prerelease
                    

                            Install ProfanityFilter.Client as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Profanity Filter: Client

This is a .NET library intended to be used as a client for the Profanity Filter API. It provides a pair of clients for both REST and realtime communication with the API. The library is built on top of the 📦 Microsoft.Extensions.Http and 📦 Microsoft.AspNetCore.SignalR.Client packages.

The Profanity Filter API is a service that filters profane language from text. This client maps to the:

ghcr.io/ievangelist/profanity-filter-api:latest container image.

Get started

To install the 📦 ProfanityFilter.Client NuGet package:

dotnet add package ProfanityFilter.Client

To register the client in your application, call AddProfanityFilterClient on an IHostApplicationBuilder instance:

var builder = WebApplication.CreateBuilder(args);

builder.AddProfanityFilterClient("profanity-filter");

var app = builder.Build();

app.MapPost(
    pattern: "/filter",
    handler: static async (
        [FromBody] ProfanityFilterRequest request,
        [FromServices] IRestClient client) =>
        await client.ApplyFilterAsync(request))
    .WithName("Filter");

app.Run();

The connection name parameter registers the client in the application's services collection. The client can be injected into any service that requires it. The following types are available via DI:

IRestClient: Interface for the REST client.
IRealtimeClient: Interface for the realtime client.
ProfanityFilterClient: Concrete type exposing the pair of REST and realtime clients.

Configuration

The client can be configured using the ProfanityFilterOptions class (in the ProfanityFilter configuration key). The following options are available:

ApiBaseAddress: The base address of the Profanity Filter API.

{
  "ProfanityFilter": {
    "ApiBaseAddress": "https://profanity-filter-api.azurewebsites.net"
  }
}

Product	Compatible and additional computed target framework versions.
.NET	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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net9.0
- Microsoft.AspNetCore.SignalR.Client (>= 9.0.2)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions (>= 9.0.2)
- Microsoft.Extensions.Hosting.Abstractions (>= 9.0.2)
- Microsoft.Extensions.Http (>= 9.0.2)
- Microsoft.Extensions.Options (>= 9.0.2)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.2)
- ProfanityFilter.Common (>= 1.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.