-
-
Notifications
You must be signed in to change notification settings - Fork 159
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto-generated documentation from 43c1a4b
- Loading branch information
Showing
6 changed files
with
310 additions
and
1 deletion.
There are no files selected for viewing
259 changes: 259 additions & 0 deletions
259
api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,259 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <title>Class DefaultOperationFilter </title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <meta name="title" content="Class DefaultOperationFilter "> | ||
|
|
||
| <meta name="description" content="Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy."> | ||
| <link rel="icon" href="../favicon.ico"> | ||
| <link rel="stylesheet" href="../public/docfx.min.css"> | ||
| <link rel="stylesheet" href="../public/main.css"> | ||
| <meta name="docfx:navrel" content="../toc.html"> | ||
| <meta name="docfx:tocrel" content="toc.html"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <meta name="docfx:docurl" content="https://github.com/json-api-dotnet/JsonApiDotNetCore/new/master/apiSpec/new?filename=JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter.md&value=---%0Auid%3A%20JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> | ||
| <meta name="loc:inThisArticle" content="In this article"> | ||
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> | ||
| <meta name="loc:searchNoResults" content="No results for "{query}""> | ||
| <meta name="loc:tocFilter" content="Filter by title"> | ||
| <meta name="loc:nextArticle" content="Next"> | ||
| <meta name="loc:prevArticle" content="Previous"> | ||
| <meta name="loc:themeLight" content="Light"> | ||
| <meta name="loc:themeDark" content="Dark"> | ||
| <meta name="loc:themeAuto" content="Auto"> | ||
| <meta name="loc:changeTheme" content="Change theme"> | ||
| <meta name="loc:copy" content="Copy"> | ||
| <meta name="loc:downloadPdf" content="Download PDF"> | ||
|
|
||
| <script type="module" src="./../public/docfx.min.js"></script> | ||
|
|
||
| <script> | ||
| const theme = localStorage.getItem('theme') || 'auto' | ||
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) | ||
| </script> | ||
|
|
||
| </head> | ||
|
|
||
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> | ||
| <header class="bg-body border-bottom"> | ||
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> | ||
| <div class="container-xxl flex-nowrap"> | ||
| <a class="navbar-brand" href="../index.html"> | ||
| <img id="logo" class="svg" src="../logo.svg" alt=""> | ||
|
|
||
| </a> | ||
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <i class="bi bi-three-dots"></i> | ||
| </button> | ||
| <div class="collapse navbar-collapse" id="navpanel"> | ||
| <div id="navbar"> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
| </header> | ||
|
|
||
| <main class="container-xxl"> | ||
| <div class="toc-offcanvas"> | ||
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> | ||
| <div class="offcanvas-header"> | ||
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> | ||
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> | ||
| </div> | ||
| <div class="offcanvas-body"> | ||
| <nav class="toc" id="toc"></nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="content"> | ||
| <div class="actionbar"> | ||
| <button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> | ||
| <i class="bi bi-list"></i> | ||
| </button> | ||
|
|
||
| <nav id="breadcrumb"></nav> | ||
| </div> | ||
|
|
||
| <article data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter"> | ||
|
|
||
|
|
||
|
|
||
| <h1 id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter" class="text-break"> | ||
| Class DefaultOperationFilter <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/DefaultOperationFilter.cs/#L10"><i class="bi bi-code-slash"></i></a> | ||
| </h1> | ||
|
|
||
| <div class="facts text-secondary"> | ||
| <dl><dt>Namespace</dt><dd><a class="xref" href="JsonApiDotNetCore.html">JsonApiDotNetCore</a>.<a class="xref" href="JsonApiDotNetCore.AtomicOperations.html">AtomicOperations</a></dd></dl> | ||
| <dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl> | ||
| </div> | ||
|
|
||
| <div class="markdown summary"><p>Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.</p> | ||
| </div> | ||
| <div class="markdown conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public class DefaultOperationFilter : IAtomicOperationFilter</code></pre> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <dl class="typelist inheritance"> | ||
| <dt>Inheritance</dt> | ||
| <dd> | ||
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div> | ||
| <div><span class="xref">DefaultOperationFilter</span></div> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <dl class="typelist implements"> | ||
| <dt>Implements</dt> | ||
| <dd> | ||
| <div><a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a></div> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
| <dl class="typelist inheritedMembers"> | ||
| <dt>Inherited Members</dt> | ||
| <dd> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a> | ||
| </div> | ||
| </dd></dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2 class="section" id="methods">Methods | ||
| </h2> | ||
|
|
||
|
|
||
| <a id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_GetJsonApiEndpoints_" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints*"></a> | ||
|
|
||
| <h3 id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_GetJsonApiEndpoints_JsonApiDotNetCore_Configuration_ResourceType_" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints(JsonApiDotNetCore.Configuration.ResourceType)"> | ||
| GetJsonApiEndpoints(ResourceType) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/DefaultOperationFilter.cs/#L35"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"></div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">protected virtual JsonApiEndpoints? GetJsonApiEndpoints(ResourceType resourceType)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>resourceType</code> <a class="xref" href="JsonApiDotNetCore.Configuration.ResourceType.html">ResourceType</a></dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
| <h4 class="section">Returns</h4> | ||
| <dl class="parameters"> | ||
| <dt><a class="xref" href="JsonApiDotNetCore.Controllers.JsonApiEndpoints.html">JsonApiEndpoints</a>?</dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_IsEnabled_" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled*"></a> | ||
|
|
||
| <h3 id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_IsEnabled_JsonApiDotNetCore_Configuration_ResourceType_JsonApiDotNetCore_Middleware_WriteOperationKind_" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled(JsonApiDotNetCore.Configuration.ResourceType,JsonApiDotNetCore.Middleware.WriteOperationKind)"> | ||
| IsEnabled(ResourceType, WriteOperationKind) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/DefaultOperationFilter.cs/#L13"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Determines whether the specified operation can be used in an atomic:operations request.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public virtual bool IsEnabled(ResourceType resourceType, WriteOperationKind writeOperation)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>resourceType</code> <a class="xref" href="JsonApiDotNetCore.Configuration.ResourceType.html">ResourceType</a></dt> | ||
| <dd><p>The targeted primary resource type of the operation.</p> | ||
| </dd> | ||
| <dt><code>writeOperation</code> <a class="xref" href="JsonApiDotNetCore.Middleware.WriteOperationKind.html">WriteOperationKind</a></dt> | ||
| <dd><p>The operation kind.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h4 class="section">Returns</h4> | ||
| <dl class="parameters"> | ||
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </article> | ||
|
|
||
| <div class="contribution d-print-none"> | ||
| <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/DefaultOperationFilter.cs/#L10" class="edit-link">Edit this page</a> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| <div class="affix"> | ||
| <nav id="affix"></nav> | ||
| </div> | ||
| </main> | ||
|
|
||
|
|
||
| <footer class="border-top text-secondary"> | ||
| <div class="container-xxl"> | ||
| <div class="flex-fill"> | ||
| <span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters