openiddict-documentation/api/OpenIddict.Abstractions.html
2021-01-17 17:45:35 +00:00

310 lines
19 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace OpenIddict.Abstractions
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace OpenIddict.Abstractions
">
<meta name="generator" content="docfx 2.56.6.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.png" alt="">
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="OpenIddict.Abstractions">
<h1 id="OpenIddict_Abstractions" data-uid="OpenIddict.Abstractions" class="text-break">Namespace OpenIddict.Abstractions
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictApplicationDescriptor.html">OpenIddictApplicationDescriptor</a></h4>
<section><p>Represents an OpenIddict application descriptor.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictAuthorizationDescriptor.html">OpenIddictAuthorizationDescriptor</a></h4>
<section><p>Represents an OpenIddict authorization descriptor.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.html">OpenIddictConstants</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Algorithms.html">OpenIddictConstants.Algorithms</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.AuthenticationMethodReferences.html">OpenIddictConstants.AuthenticationMethodReferences</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.AuthorizationTypes.html">OpenIddictConstants.AuthorizationTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Claims.html">OpenIddictConstants.Claims</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Claims.Prefixes.html">OpenIddictConstants.Claims.Prefixes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Claims.Private.html">OpenIddictConstants.Claims.Private</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.ClientAuthenticationMethods.html">OpenIddictConstants.ClientAuthenticationMethods</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.ClientTypes.html">OpenIddictConstants.ClientTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.CodeChallengeMethods.html">OpenIddictConstants.CodeChallengeMethods</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.ConsentTypes.html">OpenIddictConstants.ConsentTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Destinations.html">OpenIddictConstants.Destinations</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Errors.html">OpenIddictConstants.Errors</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.GrantTypes.html">OpenIddictConstants.GrantTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.JsonWebTokenTypes.html">OpenIddictConstants.JsonWebTokenTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.JsonWebTokenTypes.Prefixes.html">OpenIddictConstants.JsonWebTokenTypes.Prefixes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.JsonWebTokenTypes.Private.html">OpenIddictConstants.JsonWebTokenTypes.Private</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Metadata.html">OpenIddictConstants.Metadata</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Parameters.html">OpenIddictConstants.Parameters</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Permissions.html">OpenIddictConstants.Permissions</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Permissions.Endpoints.html">OpenIddictConstants.Permissions.Endpoints</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Permissions.GrantTypes.html">OpenIddictConstants.Permissions.GrantTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Permissions.Prefixes.html">OpenIddictConstants.Permissions.Prefixes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Permissions.ResponseTypes.html">OpenIddictConstants.Permissions.ResponseTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Permissions.Scopes.html">OpenIddictConstants.Permissions.Scopes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Prompts.html">OpenIddictConstants.Prompts</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Properties.html">OpenIddictConstants.Properties</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Requirements.html">OpenIddictConstants.Requirements</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Requirements.Features.html">OpenIddictConstants.Requirements.Features</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Requirements.Prefixes.html">OpenIddictConstants.Requirements.Prefixes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.ResponseModes.html">OpenIddictConstants.ResponseModes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.ResponseTypes.html">OpenIddictConstants.ResponseTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Schemes.html">OpenIddictConstants.Schemes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Scopes.html">OpenIddictConstants.Scopes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Separators.html">OpenIddictConstants.Separators</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.Statuses.html">OpenIddictConstants.Statuses</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.SubjectTypes.html">OpenIddictConstants.SubjectTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.TokenTypeHints.html">OpenIddictConstants.TokenTypeHints</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConstants.TokenTypes.html">OpenIddictConstants.TokenTypes</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictConverter.html">OpenIddictConverter</a></h4>
<section><p>Represents a JSON.NET converter able to convert OpenIddict primitives.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictExceptions.html">OpenIddictExceptions</a></h4>
<section><p>Exposes common exceptions thrown by OpenIddict.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictExceptions.ConcurrencyException.html">OpenIddictExceptions.ConcurrencyException</a></h4>
<section><p>Represents an OpenIddict concurrency exception.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictExceptions.GenericException.html">OpenIddictExceptions.GenericException</a></h4>
<section><p>Represents a generic OpenIddict exception.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictExceptions.ValidationException.html">OpenIddictExceptions.ValidationException</a></h4>
<section><p>Represents an OpenIddict validation exception.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictExtensions.html">OpenIddictExtensions</a></h4>
<section><p>Provides extension methods to make <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a>
and <a class="xref" href="OpenIddict.Abstractions.OpenIddictResponse.html">OpenIddictResponse</a> easier to work with.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictMessage.html">OpenIddictMessage</a></h4>
<section><p>Represents an abstract OpenIddict message.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></h4>
<section><p>Represents a generic OpenIddict request.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictResponse.html">OpenIddictResponse</a></h4>
<section><p>Represents a generic OpenIddict response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictScopeDescriptor.html">OpenIddictScopeDescriptor</a></h4>
<section><p>Represents an OpenIddict scope descriptor.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictTokenDescriptor.html">OpenIddictTokenDescriptor</a></h4>
<section><p>Represents an OpenIddict token descriptor.</p>
</section>
<h3 id="structs">Structs
</h3>
<h4><a class="xref" href="OpenIddict.Abstractions.OpenIddictParameter.html">OpenIddictParameter</a></h4>
<section><p>Represents an OpenIddict parameter value, that can be either a primitive value,
an array of strings or a complex JSON representation containing child nodes.</p>
</section>
<h3 id="interfaces">Interfaces
</h3>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictApplicationCache-1.html">IOpenIddictApplicationCache&lt;TApplication&gt;</a></h4>
<section><p>Provides methods allowing to cache applications after retrieving them from the store.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictApplicationManager.html">IOpenIddictApplicationManager</a></h4>
<section><p>Provides methods allowing to manage the applications stored in the store.
Note: this interface is not meant to be implemented by custom managers,
that should inherit from the generic OpenIddictApplicationManager class.
It is primarily intended to be used by services that cannot easily depend
on the generic application manager. The actual application entity type
is automatically determined at runtime based on the OpenIddict core options.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictApplicationStore-1.html">IOpenIddictApplicationStore&lt;TApplication&gt;</a></h4>
<section><p>Provides methods allowing to manage the applications stored in a database.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictApplicationStoreResolver.html">IOpenIddictApplicationStoreResolver</a></h4>
<section><p>Exposes a method allowing to resolve an application store.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictAuthorizationCache-1.html">IOpenIddictAuthorizationCache&lt;TAuthorization&gt;</a></h4>
<section><p>Provides methods allowing to cache authorizations after retrieving them from the store.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictAuthorizationManager.html">IOpenIddictAuthorizationManager</a></h4>
<section><p>Provides methods allowing to manage the authorizations stored in the store.
Note: this interface is not meant to be implemented by custom managers,
that should inherit from the generic OpenIddictAuthorizationManager class.
It is primarily intended to be used by services that cannot easily depend
on the generic authorization manager. The actual authorization entity type
is automatically determined at runtime based on the OpenIddict core options.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictAuthorizationStore-1.html">IOpenIddictAuthorizationStore&lt;TAuthorization&gt;</a></h4>
<section><p>Provides methods allowing to manage the authorizations stored in a database.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictAuthorizationStoreResolver.html">IOpenIddictAuthorizationStoreResolver</a></h4>
<section><p>Exposes a method allowing to resolve an authorization store.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictScopeCache-1.html">IOpenIddictScopeCache&lt;TScope&gt;</a></h4>
<section><p>Provides methods allowing to cache scopes after retrieving them from the store.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictScopeManager.html">IOpenIddictScopeManager</a></h4>
<section><p>Provides methods allowing to manage the scopes stored in the store.
Note: this interface is not meant to be implemented by custom managers,
that should inherit from the generic OpenIddictScopeManager class.
It is primarily intended to be used by services that cannot easily
depend on the generic scope manager. The actual scope entity type is
automatically determined at runtime based on the OpenIddict core options.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictScopeStore-1.html">IOpenIddictScopeStore&lt;TScope&gt;</a></h4>
<section><p>Provides methods allowing to manage the scopes stored in a database.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictScopeStoreResolver.html">IOpenIddictScopeStoreResolver</a></h4>
<section><p>Exposes a method allowing to resolve a scope store.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictTokenCache-1.html">IOpenIddictTokenCache&lt;TToken&gt;</a></h4>
<section><p>Provides methods allowing to cache tokens after retrieving them from the store.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictTokenManager.html">IOpenIddictTokenManager</a></h4>
<section><p>Provides methods allowing to manage the tokens stored in the store.
Note: this interface is not meant to be implemented by custom managers,
that should inherit from the generic OpenIddictTokenManager class.
It is primarily intended to be used by services that cannot easily
depend on the generic token manager. The actual token entity type is
automatically determined at runtime based on the OpenIddict core options.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictTokenStore-1.html">IOpenIddictTokenStore&lt;TToken&gt;</a></h4>
<section><p>Provides methods allowing to manage the tokens stored in a database.</p>
</section>
<h4><a class="xref" href="OpenIddict.Abstractions.IOpenIddictTokenStoreResolver.html">IOpenIddictTokenStoreResolver</a></h4>
<section><p>Exposes a method allowing to resolve a token store.</p>
</section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>