Knowmax.Quest.Client 5.0.0-beta5

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

// Install Knowmax.Quest.Client as a Cake Tool
#tool nuget:?package=Knowmax.Quest.Client&version=5.0.0-beta5&prerelease                

Knowmax Quest Client

Strongly opiniated client exclusively in use by Knowmax for connecting clients to Knowmax Quest 5 API. Designed for use with dependency injection in ASP.NET.

Getting started

Add Knowmax.Quest.Client to your project using NuGet. Knowmax.Quest.Client relies on the Knowmax.Magma.Client package, which is also available on NuGet and must be installed and configured properly. [Actually we only rely on configuration of Knowmax Magma]

Make sure to make Knowmax Quest Client service options available in your configuration.

services.Configure<Knowmax.Quest.Client.ServiceOptions>(configuration.GetSection("Quest"));

Sample JSON configuration for use in appsettings.json:

  "Quest": {
    "ApplicationName": "reference-app",
    "Endpoint": "https://quest.knowmax.com",
    "SearchService": {
      "ApiKey": "",
      "ApiVersion": "2023-07-01-Preview"
    }
  }

Use the following code to add default Knowmax Quest Client services to your depencency injection container.

services.AddKnowmaxQuest()

This sample uses the AddKnowmaxQuest extension method to add the Knowmax Quest Client services to the dependency injection container. By default only the AuthenticationService will be added. Use options to include optional other services:

services.AddKnowmaxQuest(options => {
  options.Document();
  options.Search();
});

Example use using using dependency injection to obtain a Knowmax Quest token using data configured for a Knowmax Magma user.

var tokeninfo = await authenticationService.GetTokenUsingMagmaAsync();

License

This package is licensed MIT, which waives all copyright restrictions.

Product 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. 
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
5.0.0-rc1 152 6/26/2024
5.0.0-beta6 78 6/18/2024
5.0.0-beta5 58 6/18/2024
5.0.0-beta4 46 6/13/2024
5.0.0-beta3 52 6/12/2024
5.0.0-beta2 47 6/12/2024
5.0.0-beta1 46 6/12/2024
5.0.0-alpha6 48 6/11/2024
5.0.0-alpha5 53 6/10/2024
5.0.0-alpha3 66 6/3/2024
5.0.0-alpha2 66 6/1/2024
5.0.0-alpha 59 6/1/2024