HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.ApiActionResult.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
      <title>Class ApiActionResult | HiAPI-C# 2025 </title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <meta name="title" content="Class ApiActionResult | HiAPI-C# 2025 ">
      
      <meta name="description" content="The shared outcome envelope for a web-API action: whether it succeeded and the messages it reported, in order. Returned by the project-level surface () and, on the no-active-session boundary, by the session-scoped surface ( via ). A REST / AI caller therefore reads the progress / success / error notifications inline in the HTTP response instead of only out-of-band via the SignalR sinks, and can branch on  without parsing severities.">
      <link rel="icon" href="../img/HiAPI.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:rel" content="../">
      
      
      
      <meta name="loc:inThisArticle" content="In this article">
      <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
      <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
      <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="../img/HiAPI.logo.png" 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">
              <form class="search" role="search" id="search">
                <i class="bi bi-search"></i>
                <input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
              </form>
            </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="Hi.MachiningProcs.ApiActionResult">



  <h1 id="Hi_MachiningProcs_ApiActionResult" data-uid="Hi.MachiningProcs.ApiActionResult" class="text-break">
Class ApiActionResult  
  </h1>

  <div class="facts text-secondary">
    <dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningProcs.html">MachiningProcs</a></dd></dl>
  <dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
  </div>

  <div class="markdown summary"><p>The shared outcome envelope for a web-API action: whether it succeeded and the messages
it reported, in order. Returned by the project-level surface
(<a class="xref" href="Hi.MachiningProcs.LocalProjectServiceController.html">LocalProjectServiceController</a>) and, on the no-active-session boundary, by
the session-scoped surface (<a class="xref" href="Hi.MachiningProcs.SessionShellController.html">SessionShellController</a> via
<a class="xref" href="Hi.MachiningProcs.RequireActiveSessionAttribute.html">RequireActiveSessionAttribute</a>). A REST / AI caller therefore reads the
progress / success / error notifications <i>inline in the HTTP response</i> instead of
only out-of-band via the SignalR sinks, and can branch on <a class="xref" href="Hi.MachiningProcs.ApiActionResult.html#Hi_MachiningProcs_ApiActionResult_Success">Success</a> without
parsing severities.</p>
</div>
  <div class="markdown conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public record ApiActionResult : IEquatable&lt;ApiActionResult&gt;</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">ApiActionResult</span></div>
    </dd>
  </dl>

  <dl class="typelist implements">
    <dt>Implements</dt>
    <dd>
      <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a>&lt;<a class="xref" href="Hi.MachiningProcs.ApiActionResult.html">ApiActionResult</a>&gt;</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>

  <dl class="typelist extensionMethods">
    <dt>Extension Methods</dt>
    <dd>
  <div>
      <a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
  </div>
  <div>
      <a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
  </div>
  </dd></dl>





  <h2 class="section" id="constructors">Constructors
</h2>


  <a id="Hi_MachiningProcs_ApiActionResult__ctor_" data-uid="Hi.MachiningProcs.ApiActionResult.#ctor*"></a>

  <h3 id="Hi_MachiningProcs_ApiActionResult__ctor_System_Boolean_System_Collections_Generic_IReadOnlyList_Hi_MachiningProcs_MessageDto__" data-uid="Hi.MachiningProcs.ApiActionResult.#ctor(System.Boolean,System.Collections.Generic.IReadOnlyList{Hi.MachiningProcs.MessageDto})">
  ApiActionResult(bool, IReadOnlyList&lt;MessageDto&gt;)
  
  </h3>

  <div class="markdown level1 summary"><p>The shared outcome envelope for a web-API action: whether it succeeded and the messages
it reported, in order. Returned by the project-level surface
(<a class="xref" href="Hi.MachiningProcs.LocalProjectServiceController.html">LocalProjectServiceController</a>) and, on the no-active-session boundary, by
the session-scoped surface (<a class="xref" href="Hi.MachiningProcs.SessionShellController.html">SessionShellController</a> via
<a class="xref" href="Hi.MachiningProcs.RequireActiveSessionAttribute.html">RequireActiveSessionAttribute</a>). A REST / AI caller therefore reads the
progress / success / error notifications <i>inline in the HTTP response</i> instead of
only out-of-band via the SignalR sinks, and can branch on <a class="xref" href="Hi.MachiningProcs.ApiActionResult.html#Hi_MachiningProcs_ApiActionResult_Success">Success</a> without
parsing severities.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public ApiActionResult(bool Success, IReadOnlyList&lt;MessageDto&gt; Messages)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>Success</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd><p>False when any reported message is an error; true otherwise.</p>
</dd>
    <dt><code>Messages</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a>&lt;<a class="xref" href="Hi.MachiningProcs.MessageDto.html">MessageDto</a>&gt;</dt>
    <dd><p>The messages reported during the call, in arrival order.</p>
</dd>
  </dl>












  <h2 class="section" id="properties">Properties
</h2>


  <a id="Hi_MachiningProcs_ApiActionResult_Messages_" data-uid="Hi.MachiningProcs.ApiActionResult.Messages*"></a>

  <h3 id="Hi_MachiningProcs_ApiActionResult_Messages" data-uid="Hi.MachiningProcs.ApiActionResult.Messages">
  Messages
  
  </h3>

  <div class="markdown level1 summary"><p>The messages reported during the call, in arrival order.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IReadOnlyList&lt;MessageDto&gt; Messages { get; init; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a>&lt;<a class="xref" href="Hi.MachiningProcs.MessageDto.html">MessageDto</a>&gt;</dt>
    <dd></dd>
  </dl>








  <a id="Hi_MachiningProcs_ApiActionResult_Success_" data-uid="Hi.MachiningProcs.ApiActionResult.Success*"></a>

  <h3 id="Hi_MachiningProcs_ApiActionResult_Success" data-uid="Hi.MachiningProcs.ApiActionResult.Success">
  Success
  
  </h3>

  <div class="markdown level1 summary"><p>False when any reported message is an error; true otherwise.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool Success { get; init; }</code></pre>
  </div>





  <h4 class="section">Property Value</h4>
  <dl class="parameters">
    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
    <dd></dd>
  </dl>








  <h2 class="section" id="methods">Methods
</h2>


  <a id="Hi_MachiningProcs_ApiActionResult_FromCollector_" data-uid="Hi.MachiningProcs.ApiActionResult.FromCollector*"></a>

  <h3 id="Hi_MachiningProcs_ApiActionResult_FromCollector_Hi_Common_Messages_MessageCollector_System_Nullable_System_Boolean__" data-uid="Hi.MachiningProcs.ApiActionResult.FromCollector(Hi.Common.Messages.MessageCollector,System.Nullable{System.Boolean})">
  FromCollector(MessageCollector, bool?)
  
  </h3>

  <div class="markdown level1 summary"><p>Builds a result from a per-call <a class="xref" href="Hi.Common.Messages.MessageCollector.html">MessageCollector</a>. Success is inferred as
&ldquo;no error-severity message was reported&rdquo; unless <code class="paramref">success</code> overrides it.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static ApiActionResult FromCollector(MessageCollector collector, bool? success = null)</code></pre>
  </div>

  <h4 class="section">Parameters</h4>
  <dl class="parameters">
    <dt><code>collector</code> <a class="xref" href="Hi.Common.Messages.MessageCollector.html">MessageCollector</a></dt>
    <dd><p>The per-call sink whose messages to flatten.</p>
</dd>
    <dt><code>success</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
    <dd><p>Explicit success flag, or null to infer from the messages.</p>
</dd>
  </dl>

  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Hi.MachiningProcs.ApiActionResult.html">ApiActionResult</a></dt>
    <dd><p>The outcome envelope.</p>
</dd>
  </dl>











  <a id="Hi_MachiningProcs_ApiActionResult_NoActiveSession_" data-uid="Hi.MachiningProcs.ApiActionResult.NoActiveSession*"></a>

  <h3 id="Hi_MachiningProcs_ApiActionResult_NoActiveSession" data-uid="Hi.MachiningProcs.ApiActionResult.NoActiveSession">
  NoActiveSession()
  
  </h3>

  <div class="markdown level1 summary"><p>The canonical &ldquo;no active session&rdquo; result: a single configuration error telling the
caller to start a session first. Returned (with HTTP 409) by
<a class="xref" href="Hi.MachiningProcs.RequireActiveSessionAttribute.html">RequireActiveSessionAttribute</a> when a session-scoped endpoint is invoked
outside a session.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static ApiActionResult NoActiveSession()</code></pre>
  </div>


  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Hi.MachiningProcs.ApiActionResult.html">ApiActionResult</a></dt>
    <dd><p>An unsuccessful envelope carrying the guidance message.</p>
</dd>
  </dl>











  <a id="Hi_MachiningProcs_ApiActionResult_NoProjectLoaded_" data-uid="Hi.MachiningProcs.ApiActionResult.NoProjectLoaded*"></a>

  <h3 id="Hi_MachiningProcs_ApiActionResult_NoProjectLoaded" data-uid="Hi.MachiningProcs.ApiActionResult.NoProjectLoaded">
  NoProjectLoaded()
  
  </h3>

  <div class="markdown level1 summary"><p>The canonical &ldquo;no project loaded&rdquo; result: a single configuration error telling the
caller to create or load a project first. Returned (with HTTP 409) by
<a class="xref" href="Hi.MachiningProcs.RequireLoadedProjectAttribute.html">RequireLoadedProjectAttribute</a> when a project-level endpoint is invoked
before any project is open.</p>
</div>
  <div class="markdown level1 conceptual"></div>

  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static ApiActionResult NoProjectLoaded()</code></pre>
  </div>


  <h4 class="section">Returns</h4>
  <dl class="parameters">
    <dt><a class="xref" href="Hi.MachiningProcs.ApiActionResult.html">ApiActionResult</a></dt>
    <dd><p>An unsuccessful envelope carrying the guidance message.</p>
</dd>
  </dl>












</article>

        <div class="contribution d-print-none">
        </div>


      </div>

      <div class="affix">
        <nav id="affix"></nav>
      </div>
    </main>

    <div class="container-xxl search-results" id="search-results"></div>

    <footer class="border-top text-secondary">
      <div class="container-xxl">
        <div class="flex-fill">
          <span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
        </div>
      </div>
    </footer>
  </body>
</html>