Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IWriteOnlyDataHandler&lt;TEntity&gt; | Quickie ">


<meta name="description" content="Defines write-only data operations.">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
Expand Down Expand Up @@ -96,15 +96,16 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="Quickie_DataHandlers_Writeonly_Definition_IWriteOnlyDataHandler_1" data-uid="Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler`1" class="text-break">
Interface IWriteOnlyDataHandler&lt;TEntity&gt; <a class="header-action link-secondary" title="View source" href="https://github.com/sushantpt/Quickie/blob/master/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs/#L3"><i class="bi bi-code-slash"></i></a>
Interface IWriteOnlyDataHandler&lt;TEntity&gt; <a class="header-action link-secondary" title="View source" href="https://github.com/sushantpt/Quickie/blob/master/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs/#L7"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Quickie.html">Quickie</a>.<a class="xref" href="Quickie.DataHandlers.html">DataHandlers</a>.<a class="xref" href="Quickie.DataHandlers.Writeonly.html">Writeonly</a>.<a class="xref" href="Quickie.DataHandlers.Writeonly.Definition.html">Definition</a></dd></dl>
<dl><dt>Assembly</dt><dd>Quickie.dll</dd></dl>
</div>

<div class="markdown summary"></div>
<div class="markdown summary"><p>Defines write-only data operations.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
Expand All @@ -116,7 +117,8 @@ <h1 id="Quickie_DataHandlers_Writeonly_Definition_IWriteOnlyDataHandler_1" data-
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TEntity</code></dt>
<dd></dd>
<dd><p>Type of entity</p>
</dd>
</dl>


Expand All @@ -136,10 +138,11 @@ <h2 class="section" id="methods">Methods

<h3 id="Quickie_DataHandlers_Writeonly_Definition_IWriteOnlyDataHandler_1_CreateItemAsync__0_System_Nullable_System_Threading_CancellationToken__" data-uid="Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler`1.CreateItemAsync(`0,System.Nullable{System.Threading.CancellationToken})">
CreateItemAsync(TEntity, CancellationToken?)
<a class="header-action link-secondary" title="View source" href="https://github.com/sushantpt/Quickie/blob/master/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs/#L5"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/sushantpt/Quickie/blob/master/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs/#L15"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Create an item</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
Expand All @@ -149,15 +152,18 @@ <h3 id="Quickie_DataHandlers_Writeonly_Definition_IWriteOnlyDataHandler_1_Create
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <span class="xref">TEntity</span></dt>
<dd></dd>
<dd><p>Data to create</p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
<dd></dd>
<dd><p>Cancellation token</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="Quickie.DataObj.ResponseObj-1.html">ResponseObj</a>&lt;TEntity&gt;&gt;</dt>
<dd></dd>
<dd><p>Response object</p>
</dd>
</dl>


Expand All @@ -174,10 +180,11 @@ <h4 class="section">Returns</h4>

<h3 id="Quickie_DataHandlers_Writeonly_Definition_IWriteOnlyDataHandler_1_CreateItemsAsync_System_Collections_Generic_ICollection__0__System_Nullable_System_Threading_CancellationToken__" data-uid="Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler`1.CreateItemsAsync(System.Collections.Generic.ICollection{`0},System.Nullable{System.Threading.CancellationToken})">
CreateItemsAsync(ICollection&lt;TEntity&gt;, CancellationToken?)
<a class="header-action link-secondary" title="View source" href="https://github.com/sushantpt/Quickie/blob/master/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs/#L6"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/sushantpt/Quickie/blob/master/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs/#L23"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Create collection of data</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
Expand All @@ -187,15 +194,18 @@ <h3 id="Quickie_DataHandlers_Writeonly_Definition_IWriteOnlyDataHandler_1_Create
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>items</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection</a>&lt;TEntity&gt;</dt>
<dd></dd>
<dd><p>Collection of data or items to create</p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
<dd></dd>
<dd><p>Cancellation token</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="Quickie.DataObj.ResponseObj-1.html">ResponseObj</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection</a>&lt;TEntity&gt;&gt;&gt;</dt>
<dd></dd>
<dd><p>Response object</p>
</dd>
</dl>


Expand All @@ -212,7 +222,7 @@ <h4 class="section">Returns</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/sushantpt/Quickie/blob/master/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs/#L3" class="edit-link">Edit this page</a>
<a href="https://github.com/sushantpt/Quickie/blob/master/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs/#L7" class="edit-link">Edit this page</a>
</div>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,17 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: IWriteOnlyDataHandler
path: ../src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
startLine: 2
startLine: 6
assemblies:
- Quickie
namespace: Quickie.DataHandlers.Writeonly.Definition
summary: Defines write-only data operations.
example: []
syntax:
content: 'public interface IWriteOnlyDataHandler<TEntity> where TEntity : WriteOnlyEntity'
typeParameters:
- id: TEntity
description: Type of entity
content.vb: Public Interface IWriteOnlyDataHandler(Of TEntity As WriteOnlyEntity)
nameWithType.vb: IWriteOnlyDataHandler(Of TEntity)
fullName.vb: Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler(Of TEntity)
Expand All @@ -51,19 +54,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: CreateItemAsync
path: ../src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
startLine: 4
startLine: 14
assemblies:
- Quickie
namespace: Quickie.DataHandlers.Writeonly.Definition
summary: Create an item
example: []
syntax:
content: Task<ResponseObj<TEntity>> CreateItemAsync(TEntity item, CancellationToken? cancellationToken)
parameters:
- id: item
type: '{TEntity}'
description: Data to create
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{{TEntity}}}
description: Response object
content.vb: Function CreateItemAsync(item As TEntity, cancellationToken As CancellationToken?) As Task(Of ResponseObj(Of TEntity))
overload: Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler`1.CreateItemAsync*
nameWithType.vb: IWriteOnlyDataHandler(Of TEntity).CreateItemAsync(TEntity, CancellationToken?)
Expand All @@ -86,19 +94,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: CreateItemsAsync
path: ../src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
startLine: 5
startLine: 22
assemblies:
- Quickie
namespace: Quickie.DataHandlers.Writeonly.Definition
summary: Create collection of data
example: []
syntax:
content: Task<ResponseObj<ICollection<TEntity>>> CreateItemsAsync(ICollection<TEntity> items, CancellationToken? cancellationToken)
parameters:
- id: items
type: System.Collections.Generic.ICollection{{TEntity}}
description: Collection of data or items to create
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{System.Collections.Generic.ICollection{{TEntity}}}}
description: Response object
content.vb: Function CreateItemsAsync(items As ICollection(Of TEntity), cancellationToken As CancellationToken?) As Task(Of ResponseObj(Of ICollection(Of TEntity)))
overload: Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler`1.CreateItemsAsync*
nameWithType.vb: IWriteOnlyDataHandler(Of TEntity).CreateItemsAsync(ICollection(Of TEntity), CancellationToken?)
Expand Down
3 changes: 2 additions & 1 deletion docs/api/Quickie.DataHandlers.Writeonly.Definition.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@ <h3 id="interfaces">
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.html">IWriteOnlyDataHandler&lt;TEntity&gt;</a></dt>
<dd></dd>
<dd><p>Defines write-only data operations.</p>
</dd>
</dl>


Expand Down
Loading
Loading