APIVerve.API.UsernameProfanityChecker 1.0.5

There is a newer version of this package available.
See the version list below for details.
dotnet add package APIVerve.API.UsernameProfanityChecker --version 1.0.5                
NuGet\Install-Package APIVerve.API.UsernameProfanityChecker -Version 1.0.5                
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="APIVerve.API.UsernameProfanityChecker" Version="1.0.5" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add APIVerve.API.UsernameProfanityChecker --version 1.0.5                
#r "nuget: APIVerve.API.UsernameProfanityChecker, 1.0.5"                
#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.
// Install APIVerve.API.UsernameProfanityChecker as a Cake Addin
#addin nuget:?package=APIVerve.API.UsernameProfanityChecker&version=1.0.5

// Install APIVerve.API.UsernameProfanityChecker as a Cake Tool
#tool nuget:?package=APIVerve.API.UsernameProfanityChecker&version=1.0.5                

Username Profanity Checker API

Username Profanity Checker is a simple tool for checking if a username is inappropriate or profane. It returns if the username is inappropriate or profane.

Build Status Code Climate Prod Ready

This is a .NET Wrapper for the Username Profanity Checker API


Installation

Using the .NET CLI:

dotnet add package APIVerve.API.UsernameProfanityChecker

Using the Package Manager:

nuget install APIVerve.API.UsernameProfanityChecker

Using the Package Manager Console:

Install-Package APIVerve.API.UsernameProfanityChecker

From within Visual Studio:

  1. Open the Solution Explorer.
  2. Right-click on a project within your solution.
  3. Click on Manage NuGet Packages...
  4. Click on the Browse tab and search for "APIVerve.API.UsernameProfanityChecker".
  5. Click on the APIVerve.API.UsernameProfanityChecker package, select the appropriate version in the right-tab and click Install.

Configuration

Before using the usernameprofanity API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com


Usage

The Username Profanity Checker API documentation is found here: https://docs.apiverve.com/api/usernameprofanity.
You can find parameters, example responses, and status codes documented here.

Setup

Authentication

Username Profanity Checker API uses API Key-based authentication. When you create an instance of the API client, you can pass your API Key as a parameter.

// Create an instance of the API client
var apiClient = new UsernameProfanityCheckerAPIClient("[YOUR_API_KEY]", true);

Perform Request

Using the API client, you can perform requests to the API.

Define Query
var queryOptions = new usernameprofanityQueryOptions {
  username = "b00bs"
};
Simple Request
var response = apiClient.Execute(queryOptions);
if(response.error != null) {
	Console.WriteLine(response.error);
} else {
    var jsonResponse = JsonConvert.SerializeObject(response.data, Newtonsoft.Json.Formatting.Indented);
    Console.WriteLine(jsonResponse);
}
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "username": "b00bs",
    "isProfane": true
  }
}

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


All usage of the mailboxlayer website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2024 APIVerve, and Evlar LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net20 is compatible.  net35 is compatible.  net40 is compatible.  net403 was computed.  net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.8 94 5/16/2024
1.0.7 81 5/16/2024
1.0.6 85 5/15/2024
1.0.5 91 5/14/2024
1.0.4 68 5/14/2024