Skip to content

Commit 02e752d

Browse files
sgiffinlcdsgiffinlcd
authored
Merge pull request #26 from CodeFactoryLLC/Docs
Adding SDK documentation
2 parents 0e9ba9a + 618e42f commit 02e752d

File tree

377 files changed

+163301
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

377 files changed

+163301
-0
lines changed

‎docs/api/CodeFactory.ActionException.html‎

Lines changed: 268 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,268 @@
1+
<!DOCTYPE html>
2+
<!--[if IE]><![endif]-->
3+
<html>
4+
5+
<head>
6+
<meta charset="utf-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8+
<title>Class ActionException
9+
| CodeFactory for Windows </title>
10+
<meta name="viewport" content="width=device-width">
11+
<meta name="title" content="Class ActionException
12+
| CodeFactory for Windows ">
13+
<meta name="generator" content="docfx ">
14+
15+
<link rel="shortcut icon" href="../images/favicon.png">
16+
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" rel="stylesheet">
17+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/night-owl.min.css">
18+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.css" integrity="sha384-EvBWSlnoFgZlXJvpzS+MAUEjvN7+gcCwH+qh7GRFOGgZO0PuwOFro7qPOJnLfe7l" crossorigin="anonymous">
19+
<link rel="stylesheet" href="../styles/config.css">
20+
<link rel="stylesheet" href="../styles/discord.css">
21+
<link rel="stylesheet" href="../styles/singulink.css">
22+
<link rel="stylesheet" href="../styles/main.css">
23+
<meta property="docfx:navrel" content="../toc.html">
24+
<meta property="docfx:tocrel" content="toc.html">
25+
26+
<meta property="docfx:rel" content="../">
27+
<meta property="docfx:newtab" content="true">
28+
</head>
29+
<body>
30+
<div class="top-navbar">
31+
<a class="burger-icon" onclick="toggleMenu()">
32+
<svg name="Hamburger" style="vertical-align: middle;" width="34" height="34" viewbox="0 0 24 24"><path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M20 6H4V9H20V6ZM4 10.999H20V13.999H4V10.999ZM4 15.999H20V18.999H4V15.999Z"></path></svg>
33+
</a>
34+
35+
36+
<a class="brand" href="../index.html">
37+
<img src="../images/logo.png" alt="CodeFactory for Windows" class="logomark">
38+
<span class="brand-title">CodeFactory for Windows</span>
39+
</a> </div>
40+
41+
<div class="body-content">
42+
<div id="blackout" class="blackout" onclick="toggleMenu()"></div>
43+
44+
<nav id="sidebar" role="navigation">
45+
<div class="sidebar">
46+
47+
<div>
48+
<div class="mobile-hide">
49+
50+
<a class="brand" href="../index.html">
51+
<img src="../images/logo.png" alt="CodeFactory for Windows" class="logomark">
52+
<span class="brand-title">CodeFactory for Windows</span>
53+
</a> </div>
54+
55+
<div class="sidesearch">
56+
<form id="search" role="search" class="search">
57+
<i class="bi bi-search search-icon"></i>
58+
<input type="text" id="search-query" placeholder="Search" autocomplete="off">
59+
</form>
60+
</div>
61+
62+
<div id="navbar">
63+
</div>
64+
</div> <div class="sidebar-item-separator"></div>
65+
66+
<div id="sidetoggle">
67+
<div id="sidetoc"></div>
68+
</div>
69+
</div>
70+
<div class="footer">
71+
72+
<strong><a href='https://www.codefactory.software'>CodeFactory</a></strong>
73+
</div> </nav>
74+
75+
<main class="main-panel">
76+
77+
<div id="search-results" style="display: none;">
78+
<h1 class="search-list">Search Results for <span></span></h1>
79+
<div class="sr-items">
80+
<p><i class="bi bi-hourglass-split index-loading"></i></p>
81+
</div>
82+
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
83+
</div>
84+
85+
86+
<div role="main" class="hide-when-search">
87+
88+
<div class="subnav navbar navbar-default">
89+
<div class="container hide-when-search" id="breadcrumb">
90+
<ul class="breadcrumb">
91+
<li></li>
92+
</ul>
93+
</div>
94+
</div>
95+
96+
97+
<article class="content wrap" id="_content" data-uid="CodeFactory.ActionException">
98+
99+
100+
101+
<h1 id="CodeFactory_ActionException" data-uid="CodeFactory.ActionException" class="text-break">Class ActionException
102+
</h1>
103+
<div class="markdown level0 summary"><p>Exception that is raised when an error occurred that kept a code factory command from finishing execution.</p>
104+
</div>
105+
<div class="markdown level0 conceptual"></div>
106+
<div class="inheritance">
107+
<h5>Inheritance</h5>
108+
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
109+
<div class="level1"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></div>
110+
<div class="level2"><a class="xref" href="CodeFactory.CodeFactoryException.html">CodeFactoryException</a></div>
111+
<div class="level3"><span class="xref">ActionException</span></div>
112+
</div>
113+
<div class="implements">
114+
<h5>Implements</h5>
115+
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.iserializable">ISerializable</a></div>
116+
</div>
117+
<div class="inheritedMembers">
118+
<h5>Inherited Members</h5>
119+
<div>
120+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.getbaseexception">Exception.GetBaseException()</a>
121+
</div>
122+
<div>
123+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.getobjectdata">Exception.GetObjectData(SerializationInfo, StreamingContext)</a>
124+
</div>
125+
<div>
126+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.gettype">Exception.GetType()</a>
127+
</div>
128+
<div>
129+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.tostring">Exception.ToString()</a>
130+
</div>
131+
<div>
132+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.data">Exception.Data</a>
133+
</div>
134+
<div>
135+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.helplink">Exception.HelpLink</a>
136+
</div>
137+
<div>
138+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.hresult">Exception.HResult</a>
139+
</div>
140+
<div>
141+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.innerexception">Exception.InnerException</a>
142+
</div>
143+
<div>
144+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.message">Exception.Message</a>
145+
</div>
146+
<div>
147+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.source">Exception.Source</a>
148+
</div>
149+
<div>
150+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.stacktrace">Exception.StackTrace</a>
151+
</div>
152+
<div>
153+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.targetsite">Exception.TargetSite</a>
154+
</div>
155+
<div>
156+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.serializeobjectstate">Exception.SerializeObjectState</a>
157+
</div>
158+
<div>
159+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
160+
</div>
161+
<div>
162+
<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>
163+
</div>
164+
<div>
165+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
166+
</div>
167+
<div>
168+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
169+
</div>
170+
<div>
171+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
172+
</div>
173+
</div>
174+
<h6><strong>Namespace</strong>: <a class="xref" href="CodeFactory.html">CodeFactory</a></h6>
175+
<h6><strong>Assembly</strong>: CodeFactory.dll</h6>
176+
<h5 id="CodeFactory_ActionException_syntax">Syntax</h5>
177+
<div class="codewrapper">
178+
<pre><code class="lang-csharp hljs">public class ActionException : CodeFactoryException, ISerializable</code></pre>
179+
</div>
180+
<h3 id="constructors">Constructors
181+
</h3>
182+
<a id="CodeFactory_ActionException__ctor_" data-uid="CodeFactory.ActionException.#ctor*"></a>
183+
<h4 id="CodeFactory_ActionException__ctor_System_String_" data-uid="CodeFactory.ActionException.#ctor(System.String)">ActionException(string)</h4>
184+
<div class="markdown level1 summary"><p>Creates a command exception.</p>
185+
</div>
186+
<div class="markdown level1 conceptual"></div>
187+
<h5 class="declaration">Declaration</h5>
188+
<div class="codewrapper">
189+
<pre><code class="lang-csharp hljs">public ActionException(string message)</code></pre>
190+
</div>
191+
<h5 class="parameters">Parameters</h5>
192+
<table class="table table-bordered table-condensed">
193+
<thead>
194+
<tr>
195+
<th>Type</th>
196+
<th>Name</th>
197+
<th>Description</th>
198+
</tr>
199+
</thead>
200+
<tbody>
201+
<tr>
202+
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
203+
<td><span class="parametername">message</span></td>
204+
<td><p>The error message to be captured by the exception</p>
205+
</td>
206+
</tr>
207+
</tbody>
208+
</table>
209+
<a id="CodeFactory_ActionException__ctor_" data-uid="CodeFactory.ActionException.#ctor*"></a>
210+
<h4 id="CodeFactory_ActionException__ctor_System_String_System_Exception_" data-uid="CodeFactory.ActionException.#ctor(System.String,System.Exception)">ActionException(string, Exception)</h4>
211+
<div class="markdown level1 summary"><p>Creates a command exception.</p>
212+
</div>
213+
<div class="markdown level1 conceptual"></div>
214+
<h5 class="declaration">Declaration</h5>
215+
<div class="codewrapper">
216+
<pre><code class="lang-csharp hljs">public ActionException(string message, Exception innerException)</code></pre>
217+
</div>
218+
<h5 class="parameters">Parameters</h5>
219+
<table class="table table-bordered table-condensed">
220+
<thead>
221+
<tr>
222+
<th>Type</th>
223+
<th>Name</th>
224+
<th>Description</th>
225+
</tr>
226+
</thead>
227+
<tbody>
228+
<tr>
229+
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
230+
<td><span class="parametername">message</span></td>
231+
<td><p>The error message to be captured by the exception</p>
232+
</td>
233+
</tr>
234+
<tr>
235+
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></td>
236+
<td><span class="parametername">innerException</span></td>
237+
<td><p>The inner exception that occurred and to be added to this exception.</p>
238+
</td>
239+
</tr>
240+
</tbody>
241+
</table>
242+
<h3 id="implements">Implements</h3>
243+
<div>
244+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.iserializable">ISerializable</a>
245+
</div>
246+
247+
</article>
248+
</div>
249+
250+
<div class="copyright-footer">
251+
<span>&#169; CodeFactory, LLC. All rights reserved.</span>
252+
</div>
253+
</main>
254+
</div>
255+
256+
257+
<script src="https://code.jquery.com/jquery-3.6.3.min.js" integrity="sha256-pvPw+upLPUjgMXY0G+8O0xUf+/Im1MZjXxxgOcBQBXU=" crossorigin="anonymous"></script>
258+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script>
259+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.min.js" integrity="sha384-+sLIOodYLS7CIrQpBjl+C7nPvqq+FbNUBDunl/OZv93DB7Ln/533i8e/mZXLi/P+" crossorigin="anonymous"></script>
260+
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
261+
<script type="text/javascript" src="../styles/jquery.twbsPagination.min.js"></script>
262+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/jquery.mark.min.js"></script>
263+
<script type="text/javascript" src="../styles/url.min.js"></script>
264+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/anchor.min.js"></script>
265+
<script type="text/javascript" src="../styles/docfx.js"></script>
266+
<script type="text/javascript" src="../styles/main.js"></script>
267+
<script type="text/javascript" src="../styles/singulink.js"></script> </body>
268+
</html>

0 commit comments

Comments
 (0)