Skip to content

Commit

Permalink
docs update ToSic.Sxc.Data
Browse files Browse the repository at this point in the history
  • Loading branch information
iJungleboy committed Jan 17, 2025
1 parent 8605863 commit 7afb5c8
Show file tree
Hide file tree
Showing 36 changed files with 1,152 additions and 327 deletions.
18 changes: 9 additions & 9 deletions docs/api/dot-net/Custom.Data.CustomItem.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h1 id="Custom_Data_CustomItem" data-uid="Custom.Data.CustomItem" class="text-br

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[PublicApi]
public class CustomItem : ITypedItem, ITyped, IEquatable&lt;ITypedItem&gt;, IDataModelOf&lt;ITypedItem&gt;, IDataModel</code></pre>
public class CustomItem : ITypedItem, ITyped, IEquatable&lt;ITypedItem&gt;, ICanWrap&lt;ITypedItem&gt;, ICanWrapData</code></pre>
</div>


Expand All @@ -140,8 +140,8 @@ <h1 id="Custom_Data_CustomItem" data-uid="Custom.Data.CustomItem" class="text-br
<div><a class="xref" href="ToSic.Sxc.Data.ITypedItem.html">ITypedItem</a></div>
<div><a class="xref" href="ToSic.Sxc.Data.ITyped.html">ITyped</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a>&lt;<a class="xref" href="ToSic.Sxc.Data.ITypedItem.html">ITypedItem</a>&gt;</div>
<div><a class="xref" href="ToSic.Sxc.Data.Model.IDataModelOf-1.html">IDataModelOf</a>&lt;<a class="xref" href="ToSic.Sxc.Data.ITypedItem.html">ITypedItem</a>&gt;</div>
<div><a class="xref" href="ToSic.Sxc.Data.Model.IDataModel.html">IDataModel</a></div>
<div><a class="xref" href="ToSic.Sxc.Data.ICanWrap-1.html">ICanWrap</a>&lt;<a class="xref" href="ToSic.Sxc.Data.ITypedItem.html">ITypedItem</a>&gt;</div>
<div><a class="xref" href="ToSic.Sxc.Data.ICanWrapData.html">ICanWrapData</a></div>
</dd>
</dl>

Expand Down Expand Up @@ -566,7 +566,7 @@ <h3 id="Custom_Data_CustomItem_AsList__1_System_Collections_Generic_IEnumerable_
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected IEnumerable&lt;T&gt; AsList&lt;T&gt;(IEnumerable&lt;ITypedItem&gt; source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, IDataModel</code></pre>
<pre><code class="lang-csharp hljs">protected IEnumerable&lt;T&gt; AsList&lt;T&gt;(IEnumerable&lt;ITypedItem&gt; source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ICanWrapData</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -616,7 +616,7 @@ <h3 id="Custom_Data_CustomItem_As__1_ToSic_Sxc_Data_ITypedItem_" data-uid="Custo
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected T As&lt;T&gt;(ITypedItem item) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">protected T As&lt;T&gt;(ITypedItem item) where T : class, ICanWrapData</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -809,7 +809,7 @@ <h3 id="Custom_Data_CustomItem_Child__1_System_String_ToSic_Lib_Coding_NoParamOr
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T Child&lt;T&gt;(string name, NoParamOrder protector = default, bool? required = null) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public T Child&lt;T&gt;(string name, NoParamOrder protector = default, bool? required = null) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -920,7 +920,7 @@ <h3 id="Custom_Data_CustomItem_Children__1_System_String_ToSic_Lib_Coding_NoPara
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; Children&lt;T&gt;(string field, NoParamOrder protector = default, string type = null, bool? required = null) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; Children&lt;T&gt;(string field, NoParamOrder protector = default, string type = null, bool? required = null) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -2066,7 +2066,7 @@ <h3 id="Custom_Data_CustomItem_Parent__1_ToSic_Lib_Coding_NoParamOrder_System_Nu
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T Parent&lt;T&gt;(NoParamOrder protector = default, bool? current = null, string type = null, string field = null) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public T Parent&lt;T&gt;(NoParamOrder protector = default, bool? current = null, string type = null, string field = null) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -2176,7 +2176,7 @@ <h3 id="Custom_Data_CustomItem_Parents__1_ToSic_Lib_Coding_NoParamOrder_System_S
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; Parents&lt;T&gt;(NoParamOrder protector = default, string type = null, string field = null) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; Parents&lt;T&gt;(NoParamOrder protector = default, string type = null, string field = null) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/dot-net/Custom.Hybrid.ApiTyped.html
Original file line number Diff line number Diff line change
Expand Up @@ -999,7 +999,7 @@ <h3 id="Custom_Hybrid_ApiTyped_AsList__1_System_Object_ToSic_Lib_Coding_NoParamO
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; AsList&lt;T&gt;(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, IDataModel</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; AsList&lt;T&gt;(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ICanWrapData</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -1092,7 +1092,7 @@ <h3 id="Custom_Hybrid_ApiTyped_AsStack__1_System_Object___" data-uid="Custom.Hyb
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T AsStack&lt;T&gt;(params object[] items) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public T AsStack&lt;T&gt;(params object[] items) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -1229,7 +1229,7 @@ <h3 id="Custom_Hybrid_ApiTyped_As__1_System_Object_ToSic_Lib_Coding_NoParamOrder
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T As&lt;T&gt;(object source, NoParamOrder protector = default, bool mock = false) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public T As&lt;T&gt;(object source, NoParamOrder protector = default, bool mock = false) where T : class, ICanWrapData</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/dot-net/Custom.Hybrid.CodeTyped.html
Original file line number Diff line number Diff line change
Expand Up @@ -923,7 +923,7 @@ <h3 id="Custom_Hybrid_CodeTyped_AsList__1_System_Object_ToSic_Lib_Coding_NoParam
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; AsList&lt;T&gt;(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, IDataModel</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; AsList&lt;T&gt;(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ICanWrapData</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -1016,7 +1016,7 @@ <h3 id="Custom_Hybrid_CodeTyped_AsStack__1_System_Object___" data-uid="Custom.Hy
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T AsStack&lt;T&gt;(params object[] items) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public T AsStack&lt;T&gt;(params object[] items) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -1153,7 +1153,7 @@ <h3 id="Custom_Hybrid_CodeTyped_As__1_System_Object_ToSic_Lib_Coding_NoParamOrde
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T As&lt;T&gt;(object source, NoParamOrder protector = default, bool mock = false) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public T As&lt;T&gt;(object source, NoParamOrder protector = default, bool mock = false) where T : class, ICanWrapData</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/dot-net/Custom.Hybrid.RazorTyped.html
Original file line number Diff line number Diff line change
Expand Up @@ -968,7 +968,7 @@ <h3 id="Custom_Hybrid_RazorTyped_AsList__1_System_Object_ToSic_Lib_Coding_NoPara
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; AsList&lt;T&gt;(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, IDataModel</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;T&gt; AsList&lt;T&gt;(object source, NoParamOrder protector = default, bool nullIfNull = false) where T : class, ICanWrapData</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -1061,7 +1061,7 @@ <h3 id="Custom_Hybrid_RazorTyped_AsStack__1_System_Object___" data-uid="Custom.H
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T AsStack&lt;T&gt;(params object[] items) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public T AsStack&lt;T&gt;(params object[] items) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -1198,7 +1198,7 @@ <h3 id="Custom_Hybrid_RazorTyped_As__1_System_Object_ToSic_Lib_Coding_NoParamOrd
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T As&lt;T&gt;(object source, NoParamOrder protector = default, bool mock = false) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">public T As&lt;T&gt;(object source, NoParamOrder protector = default, bool mock = false) where T : class, ICanWrapData</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/dot-net/ToSic.Sxc.Apps.IAppDataTyped.html
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ <h3 id="ToSic_Sxc_Apps_IAppDataTyped_GetAll__1_ToSic_Lib_Coding_NoParamOrder_Sys
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">IEnumerable&lt;T&gt; GetAll&lt;T&gt;(NoParamOrder protector = default, string typeName = null, bool nullIfNotFound = false) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">IEnumerable&lt;T&gt; GetAll&lt;T&gt;(NoParamOrder protector = default, string typeName = null, bool nullIfNotFound = false) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -465,7 +465,7 @@ <h3 id="ToSic_Sxc_Apps_IAppDataTyped_GetOne__1_System_Guid_ToSic_Lib_Coding_NoPa
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">T GetOne&lt;T&gt;(Guid id, NoParamOrder protector = default, bool skipTypeCheck = false) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">T GetOne&lt;T&gt;(Guid id, NoParamOrder protector = default, bool skipTypeCheck = false) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down Expand Up @@ -518,7 +518,7 @@ <h3 id="ToSic_Sxc_Apps_IAppDataTyped_GetOne__1_System_Int32_ToSic_Lib_Coding_NoP
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">T GetOne&lt;T&gt;(int id, NoParamOrder protector = default, bool skipTypeCheck = false) where T : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">T GetOne&lt;T&gt;(int id, NoParamOrder protector = default, bool skipTypeCheck = false) where T : class, ICanWrapData, new()</code></pre>
</div>

<h4 class="section">Parameters</h4>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/dot-net/ToSic.Sxc.Apps.IAppTyped-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h1 id="ToSic_Sxc_Apps_IAppTyped_2" data-uid="ToSic.Sxc.Apps.IAppTyped`2" class=

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[PublicApi]
public interface IAppTyped&lt;out TSettings, out TResources&gt; : IAppTyped, IAppIdentity, IZoneIdentity, IAppIdentityLight where TSettings : class, IDataModel, new() where TResources : class, IDataModel, new()</code></pre>
public interface IAppTyped&lt;out TSettings, out TResources&gt; : IAppTyped, IAppIdentity, IZoneIdentity, IAppIdentityLight where TSettings : class, ICanWrapData, new() where TResources : class, ICanWrapData, new()</code></pre>
</div>


Expand Down
10 changes: 5 additions & 5 deletions docs/api/dot-net/ToSic.Sxc.Code.ICodeCustomizer.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h3 id="ToSic_Sxc_Code_ICodeCustomizer_App__2" data-uid="ToSic.Sxc.Code.ICodeCus
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">IAppTyped&lt;TSettings, TResources&gt; App&lt;TSettings, TResources&gt;() where TSettings : class, IDataModel, new() where TResources : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">IAppTyped&lt;TSettings, TResources&gt; App&lt;TSettings, TResources&gt;() where TSettings : class, ICanWrapData, new() where TResources : class, ICanWrapData, new()</code></pre>
</div>


Expand Down Expand Up @@ -196,7 +196,7 @@ <h3 id="ToSic_Sxc_Code_ICodeCustomizer_MyHeader__1" data-uid="ToSic.Sxc.Code.ICo
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">TCustomType MyHeader&lt;TCustomType&gt;() where TCustomType : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">TCustomType MyHeader&lt;TCustomType&gt;() where TCustomType : class, ICanWrapData, new()</code></pre>
</div>


Expand Down Expand Up @@ -234,7 +234,7 @@ <h3 id="ToSic_Sxc_Code_ICodeCustomizer_MyItem__1" data-uid="ToSic.Sxc.Code.ICode
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">TCustomType MyItem&lt;TCustomType&gt;() where TCustomType : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">TCustomType MyItem&lt;TCustomType&gt;() where TCustomType : class, ICanWrapData, new()</code></pre>
</div>


Expand Down Expand Up @@ -272,7 +272,7 @@ <h3 id="ToSic_Sxc_Code_ICodeCustomizer_MyItems__1" data-uid="ToSic.Sxc.Code.ICod
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">IEnumerable&lt;TCustomType&gt; MyItems&lt;TCustomType&gt;() where TCustomType : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">IEnumerable&lt;TCustomType&gt; MyItems&lt;TCustomType&gt;() where TCustomType : class, ICanWrapData, new()</code></pre>
</div>


Expand Down Expand Up @@ -310,7 +310,7 @@ <h3 id="ToSic_Sxc_Code_ICodeCustomizer_MyView__2" data-uid="ToSic.Sxc.Code.ICode
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">ICmsView&lt;TSettings, TResources&gt; MyView&lt;TSettings, TResources&gt;() where TSettings : class, IDataModel, new() where TResources : class, IDataModel, new()</code></pre>
<pre><code class="lang-csharp hljs">ICmsView&lt;TSettings, TResources&gt; MyView&lt;TSettings, TResources&gt;() where TSettings : class, ICanWrapData, new() where TResources : class, ICanWrapData, new()</code></pre>
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/api/dot-net/ToSic.Sxc.Context.ICmsView-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h1 id="ToSic_Sxc_Context_ICmsView_2" data-uid="ToSic.Sxc.Context.ICmsView`2" cl

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[PublicApi]
public interface ICmsView&lt;out TSettings, out TResources&gt; : ICmsView, IHasMetadata where TSettings : class, IDataModel, new() where TResources : class, IDataModel, new()</code></pre>
public interface ICmsView&lt;out TSettings, out TResources&gt; : ICmsView, IHasMetadata where TSettings : class, ICanWrapData, new() where TResources : class, ICanWrapData, new()</code></pre>
</div>


Expand Down
Loading

0 comments on commit 7afb5c8

Please sign in to comment.