mirror of
https://github.com/RedWizardsLab/EchoHub.git
synced 2026-09-04 00:26:07 +02:00
deploy: 0c2e8eae87
This commit is contained in:
HueByte
@@ -379,6 +379,96 @@ Class CommandHandler <a class="header-action link-secondary" title="View source
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnCreateInvite" data-uid="EchoHub.Client.Commands.CommandHandler.OnCreateInvite">
|
||||
OnCreateInvite
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><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">public event Func<int?, int?, Task>? OnCreateInvite</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?, <span class="xref">Task</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnDeleteAccount" data-uid="EchoHub.Client.Commands.CommandHandler.OnDeleteAccount">
|
||||
OnDeleteAccount
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><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">public event Func<Task>? OnDeleteAccount</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<span class="xref">Task</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnExportData" data-uid="EchoHub.Client.Commands.CommandHandler.OnExportData">
|
||||
OnExportData
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><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">public event Func<Task>? OnExportData</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<span class="xref">Task</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnHelp" data-uid="EchoHub.Client.Commands.CommandHandler.OnHelp">
|
||||
OnHelp
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><i class="bi bi-code-slash"></i></a>
|
||||
@@ -499,6 +589,36 @@ Class CommandHandler <a class="header-action link-secondary" title="View source
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnListInvites" data-uid="EchoHub.Client.Commands.CommandHandler.OnListInvites">
|
||||
OnListInvites
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><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">public event Func<Task>? OnListInvites</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<span class="xref">Task</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnListUsers" data-uid="EchoHub.Client.Commands.CommandHandler.OnListUsers">
|
||||
OnListUsers
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><i class="bi bi-code-slash"></i></a>
|
||||
@@ -679,6 +799,36 @@ Class CommandHandler <a class="header-action link-secondary" title="View source
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnRevokeInvite" data-uid="EchoHub.Client.Commands.CommandHandler.OnRevokeInvite">
|
||||
OnRevokeInvite
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><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">public event Func<string, Task>? OnRevokeInvite</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <span class="xref">Task</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnRoomInfo" data-uid="EchoHub.Client.Commands.CommandHandler.OnRoomInfo">
|
||||
OnRoomInfo
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><i class="bi bi-code-slash"></i></a>
|
||||
@@ -709,6 +859,66 @@ Class CommandHandler <a class="header-action link-secondary" title="View source
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnSendAction" data-uid="EchoHub.Client.Commands.CommandHandler.OnSendAction">
|
||||
OnSendAction
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><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">public event Func<string, Task>? OnSendAction</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <span class="xref">Task</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnSendBanner" data-uid="EchoHub.Client.Commands.CommandHandler.OnSendBanner">
|
||||
OnSendBanner
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><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">public event Func<string, Task>? OnSendBanner</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <span class="xref">Task</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Commands_CommandHandler_OnSendFile" data-uid="EchoHub.Client.Commands.CommandHandler.OnSendFile">
|
||||
OnSendFile
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><i class="bi bi-code-slash"></i></a>
|
||||
@@ -894,11 +1104,14 @@ Class CommandHandler <a class="header-action link-secondary" title="View source
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Commands/CommandHandler.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Status update. A null status means "keep the current status"; a null message means
|
||||
"keep the current message" and an empty message means "clear it". The orchestrator
|
||||
resolves both against the session state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Func<UserStatus, string?, Task>? OnSetStatus</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public event Func<UserStatus?, string?, Task>? OnSetStatus</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -908,7 +1121,7 @@ Class CommandHandler <a class="header-action link-secondary" title="View source
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><<a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/UserStatus.cs">UserStatus</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <span class="xref">Task</span>></dt>
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><<a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/UserStatus.cs">UserStatus</a>?, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <span class="xref">Task</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -409,6 +409,44 @@ Class ApiClient <a class="header-action link-secondary" title="View source" hre
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_CreateInviteAsync_" data-uid="EchoHub.Client.Services.ApiClient.CreateInviteAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_CreateInviteAsync_System_Nullable_System_Int32__System_Nullable_System_Int32__" data-uid="EchoHub.Client.Services.ApiClient.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
||||
CreateInviteAsync(int?, int?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><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">public Task<InviteDto?> CreateInviteAsync(int? maxUses = null, int? expiresInHours = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>maxUses</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
<dt><code>expiresInHours</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs">InviteDto</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_DeleteChannelAsync_" data-uid="EchoHub.Client.Services.ApiClient.DeleteChannelAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_DeleteChannelAsync_System_String_" data-uid="EchoHub.Client.Services.ApiClient.DeleteChannelAsync(System.String)">
|
||||
@@ -481,6 +519,43 @@ Class ApiClient <a class="header-action link-secondary" title="View source" hre
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_DeleteMyAccountAsync_" data-uid="EchoHub.Client.Services.ApiClient.DeleteMyAccountAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_DeleteMyAccountAsync_System_String_" data-uid="EchoHub.Client.Services.ApiClient.DeleteMyAccountAsync(System.String)">
|
||||
DeleteMyAccountAsync(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Deletes the caller's account. The password re-confirms intent.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task DeleteMyAccountAsync(string password)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_Dispose_" data-uid="EchoHub.Client.Services.ApiClient.Dispose*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_Dispose" data-uid="EchoHub.Client.Services.ApiClient.Dispose">
|
||||
@@ -545,6 +620,38 @@ Class ApiClient <a class="header-action link-secondary" title="View source" hre
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_ExportMyDataAsync_" data-uid="EchoHub.Client.Services.ApiClient.ExportMyDataAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_ExportMyDataAsync" data-uid="EchoHub.Client.Services.ApiClient.ExportMyDataAsync">
|
||||
ExportMyDataAsync()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Downloads the caller's full data export as raw JSON text.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task<string> ExportMyDataAsync()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_GetChannelCryptoAsync_" data-uid="EchoHub.Client.Services.ApiClient.GetChannelCryptoAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_GetChannelCryptoAsync_System_String_" data-uid="EchoHub.Client.Services.ApiClient.GetChannelCryptoAsync(System.String)">
|
||||
@@ -683,6 +790,37 @@ size, created date, room id) for the <code>/meta</code> command. Returns null if
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_GetInvitesAsync_" data-uid="EchoHub.Client.Services.ApiClient.GetInvitesAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_GetInvitesAsync" data-uid="EchoHub.Client.Services.ApiClient.GetInvitesAsync">
|
||||
GetInvitesAsync()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><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">public Task<List<InviteDto>> GetInvitesAsync()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<span class="xref">List</span><<a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs">InviteDto</a>>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_GetServerInfoAsync_" data-uid="EchoHub.Client.Services.ApiClient.GetServerInfoAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_GetServerInfoAsync" data-uid="EchoHub.Client.Services.ApiClient.GetServerInfoAsync">
|
||||
@@ -1035,8 +1173,8 @@ Used by EchoHubConnection for SignalR token provider.</p>
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_RegisterAsync_" data-uid="EchoHub.Client.Services.ApiClient.RegisterAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_RegisterAsync_System_String_System_String_System_String_" data-uid="EchoHub.Client.Services.ApiClient.RegisterAsync(System.String,System.String,System.String)">
|
||||
RegisterAsync(string, string, string?)
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_RegisterAsync_System_String_System_String_System_String_System_String_" data-uid="EchoHub.Client.Services.ApiClient.RegisterAsync(System.String,System.String,System.String,System.String)">
|
||||
RegisterAsync(string, string, string?, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -1044,7 +1182,7 @@ Used by EchoHubConnection for SignalR token provider.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task<LoginResponse> RegisterAsync(string username, string password, string? displayName = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Task<LoginResponse> RegisterAsync(string username, string password, string? displayName = null, string? inviteCode = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -1055,6 +1193,8 @@ Used by EchoHubConnection for SignalR token provider.</p>
|
||||
<dd></dd>
|
||||
<dt><code>displayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>inviteCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
@@ -1111,6 +1251,42 @@ Used by EchoHubConnection for SignalR token provider.</p>
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_RevokeInviteAsync_" data-uid="EchoHub.Client.Services.ApiClient.RevokeInviteAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_RevokeInviteAsync_System_String_" data-uid="EchoHub.Client.Services.ApiClient.RevokeInviteAsync(System.String)">
|
||||
RevokeInviteAsync(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/ApiClient.cs"><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">public Task RevokeInviteAsync(string code)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>code</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_Services_ApiClient_SendMessageWithAttachmentsAsync_" data-uid="EchoHub.Client.Services.ApiClient.SendMessageWithAttachmentsAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_ApiClient_SendMessageWithAttachmentsAsync_System_String_System_String_System_Collections_Generic_IReadOnlyList_EchoHub_Client_Services_OutgoingAttachment__System_String_" data-uid="EchoHub.Client.Services.ApiClient.SendMessageWithAttachmentsAsync(System.String,System.String,System.Collections.Generic.IReadOnlyList{EchoHub.Client.Services.OutgoingAttachment},System.String)">
|
||||
|
||||
@@ -510,8 +510,8 @@ Class EchoHubConnection <a class="header-action link-secondary" title="View sou
|
||||
|
||||
<a id="EchoHub_Client_Services_EchoHubConnection_SendMessageAsync_" data-uid="EchoHub.Client.Services.EchoHubConnection.SendMessageAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_Services_EchoHubConnection_SendMessageAsync_System_String_System_String_" data-uid="EchoHub.Client.Services.EchoHubConnection.SendMessageAsync(System.String,System.String)">
|
||||
SendMessageAsync(string, string)
|
||||
<h3 id="EchoHub_Client_Services_EchoHubConnection_SendMessageAsync_System_String_System_String_System_Nullable_System_Guid__" data-uid="EchoHub.Client.Services.EchoHubConnection.SendMessageAsync(System.String,System.String,System.Nullable{System.Guid})">
|
||||
SendMessageAsync(string, string, Guid?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/EchoHubConnection.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -519,7 +519,7 @@ Class EchoHubConnection <a class="header-action link-secondary" title="View sou
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task SendMessageAsync(string channelName, string content)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Task SendMessageAsync(string channelName, string content, Guid? replyToMessageId = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -528,6 +528,8 @@ Class EchoHubConnection <a class="header-action link-secondary" title="View sou
|
||||
<dd></dd>
|
||||
<dt><code>content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>replyToMessageId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
@@ -589,6 +591,36 @@ Class EchoHubConnection <a class="header-action link-secondary" title="View sou
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Services_EchoHubConnection_OnChannelDeleted" data-uid="EchoHub.Client.Services.EchoHubConnection.OnChannelDeleted">
|
||||
OnChannelDeleted
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/EchoHubConnection.cs"><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">public event Action<string>? OnChannelDeleted</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_Services_EchoHubConnection_OnChannelNuked" data-uid="EchoHub.Client.Services.EchoHubConnection.OnChannelNuked">
|
||||
OnChannelNuked
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/Services/EchoHubConnection.cs"><i class="bi bi-code-slash"></i></a>
|
||||
|
||||
@@ -0,0 +1,154 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Enum AttachmentAction | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Enum AttachmentAction | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="An action a click on an attachment line can trigger.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Client_UI_Chat_AttachmentAction.md&value=---%0Auid%3A%20EchoHub.Client.UI.Chat.AttachmentAction%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Client.UI.Chat.AttachmentAction">
|
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Client_UI_Chat_AttachmentAction" data-uid="EchoHub.Client.UI.Chat.AttachmentAction" class="text-break">
|
||||
Enum AttachmentAction <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Client.html">Client</a>.<a class="xref" href="EchoHub.Client.UI.html">UI</a>.<a class="xref" href="EchoHub.Client.UI.Chat.html">Chat</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Client.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>An action a click on an attachment line can trigger.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum AttachmentAction</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="fields">Fields
|
||||
</h2>
|
||||
<dl class="parameters">
|
||||
<dt id="EchoHub_Client_UI_Chat_AttachmentAction_OpenImage"><code>OpenImage = 0</code></dt>
|
||||
|
||||
<dd></dd>
|
||||
<dt id="EchoHub_Client_UI_Chat_AttachmentAction_SaveImage"><code>SaveImage = 1</code></dt>
|
||||
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,554 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Struct AttachmentActionSpan | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Struct AttachmentActionSpan | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Inclusive column range on a chat line that triggers an attachment action when clicked.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Client_UI_Chat_AttachmentActionSpan.md&value=---%0Auid%3A%20EchoHub.Client.UI.Chat.AttachmentActionSpan%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Client.UI.Chat.AttachmentActionSpan">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Client_UI_Chat_AttachmentActionSpan" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan" class="text-break">
|
||||
Struct AttachmentActionSpan <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Client.html">Client</a>.<a class="xref" href="EchoHub.Client.UI.html">UI</a>.<a class="xref" href="EchoHub.Client.UI.Chat.html">Chat</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Client.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Inclusive column range on a chat line that triggers an attachment action when clicked.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public readonly struct AttachmentActionSpan : IEquatable<AttachmentActionSpan></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="EchoHub.Client.UI.Chat.AttachmentActionSpan.html">AttachmentActionSpan</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.gettype">object.GetType()</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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan__ctor_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan__ctor_System_Int32_System_Int32_EchoHub_Client_UI_Chat_AttachmentAction_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.#ctor(System.Int32,System.Int32,EchoHub.Client.UI.Chat.AttachmentAction)">
|
||||
AttachmentActionSpan(int, int, AttachmentAction)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Inclusive column range on a chat line that triggers an attachment action when clicked.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public AttachmentActionSpan(int StartCol, int EndCol, AttachmentAction Action)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>StartCol</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>EndCol</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Action</code> <a class="xref" href="EchoHub.Client.UI.Chat.AttachmentAction.html">AttachmentAction</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_Action_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.Action*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_Action" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.Action">
|
||||
Action
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public AttachmentAction Action { get; init; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Client.UI.Chat.AttachmentAction.html">AttachmentAction</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_EndCol_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.EndCol*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_EndCol" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.EndCol">
|
||||
EndCol
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public int EndCol { 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.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_StartCol_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.StartCol*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_StartCol" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.StartCol">
|
||||
StartCol
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public int StartCol { 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.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_Deconstruct_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_Deconstruct_System_Int32__System_Int32__EchoHub_Client_UI_Chat_AttachmentAction__" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.Deconstruct(System.Int32@,System.Int32@,EchoHub.Client.UI.Chat.AttachmentAction@)">
|
||||
Deconstruct(out int, out int, out AttachmentAction)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public void Deconstruct(out int StartCol, out int EndCol, out AttachmentAction Action)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>StartCol</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>EndCol</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Action</code> <a class="xref" href="EchoHub.Client.UI.Chat.AttachmentAction.html">AttachmentAction</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_Equals_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_Equals_EchoHub_Client_UI_Chat_AttachmentActionSpan_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.Equals(EchoHub.Client.UI.Chat.AttachmentActionSpan)">
|
||||
Equals(AttachmentActionSpan)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public bool Equals(AttachmentActionSpan other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Client.UI.Chat.AttachmentActionSpan.html">AttachmentActionSpan</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_Equals_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_Equals_System_Object_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.Equals(System.Object)">
|
||||
Equals(object)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public override bool Equals(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_GetHashCode_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_GetHashCode" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_ToString_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_ToString" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_op_Equality_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_op_Equality_EchoHub_Client_UI_Chat_AttachmentActionSpan_EchoHub_Client_UI_Chat_AttachmentActionSpan_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.op_Equality(EchoHub.Client.UI.Chat.AttachmentActionSpan,EchoHub.Client.UI.Chat.AttachmentActionSpan)">
|
||||
operator ==(AttachmentActionSpan, AttachmentActionSpan)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public static bool operator ==(AttachmentActionSpan left, AttachmentActionSpan right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Client.UI.Chat.AttachmentActionSpan.html">AttachmentActionSpan</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Client.UI.Chat.AttachmentActionSpan.html">AttachmentActionSpan</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_AttachmentActionSpan_op_Inequality_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_AttachmentActionSpan_op_Inequality_EchoHub_Client_UI_Chat_AttachmentActionSpan_EchoHub_Client_UI_Chat_AttachmentActionSpan_" data-uid="EchoHub.Client.UI.Chat.AttachmentActionSpan.op_Inequality(EchoHub.Client.UI.Chat.AttachmentActionSpan,EchoHub.Client.UI.Chat.AttachmentActionSpan)">
|
||||
operator !=(AttachmentActionSpan, AttachmentActionSpan)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><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">public static bool operator !=(AttachmentActionSpan left, AttachmentActionSpan right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Client.UI.Chat.AttachmentActionSpan.html">AttachmentActionSpan</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Client.UI.Chat.AttachmentActionSpan.html">AttachmentActionSpan</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -216,6 +216,40 @@ Class ChatLine <a class="header-action link-secondary" title="View source" href
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_ChatLine_ActionSpans_" data-uid="EchoHub.Client.UI.Chat.ChatLine.ActionSpans*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_ChatLine_ActionSpans" data-uid="EchoHub.Client.UI.Chat.ChatLine.ActionSpans">
|
||||
ActionSpans
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Clickable sub-line targets (e.g. the "[open]" and "[save original]" brackets under an
|
||||
image). Columns are relative to the unwrapped line, so only the first wrapped line
|
||||
keeps them. Null means the whole line uses the kind's default action.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public List<AttachmentActionSpan>? ActionSpans { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">List</span><<a class="xref" href="EchoHub.Client.UI.Chat.AttachmentActionSpan.html">AttachmentActionSpan</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_ChatLine_AttachmentFileName_" data-uid="EchoHub.Client.UI.Chat.ChatLine.AttachmentFileName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_ChatLine_AttachmentFileName" data-uid="EchoHub.Client.UI.Chat.ChatLine.AttachmentFileName">
|
||||
@@ -438,6 +472,39 @@ precedence over <a class="xref" href="EchoHub.Client.UI.Chat.ChatLine.html#EchoH
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_ChatLine_JumpToMessageId_" data-uid="EchoHub.Client.UI.Chat.ChatLine.JumpToMessageId*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_ChatLine_JumpToMessageId" data-uid="EchoHub.Client.UI.Chat.ChatLine.JumpToMessageId">
|
||||
JumpToMessageId
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Chat/ChatLine.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Set on a reply's quote line: activating the line jumps to this message
|
||||
if it is in the loaded history.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Guid? JumpToMessageId { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Chat_ChatLine_MessageId_" data-uid="EchoHub.Client.UI.Chat.ChatLine.MessageId*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Chat_ChatLine_MessageId" data-uid="EchoHub.Client.UI.Chat.ChatLine.MessageId">
|
||||
|
||||
@@ -121,6 +121,22 @@ so the UI layer can refresh.</p>
|
||||
<dd><p>A colored text segment within a chat line.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="structs">
|
||||
Structs
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Client.UI.Chat.AttachmentActionSpan.html">AttachmentActionSpan</a></dt>
|
||||
<dd><p>Inclusive column range on a chat line that triggers an attachment action when clicked.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="enums">
|
||||
Enums
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Client.UI.Chat.AttachmentAction.html">AttachmentAction</a></dt>
|
||||
<dd><p>An action a click on an attachment line can trigger.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
@@ -183,8 +183,8 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
|
||||
|
||||
<a id="EchoHub_Client_UI_Dialogs_ConnectDialogResult__ctor_" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Dialogs_ConnectDialogResult__ctor_System_String_System_String_System_String_System_Boolean_System_Boolean_System_String_" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.#ctor(System.String,System.String,System.String,System.Boolean,System.Boolean,System.String)">
|
||||
ConnectDialogResult(string, string, string, bool, bool, string?)
|
||||
<h3 id="EchoHub_Client_UI_Dialogs_ConnectDialogResult__ctor_System_String_System_String_System_String_System_Boolean_System_Boolean_System_String_System_String_System_String_" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.#ctor(System.String,System.String,System.String,System.Boolean,System.Boolean,System.String,System.String,System.String)">
|
||||
ConnectDialogResult(string, string, string, bool, bool, string?, string?, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Dialogs/ConnectDialog.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -193,7 +193,7 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConnectDialogResult(string ServerUrl, string Username, string Password, bool IsRegister, bool RememberMe, string? SavedRefreshToken)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ConnectDialogResult(string ServerUrl, string Username, string Password, bool IsRegister, bool RememberMe, string? SavedRefreshToken, string? DisplayName = null, string? InviteCode = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -210,6 +210,10 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
|
||||
<dd></dd>
|
||||
<dt><code>SavedRefreshToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>DisplayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>InviteCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -227,6 +231,37 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_DisplayName_" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.DisplayName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_DisplayName" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.DisplayName">
|
||||
DisplayName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Dialogs/ConnectDialog.cs"><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">public string? DisplayName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_EqualityContract_" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_EqualityContract" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.EqualityContract">
|
||||
@@ -258,6 +293,37 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_InviteCode_" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.InviteCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_InviteCode" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.InviteCode">
|
||||
InviteCode
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Dialogs/ConnectDialog.cs"><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">public string? InviteCode { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_IsRegister_" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.IsRegister*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_IsRegister" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.IsRegister">
|
||||
@@ -450,8 +516,8 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
|
||||
|
||||
<a id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_Deconstruct_" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_Deconstruct_System_String__System_String__System_String__System_Boolean__System_Boolean__System_String__" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.Deconstruct(System.String@,System.String@,System.String@,System.Boolean@,System.Boolean@,System.String@)">
|
||||
Deconstruct(out string, out string, out string, out bool, out bool, out string?)
|
||||
<h3 id="EchoHub_Client_UI_Dialogs_ConnectDialogResult_Deconstruct_System_String__System_String__System_String__System_Boolean__System_Boolean__System_String__System_String__System_String__" data-uid="EchoHub.Client.UI.Dialogs.ConnectDialogResult.Deconstruct(System.String@,System.String@,System.String@,System.Boolean@,System.Boolean@,System.String@,System.String@,System.String@)">
|
||||
Deconstruct(out string, out string, out string, out bool, out bool, out string?, out string?, out string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/Dialogs/ConnectDialog.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -459,7 +525,7 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out string ServerUrl, out string Username, out string Password, out bool IsRegister, out bool RememberMe, out string? SavedRefreshToken)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out string ServerUrl, out string Username, out string Password, out bool IsRegister, out bool RememberMe, out string? SavedRefreshToken, out string? DisplayName, out string? InviteCode)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -476,6 +542,10 @@ Class ConnectDialogResult <a class="header-action link-secondary" title="View s
|
||||
<dd></dd>
|
||||
<dt><code>SavedRefreshToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>DisplayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>InviteCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -459,8 +459,8 @@ Active channel gets a > indicator, unread channels are bright with a count ba
|
||||
|
||||
<a id="EchoHub_Client_UI_ListSources_ChannelListSource_Update_" data-uid="EchoHub.Client.UI.ListSources.ChannelListSource.Update*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_ListSources_ChannelListSource_Update_System_Collections_Generic_List_System_String__System_Collections_Generic_Dictionary_System_String_System_Int32__System_String_System_Collections_Generic_IReadOnlySet_System_String__System_Collections_Generic_IReadOnlySet_System_String__System_Collections_Generic_IReadOnlySet_System_String__" data-uid="EchoHub.Client.UI.ListSources.ChannelListSource.Update(System.Collections.Generic.List{System.String},System.Collections.Generic.Dictionary{System.String,System.Int32},System.String,System.Collections.Generic.IReadOnlySet{System.String},System.Collections.Generic.IReadOnlySet{System.String},System.Collections.Generic.IReadOnlySet{System.String})">
|
||||
Update(List<string>, Dictionary<string, int>, string, IReadOnlySet<string>?, IReadOnlySet<string>?, IReadOnlySet<string>?)
|
||||
<h3 id="EchoHub_Client_UI_ListSources_ChannelListSource_Update_System_Collections_Generic_List_System_String__System_Collections_Generic_Dictionary_System_String_System_Int32__System_String_System_Collections_Generic_IReadOnlySet_System_String__System_Collections_Generic_IReadOnlySet_System_String__System_Collections_Generic_IReadOnlySet_System_String__System_Collections_Generic_IReadOnlySet_System_String__" data-uid="EchoHub.Client.UI.ListSources.ChannelListSource.Update(System.Collections.Generic.List{System.String},System.Collections.Generic.Dictionary{System.String,System.Int32},System.String,System.Collections.Generic.IReadOnlySet{System.String},System.Collections.Generic.IReadOnlySet{System.String},System.Collections.Generic.IReadOnlySet{System.String},System.Collections.Generic.IReadOnlySet{System.String})">
|
||||
Update(List<string>, Dictionary<string, int>, string, IReadOnlySet<string>?, IReadOnlySet<string>?, IReadOnlySet<string>?, IReadOnlySet<string>?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/ListSources/ChannelListSource.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -468,7 +468,7 @@ Active channel gets a > indicator, unread channels are bright with a count ba
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Update(List<string> channels, Dictionary<string, int> unread, string activeChannel, IReadOnlySet<string>? protectedChannels = null, IReadOnlySet<string>? mentionChannels = null, IReadOnlySet<string>? privateChannels = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void Update(List<string> channels, Dictionary<string, int> unread, string activeChannel, IReadOnlySet<string>? protectedChannels = null, IReadOnlySet<string>? mentionChannels = null, IReadOnlySet<string>? privateChannels = null, IReadOnlySet<string>? systemChannels = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -485,6 +485,8 @@ Active channel gets a > indicator, unread channels are bright with a count ba
|
||||
<dd></dd>
|
||||
<dt><code>privateChannels</code> <span class="xref">IReadOnlySet</span><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>systemChannels</code> <span class="xref">IReadOnlySet</span><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -882,6 +882,37 @@ Class MainWindow <a class="header-action link-secondary" title="View source" hr
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_MainWindow_HasPendingReplyIndicator_" data-uid="EchoHub.Client.UI.MainWindow.HasPendingReplyIndicator*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_HasPendingReplyIndicator" data-uid="EchoHub.Client.UI.MainWindow.HasPendingReplyIndicator">
|
||||
HasPendingReplyIndicator
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/MainWindow.cs"><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">public bool HasPendingReplyIndicator { get; }</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>
|
||||
|
||||
@@ -943,8 +974,8 @@ Call after theme changes to refresh colors.</p>
|
||||
|
||||
<a id="EchoHub_Client_UI_MainWindow_EnsureChannelInList_" data-uid="EchoHub.Client.UI.MainWindow.EnsureChannelInList*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_EnsureChannelInList_System_String_System_Nullable_System_Boolean__System_Nullable_System_Boolean__" data-uid="EchoHub.Client.UI.MainWindow.EnsureChannelInList(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
||||
EnsureChannelInList(string, bool?, bool?)
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_EnsureChannelInList_System_String_System_Nullable_System_Boolean__System_Nullable_System_Boolean__System_Nullable_System_Boolean__" data-uid="EchoHub.Client.UI.MainWindow.EnsureChannelInList(System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
||||
EnsureChannelInList(string, bool?, bool?, bool?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/MainWindow.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -953,7 +984,7 @@ Call after theme changes to refresh colors.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void EnsureChannelInList(string channelName, bool? isPublic = null, bool? isProtected = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void EnsureChannelInList(string channelName, bool? isPublic = null, bool? isProtected = null, bool? isSystem = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -964,6 +995,8 @@ Call after theme changes to refresh colors.</p>
|
||||
<dd></dd>
|
||||
<dt><code>isProtected</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
|
||||
<dd></dd>
|
||||
<dt><code>isSystem</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -1193,6 +1226,38 @@ Call after theme changes to refresh colors.</p>
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_MainWindow_SetReplyingTo_" data-uid="EchoHub.Client.UI.MainWindow.SetReplyingTo*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_SetReplyingTo_System_String_" data-uid="EchoHub.Client.UI.MainWindow.SetReplyingTo(System.String)">
|
||||
SetReplyingTo(string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/MainWindow.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Shows/clears the "replying to" strip on the input frame's title. Pass null to clear.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetReplyingTo(string? label)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>label</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Client_UI_MainWindow_SetStagedAttachments_" data-uid="EchoHub.Client.UI.MainWindow.SetStagedAttachments*"></a>
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_SetStagedAttachments_System_Collections_Generic_IReadOnlyList_System_String__System_String_" data-uid="EchoHub.Client.UI.MainWindow.SetStagedAttachments(System.Collections.Generic.IReadOnlyList{System.String},System.String)">
|
||||
@@ -1730,6 +1795,38 @@ Parameters: channel name, absolute paths of existing files.</p>
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_OnImageOpenRequested" data-uid="EchoHub.Client.UI.MainWindow.OnImageOpenRequested">
|
||||
OnImageOpenRequested
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/MainWindow.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Fired when the user activates an image's "[open]" action to view it without saving.
|
||||
Parameters: attachmentUrl, fileName.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action<string, string>? OnImageOpenRequested</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-2">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_OnImagePasted" data-uid="EchoHub.Client.UI.MainWindow.OnImagePasted">
|
||||
OnImagePasted
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/MainWindow.cs"><i class="bi bi-code-slash"></i></a>
|
||||
@@ -1917,6 +2014,69 @@ screenshot tool). Parameters: channel name, PNG-encoded image bytes.</p>
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_OnReplyCancelRequested" data-uid="EchoHub.Client.UI.MainWindow.OnReplyCancelRequested">
|
||||
OnReplyCancelRequested
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/MainWindow.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Fired when the user cancels a pending reply (Esc in the input field).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action? OnReplyCancelRequested</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_OnReplyRequested" data-uid="EchoHub.Client.UI.MainWindow.OnReplyRequested">
|
||||
OnReplyRequested
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/MainWindow.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Fired when the user picks "Reply" on a message. Parameters: message id, sender username,
|
||||
a short plain-text snippet for the reply strip.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public event Action<Guid, string, string>? OnReplyRequested</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Event Type</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-3">Action</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Client_UI_MainWindow_OnRollbackRequested" data-uid="EchoHub.Client.UI.MainWindow.OnRollbackRequested">
|
||||
OnRollbackRequested
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Client/UI/MainWindow.cs"><i class="bi bi-code-slash"></i></a>
|
||||
|
||||
@@ -0,0 +1,322 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class MessageConventions | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class MessageConventions | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Cross-protocol message conventions. Action messages (/me) use the IRC CTCP ACTION wire format 0x01 + &quot;ACTION &quot; + text + 0x01 as the stored content, so IRC clients interoperate natively (irssi's /me arrives in exactly this shape) and the TUI renders &quot;* nick text&quot;. In end-to-end encrypted rooms the marker encrypts along with the text.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_Constants_MessageConventions.md&value=---%0Auid%3A%20EchoHub.Core.Constants.MessageConventions%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.Constants.MessageConventions">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_Constants_MessageConventions" data-uid="EchoHub.Core.Constants.MessageConventions" class="text-break">
|
||||
Class MessageConventions <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Constants/MessageConventions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.Constants.html">Constants</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Cross-protocol message conventions. Action messages (<code>/me</code>) use the IRC CTCP ACTION
|
||||
wire format 0x01 + "ACTION " + text + 0x01 as the stored content, so IRC clients
|
||||
interoperate natively (irssi's /me arrives in exactly this shape) and the TUI renders
|
||||
"* nick text". In end-to-end encrypted rooms the marker encrypts along with the text.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class MessageConventions</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">MessageConventions</span></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.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.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Core_Constants_MessageConventions_ActionPrefix" data-uid="EchoHub.Core.Constants.MessageConventions.ActionPrefix">
|
||||
ActionPrefix
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Constants/MessageConventions.cs"><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">public const string ActionPrefix = "\u0001ACTION "</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Core_Constants_MessageConventions_ActionSuffix" data-uid="EchoHub.Core.Constants.MessageConventions.ActionSuffix">
|
||||
ActionSuffix
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Constants/MessageConventions.cs"><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">public const string ActionSuffix = "\u0001"</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Constants_MessageConventions_FormatAction_" data-uid="EchoHub.Core.Constants.MessageConventions.FormatAction*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Constants_MessageConventions_FormatAction_System_String_" data-uid="EchoHub.Core.Constants.MessageConventions.FormatAction(System.String)">
|
||||
FormatAction(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Constants/MessageConventions.cs"><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">public static string FormatAction(string text)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Constants_MessageConventions_TryParseAction_" data-uid="EchoHub.Core.Constants.MessageConventions.TryParseAction*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Constants_MessageConventions_TryParseAction_System_String_System_String__" data-uid="EchoHub.Core.Constants.MessageConventions.TryParseAction(System.String,System.String@)">
|
||||
TryParseAction(string, out string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Constants/MessageConventions.cs"><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">public static bool TryParseAction(string content, out string? actionText)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>actionText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Core/Constants/MessageConventions.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -98,6 +98,14 @@ Classes
|
||||
<dt><a class="xref" href="EchoHub.Core.Constants.HubConstants.html">HubConstants</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.Constants.MessageConventions.html">MessageConventions</a></dt>
|
||||
<dd><p>Cross-protocol message conventions. Action messages (<code>/me</code>) use the IRC CTCP ACTION
|
||||
wire format 0x01 + "ACTION " + text + 0x01 as the stored content, so IRC clients
|
||||
interoperate natively (irssi's /me arrives in exactly this shape) and the TUI renders
|
||||
"* nick text". In end-to-end encrypted rooms the marker encrypts along with the text.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.Constants.ValidationConstants.html">ValidationConstants</a></dt>
|
||||
<dd></dd>
|
||||
|
||||
@@ -246,6 +246,44 @@ Interface IChannelService <a class="header-action link-secondary" title="View s
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IChannelService_EnsureSystemChannelAsync_" data-uid="EchoHub.Core.Contracts.IChannelService.EnsureSystemChannelAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IChannelService_EnsureSystemChannelAsync_System_String_System_String_" data-uid="EchoHub.Core.Contracts.IChannelService.EnsureSystemChannelAsync(System.String,System.String)">
|
||||
EnsureSystemChannelAsync(string, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Contracts/IChannelService.cs"><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">Task<ChannelDto> EnsureSystemChannelAsync(string channelName, string? topic = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>topic</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<a class="xref" href="EchoHub.Core.DTOs.ChannelDto.html">ChannelDto</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IChannelService_GetChannelByNameAsync_" data-uid="EchoHub.Core.Contracts.IChannelService.GetChannelByNameAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IChannelService_GetChannelByNameAsync_System_String_" data-uid="EchoHub.Core.Contracts.IChannelService.GetChannelByNameAsync(System.String)">
|
||||
|
||||
@@ -158,6 +158,42 @@ Interface IChatBroadcaster <a class="header-action link-secondary" title="View
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IChatBroadcaster_SendChannelDeletedAsync_" data-uid="EchoHub.Core.Contracts.IChatBroadcaster.SendChannelDeletedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IChatBroadcaster_SendChannelDeletedAsync_System_String_" data-uid="EchoHub.Core.Contracts.IChatBroadcaster.SendChannelDeletedAsync(System.String)">
|
||||
SendChannelDeletedAsync(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Contracts/IChatBroadcaster.cs"><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">Task SendChannelDeletedAsync(string channelName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IChatBroadcaster_SendChannelNukedAsync_" data-uid="EchoHub.Core.Contracts.IChatBroadcaster.SendChannelNukedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IChatBroadcaster_SendChannelNukedAsync_System_String_" data-uid="EchoHub.Core.Contracts.IChatBroadcaster.SendChannelNukedAsync(System.String)">
|
||||
@@ -310,16 +346,21 @@ Interface IChatBroadcaster <a class="header-action link-secondary" title="View
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IChatBroadcaster_SendMessageToChannelAsync_" data-uid="EchoHub.Core.Contracts.IChatBroadcaster.SendMessageToChannelAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IChatBroadcaster_SendMessageToChannelAsync_System_String_EchoHub_Core_DTOs_MessageDto_" data-uid="EchoHub.Core.Contracts.IChatBroadcaster.SendMessageToChannelAsync(System.String,EchoHub.Core.DTOs.MessageDto)">
|
||||
SendMessageToChannelAsync(string, MessageDto)
|
||||
<h3 id="EchoHub_Core_Contracts_IChatBroadcaster_SendMessageToChannelAsync_System_String_EchoHub_Core_DTOs_MessageDto_System_String_" data-uid="EchoHub.Core.Contracts.IChatBroadcaster.SendMessageToChannelAsync(System.String,EchoHub.Core.DTOs.MessageDto,System.String)">
|
||||
SendMessageToChannelAsync(string, MessageDto, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Contracts/IChatBroadcaster.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Broadcast a chat message to a channel. <code class="paramref">excludeConnectionId</code> is the
|
||||
connection the message originated from (IRC convention: never echo a message back to
|
||||
the connection that sent it — its client already displayed it locally). Other
|
||||
connections of the same user (e.g. an IRC session alongside a TUI session) still
|
||||
receive the message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">Task SendMessageToChannelAsync(string channelName, MessageDto message)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">Task SendMessageToChannelAsync(string channelName, MessageDto message, string? excludeConnectionId = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -328,6 +369,8 @@ Interface IChatBroadcaster <a class="header-action link-secondary" title="View
|
||||
<dd></dd>
|
||||
<dt><code>message</code> <a class="xref" href="EchoHub.Core.DTOs.MessageDto.html">MessageDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>excludeConnectionId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -120,6 +120,42 @@ Interface IChatService <a class="header-action link-secondary" title="View sour
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IChatService_BroadcastChannelDeletedAsync_" data-uid="EchoHub.Core.Contracts.IChatService.BroadcastChannelDeletedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IChatService_BroadcastChannelDeletedAsync_System_String_" data-uid="EchoHub.Core.Contracts.IChatService.BroadcastChannelDeletedAsync(System.String)">
|
||||
BroadcastChannelDeletedAsync(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Contracts/IChatService.cs"><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">Task BroadcastChannelDeletedAsync(string channelName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IChatService_BroadcastChannelUpdatedAsync_" data-uid="EchoHub.Core.Contracts.IChatService.BroadcastChannelUpdatedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IChatService_BroadcastChannelUpdatedAsync_EchoHub_Core_DTOs_ChannelDto_System_String_" data-uid="EchoHub.Core.Contracts.IChatService.BroadcastChannelUpdatedAsync(EchoHub.Core.DTOs.ChannelDto,System.String)">
|
||||
@@ -394,8 +430,8 @@ Interface IChatService <a class="header-action link-secondary" title="View sour
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IChatService_SendMessageAsync_" data-uid="EchoHub.Core.Contracts.IChatService.SendMessageAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IChatService_SendMessageAsync_System_Guid_System_String_System_String_System_String_" data-uid="EchoHub.Core.Contracts.IChatService.SendMessageAsync(System.Guid,System.String,System.String,System.String)">
|
||||
SendMessageAsync(Guid, string, string, string)
|
||||
<h3 id="EchoHub_Core_Contracts_IChatService_SendMessageAsync_System_Guid_System_String_System_String_System_String_System_String_System_Nullable_System_Guid__" data-uid="EchoHub.Core.Contracts.IChatService.SendMessageAsync(System.Guid,System.String,System.String,System.String,System.String,System.Nullable{System.Guid})">
|
||||
SendMessageAsync(Guid, string, string, string, string?, Guid?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Contracts/IChatService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -403,7 +439,7 @@ Interface IChatService <a class="header-action link-secondary" title="View sour
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">Task<string?> SendMessageAsync(Guid userId, string username, string channelName, string content)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">Task<string?> SendMessageAsync(Guid userId, string username, string channelName, string content, string? originConnectionId = null, Guid? replyToMessageId = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -416,6 +452,10 @@ Interface IChatService <a class="header-action link-secondary" title="View sour
|
||||
<dd></dd>
|
||||
<dt><code>content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>originConnectionId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>replyToMessageId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -121,6 +121,42 @@ Interface IEchoHubClient <a class="header-action link-secondary" title="View so
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IEchoHubClient_ChannelDeleted_" data-uid="EchoHub.Core.Contracts.IEchoHubClient.ChannelDeleted*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IEchoHubClient_ChannelDeleted_System_String_" data-uid="EchoHub.Core.Contracts.IEchoHubClient.ChannelDeleted(System.String)">
|
||||
ChannelDeleted(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Contracts/IEchoHubClient.cs"><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">Task ChannelDeleted(string channelName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IEchoHubClient_ChannelNuked_" data-uid="EchoHub.Core.Contracts.IEchoHubClient.ChannelNuked*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IEchoHubClient_ChannelNuked_System_String_" data-uid="EchoHub.Core.Contracts.IEchoHubClient.ChannelNuked(System.String)">
|
||||
|
||||
@@ -232,8 +232,8 @@ Interface IUserService <a class="header-action link-secondary" title="View sour
|
||||
|
||||
<a id="EchoHub_Core_Contracts_IUserService_RegisterUserAsync_" data-uid="EchoHub.Core.Contracts.IUserService.RegisterUserAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Contracts_IUserService_RegisterUserAsync_System_String_System_String_System_String_" data-uid="EchoHub.Core.Contracts.IUserService.RegisterUserAsync(System.String,System.String,System.String)">
|
||||
RegisterUserAsync(string, string, string?)
|
||||
<h3 id="EchoHub_Core_Contracts_IUserService_RegisterUserAsync_System_String_System_String_System_String_System_String_" data-uid="EchoHub.Core.Contracts.IUserService.RegisterUserAsync(System.String,System.String,System.String,System.String)">
|
||||
RegisterUserAsync(string, string, string?, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Contracts/IUserService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -241,7 +241,7 @@ Interface IUserService <a class="header-action link-secondary" title="View sour
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">Task<UserOperationResult> RegisterUserAsync(string username, string password, string? displayName = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">Task<UserOperationResult> RegisterUserAsync(string username, string password, string? displayName = null, string? inviteCode = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -252,6 +252,8 @@ Interface IUserService <a class="header-action link-secondary" title="View sour
|
||||
<dd></dd>
|
||||
<dt><code>displayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>inviteCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -182,8 +182,8 @@ Class ChannelDto <a class="header-action link-secondary" title="View source" hr
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ChannelDto__ctor_" data-uid="EchoHub.Core.DTOs.ChannelDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ChannelDto__ctor_System_Guid_System_String_System_String_System_Boolean_System_Int32_System_DateTimeOffset_System_Boolean_System_Boolean_" data-uid="EchoHub.Core.DTOs.ChannelDto.#ctor(System.Guid,System.String,System.String,System.Boolean,System.Int32,System.DateTimeOffset,System.Boolean,System.Boolean)">
|
||||
ChannelDto(Guid, string, string?, bool, int, DateTimeOffset, bool, bool)
|
||||
<h3 id="EchoHub_Core_DTOs_ChannelDto__ctor_System_Guid_System_String_System_String_System_Boolean_System_Int32_System_DateTimeOffset_System_Boolean_System_Boolean_System_Boolean_" data-uid="EchoHub.Core.DTOs.ChannelDto.#ctor(System.Guid,System.String,System.String,System.Boolean,System.Int32,System.DateTimeOffset,System.Boolean,System.Boolean,System.Boolean)">
|
||||
ChannelDto(Guid, string, string?, bool, int, DateTimeOffset, bool, bool, bool)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -191,7 +191,7 @@ Class ChannelDto <a class="header-action link-secondary" title="View source" hr
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ChannelDto(Guid Id, string Name, string? Topic, bool IsPublic, int MessageCount, DateTimeOffset CreatedAt, bool IsProtected = false, bool IsEncrypted = false)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ChannelDto(Guid Id, string Name, string? Topic, bool IsPublic, int MessageCount, DateTimeOffset CreatedAt, bool IsProtected = false, bool IsEncrypted = false, bool IsSystem = false)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -212,6 +212,8 @@ Class ChannelDto <a class="header-action link-secondary" title="View source" hr
|
||||
<dd></dd>
|
||||
<dt><code>IsEncrypted</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>IsSystem</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -415,6 +417,37 @@ Class ChannelDto <a class="header-action link-secondary" title="View source" hr
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ChannelDto_IsSystem_" data-uid="EchoHub.Core.DTOs.ChannelDto.IsSystem*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ChannelDto_IsSystem" data-uid="EchoHub.Core.DTOs.ChannelDto.IsSystem">
|
||||
IsSystem
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public bool IsSystem { 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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ChannelDto_MessageCount_" data-uid="EchoHub.Core.DTOs.ChannelDto.MessageCount*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ChannelDto_MessageCount" data-uid="EchoHub.Core.DTOs.ChannelDto.MessageCount">
|
||||
@@ -514,8 +547,8 @@ Class ChannelDto <a class="header-action link-secondary" title="View source" hr
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ChannelDto_Deconstruct_" data-uid="EchoHub.Core.DTOs.ChannelDto.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ChannelDto_Deconstruct_System_Guid__System_String__System_String__System_Boolean__System_Int32__System_DateTimeOffset__System_Boolean__System_Boolean__" data-uid="EchoHub.Core.DTOs.ChannelDto.Deconstruct(System.Guid@,System.String@,System.String@,System.Boolean@,System.Int32@,System.DateTimeOffset@,System.Boolean@,System.Boolean@)">
|
||||
Deconstruct(out Guid, out string, out string?, out bool, out int, out DateTimeOffset, out bool, out bool)
|
||||
<h3 id="EchoHub_Core_DTOs_ChannelDto_Deconstruct_System_Guid__System_String__System_String__System_Boolean__System_Int32__System_DateTimeOffset__System_Boolean__System_Boolean__System_Boolean__" data-uid="EchoHub.Core.DTOs.ChannelDto.Deconstruct(System.Guid@,System.String@,System.String@,System.Boolean@,System.Int32@,System.DateTimeOffset@,System.Boolean@,System.Boolean@,System.Boolean@)">
|
||||
Deconstruct(out Guid, out string, out string?, out bool, out int, out DateTimeOffset, out bool, out bool, out bool)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -523,7 +556,7 @@ Class ChannelDto <a class="header-action link-secondary" title="View source" hr
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out Guid Id, out string Name, out string? Topic, out bool IsPublic, out int MessageCount, out DateTimeOffset CreatedAt, out bool IsProtected, out bool IsEncrypted)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out Guid Id, out string Name, out string? Topic, out bool IsPublic, out int MessageCount, out DateTimeOffset CreatedAt, out bool IsProtected, out bool IsEncrypted, out bool IsSystem)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -544,6 +577,8 @@ Class ChannelDto <a class="header-action link-secondary" title="View source" hr
|
||||
<dd></dd>
|
||||
<dt><code>IsEncrypted</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>IsSystem</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,625 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class CreateInviteRequest | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class CreateInviteRequest | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_DTOs_CreateInviteRequest.md&value=---%0Auid%3A%20EchoHub.Core.DTOs.CreateInviteRequest%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.DTOs.CreateInviteRequest">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_DTOs_CreateInviteRequest" data-uid="EchoHub.Core.DTOs.CreateInviteRequest" class="text-break">
|
||||
Class CreateInviteRequest <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.DTOs.html">DTOs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public record CreateInviteRequest : IEquatable<CreateInviteRequest></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">CreateInviteRequest</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><<a class="xref" href="EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</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.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.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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest__ctor_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest__ctor_EchoHub_Core_DTOs_CreateInviteRequest_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.#ctor(EchoHub.Core.DTOs.CreateInviteRequest)">
|
||||
CreateInviteRequest(CreateInviteRequest)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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 CreateInviteRequest(CreateInviteRequest original)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>original</code> <a class="xref" href="EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest__ctor_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest__ctor_System_Nullable_System_Int32__System_Nullable_System_Int32__" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.#ctor(System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
||||
CreateInviteRequest(int?, int?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public CreateInviteRequest(int? MaxUses = null, int? ExpiresInHours = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>MaxUses</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
<dt><code>ExpiresInHours</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_EqualityContract_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_EqualityContract" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.EqualityContract">
|
||||
EqualityContract
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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 Type EqualityContract { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_ExpiresInHours_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.ExpiresInHours*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_ExpiresInHours" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.ExpiresInHours">
|
||||
ExpiresInHours
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public int? ExpiresInHours { 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.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_MaxUses_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.MaxUses*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_MaxUses" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.MaxUses">
|
||||
MaxUses
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public int? MaxUses { 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.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_Deconstruct_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_Deconstruct_System_Nullable_System_Int32___System_Nullable_System_Int32___" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.Deconstruct(System.Nullable{System.Int32}@,System.Nullable{System.Int32}@)">
|
||||
Deconstruct(out int?, out int?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public void Deconstruct(out int? MaxUses, out int? ExpiresInHours)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>MaxUses</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
<dt><code>ExpiresInHours</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_Equals_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_Equals_EchoHub_Core_DTOs_CreateInviteRequest_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.Equals(EchoHub.Core.DTOs.CreateInviteRequest)">
|
||||
Equals(CreateInviteRequest?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public virtual bool Equals(CreateInviteRequest? other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_Equals_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_Equals_System_Object_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_GetHashCode_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_GetHashCode" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_PrintMembers_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.PrintMembers*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_PrintMembers_System_Text_StringBuilder_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.PrintMembers(System.Text.StringBuilder)">
|
||||
PrintMembers(StringBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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 bool PrintMembers(StringBuilder builder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>builder</code> <span class="xref">StringBuilder</span></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_ToString_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_ToString" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_op_Equality_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_op_Equality_EchoHub_Core_DTOs_CreateInviteRequest_EchoHub_Core_DTOs_CreateInviteRequest_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.op_Equality(EchoHub.Core.DTOs.CreateInviteRequest,EchoHub.Core.DTOs.CreateInviteRequest)">
|
||||
operator ==(CreateInviteRequest?, CreateInviteRequest?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public static bool operator ==(CreateInviteRequest? left, CreateInviteRequest? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_CreateInviteRequest_op_Inequality_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_CreateInviteRequest_op_Inequality_EchoHub_Core_DTOs_CreateInviteRequest_EchoHub_Core_DTOs_CreateInviteRequest_" data-uid="EchoHub.Core.DTOs.CreateInviteRequest.op_Inequality(EchoHub.Core.DTOs.CreateInviteRequest,EchoHub.Core.DTOs.CreateInviteRequest)">
|
||||
operator !=(CreateInviteRequest?, CreateInviteRequest?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public static bool operator !=(CreateInviteRequest? left, CreateInviteRequest? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,592 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class DeleteAccountRequest | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class DeleteAccountRequest | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Password re-confirmation for destructive self-service account actions.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_DTOs_DeleteAccountRequest.md&value=---%0Auid%3A%20EchoHub.Core.DTOs.DeleteAccountRequest%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.DTOs.DeleteAccountRequest">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_DTOs_DeleteAccountRequest" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest" class="text-break">
|
||||
Class DeleteAccountRequest <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.DTOs.html">DTOs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Password re-confirmation for destructive self-service account actions.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public record DeleteAccountRequest : IEquatable<DeleteAccountRequest></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">DeleteAccountRequest</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><<a class="xref" href="EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</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.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.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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest__ctor_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest__ctor_EchoHub_Core_DTOs_DeleteAccountRequest_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.#ctor(EchoHub.Core.DTOs.DeleteAccountRequest)">
|
||||
DeleteAccountRequest(DeleteAccountRequest)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 DeleteAccountRequest(DeleteAccountRequest original)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>original</code> <a class="xref" href="EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest__ctor_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest__ctor_System_String_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.#ctor(System.String)">
|
||||
DeleteAccountRequest(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Password re-confirmation for destructive self-service account actions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DeleteAccountRequest(string Password)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_EqualityContract_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_EqualityContract" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.EqualityContract">
|
||||
EqualityContract
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 Type EqualityContract { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_Password_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.Password*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_Password" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.Password">
|
||||
Password
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public string Password { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_Deconstruct_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_Deconstruct_System_String__" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.Deconstruct(System.String@)">
|
||||
Deconstruct(out string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public void Deconstruct(out string Password)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_Equals_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_Equals_EchoHub_Core_DTOs_DeleteAccountRequest_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.Equals(EchoHub.Core.DTOs.DeleteAccountRequest)">
|
||||
Equals(DeleteAccountRequest?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public virtual bool Equals(DeleteAccountRequest? other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_Equals_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_Equals_System_Object_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_GetHashCode_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_GetHashCode" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_PrintMembers_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.PrintMembers*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_PrintMembers_System_Text_StringBuilder_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.PrintMembers(System.Text.StringBuilder)">
|
||||
PrintMembers(StringBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 bool PrintMembers(StringBuilder builder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>builder</code> <span class="xref">StringBuilder</span></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_ToString_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_ToString" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_op_Equality_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_op_Equality_EchoHub_Core_DTOs_DeleteAccountRequest_EchoHub_Core_DTOs_DeleteAccountRequest_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.op_Equality(EchoHub.Core.DTOs.DeleteAccountRequest,EchoHub.Core.DTOs.DeleteAccountRequest)">
|
||||
operator ==(DeleteAccountRequest?, DeleteAccountRequest?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public static bool operator ==(DeleteAccountRequest? left, DeleteAccountRequest? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_DeleteAccountRequest_op_Inequality_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_DeleteAccountRequest_op_Inequality_EchoHub_Core_DTOs_DeleteAccountRequest_EchoHub_Core_DTOs_DeleteAccountRequest_" data-uid="EchoHub.Core.DTOs.DeleteAccountRequest.op_Inequality(EchoHub.Core.DTOs.DeleteAccountRequest,EchoHub.Core.DTOs.DeleteAccountRequest)">
|
||||
operator !=(DeleteAccountRequest?, DeleteAccountRequest?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public static bool operator !=(DeleteAccountRequest? left, DeleteAccountRequest? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,765 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ExportedAttachmentDto | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ExportedAttachmentDto | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_DTOs_ExportedAttachmentDto.md&value=---%0Auid%3A%20EchoHub.Core.DTOs.ExportedAttachmentDto%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.DTOs.ExportedAttachmentDto">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_DTOs_ExportedAttachmentDto" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto" class="text-break">
|
||||
Class ExportedAttachmentDto <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.DTOs.html">DTOs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public record ExportedAttachmentDto : IEquatable<ExportedAttachmentDto></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">ExportedAttachmentDto</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><<a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</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.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.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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto__ctor_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto__ctor_EchoHub_Core_DTOs_ExportedAttachmentDto_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.#ctor(EchoHub.Core.DTOs.ExportedAttachmentDto)">
|
||||
ExportedAttachmentDto(ExportedAttachmentDto)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 ExportedAttachmentDto(ExportedAttachmentDto original)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>original</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto__ctor_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto__ctor_System_String_System_String_System_Int64_System_String_System_String_System_DateTimeOffset_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.#ctor(System.String,System.String,System.Int64,System.String,System.String,System.DateTimeOffset)">
|
||||
ExportedAttachmentDto(string, string, long, string, string, DateTimeOffset)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public ExportedAttachmentDto(string FileName, string Url, long FileSize, string Kind, string ChannelName, DateTimeOffset SentAt)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>FileName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Url</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>FileSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int64">long</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Kind</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ChannelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>SentAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_ChannelName_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.ChannelName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_ChannelName" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.ChannelName">
|
||||
ChannelName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public string ChannelName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_EqualityContract_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_EqualityContract" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.EqualityContract">
|
||||
EqualityContract
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 Type EqualityContract { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_FileName_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.FileName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_FileName" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.FileName">
|
||||
FileName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public string FileName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_FileSize_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.FileSize*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_FileSize" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.FileSize">
|
||||
FileSize
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public long FileSize { 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.int64">long</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_Kind_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Kind*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_Kind" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Kind">
|
||||
Kind
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public string Kind { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_SentAt_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.SentAt*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_SentAt" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.SentAt">
|
||||
SentAt
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public DateTimeOffset SentAt { 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.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_Url_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Url*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_Url" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Url">
|
||||
Url
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public string Url { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_Deconstruct_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_Deconstruct_System_String__System_String__System_Int64__System_String__System_String__System_DateTimeOffset__" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Deconstruct(System.String@,System.String@,System.Int64@,System.String@,System.String@,System.DateTimeOffset@)">
|
||||
Deconstruct(out string, out string, out long, out string, out string, out DateTimeOffset)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public void Deconstruct(out string FileName, out string Url, out long FileSize, out string Kind, out string ChannelName, out DateTimeOffset SentAt)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>FileName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Url</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>FileSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int64">long</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Kind</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ChannelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>SentAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_Equals_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_Equals_EchoHub_Core_DTOs_ExportedAttachmentDto_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Equals(EchoHub.Core.DTOs.ExportedAttachmentDto)">
|
||||
Equals(ExportedAttachmentDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public virtual bool Equals(ExportedAttachmentDto? other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_Equals_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_Equals_System_Object_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_GetHashCode_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_GetHashCode" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_PrintMembers_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.PrintMembers*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_PrintMembers_System_Text_StringBuilder_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.PrintMembers(System.Text.StringBuilder)">
|
||||
PrintMembers(StringBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 bool PrintMembers(StringBuilder builder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>builder</code> <span class="xref">StringBuilder</span></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_ToString_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_ToString" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_op_Equality_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_op_Equality_EchoHub_Core_DTOs_ExportedAttachmentDto_EchoHub_Core_DTOs_ExportedAttachmentDto_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.op_Equality(EchoHub.Core.DTOs.ExportedAttachmentDto,EchoHub.Core.DTOs.ExportedAttachmentDto)">
|
||||
operator ==(ExportedAttachmentDto?, ExportedAttachmentDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public static bool operator ==(ExportedAttachmentDto? left, ExportedAttachmentDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedAttachmentDto_op_Inequality_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedAttachmentDto_op_Inequality_EchoHub_Core_DTOs_ExportedAttachmentDto_EchoHub_Core_DTOs_ExportedAttachmentDto_" data-uid="EchoHub.Core.DTOs.ExportedAttachmentDto.op_Inequality(EchoHub.Core.DTOs.ExportedAttachmentDto,EchoHub.Core.DTOs.ExportedAttachmentDto)">
|
||||
operator !=(ExportedAttachmentDto?, ExportedAttachmentDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public static bool operator !=(ExportedAttachmentDto? left, ExportedAttachmentDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,730 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ExportedMessageDto | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ExportedMessageDto | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_DTOs_ExportedMessageDto.md&value=---%0Auid%3A%20EchoHub.Core.DTOs.ExportedMessageDto%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.DTOs.ExportedMessageDto">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_DTOs_ExportedMessageDto" data-uid="EchoHub.Core.DTOs.ExportedMessageDto" class="text-break">
|
||||
Class ExportedMessageDto <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.DTOs.html">DTOs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public record ExportedMessageDto : IEquatable<ExportedMessageDto></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">ExportedMessageDto</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><<a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</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.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.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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto__ctor_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto__ctor_EchoHub_Core_DTOs_ExportedMessageDto_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.#ctor(EchoHub.Core.DTOs.ExportedMessageDto)">
|
||||
ExportedMessageDto(ExportedMessageDto)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 ExportedMessageDto(ExportedMessageDto original)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>original</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto__ctor_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto__ctor_System_Guid_System_String_System_DateTimeOffset_System_String_System_Nullable_System_Guid__" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.#ctor(System.Guid,System.String,System.DateTimeOffset,System.String,System.Nullable{System.Guid})">
|
||||
ExportedMessageDto(Guid, string, DateTimeOffset, string, Guid?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public ExportedMessageDto(Guid Id, string ChannelName, DateTimeOffset SentAt, string Content, Guid? ReplyToMessageId)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ChannelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>SentAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ReplyToMessageId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_ChannelName_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.ChannelName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_ChannelName" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.ChannelName">
|
||||
ChannelName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public string ChannelName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_Content_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Content*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_Content" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Content">
|
||||
Content
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public string Content { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_EqualityContract_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_EqualityContract" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.EqualityContract">
|
||||
EqualityContract
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 Type EqualityContract { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_Id_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Id*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_Id" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Id">
|
||||
Id
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public Guid Id { 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.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_ReplyToMessageId_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.ReplyToMessageId*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_ReplyToMessageId" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.ReplyToMessageId">
|
||||
ReplyToMessageId
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public Guid? ReplyToMessageId { 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.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_SentAt_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.SentAt*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_SentAt" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.SentAt">
|
||||
SentAt
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public DateTimeOffset SentAt { 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.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_Deconstruct_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_Deconstruct_System_Guid__System_String__System_DateTimeOffset__System_String__System_Nullable_System_Guid___" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Deconstruct(System.Guid@,System.String@,System.DateTimeOffset@,System.String@,System.Nullable{System.Guid}@)">
|
||||
Deconstruct(out Guid, out string, out DateTimeOffset, out string, out Guid?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public void Deconstruct(out Guid Id, out string ChannelName, out DateTimeOffset SentAt, out string Content, out Guid? ReplyToMessageId)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ChannelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>SentAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ReplyToMessageId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_Equals_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_Equals_EchoHub_Core_DTOs_ExportedMessageDto_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Equals(EchoHub.Core.DTOs.ExportedMessageDto)">
|
||||
Equals(ExportedMessageDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public virtual bool Equals(ExportedMessageDto? other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_Equals_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_Equals_System_Object_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_GetHashCode_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_GetHashCode" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_PrintMembers_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.PrintMembers*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_PrintMembers_System_Text_StringBuilder_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.PrintMembers(System.Text.StringBuilder)">
|
||||
PrintMembers(StringBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 bool PrintMembers(StringBuilder builder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>builder</code> <span class="xref">StringBuilder</span></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_ToString_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_ToString" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_op_Equality_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_op_Equality_EchoHub_Core_DTOs_ExportedMessageDto_EchoHub_Core_DTOs_ExportedMessageDto_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.op_Equality(EchoHub.Core.DTOs.ExportedMessageDto,EchoHub.Core.DTOs.ExportedMessageDto)">
|
||||
operator ==(ExportedMessageDto?, ExportedMessageDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public static bool operator ==(ExportedMessageDto? left, ExportedMessageDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ExportedMessageDto_op_Inequality_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ExportedMessageDto_op_Inequality_EchoHub_Core_DTOs_ExportedMessageDto_EchoHub_Core_DTOs_ExportedMessageDto_" data-uid="EchoHub.Core.DTOs.ExportedMessageDto.op_Inequality(EchoHub.Core.DTOs.ExportedMessageDto,EchoHub.Core.DTOs.ExportedMessageDto)">
|
||||
operator !=(ExportedMessageDto?, ExportedMessageDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public static bool operator !=(ExportedMessageDto? left, ExportedMessageDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,765 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class InviteDto | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class InviteDto | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_DTOs_InviteDto.md&value=---%0Auid%3A%20EchoHub.Core.DTOs.InviteDto%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.DTOs.InviteDto">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_DTOs_InviteDto" data-uid="EchoHub.Core.DTOs.InviteDto" class="text-break">
|
||||
Class InviteDto <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.DTOs.html">DTOs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public record InviteDto : IEquatable<InviteDto></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">InviteDto</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><<a class="xref" href="EchoHub.Core.DTOs.InviteDto.html">InviteDto</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.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.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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto__ctor_" data-uid="EchoHub.Core.DTOs.InviteDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto__ctor_EchoHub_Core_DTOs_InviteDto_" data-uid="EchoHub.Core.DTOs.InviteDto.#ctor(EchoHub.Core.DTOs.InviteDto)">
|
||||
InviteDto(InviteDto)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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 InviteDto(InviteDto original)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>original</code> <a class="xref" href="EchoHub.Core.DTOs.InviteDto.html">InviteDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto__ctor_" data-uid="EchoHub.Core.DTOs.InviteDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto__ctor_System_String_System_String_System_DateTimeOffset_System_Nullable_System_DateTimeOffset__System_Int32_System_Int32_" data-uid="EchoHub.Core.DTOs.InviteDto.#ctor(System.String,System.String,System.DateTimeOffset,System.Nullable{System.DateTimeOffset},System.Int32,System.Int32)">
|
||||
InviteDto(string, string, DateTimeOffset, DateTimeOffset?, int, int)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public InviteDto(string Code, string CreatedByUsername, DateTimeOffset CreatedAt, DateTimeOffset? ExpiresAt, int MaxUses, int UseCount)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Code</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>CreatedByUsername</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>CreatedAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ExpiresAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a>?</dt>
|
||||
<dd></dd>
|
||||
<dt><code>MaxUses</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>UseCount</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_Code_" data-uid="EchoHub.Core.DTOs.InviteDto.Code*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_Code" data-uid="EchoHub.Core.DTOs.InviteDto.Code">
|
||||
Code
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public string Code { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_CreatedAt_" data-uid="EchoHub.Core.DTOs.InviteDto.CreatedAt*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_CreatedAt" data-uid="EchoHub.Core.DTOs.InviteDto.CreatedAt">
|
||||
CreatedAt
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public DateTimeOffset CreatedAt { 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.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_CreatedByUsername_" data-uid="EchoHub.Core.DTOs.InviteDto.CreatedByUsername*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_CreatedByUsername" data-uid="EchoHub.Core.DTOs.InviteDto.CreatedByUsername">
|
||||
CreatedByUsername
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public string CreatedByUsername { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_EqualityContract_" data-uid="EchoHub.Core.DTOs.InviteDto.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_EqualityContract" data-uid="EchoHub.Core.DTOs.InviteDto.EqualityContract">
|
||||
EqualityContract
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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 Type EqualityContract { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_ExpiresAt_" data-uid="EchoHub.Core.DTOs.InviteDto.ExpiresAt*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_ExpiresAt" data-uid="EchoHub.Core.DTOs.InviteDto.ExpiresAt">
|
||||
ExpiresAt
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public DateTimeOffset? ExpiresAt { 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.datetimeoffset">DateTimeOffset</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_MaxUses_" data-uid="EchoHub.Core.DTOs.InviteDto.MaxUses*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_MaxUses" data-uid="EchoHub.Core.DTOs.InviteDto.MaxUses">
|
||||
MaxUses
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public int MaxUses { 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.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_UseCount_" data-uid="EchoHub.Core.DTOs.InviteDto.UseCount*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_UseCount" data-uid="EchoHub.Core.DTOs.InviteDto.UseCount">
|
||||
UseCount
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public int UseCount { 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.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_Deconstruct_" data-uid="EchoHub.Core.DTOs.InviteDto.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_Deconstruct_System_String__System_String__System_DateTimeOffset__System_Nullable_System_DateTimeOffset___System_Int32__System_Int32__" data-uid="EchoHub.Core.DTOs.InviteDto.Deconstruct(System.String@,System.String@,System.DateTimeOffset@,System.Nullable{System.DateTimeOffset}@,System.Int32@,System.Int32@)">
|
||||
Deconstruct(out string, out string, out DateTimeOffset, out DateTimeOffset?, out int, out int)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public void Deconstruct(out string Code, out string CreatedByUsername, out DateTimeOffset CreatedAt, out DateTimeOffset? ExpiresAt, out int MaxUses, out int UseCount)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Code</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>CreatedByUsername</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>CreatedAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ExpiresAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a>?</dt>
|
||||
<dd></dd>
|
||||
<dt><code>MaxUses</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>UseCount</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_Equals_" data-uid="EchoHub.Core.DTOs.InviteDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_Equals_EchoHub_Core_DTOs_InviteDto_" data-uid="EchoHub.Core.DTOs.InviteDto.Equals(EchoHub.Core.DTOs.InviteDto)">
|
||||
Equals(InviteDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public virtual bool Equals(InviteDto? other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Core.DTOs.InviteDto.html">InviteDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_Equals_" data-uid="EchoHub.Core.DTOs.InviteDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_Equals_System_Object_" data-uid="EchoHub.Core.DTOs.InviteDto.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_GetHashCode_" data-uid="EchoHub.Core.DTOs.InviteDto.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_GetHashCode" data-uid="EchoHub.Core.DTOs.InviteDto.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_PrintMembers_" data-uid="EchoHub.Core.DTOs.InviteDto.PrintMembers*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_PrintMembers_System_Text_StringBuilder_" data-uid="EchoHub.Core.DTOs.InviteDto.PrintMembers(System.Text.StringBuilder)">
|
||||
PrintMembers(StringBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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 bool PrintMembers(StringBuilder builder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>builder</code> <span class="xref">StringBuilder</span></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_ToString_" data-uid="EchoHub.Core.DTOs.InviteDto.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_ToString" data-uid="EchoHub.Core.DTOs.InviteDto.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_op_Equality_" data-uid="EchoHub.Core.DTOs.InviteDto.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_op_Equality_EchoHub_Core_DTOs_InviteDto_EchoHub_Core_DTOs_InviteDto_" data-uid="EchoHub.Core.DTOs.InviteDto.op_Equality(EchoHub.Core.DTOs.InviteDto,EchoHub.Core.DTOs.InviteDto)">
|
||||
operator ==(InviteDto?, InviteDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public static bool operator ==(InviteDto? left, InviteDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.InviteDto.html">InviteDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.InviteDto.html">InviteDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_InviteDto_op_Inequality_" data-uid="EchoHub.Core.DTOs.InviteDto.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_InviteDto_op_Inequality_EchoHub_Core_DTOs_InviteDto_EchoHub_Core_DTOs_InviteDto_" data-uid="EchoHub.Core.DTOs.InviteDto.op_Inequality(EchoHub.Core.DTOs.InviteDto,EchoHub.Core.DTOs.InviteDto)">
|
||||
operator !=(InviteDto?, InviteDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs"><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">public static bool operator !=(InviteDto? left, InviteDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.InviteDto.html">InviteDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.InviteDto.html">InviteDto</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/InviteDtos.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -182,8 +182,8 @@ Class MessageDto <a class="header-action link-secondary" title="View source" hr
|
||||
|
||||
<a id="EchoHub_Core_DTOs_MessageDto__ctor_" data-uid="EchoHub.Core.DTOs.MessageDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_MessageDto__ctor_System_Guid_System_String_System_String_System_String_System_String_System_DateTimeOffset_System_Collections_Generic_List_EchoHub_Core_DTOs_AttachmentDto__System_Collections_Generic_List_EchoHub_Core_DTOs_EmbedDto__System_String_" data-uid="EchoHub.Core.DTOs.MessageDto.#ctor(System.Guid,System.String,System.String,System.String,System.String,System.DateTimeOffset,System.Collections.Generic.List{EchoHub.Core.DTOs.AttachmentDto},System.Collections.Generic.List{EchoHub.Core.DTOs.EmbedDto},System.String)">
|
||||
MessageDto(Guid, string, string, string?, string, DateTimeOffset, List<AttachmentDto>?, List<EmbedDto>?, string?)
|
||||
<h3 id="EchoHub_Core_DTOs_MessageDto__ctor_System_Guid_System_String_System_String_System_String_System_String_System_DateTimeOffset_System_Collections_Generic_List_EchoHub_Core_DTOs_AttachmentDto__System_Collections_Generic_List_EchoHub_Core_DTOs_EmbedDto__System_String_EchoHub_Core_DTOs_ReplyRefDto_" data-uid="EchoHub.Core.DTOs.MessageDto.#ctor(System.Guid,System.String,System.String,System.String,System.String,System.DateTimeOffset,System.Collections.Generic.List{EchoHub.Core.DTOs.AttachmentDto},System.Collections.Generic.List{EchoHub.Core.DTOs.EmbedDto},System.String,EchoHub.Core.DTOs.ReplyRefDto)">
|
||||
MessageDto(Guid, string, string, string?, string, DateTimeOffset, List<AttachmentDto>?, List<EmbedDto>?, string?, ReplyRefDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -191,7 +191,7 @@ Class MessageDto <a class="header-action link-secondary" title="View source" hr
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MessageDto(Guid Id, string Content, string SenderUsername, string? SenderNicknameColor, string ChannelName, DateTimeOffset SentAt, List<AttachmentDto>? Attachments = null, List<EmbedDto>? Embeds = null, string? SenderDisplayName = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public MessageDto(Guid Id, string Content, string SenderUsername, string? SenderNicknameColor, string ChannelName, DateTimeOffset SentAt, List<AttachmentDto>? Attachments = null, List<EmbedDto>? Embeds = null, string? SenderDisplayName = null, ReplyRefDto? ReplyTo = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -214,6 +214,8 @@ Class MessageDto <a class="header-action link-secondary" title="View source" hr
|
||||
<dd></dd>
|
||||
<dt><code>SenderDisplayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ReplyTo</code> <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -417,6 +419,37 @@ Class MessageDto <a class="header-action link-secondary" title="View source" hr
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_MessageDto_ReplyTo_" data-uid="EchoHub.Core.DTOs.MessageDto.ReplyTo*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_MessageDto_ReplyTo" data-uid="EchoHub.Core.DTOs.MessageDto.ReplyTo">
|
||||
ReplyTo
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public ReplyRefDto? ReplyTo { get; init; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_MessageDto_SenderDisplayName_" data-uid="EchoHub.Core.DTOs.MessageDto.SenderDisplayName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_MessageDto_SenderDisplayName" data-uid="EchoHub.Core.DTOs.MessageDto.SenderDisplayName">
|
||||
@@ -547,8 +580,8 @@ Class MessageDto <a class="header-action link-secondary" title="View source" hr
|
||||
|
||||
<a id="EchoHub_Core_DTOs_MessageDto_Deconstruct_" data-uid="EchoHub.Core.DTOs.MessageDto.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_MessageDto_Deconstruct_System_Guid__System_String__System_String__System_String__System_String__System_DateTimeOffset__System_Collections_Generic_List_EchoHub_Core_DTOs_AttachmentDto___System_Collections_Generic_List_EchoHub_Core_DTOs_EmbedDto___System_String__" data-uid="EchoHub.Core.DTOs.MessageDto.Deconstruct(System.Guid@,System.String@,System.String@,System.String@,System.String@,System.DateTimeOffset@,System.Collections.Generic.List{EchoHub.Core.DTOs.AttachmentDto}@,System.Collections.Generic.List{EchoHub.Core.DTOs.EmbedDto}@,System.String@)">
|
||||
Deconstruct(out Guid, out string, out string, out string?, out string, out DateTimeOffset, out List<AttachmentDto>?, out List<EmbedDto>?, out string?)
|
||||
<h3 id="EchoHub_Core_DTOs_MessageDto_Deconstruct_System_Guid__System_String__System_String__System_String__System_String__System_DateTimeOffset__System_Collections_Generic_List_EchoHub_Core_DTOs_AttachmentDto___System_Collections_Generic_List_EchoHub_Core_DTOs_EmbedDto___System_String__EchoHub_Core_DTOs_ReplyRefDto__" data-uid="EchoHub.Core.DTOs.MessageDto.Deconstruct(System.Guid@,System.String@,System.String@,System.String@,System.String@,System.DateTimeOffset@,System.Collections.Generic.List{EchoHub.Core.DTOs.AttachmentDto}@,System.Collections.Generic.List{EchoHub.Core.DTOs.EmbedDto}@,System.String@,EchoHub.Core.DTOs.ReplyRefDto@)">
|
||||
Deconstruct(out Guid, out string, out string, out string?, out string, out DateTimeOffset, out List<AttachmentDto>?, out List<EmbedDto>?, out string?, out ReplyRefDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -556,7 +589,7 @@ Class MessageDto <a class="header-action link-secondary" title="View source" hr
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out Guid Id, out string Content, out string SenderUsername, out string? SenderNicknameColor, out string ChannelName, out DateTimeOffset SentAt, out List<AttachmentDto>? Attachments, out List<EmbedDto>? Embeds, out string? SenderDisplayName)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out Guid Id, out string Content, out string SenderUsername, out string? SenderNicknameColor, out string ChannelName, out DateTimeOffset SentAt, out List<AttachmentDto>? Attachments, out List<EmbedDto>? Embeds, out string? SenderDisplayName, out ReplyRefDto? ReplyTo)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -579,6 +612,8 @@ Class MessageDto <a class="header-action link-secondary" title="View source" hr
|
||||
<dd></dd>
|
||||
<dt><code>SenderDisplayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ReplyTo</code> <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -182,8 +182,8 @@ Class RegisterRequest <a class="header-action link-secondary" title="View sourc
|
||||
|
||||
<a id="EchoHub_Core_DTOs_RegisterRequest__ctor_" data-uid="EchoHub.Core.DTOs.RegisterRequest.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_RegisterRequest__ctor_System_String_System_String_System_String_" data-uid="EchoHub.Core.DTOs.RegisterRequest.#ctor(System.String,System.String,System.String)">
|
||||
RegisterRequest(string, string, string?)
|
||||
<h3 id="EchoHub_Core_DTOs_RegisterRequest__ctor_System_String_System_String_System_String_System_String_" data-uid="EchoHub.Core.DTOs.RegisterRequest.#ctor(System.String,System.String,System.String,System.String)">
|
||||
RegisterRequest(string, string, string?, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AuthDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -191,7 +191,7 @@ Class RegisterRequest <a class="header-action link-secondary" title="View sourc
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public RegisterRequest(string Username, string Password, string? DisplayName = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public RegisterRequest(string Username, string Password, string? DisplayName = null, string? InviteCode = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -202,6 +202,8 @@ Class RegisterRequest <a class="header-action link-secondary" title="View sourc
|
||||
<dd></dd>
|
||||
<dt><code>DisplayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>InviteCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -281,6 +283,37 @@ Class RegisterRequest <a class="header-action link-secondary" title="View sourc
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_RegisterRequest_InviteCode_" data-uid="EchoHub.Core.DTOs.RegisterRequest.InviteCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_RegisterRequest_InviteCode" data-uid="EchoHub.Core.DTOs.RegisterRequest.InviteCode">
|
||||
InviteCode
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AuthDtos.cs"><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">public string? InviteCode { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_RegisterRequest_Password_" data-uid="EchoHub.Core.DTOs.RegisterRequest.Password*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_RegisterRequest_Password" data-uid="EchoHub.Core.DTOs.RegisterRequest.Password">
|
||||
@@ -349,8 +382,8 @@ Class RegisterRequest <a class="header-action link-secondary" title="View sourc
|
||||
|
||||
<a id="EchoHub_Core_DTOs_RegisterRequest_Deconstruct_" data-uid="EchoHub.Core.DTOs.RegisterRequest.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_RegisterRequest_Deconstruct_System_String__System_String__System_String__" data-uid="EchoHub.Core.DTOs.RegisterRequest.Deconstruct(System.String@,System.String@,System.String@)">
|
||||
Deconstruct(out string, out string, out string?)
|
||||
<h3 id="EchoHub_Core_DTOs_RegisterRequest_Deconstruct_System_String__System_String__System_String__System_String__" data-uid="EchoHub.Core.DTOs.RegisterRequest.Deconstruct(System.String@,System.String@,System.String@,System.String@)">
|
||||
Deconstruct(out string, out string, out string?, out string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AuthDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -358,7 +391,7 @@ Class RegisterRequest <a class="header-action link-secondary" title="View sourc
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out string Username, out string Password, out string? DisplayName)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out string Username, out string Password, out string? DisplayName, out string? InviteCode)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -369,6 +402,8 @@ Class RegisterRequest <a class="header-action link-secondary" title="View sourc
|
||||
<dd></dd>
|
||||
<dt><code>DisplayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>InviteCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,668 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ReplyRefDto | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ReplyRefDto | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Reference to the message a reply targets. is treated exactly like message content on the wire: transport-encrypted, and for end-to-end encrypted rooms it is room ciphertext the client must decrypt (the server truncates only plaintext snippets). Null on a when the original message no longer exists.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_DTOs_ReplyRefDto.md&value=---%0Auid%3A%20EchoHub.Core.DTOs.ReplyRefDto%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.DTOs.ReplyRefDto">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_DTOs_ReplyRefDto" data-uid="EchoHub.Core.DTOs.ReplyRefDto" class="text-break">
|
||||
Class ReplyRefDto <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.DTOs.html">DTOs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Reference to the message a reply targets. <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html#EchoHub_Core_DTOs_ReplyRefDto_Content">Content</a> is treated exactly like
|
||||
message content on the wire: transport-encrypted, and for end-to-end encrypted rooms it is
|
||||
room ciphertext the client must decrypt (the server truncates only plaintext snippets).
|
||||
Null on a <a class="xref" href="EchoHub.Core.DTOs.MessageDto.html">MessageDto</a> when the original message no longer exists.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public record ReplyRefDto : IEquatable<ReplyRefDto></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">ReplyRefDto</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><<a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</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.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.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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto__ctor_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto__ctor_EchoHub_Core_DTOs_ReplyRefDto_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.#ctor(EchoHub.Core.DTOs.ReplyRefDto)">
|
||||
ReplyRefDto(ReplyRefDto)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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 ReplyRefDto(ReplyRefDto original)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>original</code> <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto__ctor_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto__ctor_System_Guid_System_String_System_String_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.#ctor(System.Guid,System.String,System.String)">
|
||||
ReplyRefDto(Guid, string, string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Reference to the message a reply targets. <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html#EchoHub_Core_DTOs_ReplyRefDto_Content">Content</a> is treated exactly like
|
||||
message content on the wire: transport-encrypted, and for end-to-end encrypted rooms it is
|
||||
room ciphertext the client must decrypt (the server truncates only plaintext snippets).
|
||||
Null on a <a class="xref" href="EchoHub.Core.DTOs.MessageDto.html">MessageDto</a> when the original message no longer exists.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ReplyRefDto(Guid MessageId, string SenderUsername, string Content)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>MessageId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>SenderUsername</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_Content_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.Content*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_Content" data-uid="EchoHub.Core.DTOs.ReplyRefDto.Content">
|
||||
Content
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public string Content { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_EqualityContract_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_EqualityContract" data-uid="EchoHub.Core.DTOs.ReplyRefDto.EqualityContract">
|
||||
EqualityContract
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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 Type EqualityContract { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_MessageId_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.MessageId*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_MessageId" data-uid="EchoHub.Core.DTOs.ReplyRefDto.MessageId">
|
||||
MessageId
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public Guid MessageId { 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.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_SenderUsername_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.SenderUsername*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_SenderUsername" data-uid="EchoHub.Core.DTOs.ReplyRefDto.SenderUsername">
|
||||
SenderUsername
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public string SenderUsername { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_Deconstruct_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_Deconstruct_System_Guid__System_String__System_String__" data-uid="EchoHub.Core.DTOs.ReplyRefDto.Deconstruct(System.Guid@,System.String@,System.String@)">
|
||||
Deconstruct(out Guid, out string, out string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public void Deconstruct(out Guid MessageId, out string SenderUsername, out string Content)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>MessageId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>SenderUsername</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_Equals_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_Equals_EchoHub_Core_DTOs_ReplyRefDto_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.Equals(EchoHub.Core.DTOs.ReplyRefDto)">
|
||||
Equals(ReplyRefDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public virtual bool Equals(ReplyRefDto? other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_Equals_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_Equals_System_Object_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_GetHashCode_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_GetHashCode" data-uid="EchoHub.Core.DTOs.ReplyRefDto.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_PrintMembers_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.PrintMembers*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_PrintMembers_System_Text_StringBuilder_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.PrintMembers(System.Text.StringBuilder)">
|
||||
PrintMembers(StringBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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 bool PrintMembers(StringBuilder builder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>builder</code> <span class="xref">StringBuilder</span></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_ToString_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_ToString" data-uid="EchoHub.Core.DTOs.ReplyRefDto.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_op_Equality_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_op_Equality_EchoHub_Core_DTOs_ReplyRefDto_EchoHub_Core_DTOs_ReplyRefDto_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.op_Equality(EchoHub.Core.DTOs.ReplyRefDto,EchoHub.Core.DTOs.ReplyRefDto)">
|
||||
operator ==(ReplyRefDto?, ReplyRefDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public static bool operator ==(ReplyRefDto? left, ReplyRefDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ReplyRefDto_op_Inequality_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ReplyRefDto_op_Inequality_EchoHub_Core_DTOs_ReplyRefDto_EchoHub_Core_DTOs_ReplyRefDto_" data-uid="EchoHub.Core.DTOs.ReplyRefDto.op_Inequality(EchoHub.Core.DTOs.ReplyRefDto,EchoHub.Core.DTOs.ReplyRefDto)">
|
||||
operator !=(ReplyRefDto?, ReplyRefDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs"><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">public static bool operator !=(ReplyRefDto? left, ReplyRefDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -182,8 +182,8 @@ Class ServerStatusDto <a class="header-action link-secondary" title="View sourc
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ServerStatusDto__ctor_" data-uid="EchoHub.Core.DTOs.ServerStatusDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ServerStatusDto__ctor_System_String_System_String_System_Int32_System_Int32_" data-uid="EchoHub.Core.DTOs.ServerStatusDto.#ctor(System.String,System.String,System.Int32,System.Int32)">
|
||||
ServerStatusDto(string, string?, int, int)
|
||||
<h3 id="EchoHub_Core_DTOs_ServerStatusDto__ctor_System_String_System_String_System_Int32_System_Int32_System_String_" data-uid="EchoHub.Core.DTOs.ServerStatusDto.#ctor(System.String,System.String,System.Int32,System.Int32,System.String)">
|
||||
ServerStatusDto(string, string?, int, int, string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ServerDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -191,7 +191,7 @@ Class ServerStatusDto <a class="header-action link-secondary" title="View sourc
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ServerStatusDto(string Name, string? Description, int OnlineUsers, int TotalChannels)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ServerStatusDto(string Name, string? Description, int OnlineUsers, int TotalChannels, string RegistrationMode = "open")</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -204,6 +204,8 @@ Class ServerStatusDto <a class="header-action link-secondary" title="View sourc
|
||||
<dd></dd>
|
||||
<dt><code>TotalChannels</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>RegistrationMode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -345,6 +347,37 @@ Class ServerStatusDto <a class="header-action link-secondary" title="View sourc
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ServerStatusDto_RegistrationMode_" data-uid="EchoHub.Core.DTOs.ServerStatusDto.RegistrationMode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ServerStatusDto_RegistrationMode" data-uid="EchoHub.Core.DTOs.ServerStatusDto.RegistrationMode">
|
||||
RegistrationMode
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ServerDtos.cs"><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">public string RegistrationMode { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ServerStatusDto_TotalChannels_" data-uid="EchoHub.Core.DTOs.ServerStatusDto.TotalChannels*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ServerStatusDto_TotalChannels" data-uid="EchoHub.Core.DTOs.ServerStatusDto.TotalChannels">
|
||||
@@ -382,8 +415,8 @@ Class ServerStatusDto <a class="header-action link-secondary" title="View sourc
|
||||
|
||||
<a id="EchoHub_Core_DTOs_ServerStatusDto_Deconstruct_" data-uid="EchoHub.Core.DTOs.ServerStatusDto.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_ServerStatusDto_Deconstruct_System_String__System_String__System_Int32__System_Int32__" data-uid="EchoHub.Core.DTOs.ServerStatusDto.Deconstruct(System.String@,System.String@,System.Int32@,System.Int32@)">
|
||||
Deconstruct(out string, out string?, out int, out int)
|
||||
<h3 id="EchoHub_Core_DTOs_ServerStatusDto_Deconstruct_System_String__System_String__System_Int32__System_Int32__System_String__" data-uid="EchoHub.Core.DTOs.ServerStatusDto.Deconstruct(System.String@,System.String@,System.Int32@,System.Int32@,System.String@)">
|
||||
Deconstruct(out string, out string?, out int, out int, out string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ServerDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -391,7 +424,7 @@ Class ServerStatusDto <a class="header-action link-secondary" title="View sourc
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out string Name, out string? Description, out int OnlineUsers, out int TotalChannels)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public void Deconstruct(out string Name, out string? Description, out int OnlineUsers, out int TotalChannels, out string RegistrationMode)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -404,6 +437,8 @@ Class ServerStatusDto <a class="header-action link-secondary" title="View sourc
|
||||
<dd></dd>
|
||||
<dt><code>TotalChannels</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>RegistrationMode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,734 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class UserDataExportDto | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class UserDataExportDto | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Everything the server holds about a user, as stored. For end-to-end encrypted rooms the message content in here is room ciphertext — the server cannot include plaintext it never had.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_DTOs_UserDataExportDto.md&value=---%0Auid%3A%20EchoHub.Core.DTOs.UserDataExportDto%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.DTOs.UserDataExportDto">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_DTOs_UserDataExportDto" data-uid="EchoHub.Core.DTOs.UserDataExportDto" class="text-break">
|
||||
Class UserDataExportDto <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.DTOs.html">DTOs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Everything the server holds about a user, as stored. For end-to-end encrypted rooms the
|
||||
message content in here is room ciphertext — the server cannot include plaintext it never had.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public record UserDataExportDto : IEquatable<UserDataExportDto></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">UserDataExportDto</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><<a class="xref" href="EchoHub.Core.DTOs.UserDataExportDto.html">UserDataExportDto</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.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.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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto__ctor_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto__ctor_EchoHub_Core_DTOs_UserDataExportDto_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.#ctor(EchoHub.Core.DTOs.UserDataExportDto)">
|
||||
UserDataExportDto(UserDataExportDto)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 UserDataExportDto(UserDataExportDto original)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>original</code> <a class="xref" href="EchoHub.Core.DTOs.UserDataExportDto.html">UserDataExportDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto__ctor_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto__ctor_System_DateTimeOffset_System_String_EchoHub_Core_DTOs_UserProfileDto_System_Collections_Generic_List_EchoHub_Core_DTOs_ExportedMessageDto__System_Collections_Generic_List_EchoHub_Core_DTOs_ExportedAttachmentDto__" data-uid="EchoHub.Core.DTOs.UserDataExportDto.#ctor(System.DateTimeOffset,System.String,EchoHub.Core.DTOs.UserProfileDto,System.Collections.Generic.List{EchoHub.Core.DTOs.ExportedMessageDto},System.Collections.Generic.List{EchoHub.Core.DTOs.ExportedAttachmentDto})">
|
||||
UserDataExportDto(DateTimeOffset, string, UserProfileDto, List<ExportedMessageDto>, List<ExportedAttachmentDto>)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Everything the server holds about a user, as stored. For end-to-end encrypted rooms the
|
||||
message content in here is room ciphertext — the server cannot include plaintext it never had.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public UserDataExportDto(DateTimeOffset ExportedAt, string ServerName, UserProfileDto Profile, List<ExportedMessageDto> Messages, List<ExportedAttachmentDto> Attachments)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>ExportedAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ServerName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Profile</code> <a class="xref" href="EchoHub.Core.DTOs.UserProfileDto.html">UserProfileDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Messages</code> <span class="xref">List</span><<a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Attachments</code> <span class="xref">List</span><<a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_Attachments_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Attachments*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_Attachments" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Attachments">
|
||||
Attachments
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public List<ExportedAttachmentDto> Attachments { get; init; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">List</span><<a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_EqualityContract_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_EqualityContract" data-uid="EchoHub.Core.DTOs.UserDataExportDto.EqualityContract">
|
||||
EqualityContract
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 Type EqualityContract { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_ExportedAt_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.ExportedAt*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_ExportedAt" data-uid="EchoHub.Core.DTOs.UserDataExportDto.ExportedAt">
|
||||
ExportedAt
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public DateTimeOffset ExportedAt { 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.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_Messages_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Messages*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_Messages" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Messages">
|
||||
Messages
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public List<ExportedMessageDto> Messages { get; init; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">List</span><<a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_Profile_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Profile*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_Profile" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Profile">
|
||||
Profile
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public UserProfileDto Profile { get; init; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.UserProfileDto.html">UserProfileDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_ServerName_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.ServerName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_ServerName" data-uid="EchoHub.Core.DTOs.UserDataExportDto.ServerName">
|
||||
ServerName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public string ServerName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_Deconstruct_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_Deconstruct_System_DateTimeOffset__System_String__EchoHub_Core_DTOs_UserProfileDto__System_Collections_Generic_List_EchoHub_Core_DTOs_ExportedMessageDto___System_Collections_Generic_List_EchoHub_Core_DTOs_ExportedAttachmentDto___" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Deconstruct(System.DateTimeOffset@,System.String@,EchoHub.Core.DTOs.UserProfileDto@,System.Collections.Generic.List{EchoHub.Core.DTOs.ExportedMessageDto}@,System.Collections.Generic.List{EchoHub.Core.DTOs.ExportedAttachmentDto}@)">
|
||||
Deconstruct(out DateTimeOffset, out string, out UserProfileDto, out List<ExportedMessageDto>, out List<ExportedAttachmentDto>)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public void Deconstruct(out DateTimeOffset ExportedAt, out string ServerName, out UserProfileDto Profile, out List<ExportedMessageDto> Messages, out List<ExportedAttachmentDto> Attachments)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>ExportedAt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>ServerName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Profile</code> <a class="xref" href="EchoHub.Core.DTOs.UserProfileDto.html">UserProfileDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Messages</code> <span class="xref">List</span><<a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Attachments</code> <span class="xref">List</span><<a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_Equals_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_Equals_EchoHub_Core_DTOs_UserDataExportDto_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Equals(EchoHub.Core.DTOs.UserDataExportDto)">
|
||||
Equals(UserDataExportDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public virtual bool Equals(UserDataExportDto? other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Core.DTOs.UserDataExportDto.html">UserDataExportDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_Equals_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_Equals_System_Object_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_GetHashCode_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_GetHashCode" data-uid="EchoHub.Core.DTOs.UserDataExportDto.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_PrintMembers_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.PrintMembers*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_PrintMembers_System_Text_StringBuilder_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.PrintMembers(System.Text.StringBuilder)">
|
||||
PrintMembers(StringBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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 bool PrintMembers(StringBuilder builder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>builder</code> <span class="xref">StringBuilder</span></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_ToString_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_ToString" data-uid="EchoHub.Core.DTOs.UserDataExportDto.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_op_Equality_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_op_Equality_EchoHub_Core_DTOs_UserDataExportDto_EchoHub_Core_DTOs_UserDataExportDto_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.op_Equality(EchoHub.Core.DTOs.UserDataExportDto,EchoHub.Core.DTOs.UserDataExportDto)">
|
||||
operator ==(UserDataExportDto?, UserDataExportDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public static bool operator ==(UserDataExportDto? left, UserDataExportDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.UserDataExportDto.html">UserDataExportDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.UserDataExportDto.html">UserDataExportDto</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_DTOs_UserDataExportDto_op_Inequality_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_DTOs_UserDataExportDto_op_Inequality_EchoHub_Core_DTOs_UserDataExportDto_EchoHub_Core_DTOs_UserDataExportDto_" data-uid="EchoHub.Core.DTOs.UserDataExportDto.op_Inequality(EchoHub.Core.DTOs.UserDataExportDto,EchoHub.Core.DTOs.UserDataExportDto)">
|
||||
operator !=(UserDataExportDto?, UserDataExportDto?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs"><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">public static bool operator !=(UserDataExportDto? left, UserDataExportDto? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Core.DTOs.UserDataExportDto.html">UserDataExportDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Core.DTOs.UserDataExportDto.html">UserDataExportDto</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/AccountDtos.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -147,6 +147,15 @@ attachment blob sizes plus message text length, so it is an estimate, not an exa
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.CreateChannelRequest.html">CreateChannelRequest</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</a></dt>
|
||||
<dd><p>Password re-confirmation for destructive self-service account actions.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.EmbedDto.html">EmbedDto</a></dt>
|
||||
<dd></dd>
|
||||
@@ -159,6 +168,18 @@ attachment blob sizes plus message text length, so it is an estimate, not an exa
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.ErrorResponse.html">ErrorResponse</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.ExportedAttachmentDto.html">ExportedAttachmentDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.ExportedMessageDto.html">ExportedMessageDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.InviteDto.html">InviteDto</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.JoinChannelResult.html">JoinChannelResult</a></dt>
|
||||
<dd></dd>
|
||||
@@ -199,6 +220,14 @@ attachment blob sizes plus message text length, so it is an estimate, not an exa
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.RekeyChannelRequest.html">RekeyChannelRequest</a></dt>
|
||||
<dd><p>Passphrase change for an encrypted channel: the client proves knowledge of the old
|
||||
passphrase (old auth key), then supplies the re-wrapped room key under the new one.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html">ReplyRefDto</a></dt>
|
||||
<dd><p>Reference to the message a reply targets. <a class="xref" href="EchoHub.Core.DTOs.ReplyRefDto.html#EchoHub_Core_DTOs_ReplyRefDto_Content">Content</a> is treated exactly like
|
||||
message content on the wire: transport-encrypted, and for end-to-end encrypted rooms it is
|
||||
room ciphertext the client must decrypt (the server truncates only plaintext snippets).
|
||||
Null on a <a class="xref" href="EchoHub.Core.DTOs.MessageDto.html">MessageDto</a> when the original message no longer exists.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
@@ -225,6 +254,12 @@ passphrase (old auth key), then supplies the re-wrapped room key under the new o
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.UpdateTopicRequest.html">UpdateTopicRequest</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.UserDataExportDto.html">UserDataExportDto</a></dt>
|
||||
<dd><p>Everything the server holds about a user, as stored. For end-to-end encrypted rooms the
|
||||
message content in here is room ciphertext — the server cannot include plaintext it never had.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.DTOs.UserDto.html">UserDto</a></dt>
|
||||
<dd></dd>
|
||||
|
||||
@@ -337,6 +337,37 @@ Class Channel <a class="header-action link-secondary" title="View source" href=
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_Channel_IsSystem_" data-uid="EchoHub.Core.Models.Channel.IsSystem*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_Channel_IsSystem" data-uid="EchoHub.Core.Models.Channel.IsSystem">
|
||||
IsSystem
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/Channel.cs"><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">public bool IsSystem { get; set; }</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_Channel_Messages_" data-uid="EchoHub.Core.Models.Channel.Messages*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_Channel_Messages" data-uid="EchoHub.Core.Models.Channel.Messages">
|
||||
|
||||
@@ -0,0 +1,461 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class InviteCode | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class InviteCode | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="A registration invite code. When the server runs with Server:Registration = &quot;invite&quot;, new accounts (REST and IRC alike) require a valid, unexpired, not-fully-used code.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_Models_InviteCode.md&value=---%0Auid%3A%20EchoHub.Core.Models.InviteCode%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.Models.InviteCode">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_Models_InviteCode" data-uid="EchoHub.Core.Models.InviteCode" class="text-break">
|
||||
Class InviteCode <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.Models.html">Models</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A registration invite code. When the server runs with <code>Server:Registration = "invite"</code>,
|
||||
new accounts (REST and IRC alike) require a valid, unexpired, not-fully-used code.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class InviteCode</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">InviteCode</span></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.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.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode__ctor_" data-uid="EchoHub.Core.Models.InviteCode.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode__ctor" data-uid="EchoHub.Core.Models.InviteCode.#ctor">
|
||||
InviteCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><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">public InviteCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode_Code_" data-uid="EchoHub.Core.Models.InviteCode.Code*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode_Code" data-uid="EchoHub.Core.Models.InviteCode.Code">
|
||||
Code
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><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">public required string Code { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode_CreatedAt_" data-uid="EchoHub.Core.Models.InviteCode.CreatedAt*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode_CreatedAt" data-uid="EchoHub.Core.Models.InviteCode.CreatedAt">
|
||||
CreatedAt
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><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">public DateTimeOffset CreatedAt { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode_CreatedByUserId_" data-uid="EchoHub.Core.Models.InviteCode.CreatedByUserId*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode_CreatedByUserId" data-uid="EchoHub.Core.Models.InviteCode.CreatedByUserId">
|
||||
CreatedByUserId
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><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">public Guid CreatedByUserId { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode_CreatedByUsername_" data-uid="EchoHub.Core.Models.InviteCode.CreatedByUsername*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode_CreatedByUsername" data-uid="EchoHub.Core.Models.InviteCode.CreatedByUsername">
|
||||
CreatedByUsername
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><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">public string CreatedByUsername { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode_ExpiresAt_" data-uid="EchoHub.Core.Models.InviteCode.ExpiresAt*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode_ExpiresAt" data-uid="EchoHub.Core.Models.InviteCode.ExpiresAt">
|
||||
ExpiresAt
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Null means the code never expires.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DateTimeOffset? ExpiresAt { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode_Id_" data-uid="EchoHub.Core.Models.InviteCode.Id*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode_Id" data-uid="EchoHub.Core.Models.InviteCode.Id">
|
||||
Id
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><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">public Guid Id { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode_MaxUses_" data-uid="EchoHub.Core.Models.InviteCode.MaxUses*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode_MaxUses" data-uid="EchoHub.Core.Models.InviteCode.MaxUses">
|
||||
MaxUses
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><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">public int MaxUses { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_InviteCode_UseCount_" data-uid="EchoHub.Core.Models.InviteCode.UseCount*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_InviteCode_UseCount" data-uid="EchoHub.Core.Models.InviteCode.UseCount">
|
||||
UseCount
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs"><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">public int UseCount { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -463,6 +463,38 @@ Class Message <a class="header-action link-secondary" title="View source" href=
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_Message_ReplyToMessageId_" data-uid="EchoHub.Core.Models.Message.ReplyToMessageId*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_Message_ReplyToMessageId" data-uid="EchoHub.Core.Models.Message.ReplyToMessageId">
|
||||
ReplyToMessageId
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/Message.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Message this one replies to, if any. The target may since have been deleted.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Guid? ReplyToMessageId { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Models_Message_SenderUserId_" data-uid="EchoHub.Core.Models.Message.SenderUserId*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Models_Message_SenderUserId" data-uid="EchoHub.Core.Models.Message.SenderUserId">
|
||||
|
||||
@@ -108,6 +108,12 @@ zero or more attachments alongside its text content (Discord-style).</p>
|
||||
<dt><a class="xref" href="EchoHub.Core.Models.ChannelMembership.html">ChannelMembership</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.Models.InviteCode.html">InviteCode</a></dt>
|
||||
<dd><p>A registration invite code. When the server runs with <code>Server:Registration = "invite"</code>,
|
||||
new accounts (REST and IRC alike) require a valid, unexpired, not-fully-used code.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.Models.Message.html">Message</a></dt>
|
||||
<dd></dd>
|
||||
|
||||
@@ -0,0 +1,256 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class AsciiBannerService | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class AsciiBannerService | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Renders short text as a 5-row block-character banner (the /banner command). Entirely local — a hand-rolled figlet-style font, no dependencies, no network. Output is plain message content, so it travels (and encrypts) like any other text.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Core_Services_AsciiBannerService.md&value=---%0Auid%3A%20EchoHub.Core.Services.AsciiBannerService%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Core.Services.AsciiBannerService">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Core_Services_AsciiBannerService" data-uid="EchoHub.Core.Services.AsciiBannerService" class="text-break">
|
||||
Class AsciiBannerService <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Services/AsciiBannerService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Core.html">Core</a>.<a class="xref" href="EchoHub.Core.Services.html">Services</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Core.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Renders short text as a 5-row block-character banner (the <code>/banner</code> command).
|
||||
Entirely local — a hand-rolled figlet-style font, no dependencies, no network.
|
||||
Output is plain message content, so it travels (and encrypts) like any other text.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class AsciiBannerService</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">AsciiBannerService</span></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.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.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Core_Services_AsciiBannerService_MaxInputLength" data-uid="EchoHub.Core.Services.AsciiBannerService.MaxInputLength">
|
||||
MaxInputLength
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Services/AsciiBannerService.cs"><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">public const int MaxInputLength = 20</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Core_Services_AsciiBannerService_Render_" data-uid="EchoHub.Core.Services.AsciiBannerService.Render*"></a>
|
||||
|
||||
<h3 id="EchoHub_Core_Services_AsciiBannerService_Render_System_String_" data-uid="EchoHub.Core.Services.AsciiBannerService.Render(System.String)">
|
||||
Render(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Services/AsciiBannerService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Renders <code class="paramref">text</code> as banner lines joined with '\n'.
|
||||
Returns null when the input is empty or contains no renderable characters.
|
||||
Characters outside the font (letters, digits, and basic punctuation) are skipped.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string? Render(string text)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Services/AsciiBannerService.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -94,6 +94,13 @@
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.Services.AsciiBannerService.html">AsciiBannerService</a></dt>
|
||||
<dd><p>Renders short text as a 5-row block-character banner (the <code>/banner</code> command).
|
||||
Entirely local — a hand-rolled figlet-style font, no dependencies, no network.
|
||||
Output is plain message content, so it travels (and encrypts) like any other text.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Core.Services.FileValidationHelper.html">FileValidationHelper</a></dt>
|
||||
<dd></dd>
|
||||
|
||||
@@ -233,6 +233,42 @@ Class IrcBroadcaster <a class="header-action link-secondary" title="View source
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Irc_IrcBroadcaster_SendChannelDeletedAsync_" data-uid="EchoHub.Server.Irc.IrcBroadcaster.SendChannelDeletedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Irc_IrcBroadcaster_SendChannelDeletedAsync_System_String_" data-uid="EchoHub.Server.Irc.IrcBroadcaster.SendChannelDeletedAsync(System.String)">
|
||||
SendChannelDeletedAsync(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server.Irc/IrcBroadcaster.cs"><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">public Task SendChannelDeletedAsync(string channelName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Irc_IrcBroadcaster_SendChannelNukedAsync_" data-uid="EchoHub.Server.Irc.IrcBroadcaster.SendChannelNukedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Irc_IrcBroadcaster_SendChannelNukedAsync_System_String_" data-uid="EchoHub.Server.Irc.IrcBroadcaster.SendChannelNukedAsync(System.String)">
|
||||
@@ -385,16 +421,21 @@ Class IrcBroadcaster <a class="header-action link-secondary" title="View source
|
||||
|
||||
<a id="EchoHub_Server_Irc_IrcBroadcaster_SendMessageToChannelAsync_" data-uid="EchoHub.Server.Irc.IrcBroadcaster.SendMessageToChannelAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Irc_IrcBroadcaster_SendMessageToChannelAsync_System_String_EchoHub_Core_DTOs_MessageDto_" data-uid="EchoHub.Server.Irc.IrcBroadcaster.SendMessageToChannelAsync(System.String,EchoHub.Core.DTOs.MessageDto)">
|
||||
SendMessageToChannelAsync(string, MessageDto)
|
||||
<h3 id="EchoHub_Server_Irc_IrcBroadcaster_SendMessageToChannelAsync_System_String_EchoHub_Core_DTOs_MessageDto_System_String_" data-uid="EchoHub.Server.Irc.IrcBroadcaster.SendMessageToChannelAsync(System.String,EchoHub.Core.DTOs.MessageDto,System.String)">
|
||||
SendMessageToChannelAsync(string, MessageDto, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server.Irc/IrcBroadcaster.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Broadcast a chat message to a channel. <code class="paramref">excludeConnectionId</code> is the
|
||||
connection the message originated from (IRC convention: never echo a message back to
|
||||
the connection that sent it — its client already displayed it locally). Other
|
||||
connections of the same user (e.g. an IRC session alongside a TUI session) still
|
||||
receive the message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task SendMessageToChannelAsync(string channelName, MessageDto message)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Task SendMessageToChannelAsync(string channelName, MessageDto message, string? excludeConnectionId = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -403,6 +444,8 @@ Class IrcBroadcaster <a class="header-action link-secondary" title="View source
|
||||
<dd></dd>
|
||||
<dt><code>message</code> <a class="xref" href="../core/EchoHub.Core.DTOs.MessageDto.html">MessageDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>excludeConnectionId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -152,63 +152,30 @@ Class IrcMessageFormatter <a class="header-action link-secondary" title="View s
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Irc_IrcMessageFormatter_ColorTagsToAnsi_" data-uid="EchoHub.Server.Irc.IrcMessageFormatter.ColorTagsToAnsi*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Irc_IrcMessageFormatter_ColorTagsToAnsi_System_String_" data-uid="EchoHub.Server.Irc.IrcMessageFormatter.ColorTagsToAnsi(System.String)">
|
||||
ColorTagsToAnsi(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server.Irc/IrcMessageFormatter.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Convert printable color tags ({F:RRGGBB}, {B:RRGGBB}, {X}) to ANSI escape codes for IRC clients.
|
||||
Also passes through content that already uses ANSI codes unchanged.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string ColorTagsToAnsi(string text)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Irc_IrcMessageFormatter_FormatMessage_" data-uid="EchoHub.Server.Irc.IrcMessageFormatter.FormatMessage*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Irc_IrcMessageFormatter_FormatMessage_EchoHub_Core_DTOs_MessageDto_" data-uid="EchoHub.Server.Irc.IrcMessageFormatter.FormatMessage(EchoHub.Core.DTOs.MessageDto)">
|
||||
FormatMessage(MessageDto)
|
||||
<h3 id="EchoHub_Server_Irc_IrcMessageFormatter_FormatMessage_EchoHub_Core_DTOs_MessageDto_System_String_" data-uid="EchoHub.Server.Irc.IrcMessageFormatter.FormatMessage(EchoHub.Core.DTOs.MessageDto,System.String)">
|
||||
FormatMessage(MessageDto, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server.Irc/IrcMessageFormatter.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Format a MessageDto as one or more IRC PRIVMSG lines.</p>
|
||||
<div class="markdown level1 summary"><p>Format a MessageDto as one or more IRC PRIVMSG lines.
|
||||
Attachments are rendered as single link lines \u2014 the widely-supported IRC convention
|
||||
(clients auto-preview or open plain http(s) URLs) \u2014 never as terminal color art.
|
||||
<code class="paramref">publicBaseUrl</code> makes the links absolute so any IRC client can open them.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static List<string> FormatMessage(MessageDto message)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public static List<string> FormatMessage(MessageDto message, string? publicBaseUrl = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>message</code> <a class="xref" href="../core/EchoHub.Core.DTOs.MessageDto.html">MessageDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>publicBaseUrl</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
@@ -266,6 +233,46 @@ Also passes through content that already uses ANSI codes unchanged.</p>
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Irc_IrcMessageFormatter_ToAbsoluteUrl_" data-uid="EchoHub.Server.Irc.IrcMessageFormatter.ToAbsoluteUrl*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Irc_IrcMessageFormatter_ToAbsoluteUrl_System_String_System_String_" data-uid="EchoHub.Server.Irc.IrcMessageFormatter.ToAbsoluteUrl(System.String,System.String)">
|
||||
ToAbsoluteUrl(string, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server.Irc/IrcMessageFormatter.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Joins a relative attachment path onto the configured public base URL.
|
||||
Already-absolute URLs and unset base URLs pass through unchanged.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string ToAbsoluteUrl(string url, string? publicBaseUrl)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>url</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>publicBaseUrl</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
@@ -306,6 +306,40 @@ Class IrcOptions <a class="header-action link-secondary" title="View source" hr
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Irc_IrcOptions_PublicBaseUrl_" data-uid="EchoHub.Server.Irc.IrcOptions.PublicBaseUrl*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Irc_IrcOptions_PublicBaseUrl" data-uid="EchoHub.Server.Irc.IrcOptions.PublicBaseUrl">
|
||||
PublicBaseUrl
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server.Irc/IrcOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Public HTTP(S) base of this EchoHub server (e.g. "https://chat.example.com"),
|
||||
used to turn relative attachment URLs into absolute links IRC clients can open.
|
||||
When unset, attachment lines fall back to the relative path.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string? PublicBaseUrl { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Irc_IrcOptions_ServerName_" data-uid="EchoHub.Server.Irc.IrcOptions.ServerName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Irc_IrcOptions_ServerName" data-uid="EchoHub.Server.Irc.IrcOptions.ServerName">
|
||||
|
||||
@@ -0,0 +1,469 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ServerLogsOptions | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ServerLogsOptions | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Live server-log room settings, bound from the &quot;ServerLogs&quot; config section (env override: ServerLogs__Enabled etc.). When enabled, a read-only system channel is auto-created and log events are streamed to it live — log lines are never stored as messages in the database; the rolling Serilog log files remain the only persistence.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Config_ServerLogsOptions.md&value=---%0Auid%3A%20EchoHub.Server.Config.ServerLogsOptions%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Config.ServerLogsOptions">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Config_ServerLogsOptions" data-uid="EchoHub.Server.Config.ServerLogsOptions" class="text-break">
|
||||
Class ServerLogsOptions <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Config.html">Config</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Live server-log room settings, bound from the "ServerLogs" config section (env override:
|
||||
<code>ServerLogs__Enabled</code> etc.). When enabled, a read-only system channel is auto-created
|
||||
and log events are streamed to it live — log lines are never stored as messages in the
|
||||
database; the rolling Serilog log files remain the only persistence.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class ServerLogsOptions</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">ServerLogsOptions</span></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.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions__ctor_" data-uid="EchoHub.Server.Config.ServerLogsOptions.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions__ctor" data-uid="EchoHub.Server.Config.ServerLogsOptions.#ctor">
|
||||
ServerLogsOptions()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><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">public ServerLogsOptions()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions_BacklogLines_" data-uid="EchoHub.Server.Config.ServerLogsOptions.BacklogLines*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions_BacklogLines" data-uid="EchoHub.Server.Config.ServerLogsOptions.BacklogLines">
|
||||
BacklogLines
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>How many recent log entries are replayed from the log file when someone opens the room.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int BacklogLines { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions_Enabled_" data-uid="EchoHub.Server.Config.ServerLogsOptions.Enabled*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions_Enabled" data-uid="EchoHub.Server.Config.ServerLogsOptions.Enabled">
|
||||
Enabled
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Master switch for the live log room.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Enabled { get; set; }</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions_LogDirectory_" data-uid="EchoHub.Server.Config.ServerLogsOptions.LogDirectory*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions_LogDirectory" data-uid="EchoHub.Server.Config.ServerLogsOptions.LogDirectory">
|
||||
LogDirectory
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Directory holding the rolling log files. Must match the Serilog file sink's path.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string LogDirectory { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions_LogFilePattern_" data-uid="EchoHub.Server.Config.ServerLogsOptions.LogFilePattern*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions_LogFilePattern" data-uid="EchoHub.Server.Config.ServerLogsOptions.LogFilePattern">
|
||||
LogFilePattern
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Filename glob for the rolling log files inside <a class="xref" href="EchoHub.Server.Config.ServerLogsOptions.html#EchoHub_Server_Config_ServerLogsOptions_LogDirectory">LogDirectory</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string LogFilePattern { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions_MinLevel_" data-uid="EchoHub.Server.Config.ServerLogsOptions.MinLevel*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions_MinLevel" data-uid="EchoHub.Server.Config.ServerLogsOptions.MinLevel">
|
||||
MinLevel
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Minimum level of log events streamed to the room (Verbose/Debug/Information/Warning/
|
||||
Error/Fatal). Only affects the room — file and console sinks keep their own levels.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public LogEventLevel MinLevel { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">LogEventLevel</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions_MinRole_" data-uid="EchoHub.Server.Config.ServerLogsOptions.MinRole*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions_MinRole" data-uid="EchoHub.Server.Config.ServerLogsOptions.MinRole">
|
||||
MinRole
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Minimum server role allowed to see and join the log room (Member/Mod/Admin/Owner).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ServerRole MinRole { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="../core/EchoHub.Core.Models.ServerRole.html">ServerRole</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions_NormalizedRoomName_" data-uid="EchoHub.Server.Config.ServerLogsOptions.NormalizedRoomName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions_NormalizedRoomName" data-uid="EchoHub.Server.Config.ServerLogsOptions.NormalizedRoomName">
|
||||
NormalizedRoomName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Channel names are stored lowercased; compare against this form.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string NormalizedRoomName { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_ServerLogsOptions_RoomName_" data-uid="EchoHub.Server.Config.ServerLogsOptions.RoomName*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_ServerLogsOptions_RoomName" data-uid="EchoHub.Server.Config.ServerLogsOptions.RoomName">
|
||||
RoomName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Name of the auto-created system channel. Must satisfy the normal channel-name rules;
|
||||
the name is reserved — users cannot create a channel with it.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string RoomName { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/ServerLogsOptions.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,564 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SpamOptions | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SpamOptions | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Anti-spam thresholds, bound from the &quot;Spam&quot; config section. Defaults are lenient enough that a fast typist never trips them; Mods and above are always exempt.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Config_SpamOptions.md&value=---%0Auid%3A%20EchoHub.Server.Config.SpamOptions%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Config.SpamOptions">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Config_SpamOptions" data-uid="EchoHub.Server.Config.SpamOptions" class="text-break">
|
||||
Class SpamOptions <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Config.html">Config</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Anti-spam thresholds, bound from the "Spam" config section. Defaults are lenient enough
|
||||
that a fast typist never trips them; Mods and above are always exempt.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class SpamOptions</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">SpamOptions</span></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.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions__ctor_" data-uid="EchoHub.Server.Config.SpamOptions.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions__ctor" data-uid="EchoHub.Server.Config.SpamOptions.#ctor">
|
||||
SpamOptions()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><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">public SpamOptions()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_AutoMuteMinutes_" data-uid="EchoHub.Server.Config.SpamOptions.AutoMuteMinutes*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_AutoMuteMinutes" data-uid="EchoHub.Server.Config.SpamOptions.AutoMuteMinutes">
|
||||
AutoMuteMinutes
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Auto-mute duration once a user accumulates <a class="xref" href="EchoHub.Server.Config.SpamOptions.html#EchoHub_Server_Config_SpamOptions_ViolationThreshold">ViolationThreshold</a> rejected
|
||||
sends within <a class="xref" href="EchoHub.Server.Config.SpamOptions.html#EchoHub_Server_Config_SpamOptions_ViolationWindowMinutes">ViolationWindowMinutes</a>. 0 disables auto-mute (rejections
|
||||
still apply). The mute uses the normal timed-mute machinery, so moderators see it
|
||||
and <code>MuteExpirationService</code> lifts it.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int AutoMuteMinutes { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_ChannelCreateWindowMinutes_" data-uid="EchoHub.Server.Config.SpamOptions.ChannelCreateWindowMinutes*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_ChannelCreateWindowMinutes" data-uid="EchoHub.Server.Config.SpamOptions.ChannelCreateWindowMinutes">
|
||||
ChannelCreateWindowMinutes
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><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">public int ChannelCreateWindowMinutes { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_Enabled_" data-uid="EchoHub.Server.Config.SpamOptions.Enabled*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_Enabled" data-uid="EchoHub.Server.Config.SpamOptions.Enabled">
|
||||
Enabled
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Master switch for all spam protection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Enabled { get; set; }</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_JoinWindowSeconds_" data-uid="EchoHub.Server.Config.SpamOptions.JoinWindowSeconds*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_JoinWindowSeconds" data-uid="EchoHub.Server.Config.SpamOptions.JoinWindowSeconds">
|
||||
JoinWindowSeconds
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><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">public int JoinWindowSeconds { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_MaxChannelCreatesPerWindow_" data-uid="EchoHub.Server.Config.SpamOptions.MaxChannelCreatesPerWindow*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_MaxChannelCreatesPerWindow" data-uid="EchoHub.Server.Config.SpamOptions.MaxChannelCreatesPerWindow">
|
||||
MaxChannelCreatesPerWindow
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Max channel creations per <a class="xref" href="EchoHub.Server.Config.SpamOptions.html#EchoHub_Server_Config_SpamOptions_ChannelCreateWindowMinutes">ChannelCreateWindowMinutes</a> window.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int MaxChannelCreatesPerWindow { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_MaxDuplicateMessages_" data-uid="EchoHub.Server.Config.SpamOptions.MaxDuplicateMessages*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_MaxDuplicateMessages" data-uid="EchoHub.Server.Config.SpamOptions.MaxDuplicateMessages">
|
||||
MaxDuplicateMessages
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>How many identical messages in a row are tolerated; the next one is rejected.
|
||||
(End-to-end encrypted rooms are naturally exempt — identical plaintext produces
|
||||
different ciphertext per message, so repeats never look identical to the server.)</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int MaxDuplicateMessages { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_MaxJoinsPerWindow_" data-uid="EchoHub.Server.Config.SpamOptions.MaxJoinsPerWindow*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_MaxJoinsPerWindow" data-uid="EchoHub.Server.Config.SpamOptions.MaxJoinsPerWindow">
|
||||
MaxJoinsPerWindow
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Max <em>first-time</em> channel joins per <a class="xref" href="EchoHub.Server.Config.SpamOptions.html#EchoHub_Server_Config_SpamOptions_JoinWindowSeconds">JoinWindowSeconds</a> window. Joins of
|
||||
channels the user already belongs to (reconnect/auto-join) never count, but a brand-new
|
||||
user's first connect joins every public channel at once — keep this above your public
|
||||
channel count.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int MaxJoinsPerWindow { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_MaxMessagesPerWindow_" data-uid="EchoHub.Server.Config.SpamOptions.MaxMessagesPerWindow*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_MaxMessagesPerWindow" data-uid="EchoHub.Server.Config.SpamOptions.MaxMessagesPerWindow">
|
||||
MaxMessagesPerWindow
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Max messages a user may send per <a class="xref" href="EchoHub.Server.Config.SpamOptions.html#EchoHub_Server_Config_SpamOptions_WindowSeconds">WindowSeconds</a> window.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int MaxMessagesPerWindow { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_ViolationThreshold_" data-uid="EchoHub.Server.Config.SpamOptions.ViolationThreshold*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_ViolationThreshold" data-uid="EchoHub.Server.Config.SpamOptions.ViolationThreshold">
|
||||
ViolationThreshold
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><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">public int ViolationThreshold { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_ViolationWindowMinutes_" data-uid="EchoHub.Server.Config.SpamOptions.ViolationWindowMinutes*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_ViolationWindowMinutes" data-uid="EchoHub.Server.Config.SpamOptions.ViolationWindowMinutes">
|
||||
ViolationWindowMinutes
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><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">public int ViolationWindowMinutes { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Config_SpamOptions_WindowSeconds_" data-uid="EchoHub.Server.Config.SpamOptions.WindowSeconds*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Config_SpamOptions_WindowSeconds" data-uid="EchoHub.Server.Config.SpamOptions.WindowSeconds">
|
||||
WindowSeconds
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs"><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">public int WindowSeconds { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Config/SpamOptions.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -94,6 +94,20 @@
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Config.ServerLogsOptions.html">ServerLogsOptions</a></dt>
|
||||
<dd><p>Live server-log room settings, bound from the "ServerLogs" config section (env override:
|
||||
<code>ServerLogs__Enabled</code> etc.). When enabled, a read-only system channel is auto-created
|
||||
and log events are streamed to it live — log lines are never stored as messages in the
|
||||
database; the rolling Serilog log files remain the only persistence.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Config.SpamOptions.html">SpamOptions</a></dt>
|
||||
<dd><p>Anti-spam thresholds, bound from the "Spam" config section. Defaults are lenient enough
|
||||
that a fast typist never trips them; Mods and above are always exempt.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Config.UploadLimits.html">UploadLimits</a></dt>
|
||||
<dd><p>Admin-configurable upload limits, bound from the <code>Uploads</code> configuration section.
|
||||
|
||||
@@ -199,11 +199,16 @@ public class FilesController : ControllerBase</code></pre>
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/FilesController.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Serves an uploaded file. Anonymous by design: the unguessable GUID in the URL is the
|
||||
access token (Discord-CDN-style capability URL), so attachment links can be opened
|
||||
directly in a browser and shared to IRC clients. E2E-encrypted room blobs are
|
||||
ciphertext at rest, so anonymous access reveals nothing for those channels.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[HttpGet("{fileId}")]
|
||||
[AllowAnonymous]
|
||||
public IActionResult GetFile(string fileId)</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -0,0 +1,330 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class InvitesController | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class InvitesController | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Invite-code management for invite-gated registration (Admin+ only). Codes live in this server's own database — there is no central service.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Controllers_InvitesController.md&value=---%0Auid%3A%20EchoHub.Server.Controllers.InvitesController%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Controllers.InvitesController">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Controllers_InvitesController" data-uid="EchoHub.Server.Controllers.InvitesController" class="text-break">
|
||||
Class InvitesController <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/InvitesController.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Controllers.html">Controllers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Invite-code management for invite-gated registration (Admin+ only).
|
||||
Codes live in this server's own database — there is no central service.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[ApiController]
|
||||
[Route("api/invites")]
|
||||
[Authorize]
|
||||
[EnableRateLimiting("general")]
|
||||
public class InvitesController : ControllerBase</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">ControllerBase</span></div>
|
||||
<div><span class="xref">InvitesController</span></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.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.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Controllers_InvitesController__ctor_" data-uid="EchoHub.Server.Controllers.InvitesController.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_InvitesController__ctor_EchoHub_Server_Data_EchoHubDbContext_Microsoft_Extensions_Logging_ILogger_EchoHub_Server_Controllers_InvitesController__" data-uid="EchoHub.Server.Controllers.InvitesController.#ctor(EchoHub.Server.Data.EchoHubDbContext,Microsoft.Extensions.Logging.ILogger{EchoHub.Server.Controllers.InvitesController})">
|
||||
InvitesController(EchoHubDbContext, ILogger<InvitesController>)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/InvitesController.cs"><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">public InvitesController(EchoHubDbContext db, ILogger<InvitesController> logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>db</code> <a class="xref" href="EchoHub.Server.Data.EchoHubDbContext.html">EchoHubDbContext</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>logger</code> <span class="xref">ILogger</span><<a class="xref" href="EchoHub.Server.Controllers.InvitesController.html">InvitesController</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Controllers_InvitesController_Create_" data-uid="EchoHub.Server.Controllers.InvitesController.Create*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_InvitesController_Create_EchoHub_Core_DTOs_CreateInviteRequest_" data-uid="EchoHub.Server.Controllers.InvitesController.Create(EchoHub.Core.DTOs.CreateInviteRequest)">
|
||||
Create(CreateInviteRequest)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/InvitesController.cs"><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">[HttpPost]
|
||||
public Task<IActionResult> Create(CreateInviteRequest request)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>request</code> <a class="xref" href="../core/EchoHub.Core.DTOs.CreateInviteRequest.html">CreateInviteRequest</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<span class="xref">IActionResult</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Controllers_InvitesController_List_" data-uid="EchoHub.Server.Controllers.InvitesController.List*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_InvitesController_List" data-uid="EchoHub.Server.Controllers.InvitesController.List">
|
||||
List()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/InvitesController.cs"><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">[HttpGet]
|
||||
public Task<IActionResult> List()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<span class="xref">IActionResult</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Controllers_InvitesController_Revoke_" data-uid="EchoHub.Server.Controllers.InvitesController.Revoke*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_InvitesController_Revoke_System_String_" data-uid="EchoHub.Server.Controllers.InvitesController.Revoke(System.String)">
|
||||
Revoke(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/InvitesController.cs"><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">[HttpDelete("{code}")]
|
||||
public Task<IActionResult> Revoke(string code)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>code</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<span class="xref">IActionResult</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/InvitesController.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -159,8 +159,8 @@ public class UsersController : ControllerBase</code></pre>
|
||||
|
||||
<a id="EchoHub_Server_Controllers_UsersController__ctor_" data-uid="EchoHub.Server.Controllers.UsersController.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_UsersController__ctor_EchoHub_Core_Contracts_IUserService_EchoHub_Core_Services_ImageToAsciiService_EchoHub_Server_Config_UploadLimits_" data-uid="EchoHub.Server.Controllers.UsersController.#ctor(EchoHub.Core.Contracts.IUserService,EchoHub.Core.Services.ImageToAsciiService,EchoHub.Server.Config.UploadLimits)">
|
||||
UsersController(IUserService, ImageToAsciiService, UploadLimits)
|
||||
<h3 id="EchoHub_Server_Controllers_UsersController__ctor_EchoHub_Core_Contracts_IUserService_EchoHub_Core_Services_ImageToAsciiService_EchoHub_Server_Config_UploadLimits_EchoHub_Server_Data_EchoHubDbContext_EchoHub_Core_Contracts_IMessageEncryptionService_EchoHub_Server_Services_FileStorageService_EchoHub_Server_Services_PresenceTracker_System_Collections_Generic_IEnumerable_EchoHub_Core_Contracts_IChatBroadcaster__Microsoft_Extensions_Configuration_IConfiguration_Microsoft_Extensions_Logging_ILogger_EchoHub_Server_Controllers_UsersController__" data-uid="EchoHub.Server.Controllers.UsersController.#ctor(EchoHub.Core.Contracts.IUserService,EchoHub.Core.Services.ImageToAsciiService,EchoHub.Server.Config.UploadLimits,EchoHub.Server.Data.EchoHubDbContext,EchoHub.Core.Contracts.IMessageEncryptionService,EchoHub.Server.Services.FileStorageService,EchoHub.Server.Services.PresenceTracker,System.Collections.Generic.IEnumerable{EchoHub.Core.Contracts.IChatBroadcaster},Microsoft.Extensions.Configuration.IConfiguration,Microsoft.Extensions.Logging.ILogger{EchoHub.Server.Controllers.UsersController})">
|
||||
UsersController(IUserService, ImageToAsciiService, UploadLimits, EchoHubDbContext, IMessageEncryptionService, FileStorageService, PresenceTracker, IEnumerable<IChatBroadcaster>, IConfiguration, ILogger<UsersController>)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/UsersController.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -168,7 +168,7 @@ public class UsersController : ControllerBase</code></pre>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public UsersController(IUserService userService, ImageToAsciiService asciiService, UploadLimits uploadLimits)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public UsersController(IUserService userService, ImageToAsciiService asciiService, UploadLimits uploadLimits, EchoHubDbContext db, IMessageEncryptionService encryption, FileStorageService fileStorage, PresenceTracker presenceTracker, IEnumerable<IChatBroadcaster> broadcasters, IConfiguration config, ILogger<UsersController> logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -179,6 +179,20 @@ public class UsersController : ControllerBase</code></pre>
|
||||
<dd></dd>
|
||||
<dt><code>uploadLimits</code> <a class="xref" href="EchoHub.Server.Config.UploadLimits.html">UploadLimits</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>db</code> <a class="xref" href="EchoHub.Server.Data.EchoHubDbContext.html">EchoHubDbContext</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>encryption</code> <a class="xref" href="../core/EchoHub.Core.Contracts.IMessageEncryptionService.html">IMessageEncryptionService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>fileStorage</code> <a class="xref" href="EchoHub.Server.Services.FileStorageService.html">FileStorageService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>presenceTracker</code> <a class="xref" href="EchoHub.Server.Services.PresenceTracker.html">PresenceTracker</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>broadcasters</code> <span class="xref">IEnumerable</span><<a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Contracts/IChatBroadcaster.cs">IChatBroadcaster</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>config</code> <span class="xref">IConfiguration</span></dt>
|
||||
<dd></dd>
|
||||
<dt><code>logger</code> <span class="xref">ILogger</span><<a class="xref" href="EchoHub.Server.Controllers.UsersController.html">UsersController</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -192,10 +206,122 @@ public class UsersController : ControllerBase</code></pre>
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_UsersController_DeletedUserName" data-uid="EchoHub.Server.Controllers.UsersController.DeletedUserName">
|
||||
DeletedUserName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/UsersController.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Username tombstoned messages are re-attributed to after account deletion.
|
||||
Reserved — <a class="xref" href="EchoHub.Server.Services.UserService.html">UserService</a> refuses to register it.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string DeletedUserName = "deleted-user"</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Controllers_UsersController_DeleteMyAccount_" data-uid="EchoHub.Server.Controllers.UsersController.DeleteMyAccount*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_UsersController_DeleteMyAccount_EchoHub_Core_DTOs_DeleteAccountRequest_" data-uid="EchoHub.Server.Controllers.UsersController.DeleteMyAccount(EchoHub.Core.DTOs.DeleteAccountRequest)">
|
||||
DeleteMyAccount(DeleteAccountRequest)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/UsersController.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Self-service account deletion (password re-confirmed). Removes the account, its refresh
|
||||
tokens and memberships (FK cascade), and every attachment blob the user uploaded.
|
||||
Their messages are kept but tombstoned to <a class="xref" href="EchoHub.Server.Controllers.UsersController.html#EchoHub_Server_Controllers_UsersController_DeletedUserName">DeletedUserName</a> — deleting them
|
||||
outright would silently gut other people's conversations.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[HttpDelete("me")]
|
||||
public Task<IActionResult> DeleteMyAccount(DeleteAccountRequest request)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>request</code> <a class="xref" href="../core/EchoHub.Core.DTOs.DeleteAccountRequest.html">DeleteAccountRequest</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<span class="xref">IActionResult</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Controllers_UsersController_ExportMyData_" data-uid="EchoHub.Server.Controllers.UsersController.ExportMyData*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_UsersController_ExportMyData" data-uid="EchoHub.Server.Controllers.UsersController.ExportMyData">
|
||||
ExportMyData()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Controllers/UsersController.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Everything the server stores about the caller, as stored: profile, their messages
|
||||
(end-to-end encrypted room content stays ciphertext — the server never had plaintext),
|
||||
and metadata of their uploaded attachments. "You own the data" made demonstrable.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[HttpGet("me/export")]
|
||||
public Task<IActionResult> ExportMyData()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<span class="xref">IActionResult</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Controllers_UsersController_GetProfile_" data-uid="EchoHub.Server.Controllers.UsersController.GetProfile*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Controllers_UsersController_GetProfile_System_String_" data-uid="EchoHub.Server.Controllers.UsersController.GetProfile(System.String)">
|
||||
|
||||
@@ -106,6 +106,12 @@ Classes
|
||||
<dt><a class="xref" href="EchoHub.Server.Controllers.FilesController.html">FilesController</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Controllers.InvitesController.html">InvitesController</a></dt>
|
||||
<dd><p>Invite-code management for invite-gated registration (Admin+ only).
|
||||
Codes live in this server's own database — there is no central service.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Controllers.ModerationController.html">ModerationController</a></dt>
|
||||
<dd></dd>
|
||||
|
||||
@@ -288,6 +288,37 @@ Class EchoHubDbContext <a class="header-action link-secondary" title="View sour
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_EchoHubDbContext_InviteCodes_" data-uid="EchoHub.Server.Data.EchoHubDbContext.InviteCodes*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_EchoHubDbContext_InviteCodes" data-uid="EchoHub.Server.Data.EchoHubDbContext.InviteCodes">
|
||||
InviteCodes
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/EchoHubDbContext.cs"><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">public DbSet<InviteCode> InviteCodes { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">DbSet</span><<a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/Models/InviteCode.cs">InviteCode</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_EchoHubDbContext_Messages_" data-uid="EchoHub.Server.Data.EchoHubDbContext.Messages*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_EchoHubDbContext_Messages" data-uid="EchoHub.Server.Data.EchoHubDbContext.Messages">
|
||||
|
||||
@@ -0,0 +1,306 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class AddChannelIsSystem | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class AddChannelIsSystem | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Data_Migrations_AddChannelIsSystem.md&value=---%0Auid%3A%20EchoHub.Server.Data.Migrations.AddChannelIsSystem%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Data.Migrations.AddChannelIsSystem">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Data_Migrations_AddChannelIsSystem" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem" class="text-break">
|
||||
Class AddChannelIsSystem <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717182450_AddChannelIsSystem.Designer.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Data.html">Data</a>.<a class="xref" href="EchoHub.Server.Data.Migrations.html">Migrations</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[DbContext(typeof(EchoHubDbContext))]
|
||||
[Migration("20260717182450_AddChannelIsSystem")]
|
||||
public class AddChannelIsSystem : Migration</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">Migration</span></div>
|
||||
<div><span class="xref">AddChannelIsSystem</span></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.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.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_Migrations_AddChannelIsSystem__ctor_" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_Migrations_AddChannelIsSystem__ctor" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem.#ctor">
|
||||
AddChannelIsSystem()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717182450_AddChannelIsSystem.Designer.cs"><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">public AddChannelIsSystem()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_Migrations_AddChannelIsSystem_BuildTargetModel_" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem.BuildTargetModel*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_Migrations_AddChannelIsSystem_BuildTargetModel_Microsoft_EntityFrameworkCore_ModelBuilder_" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem.BuildTargetModel(Microsoft.EntityFrameworkCore.ModelBuilder)">
|
||||
BuildTargetModel(ModelBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717182450_AddChannelIsSystem.Designer.cs"><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 override void BuildTargetModel(ModelBuilder modelBuilder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>modelBuilder</code> <span class="xref">ModelBuilder</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_Migrations_AddChannelIsSystem_Down_" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem.Down*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_Migrations_AddChannelIsSystem_Down_Microsoft_EntityFrameworkCore_Migrations_MigrationBuilder_" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem.Down(Microsoft.EntityFrameworkCore.Migrations.MigrationBuilder)">
|
||||
Down(MigrationBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717182450_AddChannelIsSystem.cs"><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 override void Down(MigrationBuilder migrationBuilder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>migrationBuilder</code> <span class="xref">MigrationBuilder</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_Migrations_AddChannelIsSystem_Up_" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem.Up*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_Migrations_AddChannelIsSystem_Up_Microsoft_EntityFrameworkCore_Migrations_MigrationBuilder_" data-uid="EchoHub.Server.Data.Migrations.AddChannelIsSystem.Up(Microsoft.EntityFrameworkCore.Migrations.MigrationBuilder)">
|
||||
Up(MigrationBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717182450_AddChannelIsSystem.cs"><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 override void Up(MigrationBuilder migrationBuilder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>migrationBuilder</code> <span class="xref">MigrationBuilder</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717182450_AddChannelIsSystem.Designer.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,306 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class AddInvitesAndReplies | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class AddInvitesAndReplies | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Data_Migrations_AddInvitesAndReplies.md&value=---%0Auid%3A%20EchoHub.Server.Data.Migrations.AddInvitesAndReplies%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Data.Migrations.AddInvitesAndReplies">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies" class="text-break">
|
||||
Class AddInvitesAndReplies <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717165218_AddInvitesAndReplies.Designer.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Data.html">Data</a>.<a class="xref" href="EchoHub.Server.Data.Migrations.html">Migrations</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[DbContext(typeof(EchoHubDbContext))]
|
||||
[Migration("20260717165218_AddInvitesAndReplies")]
|
||||
public class AddInvitesAndReplies : Migration</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">Migration</span></div>
|
||||
<div><span class="xref">AddInvitesAndReplies</span></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.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.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies__ctor_" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies__ctor" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.#ctor">
|
||||
AddInvitesAndReplies()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717165218_AddInvitesAndReplies.Designer.cs"><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">public AddInvitesAndReplies()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies_BuildTargetModel_" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.BuildTargetModel*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies_BuildTargetModel_Microsoft_EntityFrameworkCore_ModelBuilder_" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.BuildTargetModel(Microsoft.EntityFrameworkCore.ModelBuilder)">
|
||||
BuildTargetModel(ModelBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717165218_AddInvitesAndReplies.Designer.cs"><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 override void BuildTargetModel(ModelBuilder modelBuilder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>modelBuilder</code> <span class="xref">ModelBuilder</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies_Down_" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.Down*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies_Down_Microsoft_EntityFrameworkCore_Migrations_MigrationBuilder_" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.Down(Microsoft.EntityFrameworkCore.Migrations.MigrationBuilder)">
|
||||
Down(MigrationBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717165218_AddInvitesAndReplies.cs"><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 override void Down(MigrationBuilder migrationBuilder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>migrationBuilder</code> <span class="xref">MigrationBuilder</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies_Up_" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.Up*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Data_Migrations_AddInvitesAndReplies_Up_Microsoft_EntityFrameworkCore_Migrations_MigrationBuilder_" data-uid="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.Up(Microsoft.EntityFrameworkCore.Migrations.MigrationBuilder)">
|
||||
Up(MigrationBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717165218_AddInvitesAndReplies.cs"><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 override void Up(MigrationBuilder migrationBuilder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>migrationBuilder</code> <span class="xref">MigrationBuilder</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Data/Migrations/20260717165218_AddInvitesAndReplies.Designer.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -106,6 +106,10 @@ Classes
|
||||
<dt><a class="xref" href="EchoHub.Server.Data.Migrations.AddChannelIsPublic.html">AddChannelIsPublic</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Data.Migrations.AddChannelIsSystem.html">AddChannelIsSystem</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Data.Migrations.AddChannelMembership.html">AddChannelMembership</a></dt>
|
||||
<dd></dd>
|
||||
@@ -118,6 +122,10 @@ Classes
|
||||
<dt><a class="xref" href="EchoHub.Server.Data.Migrations.AddEncryptionSupport.html">AddEncryptionSupport</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Data.Migrations.AddInvitesAndReplies.html">AddInvitesAndReplies</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Data.Migrations.AddMessageAttachments.html">AddMessageAttachments</a></dt>
|
||||
<dd></dd>
|
||||
|
||||
@@ -419,8 +419,8 @@ public class ChatHub : Hub<IEchoHubClient>, IDisposable</code></pre>
|
||||
|
||||
<a id="EchoHub_Server_Hubs_ChatHub_SendMessage_" data-uid="EchoHub.Server.Hubs.ChatHub.SendMessage*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Hubs_ChatHub_SendMessage_System_String_System_String_" data-uid="EchoHub.Server.Hubs.ChatHub.SendMessage(System.String,System.String)">
|
||||
SendMessage(string, string)
|
||||
<h3 id="EchoHub_Server_Hubs_ChatHub_SendMessage_System_String_System_String_System_Nullable_System_Guid__" data-uid="EchoHub.Server.Hubs.ChatHub.SendMessage(System.String,System.String,System.Nullable{System.Guid})">
|
||||
SendMessage(string, string, Guid?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Hubs/ChatHub.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -428,7 +428,7 @@ public class ChatHub : Hub<IEchoHubClient>, IDisposable</code></pre>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task SendMessage(string channelName, string content)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Task SendMessage(string channelName, string content, Guid? replyToMessageId = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -437,6 +437,8 @@ public class ChatHub : Hub<IEchoHubClient>, IDisposable</code></pre>
|
||||
<dd></dd>
|
||||
<dt><code>content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>replyToMessageId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -160,8 +160,8 @@ Class ChannelService <a class="header-action link-secondary" title="View source
|
||||
|
||||
<a id="EchoHub_Server_Services_ChannelService__ctor_" data-uid="EchoHub.Server.Services.ChannelService.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ChannelService__ctor_Microsoft_Extensions_DependencyInjection_IServiceScopeFactory_EchoHub_Server_Services_PresenceTracker_Microsoft_Extensions_Logging_ILogger_EchoHub_Server_Services_ChannelService__" data-uid="EchoHub.Server.Services.ChannelService.#ctor(Microsoft.Extensions.DependencyInjection.IServiceScopeFactory,EchoHub.Server.Services.PresenceTracker,Microsoft.Extensions.Logging.ILogger{EchoHub.Server.Services.ChannelService})">
|
||||
ChannelService(IServiceScopeFactory, PresenceTracker, ILogger<ChannelService>)
|
||||
<h3 id="EchoHub_Server_Services_ChannelService__ctor_Microsoft_Extensions_DependencyInjection_IServiceScopeFactory_EchoHub_Server_Services_PresenceTracker_EchoHub_Server_Services_SpamGuard_EchoHub_Server_Services_ServerLogs_ServerLogsService_Microsoft_Extensions_Logging_ILogger_EchoHub_Server_Services_ChannelService__" data-uid="EchoHub.Server.Services.ChannelService.#ctor(Microsoft.Extensions.DependencyInjection.IServiceScopeFactory,EchoHub.Server.Services.PresenceTracker,EchoHub.Server.Services.SpamGuard,EchoHub.Server.Services.ServerLogs.ServerLogsService,Microsoft.Extensions.Logging.ILogger{EchoHub.Server.Services.ChannelService})">
|
||||
ChannelService(IServiceScopeFactory, PresenceTracker, SpamGuard, ServerLogsService, ILogger<ChannelService>)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ChannelService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -169,7 +169,7 @@ Class ChannelService <a class="header-action link-secondary" title="View source
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ChannelService(IServiceScopeFactory scopeFactory, PresenceTracker presenceTracker, ILogger<ChannelService> logger)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ChannelService(IServiceScopeFactory scopeFactory, PresenceTracker presenceTracker, SpamGuard spamGuard, ServerLogsService serverLogs, ILogger<ChannelService> logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -178,6 +178,10 @@ Class ChannelService <a class="header-action link-secondary" title="View source
|
||||
<dd></dd>
|
||||
<dt><code>presenceTracker</code> <a class="xref" href="EchoHub.Server.Services.PresenceTracker.html">PresenceTracker</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>spamGuard</code> <a class="xref" href="EchoHub.Server.Services.SpamGuard.html">SpamGuard</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>serverLogs</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsService.html">ServerLogsService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>logger</code> <span class="xref">ILogger</span><<a class="xref" href="EchoHub.Server.Services.ChannelService.html">ChannelService</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
@@ -323,6 +327,44 @@ Class ChannelService <a class="header-action link-secondary" title="View source
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ChannelService_EnsureSystemChannelAsync_" data-uid="EchoHub.Server.Services.ChannelService.EnsureSystemChannelAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ChannelService_EnsureSystemChannelAsync_System_String_System_String_" data-uid="EchoHub.Server.Services.ChannelService.EnsureSystemChannelAsync(System.String,System.String)">
|
||||
EnsureSystemChannelAsync(string, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ChannelService.cs"><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">public Task<ChannelDto> EnsureSystemChannelAsync(string channelName, string? topic = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>topic</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span><<a class="xref" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Core/DTOs/ChatDtos.cs">ChannelDto</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ChannelService_GetChannelByNameAsync_" data-uid="EchoHub.Server.Services.ChannelService.GetChannelByNameAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ChannelService_GetChannelByNameAsync_System_String_" data-uid="EchoHub.Server.Services.ChannelService.GetChannelByNameAsync(System.String)">
|
||||
|
||||
@@ -160,8 +160,8 @@ Class ChatService <a class="header-action link-secondary" title="View source" h
|
||||
|
||||
<a id="EchoHub_Server_Services_ChatService__ctor_" data-uid="EchoHub.Server.Services.ChatService.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ChatService__ctor_Microsoft_Extensions_DependencyInjection_IServiceScopeFactory_EchoHub_Server_Services_PresenceTracker_System_Collections_Generic_IEnumerable_EchoHub_Core_Contracts_IChatBroadcaster__EchoHub_Server_Services_LinkEmbedService_EchoHub_Core_Contracts_IMessageEncryptionService_EchoHub_Core_Contracts_IChannelService_EchoHub_Server_Services_FileStorageService_Microsoft_Extensions_Logging_ILogger_EchoHub_Server_Services_ChatService__" data-uid="EchoHub.Server.Services.ChatService.#ctor(Microsoft.Extensions.DependencyInjection.IServiceScopeFactory,EchoHub.Server.Services.PresenceTracker,System.Collections.Generic.IEnumerable{EchoHub.Core.Contracts.IChatBroadcaster},EchoHub.Server.Services.LinkEmbedService,EchoHub.Core.Contracts.IMessageEncryptionService,EchoHub.Core.Contracts.IChannelService,EchoHub.Server.Services.FileStorageService,Microsoft.Extensions.Logging.ILogger{EchoHub.Server.Services.ChatService})">
|
||||
ChatService(IServiceScopeFactory, PresenceTracker, IEnumerable<IChatBroadcaster>, LinkEmbedService, IMessageEncryptionService, IChannelService, FileStorageService, ILogger<ChatService>)
|
||||
<h3 id="EchoHub_Server_Services_ChatService__ctor_Microsoft_Extensions_DependencyInjection_IServiceScopeFactory_EchoHub_Server_Services_PresenceTracker_System_Collections_Generic_IEnumerable_EchoHub_Core_Contracts_IChatBroadcaster__EchoHub_Server_Services_LinkEmbedService_EchoHub_Core_Contracts_IMessageEncryptionService_EchoHub_Core_Contracts_IChannelService_EchoHub_Server_Services_FileStorageService_EchoHub_Server_Services_SpamGuard_EchoHub_Server_Services_ServerLogs_ServerLogsService_Microsoft_Extensions_Logging_ILogger_EchoHub_Server_Services_ChatService__" data-uid="EchoHub.Server.Services.ChatService.#ctor(Microsoft.Extensions.DependencyInjection.IServiceScopeFactory,EchoHub.Server.Services.PresenceTracker,System.Collections.Generic.IEnumerable{EchoHub.Core.Contracts.IChatBroadcaster},EchoHub.Server.Services.LinkEmbedService,EchoHub.Core.Contracts.IMessageEncryptionService,EchoHub.Core.Contracts.IChannelService,EchoHub.Server.Services.FileStorageService,EchoHub.Server.Services.SpamGuard,EchoHub.Server.Services.ServerLogs.ServerLogsService,Microsoft.Extensions.Logging.ILogger{EchoHub.Server.Services.ChatService})">
|
||||
ChatService(IServiceScopeFactory, PresenceTracker, IEnumerable<IChatBroadcaster>, LinkEmbedService, IMessageEncryptionService, IChannelService, FileStorageService, SpamGuard, ServerLogsService, ILogger<ChatService>)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ChatService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -169,7 +169,7 @@ Class ChatService <a class="header-action link-secondary" title="View source" h
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ChatService(IServiceScopeFactory scopeFactory, PresenceTracker presenceTracker, IEnumerable<IChatBroadcaster> broadcasters, LinkEmbedService embedService, IMessageEncryptionService encryption, IChannelService channelService, FileStorageService fileStorage, ILogger<ChatService> logger)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ChatService(IServiceScopeFactory scopeFactory, PresenceTracker presenceTracker, IEnumerable<IChatBroadcaster> broadcasters, LinkEmbedService embedService, IMessageEncryptionService encryption, IChannelService channelService, FileStorageService fileStorage, SpamGuard spamGuard, ServerLogsService serverLogs, ILogger<ChatService> logger)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -188,6 +188,10 @@ Class ChatService <a class="header-action link-secondary" title="View source" h
|
||||
<dd></dd>
|
||||
<dt><code>fileStorage</code> <a class="xref" href="EchoHub.Server.Services.FileStorageService.html">FileStorageService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>spamGuard</code> <a class="xref" href="EchoHub.Server.Services.SpamGuard.html">SpamGuard</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>serverLogs</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsService.html">ServerLogsService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>logger</code> <span class="xref">ILogger</span><<a class="xref" href="EchoHub.Server.Services.ChatService.html">ChatService</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
@@ -207,6 +211,42 @@ Class ChatService <a class="header-action link-secondary" title="View source" h
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ChatService_BroadcastChannelDeletedAsync_" data-uid="EchoHub.Server.Services.ChatService.BroadcastChannelDeletedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ChatService_BroadcastChannelDeletedAsync_System_String_" data-uid="EchoHub.Server.Services.ChatService.BroadcastChannelDeletedAsync(System.String)">
|
||||
BroadcastChannelDeletedAsync(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ChatService.cs"><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">public Task BroadcastChannelDeletedAsync(string channelName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ChatService_BroadcastChannelUpdatedAsync_" data-uid="EchoHub.Server.Services.ChatService.BroadcastChannelUpdatedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ChatService_BroadcastChannelUpdatedAsync_EchoHub_Core_DTOs_ChannelDto_System_String_" data-uid="EchoHub.Server.Services.ChatService.BroadcastChannelUpdatedAsync(EchoHub.Core.DTOs.ChannelDto,System.String)">
|
||||
@@ -481,8 +521,8 @@ Class ChatService <a class="header-action link-secondary" title="View source" h
|
||||
|
||||
<a id="EchoHub_Server_Services_ChatService_SendMessageAsync_" data-uid="EchoHub.Server.Services.ChatService.SendMessageAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ChatService_SendMessageAsync_System_Guid_System_String_System_String_System_String_" data-uid="EchoHub.Server.Services.ChatService.SendMessageAsync(System.Guid,System.String,System.String,System.String)">
|
||||
SendMessageAsync(Guid, string, string, string)
|
||||
<h3 id="EchoHub_Server_Services_ChatService_SendMessageAsync_System_Guid_System_String_System_String_System_String_System_String_System_Nullable_System_Guid__" data-uid="EchoHub.Server.Services.ChatService.SendMessageAsync(System.Guid,System.String,System.String,System.String,System.String,System.Nullable{System.Guid})">
|
||||
SendMessageAsync(Guid, string, string, string, string?, Guid?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ChatService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -490,7 +530,7 @@ Class ChatService <a class="header-action link-secondary" title="View source" h
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task<string?> SendMessageAsync(Guid userId, string username, string channelName, string content)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Task<string?> SendMessageAsync(Guid userId, string username, string channelName, string content, string? originConnectionId = null, Guid? replyToMessageId = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -503,6 +543,10 @@ Class ChatService <a class="header-action link-secondary" title="View source" h
|
||||
<dd></dd>
|
||||
<dt><code>content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>originConnectionId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>replyToMessageId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -0,0 +1,629 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class LogBacklogEntry | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class LogBacklogEntry | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="A backlog entry read from the log file: one timestamped log line plus any continuation lines (exception stack traces) that followed it.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Services_ServerLogs_LogBacklogEntry.md&value=---%0Auid%3A%20EchoHub.Server.Services.ServerLogs.LogBacklogEntry%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Services.ServerLogs.LogBacklogEntry">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry" class="text-break">
|
||||
Class LogBacklogEntry <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Services.html">Services</a>.<a class="xref" href="EchoHub.Server.Services.ServerLogs.html">ServerLogs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A backlog entry read from the log file: one timestamped log line plus any continuation
|
||||
lines (exception stack traces) that followed it.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public record LogBacklogEntry : IEquatable<LogBacklogEntry></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">LogBacklogEntry</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><<a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</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.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.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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry__ctor_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry__ctor_EchoHub_Server_Services_ServerLogs_LogBacklogEntry_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.#ctor(EchoHub.Server.Services.ServerLogs.LogBacklogEntry)">
|
||||
LogBacklogEntry(LogBacklogEntry)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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 LogBacklogEntry(LogBacklogEntry original)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>original</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry__ctor_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry__ctor_System_DateTimeOffset_System_String_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.#ctor(System.DateTimeOffset,System.String)">
|
||||
LogBacklogEntry(DateTimeOffset, string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>A backlog entry read from the log file: one timestamped log line plus any continuation
|
||||
lines (exception stack traces) that followed it.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public LogBacklogEntry(DateTimeOffset Timestamp, string Content)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Timestamp</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Content_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Content*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Content" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Content">
|
||||
Content
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public string Content { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_EqualityContract_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.EqualityContract*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_EqualityContract" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.EqualityContract">
|
||||
EqualityContract
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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 Type EqualityContract { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Timestamp_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Timestamp*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Timestamp" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Timestamp">
|
||||
Timestamp
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public DateTimeOffset Timestamp { 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.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Deconstruct_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Deconstruct_System_DateTimeOffset__System_String__" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Deconstruct(System.DateTimeOffset@,System.String@)">
|
||||
Deconstruct(out DateTimeOffset, out string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public void Deconstruct(out DateTimeOffset Timestamp, out string Content)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Timestamp</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Equals_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Equals_EchoHub_Server_Services_ServerLogs_LogBacklogEntry_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Equals(EchoHub.Server.Services.ServerLogs.LogBacklogEntry)">
|
||||
Equals(LogBacklogEntry?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public virtual bool Equals(LogBacklogEntry? other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Equals_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_Equals_System_Object_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_GetHashCode_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_GetHashCode" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_PrintMembers_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.PrintMembers*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_PrintMembers_System_Text_StringBuilder_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.PrintMembers(System.Text.StringBuilder)">
|
||||
PrintMembers(StringBuilder)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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 bool PrintMembers(StringBuilder builder)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>builder</code> <span class="xref">StringBuilder</span></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_ToString_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_ToString" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_op_Equality_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_op_Equality_EchoHub_Server_Services_ServerLogs_LogBacklogEntry_EchoHub_Server_Services_ServerLogs_LogBacklogEntry_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.op_Equality(EchoHub.Server.Services.ServerLogs.LogBacklogEntry,EchoHub.Server.Services.ServerLogs.LogBacklogEntry)">
|
||||
operator ==(LogBacklogEntry?, LogBacklogEntry?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public static bool operator ==(LogBacklogEntry? left, LogBacklogEntry? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_op_Inequality_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_LogBacklogEntry_op_Inequality_EchoHub_Server_Services_ServerLogs_LogBacklogEntry_EchoHub_Server_Services_ServerLogs_LogBacklogEntry_" data-uid="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.op_Inequality(EchoHub.Server.Services.ServerLogs.LogBacklogEntry,EchoHub.Server.Services.ServerLogs.LogBacklogEntry)">
|
||||
operator !=(LogBacklogEntry?, LogBacklogEntry?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public static bool operator !=(LogBacklogEntry? left, LogBacklogEntry? right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,465 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ServerLogsService | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ServerLogsService | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Shared logic for the live log room: room identity, the role gate, and reading the backlog tail from the current rolling log file. The file stays the only persistence — log lines are never stored as messages.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Services_ServerLogs_ServerLogsService.md&value=---%0Auid%3A%20EchoHub.Server.Services.ServerLogs.ServerLogsService%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Services.ServerLogs.ServerLogsService">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Services_ServerLogs_ServerLogsService" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService" class="text-break">
|
||||
Class ServerLogsService <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Services.html">Services</a>.<a class="xref" href="EchoHub.Server.Services.ServerLogs.html">ServerLogs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Shared logic for the live log room: room identity, the role gate, and reading the backlog
|
||||
tail from the current rolling log file. The file stays the only persistence — log lines
|
||||
are never stored as messages.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class ServerLogsService</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">ServerLogsService</span></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.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsService__ctor_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsService__ctor_EchoHub_Server_Config_ServerLogsOptions_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.#ctor(EchoHub.Server.Config.ServerLogsOptions)">
|
||||
ServerLogsService(ServerLogsOptions)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public ServerLogsService(ServerLogsOptions options)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>options</code> <a class="xref" href="EchoHub.Server.Config.ServerLogsOptions.html">ServerLogsOptions</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsService_RoomTopic" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.RoomTopic">
|
||||
RoomTopic
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public const string RoomTopic = "Live server logs — read-only"</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsService_SenderName" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.SenderName">
|
||||
SenderName
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Username shown as the sender of streamed log messages.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const string SenderName = "server"</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsService_Options_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.Options*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsService_Options" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.Options">
|
||||
Options
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><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">public ServerLogsOptions Options { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Server.Config.ServerLogsOptions.html">ServerLogsOptions</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsService_CanView_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.CanView*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsService_CanView_EchoHub_Core_Models_ServerRole_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.CanView(EchoHub.Core.Models.ServerRole)">
|
||||
CanView(ServerRole)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Whether a user with this role may see and join the log room.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool CanView(ServerRole role)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>role</code> <a class="xref" href="../core/EchoHub.Core.Models.ServerRole.html">ServerRole</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsService_GroupIntoEntries_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.GroupIntoEntries*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsService_GroupIntoEntries_System_Collections_Generic_IReadOnlyList_System_String__System_Boolean_System_Int32_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.GroupIntoEntries(System.Collections.Generic.IReadOnlyList{System.String},System.Boolean,System.Int32)">
|
||||
GroupIntoEntries(IReadOnlyList<string>, bool, int)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Groups raw file lines into entries by their timestamp prefix. Public for tests.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IReadOnlyList<LogBacklogEntry> GroupIntoEntries(IReadOnlyList<string> lines, bool skipLeadingContinuations, int maxEntries)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>lines</code> <span class="xref">IReadOnlyList</span><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
|
||||
<dd></dd>
|
||||
<dt><code>skipLeadingContinuations</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>maxEntries</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">IReadOnlyList</span><<a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsService_IsLogsChannel_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.IsLogsChannel*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsService_IsLogsChannel_System_String_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.IsLogsChannel(System.String)">
|
||||
IsLogsChannel(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Whether the given channel is the (enabled) live log room.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool IsLogsChannel(string channelName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsService_ReadBacklog_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.ReadBacklog*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsService_ReadBacklog" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsService.ReadBacklog">
|
||||
ReadBacklog()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Reads the last <a class="xref" href="EchoHub.Server.Config.ServerLogsOptions.html#EchoHub_Server_Config_ServerLogsOptions_BacklogLines">BacklogLines</a> entries from the newest
|
||||
log file. A line starting with a timestamp begins a new entry; continuation lines
|
||||
(stack traces) stay attached to the entry above them. Best-effort: any I/O problem
|
||||
yields an empty backlog rather than failing the join.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IReadOnlyList<LogBacklogEntry> ReadBacklog()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">IReadOnlyList</span><<a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsService.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,289 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ServerLogsSink | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ServerLogsSink | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Serilog sink feeding the live log room. Events are queued in a bounded drop-oldest buffer and consumed by ; nothing is written to the database. Events emitted by the streaming pipeline itself (the stream service and SignalR transport internals) are dropped here so a broadcast that logs — e.g. a transport warning on a dead connection — can never enter a log → broadcast → log feedback loop.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Services_ServerLogs_ServerLogsSink.md&value=---%0Auid%3A%20EchoHub.Server.Services.ServerLogs.ServerLogsSink%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Services.ServerLogs.ServerLogsSink">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Services_ServerLogs_ServerLogsSink" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsSink" class="text-break">
|
||||
Class ServerLogsSink <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsSink.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Services.html">Services</a>.<a class="xref" href="EchoHub.Server.Services.ServerLogs.html">ServerLogs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Serilog sink feeding the live log room. Events are queued in a bounded drop-oldest buffer
|
||||
and consumed by <a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.html">ServerLogsStreamService</a>; nothing is written to the database.
|
||||
Events emitted by the streaming pipeline itself (the stream service and SignalR transport
|
||||
internals) are dropped here so a broadcast that logs — e.g. a transport warning on a dead
|
||||
connection — can never enter a log → broadcast → log feedback loop.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class ServerLogsSink : ILogEventSink</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">ServerLogsSink</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><span class="xref">ILogEventSink</span></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.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsSink__ctor_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsSink.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsSink__ctor_EchoHub_Server_Config_ServerLogsOptions_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsSink.#ctor(EchoHub.Server.Config.ServerLogsOptions)">
|
||||
ServerLogsSink(ServerLogsOptions)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsSink.cs"><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">public ServerLogsSink(ServerLogsOptions options)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>options</code> <a class="xref" href="EchoHub.Server.Config.ServerLogsOptions.html">ServerLogsOptions</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsSink_Reader_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsSink.Reader*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsSink_Reader" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsSink.Reader">
|
||||
Reader
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsSink.cs"><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">public ChannelReader<LogEvent> Reader { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">ChannelReader</span><<span class="xref">LogEvent</span>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsSink_Emit_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsSink.Emit*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsSink_Emit_Serilog_Events_LogEvent_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsSink.Emit(Serilog.Events.LogEvent)">
|
||||
Emit(LogEvent)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsSink.cs"><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">public void Emit(LogEvent logEvent)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>logEvent</code> <span class="xref">LogEvent</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsSink.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,306 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ServerLogsStreamService | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ServerLogsStreamService | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="Streams queued log events to the live log room as ephemeral messages: SignalR only (the IRC gateway never sees them) and no database rows. Ensures the room exists before streaming, recreating it on the fly if it was deleted. This class must never log from its streaming path — its namespace is excluded by as a second line of defense, but the primary rule is simply not to log per event, otherwise every streamed line would spawn another.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Services_ServerLogs_ServerLogsStreamService.md&value=---%0Auid%3A%20EchoHub.Server.Services.ServerLogs.ServerLogsStreamService%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Services_ServerLogs_ServerLogsStreamService" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService" class="text-break">
|
||||
Class ServerLogsStreamService <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsStreamService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Services.html">Services</a>.<a class="xref" href="EchoHub.Server.Services.ServerLogs.html">ServerLogs</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Streams queued log events to the live log room as ephemeral messages: SignalR only (the
|
||||
IRC gateway never sees them) and no database rows. Ensures the room exists before
|
||||
streaming, recreating it on the fly if it was deleted.</p>
|
||||
<p>This class must never log from its streaming path — its namespace is excluded by
|
||||
<a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsSink.html">ServerLogsSink</a> as a second line of defense, but the primary rule is simply
|
||||
not to log per event, otherwise every streamed line would spawn another.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class ServerLogsStreamService : BackgroundService, IDisposable</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">BackgroundService</span></div>
|
||||
<div><span class="xref">ServerLogsStreamService</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</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.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsStreamService__ctor_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsStreamService__ctor_EchoHub_Server_Services_ServerLogs_ServerLogsSink_EchoHub_Server_Config_ServerLogsOptions_EchoHub_Core_Contracts_IChannelService_EchoHub_Core_Contracts_IMessageEncryptionService_System_IServiceProvider_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.#ctor(EchoHub.Server.Services.ServerLogs.ServerLogsSink,EchoHub.Server.Config.ServerLogsOptions,EchoHub.Core.Contracts.IChannelService,EchoHub.Core.Contracts.IMessageEncryptionService,System.IServiceProvider)">
|
||||
ServerLogsStreamService(ServerLogsSink, ServerLogsOptions, IChannelService, IMessageEncryptionService, IServiceProvider)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsStreamService.cs"><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">public ServerLogsStreamService(ServerLogsSink sink, ServerLogsOptions options, IChannelService channelService, IMessageEncryptionService encryption, IServiceProvider serviceProvider)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>sink</code> <a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsSink.html">ServerLogsSink</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>options</code> <a class="xref" href="EchoHub.Server.Config.ServerLogsOptions.html">ServerLogsOptions</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>channelService</code> <a class="xref" href="../core/EchoHub.Core.Contracts.IChannelService.html">IChannelService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>encryption</code> <a class="xref" href="../core/EchoHub.Core.Contracts.IMessageEncryptionService.html">IMessageEncryptionService</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>serviceProvider</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iserviceprovider">IServiceProvider</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsStreamService_ExecuteAsync_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.ExecuteAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsStreamService_ExecuteAsync_System_Threading_CancellationToken_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.ExecuteAsync(System.Threading.CancellationToken)">
|
||||
ExecuteAsync(CancellationToken)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsStreamService.cs"><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 override Task ExecuteAsync(CancellationToken stoppingToken)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>stoppingToken</code> <span class="xref">CancellationToken</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_ServerLogs_ServerLogsStreamService_Format_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.Format*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_ServerLogs_ServerLogsStreamService_Format_Serilog_Events_LogEvent_" data-uid="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.Format(Serilog.Events.LogEvent)">
|
||||
Format(LogEvent)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsStreamService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Formats an event like the file sink's template, minus the timestamp (clients render their own). Public for tests.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string Format(LogEvent logEvent)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>logEvent</code> <span class="xref">LogEvent</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/ServerLogs/ServerLogsStreamService.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,154 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace EchoHub.Server.Services.ServerLogs | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace EchoHub.Server.Services.ServerLogs | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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 "{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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Services.ServerLogs">
|
||||
|
||||
<h1 id="EchoHub_Server_Services_ServerLogs" data-uid="EchoHub.Server.Services.ServerLogs" class="text-break">Namespace EchoHub.Server.Services.ServerLogs</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html">LogBacklogEntry</a></dt>
|
||||
<dd><p>A backlog entry read from the log file: one timestamped log line plus any continuation
|
||||
lines (exception stack traces) that followed it.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsService.html">ServerLogsService</a></dt>
|
||||
<dd><p>Shared logic for the live log room: room identity, the role gate, and reading the backlog
|
||||
tail from the current rolling log file. The file stays the only persistence — log lines
|
||||
are never stored as messages.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsSink.html">ServerLogsSink</a></dt>
|
||||
<dd><p>Serilog sink feeding the live log room. Events are queued in a bounded drop-oldest buffer
|
||||
and consumed by <a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.html">ServerLogsStreamService</a>; nothing is written to the database.
|
||||
Events emitted by the streaming pipeline itself (the stream service and SignalR transport
|
||||
internals) are dropped here so a broadcast that logs — e.g. a transport warning on a dead
|
||||
connection — can never enter a log → broadcast → log feedback loop.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.html">ServerLogsStreamService</a></dt>
|
||||
<dd><p>Streams queued log events to the live log room as ephemeral messages: SignalR only (the
|
||||
IRC gateway never sees them) and no database rows. Ensures the room exists before
|
||||
streaming, recreating it on the fly if it was deleted.</p>
|
||||
<p>This class must never log from its streaming path — its namespace is excluded by
|
||||
<a class="xref" href="EchoHub.Server.Services.ServerLogs.ServerLogsSink.html">ServerLogsSink</a> as a second line of defense, but the primary rule is simply
|
||||
not to log per event, otherwise every streamed line would spawn another.</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -233,6 +233,42 @@ Class SignalRBroadcaster <a class="header-action link-secondary" title="View so
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SignalRBroadcaster_SendChannelDeletedAsync_" data-uid="EchoHub.Server.Services.SignalRBroadcaster.SendChannelDeletedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SignalRBroadcaster_SendChannelDeletedAsync_System_String_" data-uid="EchoHub.Server.Services.SignalRBroadcaster.SendChannelDeletedAsync(System.String)">
|
||||
SendChannelDeletedAsync(string)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SignalRBroadcaster.cs"><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">public Task SendChannelDeletedAsync(string channelName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>channelName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">Task</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SignalRBroadcaster_SendChannelNukedAsync_" data-uid="EchoHub.Server.Services.SignalRBroadcaster.SendChannelNukedAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SignalRBroadcaster_SendChannelNukedAsync_System_String_" data-uid="EchoHub.Server.Services.SignalRBroadcaster.SendChannelNukedAsync(System.String)">
|
||||
@@ -385,16 +421,21 @@ Class SignalRBroadcaster <a class="header-action link-secondary" title="View so
|
||||
|
||||
<a id="EchoHub_Server_Services_SignalRBroadcaster_SendMessageToChannelAsync_" data-uid="EchoHub.Server.Services.SignalRBroadcaster.SendMessageToChannelAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SignalRBroadcaster_SendMessageToChannelAsync_System_String_EchoHub_Core_DTOs_MessageDto_" data-uid="EchoHub.Server.Services.SignalRBroadcaster.SendMessageToChannelAsync(System.String,EchoHub.Core.DTOs.MessageDto)">
|
||||
SendMessageToChannelAsync(string, MessageDto)
|
||||
<h3 id="EchoHub_Server_Services_SignalRBroadcaster_SendMessageToChannelAsync_System_String_EchoHub_Core_DTOs_MessageDto_System_String_" data-uid="EchoHub.Server.Services.SignalRBroadcaster.SendMessageToChannelAsync(System.String,EchoHub.Core.DTOs.MessageDto,System.String)">
|
||||
SendMessageToChannelAsync(string, MessageDto, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SignalRBroadcaster.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Broadcast a chat message to a channel. <code class="paramref">excludeConnectionId</code> is the
|
||||
connection the message originated from (IRC convention: never echo a message back to
|
||||
the connection that sent it — its client already displayed it locally). Other
|
||||
connections of the same user (e.g. an IRC session alongside a TUI session) still
|
||||
receive the message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task SendMessageToChannelAsync(string channelName, MessageDto message)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Task SendMessageToChannelAsync(string channelName, MessageDto message, string? excludeConnectionId = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -403,6 +444,8 @@ Class SignalRBroadcaster <a class="header-action link-secondary" title="View so
|
||||
<dd></dd>
|
||||
<dt><code>message</code> <a class="xref" href="../core/EchoHub.Core.DTOs.MessageDto.html">MessageDto</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>excludeConnectionId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -0,0 +1,379 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SpamGuard | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SpamGuard | EchoHub Documentation ">
|
||||
|
||||
<meta name="description" content="In-memory, per-user spam protection consulted from (messages, joins) and (channel creation), so every ingress protocol — SignalR and IRC alike — shares the same limits. State is per-process and never persisted; auto-mutes land in the normal mute store. Operates only on content the server already stores (for end-to-end encrypted rooms that is ciphertext) — nothing is decrypted.">
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Services_SpamGuard.md&value=---%0Auid%3A%20EchoHub.Server.Services.SpamGuard%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Services.SpamGuard">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Services_SpamGuard" data-uid="EchoHub.Server.Services.SpamGuard" class="text-break">
|
||||
Class SpamGuard <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Services.html">Services</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>In-memory, per-user spam protection consulted from <a class="xref" href="EchoHub.Server.Services.ChatService.html">ChatService</a> (messages,
|
||||
joins) and <a class="xref" href="EchoHub.Server.Services.ChannelService.html">ChannelService</a> (channel creation), so every ingress protocol —
|
||||
SignalR and IRC alike — shares the same limits. State is per-process and never persisted;
|
||||
auto-mutes land in the normal mute store. Operates only on content the server already
|
||||
stores (for end-to-end encrypted rooms that is ciphertext) — nothing is decrypted.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class SpamGuard</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">SpamGuard</span></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.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
<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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamGuard__ctor_" data-uid="EchoHub.Server.Services.SpamGuard.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamGuard__ctor_EchoHub_Server_Config_SpamOptions_" data-uid="EchoHub.Server.Services.SpamGuard.#ctor(EchoHub.Server.Config.SpamOptions)">
|
||||
SpamGuard(SpamOptions)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public SpamGuard(SpamOptions options)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>options</code> <a class="xref" href="EchoHub.Server.Config.SpamOptions.html">SpamOptions</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamGuard_Enabled_" data-uid="EchoHub.Server.Services.SpamGuard.Enabled*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamGuard_Enabled" data-uid="EchoHub.Server.Services.SpamGuard.Enabled">
|
||||
Enabled
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public bool Enabled { get; }</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="EchoHub_Server_Services_SpamGuard_CheckChannelCreate_" data-uid="EchoHub.Server.Services.SpamGuard.CheckChannelCreate*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamGuard_CheckChannelCreate_System_Guid_EchoHub_Core_Models_ServerRole_System_Nullable_System_DateTimeOffset__" data-uid="EchoHub.Server.Services.SpamGuard.CheckChannelCreate(System.Guid,EchoHub.Core.Models.ServerRole,System.Nullable{System.DateTimeOffset})">
|
||||
CheckChannelCreate(Guid, ServerRole, DateTimeOffset?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Checks a channel creation. Rejections count as violations but never auto-mute.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SpamVerdict CheckChannelCreate(Guid userId, ServerRole role, DateTimeOffset? nowOverride = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>userId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>role</code> <a class="xref" href="../core/EchoHub.Core.Models.ServerRole.html">ServerRole</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>nowOverride</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamGuard_CheckJoin_" data-uid="EchoHub.Server.Services.SpamGuard.CheckJoin*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamGuard_CheckJoin_System_Guid_EchoHub_Core_Models_ServerRole_System_Nullable_System_DateTimeOffset__" data-uid="EchoHub.Server.Services.SpamGuard.CheckJoin(System.Guid,EchoHub.Core.Models.ServerRole,System.Nullable{System.DateTimeOffset})">
|
||||
CheckJoin(Guid, ServerRole, DateTimeOffset?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Checks a channel join. Rejections count as violations but never auto-mute.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SpamVerdict CheckJoin(Guid userId, ServerRole role, DateTimeOffset? nowOverride = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>userId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>role</code> <a class="xref" href="../core/EchoHub.Core.Models.ServerRole.html">ServerRole</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>nowOverride</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamGuard_CheckMessage_" data-uid="EchoHub.Server.Services.SpamGuard.CheckMessage*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamGuard_CheckMessage_System_Guid_EchoHub_Core_Models_ServerRole_System_String_System_Nullable_System_DateTimeOffset__" data-uid="EchoHub.Server.Services.SpamGuard.CheckMessage(System.Guid,EchoHub.Core.Models.ServerRole,System.String,System.Nullable{System.DateTimeOffset})">
|
||||
CheckMessage(Guid, ServerRole, string, DateTimeOffset?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Checks a message send. Rejections count as violations; enough violations inside the
|
||||
violation window escalate to <a class="xref" href="EchoHub.Server.Services.SpamVerdictKind.html#EchoHub_Server_Services_SpamVerdictKind_AutoMute">AutoMute</a> (evaluated only on
|
||||
rejected messages, so a clean message never mutes anyone).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public SpamVerdict CheckMessage(Guid userId, ServerRole role, string content, DateTimeOffset? nowOverride = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>userId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>role</code> <a class="xref" href="../core/EchoHub.Core.Models.ServerRole.html">ServerRole</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>content</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>nowOverride</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetimeoffset">DateTimeOffset</a>?</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,586 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Struct SpamVerdict | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Struct SpamVerdict | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Services_SpamVerdict.md&value=---%0Auid%3A%20EchoHub.Server.Services.SpamVerdict%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Services.SpamVerdict">
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Services_SpamVerdict" data-uid="EchoHub.Server.Services.SpamVerdict" class="text-break">
|
||||
Struct SpamVerdict <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Services.html">Services</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public readonly struct SpamVerdict : IEquatable<SpamVerdict></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</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.gettype">object.GetType()</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.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict__ctor_" data-uid="EchoHub.Server.Services.SpamVerdict.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict__ctor_EchoHub_Server_Services_SpamVerdictKind_System_String_System_TimeSpan_" data-uid="EchoHub.Server.Services.SpamVerdict.#ctor(EchoHub.Server.Services.SpamVerdictKind,System.String,System.TimeSpan)">
|
||||
SpamVerdict(SpamVerdictKind, string?, TimeSpan)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public SpamVerdict(SpamVerdictKind Kind, string? Reason = null, TimeSpan MuteDuration = default)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Kind</code> <a class="xref" href="EchoHub.Server.Services.SpamVerdictKind.html">SpamVerdictKind</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Reason</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>MuteDuration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_Allowed" data-uid="EchoHub.Server.Services.SpamVerdict.Allowed">
|
||||
Allowed
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public static readonly SpamVerdict Allowed</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_Kind_" data-uid="EchoHub.Server.Services.SpamVerdict.Kind*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_Kind" data-uid="EchoHub.Server.Services.SpamVerdict.Kind">
|
||||
Kind
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public SpamVerdictKind Kind { get; init; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SpamVerdictKind.html">SpamVerdictKind</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_MuteDuration_" data-uid="EchoHub.Server.Services.SpamVerdict.MuteDuration*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_MuteDuration" data-uid="EchoHub.Server.Services.SpamVerdict.MuteDuration">
|
||||
MuteDuration
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public TimeSpan MuteDuration { 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.timespan">TimeSpan</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_Reason_" data-uid="EchoHub.Server.Services.SpamVerdict.Reason*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_Reason" data-uid="EchoHub.Server.Services.SpamVerdict.Reason">
|
||||
Reason
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public string? Reason { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_Deconstruct_" data-uid="EchoHub.Server.Services.SpamVerdict.Deconstruct*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_Deconstruct_EchoHub_Server_Services_SpamVerdictKind__System_String__System_TimeSpan__" data-uid="EchoHub.Server.Services.SpamVerdict.Deconstruct(EchoHub.Server.Services.SpamVerdictKind@,System.String@,System.TimeSpan@)">
|
||||
Deconstruct(out SpamVerdictKind, out string?, out TimeSpan)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public void Deconstruct(out SpamVerdictKind Kind, out string? Reason, out TimeSpan MuteDuration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>Kind</code> <a class="xref" href="EchoHub.Server.Services.SpamVerdictKind.html">SpamVerdictKind</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>Reason</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>MuteDuration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_Equals_" data-uid="EchoHub.Server.Services.SpamVerdict.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_Equals_EchoHub_Server_Services_SpamVerdict_" data-uid="EchoHub.Server.Services.SpamVerdict.Equals(EchoHub.Server.Services.SpamVerdict)">
|
||||
Equals(SpamVerdict)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public bool Equals(SpamVerdict other)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>other</code> <a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_Equals_" data-uid="EchoHub.Server.Services.SpamVerdict.Equals*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_Equals_System_Object_" data-uid="EchoHub.Server.Services.SpamVerdict.Equals(System.Object)">
|
||||
Equals(object)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public override bool Equals(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_GetHashCode_" data-uid="EchoHub.Server.Services.SpamVerdict.GetHashCode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_GetHashCode" data-uid="EchoHub.Server.Services.SpamVerdict.GetHashCode">
|
||||
GetHashCode()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public override int GetHashCode()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_ToString_" data-uid="EchoHub.Server.Services.SpamVerdict.ToString*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_ToString" data-uid="EchoHub.Server.Services.SpamVerdict.ToString">
|
||||
ToString()
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_op_Equality_" data-uid="EchoHub.Server.Services.SpamVerdict.op_Equality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_op_Equality_EchoHub_Server_Services_SpamVerdict_EchoHub_Server_Services_SpamVerdict_" data-uid="EchoHub.Server.Services.SpamVerdict.op_Equality(EchoHub.Server.Services.SpamVerdict,EchoHub.Server.Services.SpamVerdict)">
|
||||
operator ==(SpamVerdict, SpamVerdict)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public static bool operator ==(SpamVerdict left, SpamVerdict right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_SpamVerdict_op_Inequality_" data-uid="EchoHub.Server.Services.SpamVerdict.op_Inequality*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_SpamVerdict_op_Inequality_EchoHub_Server_Services_SpamVerdict_EchoHub_Server_Services_SpamVerdict_" data-uid="EchoHub.Server.Services.SpamVerdict.op_Inequality(EchoHub.Server.Services.SpamVerdict,EchoHub.Server.Services.SpamVerdict)">
|
||||
operator !=(SpamVerdict, SpamVerdict)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><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">public static bool operator !=(SpamVerdict left, SpamVerdict right)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>left</code> <a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>right</code> <a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></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/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,157 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Enum SpamVerdictKind | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Enum SpamVerdictKind | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/new/master/apiSpec/new?filename=EchoHub_Server_Services_SpamVerdictKind.md&value=---%0Auid%3A%20EchoHub.Server.Services.SpamVerdictKind%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="../../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="EchoHub.Server.Services.SpamVerdictKind">
|
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="EchoHub_Server_Services_SpamVerdictKind" data-uid="EchoHub.Server.Services.SpamVerdictKind" class="text-break">
|
||||
Enum SpamVerdictKind <a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="EchoHub.html">EchoHub</a>.<a class="xref" href="EchoHub.Server.html">Server</a>.<a class="xref" href="EchoHub.Server.Services.html">Services</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>EchoHub.Server.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum SpamVerdictKind</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="fields">Fields
|
||||
</h2>
|
||||
<dl class="parameters">
|
||||
<dt id="EchoHub_Server_Services_SpamVerdictKind_Allowed"><code>Allowed = 0</code></dt>
|
||||
|
||||
<dd></dd>
|
||||
<dt id="EchoHub_Server_Services_SpamVerdictKind_AutoMute"><code>AutoMute = 2</code></dt>
|
||||
|
||||
<dd><p>The user crossed the violation threshold — the caller should apply a timed mute.</p>
|
||||
</dd>
|
||||
<dt id="EchoHub_Server_Services_SpamVerdictKind_Rejected"><code>Rejected = 1</code></dt>
|
||||
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/SpamGuard.cs" class="edit-link">Edit this page</a>
|
||||
</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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
@@ -160,8 +160,8 @@ Class UserService <a class="header-action link-secondary" title="View source" h
|
||||
|
||||
<a id="EchoHub_Server_Services_UserService__ctor_" data-uid="EchoHub.Server.Services.UserService.#ctor*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_UserService__ctor_Microsoft_Extensions_DependencyInjection_IServiceScopeFactory_" data-uid="EchoHub.Server.Services.UserService.#ctor(Microsoft.Extensions.DependencyInjection.IServiceScopeFactory)">
|
||||
UserService(IServiceScopeFactory)
|
||||
<h3 id="EchoHub_Server_Services_UserService__ctor_Microsoft_Extensions_DependencyInjection_IServiceScopeFactory_Microsoft_Extensions_Configuration_IConfiguration_" data-uid="EchoHub.Server.Services.UserService.#ctor(Microsoft.Extensions.DependencyInjection.IServiceScopeFactory,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
UserService(IServiceScopeFactory, IConfiguration)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/UserService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -169,13 +169,15 @@ Class UserService <a class="header-action link-secondary" title="View source" h
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public UserService(IServiceScopeFactory scopeFactory)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public UserService(IServiceScopeFactory scopeFactory, IConfiguration configuration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>scopeFactory</code> <span class="xref">IServiceScopeFactory</span></dt>
|
||||
<dd></dd>
|
||||
<dt><code>configuration</code> <span class="xref">IConfiguration</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -189,6 +191,42 @@ Class UserService <a class="header-action link-secondary" title="View source" h
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="EchoHub_Server_Services_UserService_RegistrationMode_" data-uid="EchoHub.Server.Services.UserService.RegistrationMode*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_UserService_RegistrationMode" data-uid="EchoHub.Server.Services.UserService.RegistrationMode">
|
||||
RegistrationMode
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/UserService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Registration mode from config: "open" (default), "invite", or "closed".</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string RegistrationMode { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
@@ -305,8 +343,8 @@ Class UserService <a class="header-action link-secondary" title="View source" h
|
||||
|
||||
<a id="EchoHub_Server_Services_UserService_RegisterUserAsync_" data-uid="EchoHub.Server.Services.UserService.RegisterUserAsync*"></a>
|
||||
|
||||
<h3 id="EchoHub_Server_Services_UserService_RegisterUserAsync_System_String_System_String_System_String_" data-uid="EchoHub.Server.Services.UserService.RegisterUserAsync(System.String,System.String,System.String)">
|
||||
RegisterUserAsync(string, string, string?)
|
||||
<h3 id="EchoHub_Server_Services_UserService_RegisterUserAsync_System_String_System_String_System_String_System_String_" data-uid="EchoHub.Server.Services.UserService.RegisterUserAsync(System.String,System.String,System.String,System.String)">
|
||||
RegisterUserAsync(string, string, string?, string?)
|
||||
<a class="header-action link-secondary" title="View source" href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/Services/UserService.cs"><i class="bi bi-code-slash"></i></a>
|
||||
</h3>
|
||||
|
||||
@@ -314,7 +352,7 @@ Class UserService <a class="header-action link-secondary" title="View source" h
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Task<UserOperationResult> RegisterUserAsync(string username, string password, string? displayName = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Task<UserOperationResult> RegisterUserAsync(string username, string password, string? displayName = null, string? inviteCode = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -325,6 +363,8 @@ Class UserService <a class="header-action link-secondary" title="View source" h
|
||||
<dd></dd>
|
||||
<dt><code>displayName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>inviteCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
|
||||
@@ -147,10 +147,33 @@ status (success/failure code, conflicting hosts) for operator-facing endpoints.<
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SignalRBroadcaster.html">SignalRBroadcaster</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SpamGuard.html">SpamGuard</a></dt>
|
||||
<dd><p>In-memory, per-user spam protection consulted from <a class="xref" href="EchoHub.Server.Services.ChatService.html">ChatService</a> (messages,
|
||||
joins) and <a class="xref" href="EchoHub.Server.Services.ChannelService.html">ChannelService</a> (channel creation), so every ingress protocol —
|
||||
SignalR and IRC alike — shares the same limits. State is per-process and never persisted;
|
||||
auto-mutes land in the normal mute store. Operates only on content the server already
|
||||
stores (for end-to-end encrypted rooms that is ciphertext) — nothing is decrypted.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.UserService.html">UserService</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<h3 id="structs">
|
||||
Structs
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SpamVerdict.html">SpamVerdict</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<h3 id="enums">
|
||||
Enums
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="EchoHub.Server.Services.SpamVerdictKind.html">SpamVerdictKind</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
@@ -168,6 +168,12 @@
|
||||
<a href="client/EchoHub.Client.UI.Chat.html" name="" title="EchoHub.Client.UI.Chat">EchoHub.Client.UI.Chat</a>
|
||||
|
||||
<ul class="nav level4">
|
||||
<li>
|
||||
<a href="client/EchoHub.Client.UI.Chat.AttachmentAction.html" name="" title="AttachmentAction">AttachmentAction</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="client/EchoHub.Client.UI.Chat.AttachmentActionSpan.html" name="" title="AttachmentActionSpan">AttachmentActionSpan</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="client/EchoHub.Client.UI.Chat.ChatColors.html" name="" title="ChatColors">ChatColors</a>
|
||||
</li>
|
||||
@@ -307,6 +313,9 @@
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.Constants.HubConstants.html" name="" title="HubConstants">HubConstants</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.Constants.MessageConventions.html" name="" title="MessageConventions">MessageConventions</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.Constants.ValidationConstants.html" name="" title="ValidationConstants">ValidationConstants</a>
|
||||
</li>
|
||||
@@ -381,6 +390,12 @@
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.CreateChannelRequest.html" name="" title="CreateChannelRequest">CreateChannelRequest</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.CreateInviteRequest.html" name="" title="CreateInviteRequest">CreateInviteRequest</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.DeleteAccountRequest.html" name="" title="DeleteAccountRequest">DeleteAccountRequest</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.EmbedDto.html" name="" title="EmbedDto">EmbedDto</a>
|
||||
</li>
|
||||
@@ -390,6 +405,15 @@
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.ErrorResponse.html" name="" title="ErrorResponse">ErrorResponse</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.ExportedAttachmentDto.html" name="" title="ExportedAttachmentDto">ExportedAttachmentDto</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.ExportedMessageDto.html" name="" title="ExportedMessageDto">ExportedMessageDto</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.InviteDto.html" name="" title="InviteDto">InviteDto</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.JoinChannelResult.html" name="" title="JoinChannelResult">JoinChannelResult</a>
|
||||
</li>
|
||||
@@ -420,6 +444,9 @@
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.RekeyChannelRequest.html" name="" title="RekeyChannelRequest">RekeyChannelRequest</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.ReplyRefDto.html" name="" title="ReplyRefDto">ReplyRefDto</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.SendMessageRequest.html" name="" title="SendMessageRequest">SendMessageRequest</a>
|
||||
</li>
|
||||
@@ -438,6 +465,9 @@
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.UpdateTopicRequest.html" name="" title="UpdateTopicRequest">UpdateTopicRequest</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.UserDataExportDto.html" name="" title="UserDataExportDto">UserDataExportDto</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.DTOs.UserDto.html" name="" title="UserDto">UserDto</a>
|
||||
</li>
|
||||
@@ -472,6 +502,9 @@
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.Models.ChannelMembership.html" name="" title="ChannelMembership">ChannelMembership</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.Models.InviteCode.html" name="" title="InviteCode">InviteCode</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.Models.Message.html" name="" title="Message">Message</a>
|
||||
</li>
|
||||
@@ -510,6 +543,9 @@
|
||||
<a href="core/EchoHub.Core.Services.html" name="" title="EchoHub.Core.Services">EchoHub.Core.Services</a>
|
||||
|
||||
<ul class="nav level4">
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.Services.AsciiBannerService.html" name="" title="AsciiBannerService">AsciiBannerService</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="core/EchoHub.Core.Services.FileValidationHelper.html" name="" title="FileValidationHelper">FileValidationHelper</a>
|
||||
</li>
|
||||
@@ -557,6 +593,12 @@
|
||||
<a href="server/EchoHub.Server.Config.html" name="" title="EchoHub.Server.Config">EchoHub.Server.Config</a>
|
||||
|
||||
<ul class="nav level4">
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Config.ServerLogsOptions.html" name="" title="ServerLogsOptions">ServerLogsOptions</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Config.SpamOptions.html" name="" title="SpamOptions">SpamOptions</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Config.UploadLimits.html" name="" title="UploadLimits">UploadLimits</a>
|
||||
</li>
|
||||
@@ -576,6 +618,9 @@
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Controllers.FilesController.html" name="" title="FilesController">FilesController</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Controllers.InvitesController.html" name="" title="InvitesController">InvitesController</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Controllers.ModerationController.html" name="" title="ModerationController">ModerationController</a>
|
||||
</li>
|
||||
@@ -611,6 +656,9 @@
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Data.Migrations.AddChannelIsPublic.html" name="" title="AddChannelIsPublic">AddChannelIsPublic</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Data.Migrations.AddChannelIsSystem.html" name="" title="AddChannelIsSystem">AddChannelIsSystem</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Data.Migrations.AddChannelMembership.html" name="" title="AddChannelMembership">AddChannelMembership</a>
|
||||
</li>
|
||||
@@ -620,6 +668,9 @@
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Data.Migrations.AddEncryptionSupport.html" name="" title="AddEncryptionSupport">AddEncryptionSupport</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Data.Migrations.AddInvitesAndReplies.html" name="" title="AddInvitesAndReplies">AddInvitesAndReplies</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Data.Migrations.AddMessageAttachments.html" name="" title="AddMessageAttachments">AddMessageAttachments</a>
|
||||
</li>
|
||||
@@ -685,11 +736,39 @@
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.SignalRBroadcaster.html" name="" title="SignalRBroadcaster">SignalRBroadcaster</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.SpamGuard.html" name="" title="SpamGuard">SpamGuard</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.SpamVerdict.html" name="" title="SpamVerdict">SpamVerdict</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.SpamVerdictKind.html" name="" title="SpamVerdictKind">SpamVerdictKind</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.UserService.html" name="" title="UserService">UserService</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="server/EchoHub.Server.Services.ServerLogs.html" name="" title="EchoHub.Server.Services.ServerLogs">EchoHub.Server.Services.ServerLogs</a>
|
||||
|
||||
<ul class="nav level4">
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html" name="" title="LogBacklogEntry">LogBacklogEntry</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.ServerLogs.ServerLogsService.html" name="" title="ServerLogsService">ServerLogsService</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.ServerLogs.ServerLogsSink.html" name="" title="ServerLogsSink">ServerLogsSink</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="server/EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.html" name="" title="ServerLogsStreamService">ServerLogsStreamService</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<span class="expand-stub"></span>
|
||||
<a href="server/EchoHub.Server.Setup.html" name="" title="EchoHub.Server.Setup">EchoHub.Server.Setup</a>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+144
-3
@@ -247,15 +247,30 @@ export Server__PublicServer=true
|
||||
<td>Register on the <a href="https://echohub.voidcube.cloud/servers">public directory</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Server:PublicHost</code></td>
|
||||
<td><em>(empty)</em></td>
|
||||
<td>Public hostname for the directory listing (e.g. <code>chat.example.com:5000</code>)</td>
|
||||
<td><code>Server:PublicHosts</code></td>
|
||||
<td><code>[]</code></td>
|
||||
<td>Hostnames advertised to the directory (array, e.g. <code>["chat.example.com"]</code>). Required when <code>PublicServer</code> is <code>true</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Server:Tags</code></td>
|
||||
<td><code>[]</code></td>
|
||||
<td>Topic tags surfaced in the directory browser (array, e.g. <code>["community", "gaming"]</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Server:Admins</code></td>
|
||||
<td><code>[]</code></td>
|
||||
<td>Array of admin usernames (e.g. <code>["alice", "bob"]</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Server:Registration</code></td>
|
||||
<td><code>open</code></td>
|
||||
<td>Registration mode: <code>open</code>, <code>invite</code> (codes via <code>/invite</code>, Admin+), or <code>closed</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Server:DirectoryClaimPath</code></td>
|
||||
<td><em>(empty)</em></td>
|
||||
<td>Overrides where the directory claim token file is stored. Empty = <code>directory-claim.json</code> next to the SQLite database. Treat it as a secret and back it up with the database</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="uploads">Uploads</h3>
|
||||
@@ -300,6 +315,76 @@ absent or partial <code>Uploads</code> section keeps the built-in defaults. See
|
||||
</table>
|
||||
<p>The server sizes its request-body limits from these values, so raising a limit here is all
|
||||
that's needed — no separate Kestrel tuning.</p>
|
||||
<h3 id="spam-protection">Spam Protection</h3>
|
||||
<p>Per-user flood, duplicate, join, and channel-create limits with auto-mute escalation. Mods and
|
||||
above are always exempt, and the defaults are lenient enough that a fast typist never trips them.
|
||||
An absent or partial <code>Spam</code> section keeps these defaults.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Key</th>
|
||||
<th>Default</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Spam:Enabled</code></td>
|
||||
<td><code>true</code></td>
|
||||
<td>Master switch for all spam protection</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:MaxMessagesPerWindow</code></td>
|
||||
<td><code>8</code></td>
|
||||
<td>Max messages per <code>WindowSeconds</code> before a send is rejected</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:WindowSeconds</code></td>
|
||||
<td><code>5</code></td>
|
||||
<td>Sliding window (seconds) for the message-rate check</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:MaxDuplicateMessages</code></td>
|
||||
<td><code>3</code></td>
|
||||
<td>Identical messages in a row tolerated before rejection (E2E rooms are exempt — ciphertext differs each time)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:AutoMuteMinutes</code></td>
|
||||
<td><code>5</code></td>
|
||||
<td>Auto-mute duration once a user hits the violation threshold. <code>0</code> disables auto-mute (rejections still apply)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:ViolationThreshold</code></td>
|
||||
<td><code>5</code></td>
|
||||
<td>Rejected sends within <code>ViolationWindowMinutes</code> that trigger an auto-mute</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:ViolationWindowMinutes</code></td>
|
||||
<td><code>5</code></td>
|
||||
<td>Window (minutes) over which violations accumulate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:MaxJoinsPerWindow</code></td>
|
||||
<td><code>25</code></td>
|
||||
<td>Max first-time channel joins per <code>JoinWindowSeconds</code> — keep this above your public channel count</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:JoinWindowSeconds</code></td>
|
||||
<td><code>30</code></td>
|
||||
<td>Sliding window (seconds) for the join-rate check</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:MaxChannelCreatesPerWindow</code></td>
|
||||
<td><code>3</code></td>
|
||||
<td>Max channel creations per <code>ChannelCreateWindowMinutes</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spam:ChannelCreateWindowMinutes</code></td>
|
||||
<td><code>10</code></td>
|
||||
<td>Window (minutes) for the channel-create check</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="encryption">Encryption</h3>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -333,6 +418,11 @@ that's needed — no separate Kestrel tuning.</p>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Storage:Path</code></td>
|
||||
<td><em>(empty)</em></td>
|
||||
<td>Directory for uploaded file blobs (attachments, avatars). Empty = <code>uploads/</code> in the app directory; the Docker image sets it to <code>/app/data/uploads</code> on the persistent volume</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Storage:CleanupIntervalHours</code></td>
|
||||
<td><code>1</code></td>
|
||||
<td>How often the cleanup job runs (hours)</td>
|
||||
@@ -396,6 +486,57 @@ that's needed — no separate Kestrel tuning.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="server-logs-room">Server Logs Room</h3>
|
||||
<p>When enabled, EchoHub auto-creates a read-only system channel and streams log events to it live,
|
||||
so operators can watch the server from inside the app. Log lines are <strong>never stored as messages</strong> —
|
||||
the rolling Serilog files remain the only persistence, and the room replays recent lines from those
|
||||
files when someone opens it.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Key</th>
|
||||
<th>Default</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>ServerLogs:Enabled</code></td>
|
||||
<td><code>true</code></td>
|
||||
<td>Master switch for the live log room</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ServerLogs:RoomName</code></td>
|
||||
<td><code>server-logs</code></td>
|
||||
<td>Name of the auto-created channel (reserved — users can't create a channel with this name)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ServerLogs:MinRole</code></td>
|
||||
<td><code>Mod</code></td>
|
||||
<td>Minimum server role that can see and join the room (<code>Member</code>, <code>Mod</code>, <code>Admin</code>, <code>Owner</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ServerLogs:MinLevel</code></td>
|
||||
<td><code>Information</code></td>
|
||||
<td>Minimum log level streamed to the room (<code>Verbose</code>, <code>Debug</code>, <code>Information</code>, <code>Warning</code>, <code>Error</code>, <code>Fatal</code>) — affects only the room, not the file/console sinks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ServerLogs:BacklogLines</code></td>
|
||||
<td><code>100</code></td>
|
||||
<td>Recent log lines replayed from file when someone opens the room</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ServerLogs:LogDirectory</code></td>
|
||||
<td><code>logs</code></td>
|
||||
<td>Directory holding the rolling log files (must match the Serilog file sink path below)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ServerLogs:LogFilePattern</code></td>
|
||||
<td><code>echohub-server-*.log</code></td>
|
||||
<td>Filename glob for the rolling log files inside <code>LogDirectory</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="logging">Logging</h3>
|
||||
<p>EchoHub uses <a href="https://serilog.net/">Serilog</a> for structured logging — console output + daily rolling files with 14-day retention by default.</p>
|
||||
<table>
|
||||
|
||||
@@ -90,6 +90,7 @@
|
||||
<p>Release history for EchoHub.</p>
|
||||
<h2 id="releases">Releases</h2>
|
||||
<ul>
|
||||
<li><a href="v0.2.15.html">v0.2.15</a> - Invite Codes, Data Export & Deletion, /me, /banner, Replies, Open Images In Browser & IRC Image Links</li>
|
||||
<li><a href="v0.2.14.html">v0.2.14</a> - Clipboard Image & Multi-File Paste, E2E Room Unlock Fixes, Encrypted Key Cache & IRC Gateway Polish</li>
|
||||
<li><a href="v0.2.13.html">v0.2.13</a> - Chat Visual Overhaul, Auto-Join All Channels & Persistent Read Positions</li>
|
||||
<li><a href="v0.2.12.html">v0.2.12</a> - End-to-End Encrypted Channels, IRC Channel Keys, Image Save & Ctrl+W Crash Fix</li>
|
||||
|
||||
@@ -15,6 +15,9 @@
|
||||
<li>
|
||||
<a href="index.html" name="" title="Overview">Overview</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="v0.2.15.html" name="" title="v0.2.15">v0.2.15</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="v0.2.14.html" name="" title="v0.2.14">v0.2.14</a>
|
||||
</li>
|
||||
|
||||
+1
-1
@@ -1,2 +1,2 @@
|
||||
|
||||
{"items":[{"name":"Overview","href":"index.html","topicHref":"index.html"},{"name":"v0.2.14","href":"v0.2.14.html","topicHref":"v0.2.14.html"},{"name":"v0.2.13","href":"v0.2.13.html","topicHref":"v0.2.13.html"},{"name":"v0.2.12","href":"v0.2.12.html","topicHref":"v0.2.12.html"},{"name":"v0.2.11","href":"v0.2.11.html","topicHref":"v0.2.11.html"},{"name":"v0.2.10","href":"v0.2.10.html","topicHref":"v0.2.10.html"},{"name":"v0.2.9","href":"v0.2.9.html","topicHref":"v0.2.9.html"},{"name":"v0.2.8","href":"v0.2.8.html","topicHref":"v0.2.8.html"},{"name":"v0.2.7","href":"v0.2.7.html","topicHref":"v0.2.7.html"},{"name":"v0.2.6","href":"v0.2.6.html","topicHref":"v0.2.6.html"},{"name":"v0.2.5","href":"v0.2.5.html","topicHref":"v0.2.5.html"},{"name":"v0.2.4","href":"v0.2.4.html","topicHref":"v0.2.4.html"},{"name":"v0.2.3","href":"v0.2.3.html","topicHref":"v0.2.3.html"},{"name":"v0.2.2","href":"v0.2.2.html","topicHref":"v0.2.2.html"},{"name":"v0.2.1","href":"v0.2.1.html","topicHref":"v0.2.1.html"},{"name":"v0.2.0","href":"v0.2.0.html","topicHref":"v0.2.0.html"},{"name":"v0.1.1","href":"v0.1.1.html","topicHref":"v0.1.1.html"},{"name":"v0.1.0","href":"v0.1.0.html","topicHref":"v0.1.0.html"}]}
|
||||
{"items":[{"name":"Overview","href":"index.html","topicHref":"index.html"},{"name":"v0.2.15","href":"v0.2.15.html","topicHref":"v0.2.15.html"},{"name":"v0.2.14","href":"v0.2.14.html","topicHref":"v0.2.14.html"},{"name":"v0.2.13","href":"v0.2.13.html","topicHref":"v0.2.13.html"},{"name":"v0.2.12","href":"v0.2.12.html","topicHref":"v0.2.12.html"},{"name":"v0.2.11","href":"v0.2.11.html","topicHref":"v0.2.11.html"},{"name":"v0.2.10","href":"v0.2.10.html","topicHref":"v0.2.10.html"},{"name":"v0.2.9","href":"v0.2.9.html","topicHref":"v0.2.9.html"},{"name":"v0.2.8","href":"v0.2.8.html","topicHref":"v0.2.8.html"},{"name":"v0.2.7","href":"v0.2.7.html","topicHref":"v0.2.7.html"},{"name":"v0.2.6","href":"v0.2.6.html","topicHref":"v0.2.6.html"},{"name":"v0.2.5","href":"v0.2.5.html","topicHref":"v0.2.5.html"},{"name":"v0.2.4","href":"v0.2.4.html","topicHref":"v0.2.4.html"},{"name":"v0.2.3","href":"v0.2.3.html","topicHref":"v0.2.3.html"},{"name":"v0.2.2","href":"v0.2.2.html","topicHref":"v0.2.2.html"},{"name":"v0.2.1","href":"v0.2.1.html","topicHref":"v0.2.1.html"},{"name":"v0.2.0","href":"v0.2.0.html","topicHref":"v0.2.0.html"},{"name":"v0.1.1","href":"v0.1.1.html","topicHref":"v0.1.1.html"},{"name":"v0.1.0","href":"v0.1.0.html","topicHref":"v0.1.0.html"}]}
|
||||
|
||||
@@ -0,0 +1,192 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>v0.2.15 | EchoHub Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="v0.2.15 | EchoHub Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../images/hue_icon.svg">
|
||||
<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="docfx:docurl" content="https://github.com/HueByte/EchoHub/blob/master/docs/#L1">
|
||||
<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="">
|
||||
<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="../images/hue_icon.svg" alt="EchoHub">
|
||||
EchoHub
|
||||
</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="">
|
||||
<h1 id="v0215">v0.2.15</h1>
|
||||
|
||||
<p>A big one. Server owners can gate registration behind invite codes, users can export or delete
|
||||
everything the server holds about them, and chat gets three classics — <code>/me</code> actions that
|
||||
interop natively with IRC, <code>/banner</code> ASCII text, and message replies with quote rendering and
|
||||
jump-to-original. Images become properly shareable: every image gets an <strong>[open]</strong> action that
|
||||
views it in your browser (or, in end-to-end encrypted rooms, decrypts and opens it locally).
|
||||
The IRC gateway stops painting ANSI art nobody asked for and posts plain image links any IRC
|
||||
client can open or auto-preview. And a long-standing dual-session annoyance is fixed: messages
|
||||
you send from the TUI now reach your own connected IRC client instantly.</p>
|
||||
<h2 id="new-features">New Features</h2>
|
||||
<ul>
|
||||
<li><strong>Invite-gated registration</strong> — set <code>Server:Registration</code> to <code>"invite"</code> (or <code>"closed"</code>) in
|
||||
<code>appsettings.json</code> and new accounts require a valid invite code; the default <code>"open"</code> keeps
|
||||
today's behavior. Admins mint codes with <code>/invite [uses] [hours]</code> (single-use, never-expiring
|
||||
by default), list them with <code>/invite list</code>, and revoke with <code>/invite revoke <code></code>. Codes are
|
||||
unguessable (<code>K7QM-3XPF</code> style), stored only in your server's own database, and consumed
|
||||
atomically so a code's last use can't be taken twice. The IRC gateway respects the gate too:
|
||||
unknown nicknames connecting to an invite-only server get a clear error instead of a silent
|
||||
auto-registered account. The very first account (server owner bootstrap) is always allowed.</li>
|
||||
<li><strong>Data export</strong> — <code>/export</code> downloads everything the server stores about you (profile, your
|
||||
messages, attachment metadata) as JSON into your download folder. Content from end-to-end
|
||||
encrypted rooms appears as ciphertext, because the server never had the plaintext — "you own
|
||||
the data", demonstrably.</li>
|
||||
<li><strong>Account deletion</strong> — <code>/deleteaccount</code> permanently removes your account after a typed
|
||||
confirmation and password re-check: profile, sessions, and every file you uploaded are
|
||||
deleted. Your messages remain (deleting them would gut other people's conversations) but are
|
||||
re-attributed to a reserved <code>deleted-user</code> name. The last remaining Owner can't self-delete.</li>
|
||||
<li><strong><code>/me</code> actions</strong> — <code>/me waves</code> renders as <code>* nick waves</code>. On the wire it's a real CTCP
|
||||
ACTION, so irssi/WeeChat users see a native action line, and their <code>/me</code> renders properly in
|
||||
the TUI. Works in encrypted rooms (the marker encrypts with the text).</li>
|
||||
<li><strong><code>/banner <text></code></strong> — renders short text (up to 20 characters) as a 5-row block-letter
|
||||
banner. Rendered locally with a built-in font — no network, no dependencies — and sent as
|
||||
plain message content, so it works over IRC and in encrypted rooms.</li>
|
||||
<li><strong>Message replies</strong> — right-click a message (or F6-select) and pick <strong>Reply</strong>: the input
|
||||
shows a "Replying to" strip (Esc cancels), and the sent message renders with a dim
|
||||
<code>┌ nick: snippet</code> quote line. Activating the quote line jumps to the original message.
|
||||
Being replied to lights up the channel like an @mention. IRC clients see the familiar
|
||||
<code>> nick: snippet | text</code> convention. In encrypted rooms the quoted snippet is decrypted
|
||||
client-side with the room key — the server still never reads room content.</li>
|
||||
<li><strong><code>[open]</code> images without saving them</strong> — every image attachment now shows <code>[open] [↓ save original]</code> beneath its preview. Open views the image in your default browser straight from the server; in end-to-end encrypted rooms (where a browser would only see ciphertext) the client downloads, decrypts with the room key, and opens the image in your OS viewer from a temp file instead. Both actions are individually clickable, Enter on the line opens, and the right-click menu carries both.</li>
|
||||
<li><strong>Attachment links work in a browser</strong> — <code>GET /api/files/{id}</code> is now a capability URL: the unguessable GUID in the link is the access token (Discord-CDN style), so attachment links can be opened directly in a browser or shared to IRC without a login token. Images and audio are served inline so the browser displays them instead of forcing a download. Blobs from encrypted rooms remain ciphertext, so their links reveal nothing.</li>
|
||||
<li><strong>IRC gets image links instead of terminal art</strong> — the gateway no longer floods IRC clients with truecolor-ANSI ASCII art for images. Each attachment is now a single line — <code>[Image: photo.png] https://your-server/api/files/…</code> — the convention every IRC client understands, and ones like TheLounge or IRCCloud auto-preview. Set the new <code>Irc:PublicBaseUrl</code> option (e.g. <code>"https://chat.example.com"</code>) so those links come out absolute; unset, they fall back to relative paths as before.</li>
|
||||
<li><strong>Spam protection</strong> — per-user message flood and duplicate-message limits, join and
|
||||
channel-creation throttles, and automatic escalation: enough rejected sends in a few minutes
|
||||
earns a timed auto-mute through the normal mute system (moderators see it, and it expires on
|
||||
its own). One guard covers every ingress — TUI and IRC clients hit the same limits. Mods and
|
||||
above are exempt, everything is configurable under the new <code>Spam</code> section
|
||||
(<code>Spam:Enabled</code> master switch, lenient defaults a fast typist won't trip), and the guard only
|
||||
ever sees stored content — encrypted-room messages stay ciphertext.</li>
|
||||
</ul>
|
||||
<h2 id="improvements">Improvements</h2>
|
||||
<ul>
|
||||
<li><strong>Strict <code>/status</code></strong> — <code>/status garbage</code> is now an error instead of silently becoming your
|
||||
status message (and resetting you to Online). Status messages moved to <code>/status msg <text></code>,
|
||||
which preserves your current status; <code>/status msg</code> with no text clears it. The server also
|
||||
rejects out-of-range status values sent by misbehaving clients.</li>
|
||||
<li><strong>Registration dialog</strong> — gained Invite Code support, and the Display Name field you could
|
||||
already type into is now actually sent with registration.</li>
|
||||
</ul>
|
||||
<h2 id="bug-fixes">Bug Fixes</h2>
|
||||
<ul>
|
||||
<li><strong>Messages sent from the TUI now reach your own IRC session.</strong> With the same account online via both the TUI and an IRC client, messages sent from the TUI never appeared in the IRC client until it reconnected (which replayed history). The gateway suppressed the sender's echo by <em>nickname</em>, which swallowed the message for every IRC connection on that account — it now excludes only the exact connection a message originated from, so all your other sessions (a second IRC client included) receive it immediately.</li>
|
||||
<li><strong>Channel deleted event</strong> — when a channel is deleted, all connected clients are now immediately notified via the new <code>ChannelDeleted</code> SignalR event. The channel is removed from the channel list. Previously only the deleting client was able to delete the channel. Other clients would see the channel linger until the next manual refresh.</li>
|
||||
<li><strong>Deleted accounts don't break history</strong> — channel history now left-joins users, so messages
|
||||
from deleted accounts render (as <code>deleted-user</code>) instead of silently disappearing.</li>
|
||||
</ul>
|
||||
<h2 id="notes-for-server-operators">Notes for server operators</h2>
|
||||
<ul>
|
||||
<li>New config key: <code>Server:Registration</code> — <code>"open"</code> (default), <code>"invite"</code>, or <code>"closed"</code>.</li>
|
||||
<li>New config section: <code>Spam</code> — flood/duplicate/join/create thresholds and auto-mute duration;
|
||||
see <code>appsettings.example.json</code>. On by default with lenient limits; <code>Spam:Enabled: false</code>
|
||||
turns it all off. Note <code>Spam:MaxJoinsPerWindow</code> counts only <em>first-time</em> channel joins —
|
||||
keep it above your public channel count so a new member's first connect isn't throttled.</li>
|
||||
<li>New REST endpoints: <code>POST/GET/DELETE /api/invites</code> (Admin+), <code>GET /api/users/me/export</code>,
|
||||
<code>DELETE /api/users/me</code>.</li>
|
||||
<li>One new database migration (<code>AddInvitesAndReplies</code>) applies automatically on startup.</li>
|
||||
</ul>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
<a href="https://github.com/HueByte/EchoHub/blob/master/docs/#L1" class="edit-link">Edit this page</a>
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></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">
|
||||
<div class='footer-custom'><div class='footer-inner'><span class='footer-brand'>EchoHub</span><span class='footer-sep'>·</span><a href='https://github.com/HueByte/EchoHub'>GitHub</a><span class='footer-sep'>·</span><a href='https://echohub.voidcube.cloud'>Website</a></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
+170
-40
File diff suppressed because one or more lines are too long
+360
@@ -514,6 +514,34 @@
|
||||
"Title": "EchoHub.Client.Themes",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/client/EchoHub.Client.UI.Chat.AttachmentAction.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/client/EchoHub.Client.UI.Chat.AttachmentAction.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Client.UI.Chat.AttachmentAction",
|
||||
"Summary": "<p sourcefile=\"_api_meta/client/EchoHub.Client.UI.Chat.AttachmentAction.yml\" sourcestartlinenumber=\"1\">An action a click on an attachment line can trigger.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/client/EchoHub.Client.UI.Chat.AttachmentActionSpan.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/client/EchoHub.Client.UI.Chat.AttachmentActionSpan.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Client.UI.Chat.AttachmentActionSpan",
|
||||
"Summary": "<p sourcefile=\"_api_meta/client/EchoHub.Client.UI.Chat.AttachmentActionSpan.yml\" sourcestartlinenumber=\"1\">Inclusive column range on a chat line that triggers an attachment action when clicked.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/client/EchoHub.Client.UI.Chat.ChatColors.yml",
|
||||
@@ -1018,6 +1046,20 @@
|
||||
"Title": "EchoHub.Core.Constants.HubConstants",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.Constants.MessageConventions.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.Constants.MessageConventions.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.Constants.MessageConventions",
|
||||
"Summary": "<p sourcefile=\"_api_meta/core/EchoHub.Core.Constants.MessageConventions.yml\" sourcestartlinenumber=\"1\">Cross-protocol message conventions. Action messages (<code>/me</code>) use the IRC CTCP ACTION\nwire format 0x01 + "ACTION " + text + 0x01 as the stored content, so IRC clients\ninteroperate natively (irssi's /me arrives in exactly this shape) and the TUI renders\n"* nick text". In end-to-end encrypted rooms the marker encrypts along with the text.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.Constants.ValidationConstants.yml",
|
||||
@@ -1326,6 +1368,34 @@
|
||||
"Title": "EchoHub.Core.DTOs.CreateChannelRequest",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.CreateInviteRequest.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.DTOs.CreateInviteRequest.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.DTOs.CreateInviteRequest",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.DeleteAccountRequest.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.DTOs.DeleteAccountRequest.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.DTOs.DeleteAccountRequest",
|
||||
"Summary": "<p sourcefile=\"_api_meta/core/EchoHub.Core.DTOs.DeleteAccountRequest.yml\" sourcestartlinenumber=\"1\">Password re-confirmation for destructive self-service account actions.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.EmbedDto.yml",
|
||||
@@ -1368,6 +1438,48 @@
|
||||
"Title": "EchoHub.Core.DTOs.ErrorResponse",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.ExportedAttachmentDto.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.DTOs.ExportedAttachmentDto.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.DTOs.ExportedAttachmentDto",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.ExportedMessageDto.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.DTOs.ExportedMessageDto.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.DTOs.ExportedMessageDto",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.InviteDto.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.DTOs.InviteDto.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.DTOs.InviteDto",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.JoinChannelResult.yml",
|
||||
@@ -1508,6 +1620,20 @@
|
||||
"Title": "EchoHub.Core.DTOs.RekeyChannelRequest",
|
||||
"Summary": "<p sourcefile=\"_api_meta/core/EchoHub.Core.DTOs.RekeyChannelRequest.yml\" sourcestartlinenumber=\"1\">Passphrase change for an encrypted channel: the client proves knowledge of the old\npassphrase (old auth key), then supplies the re-wrapped room key under the new one.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.ReplyRefDto.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.DTOs.ReplyRefDto.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.DTOs.ReplyRefDto",
|
||||
"Summary": "<p sourcefile=\"_api_meta/core/EchoHub.Core.DTOs.ReplyRefDto.yml\" sourcestartlinenumber=\"1\">Reference to the message a reply targets. <xref href=\"EchoHub.Core.DTOs.ReplyRefDto.Content\" data-throw-if-not-resolved=\"false\"></xref> is treated exactly like\nmessage content on the wire: transport-encrypted, and for end-to-end encrypted rooms it is\nroom ciphertext the client must decrypt (the server truncates only plaintext snippets).\nNull on a <xref href=\"EchoHub.Core.DTOs.MessageDto\" data-throw-if-not-resolved=\"false\"></xref> when the original message no longer exists.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.SendMessageRequest.yml",
|
||||
@@ -1592,6 +1718,20 @@
|
||||
"Title": "EchoHub.Core.DTOs.UpdateTopicRequest",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.UserDataExportDto.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.DTOs.UserDataExportDto.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.DTOs.UserDataExportDto",
|
||||
"Summary": "<p sourcefile=\"_api_meta/core/EchoHub.Core.DTOs.UserDataExportDto.yml\" sourcestartlinenumber=\"1\">Everything the server holds about a user, as stored. For end-to-end encrypted rooms the\nmessage content in here is room ciphertext — the server cannot include plaintext it never had.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.DTOs.UserDto.yml",
|
||||
@@ -1732,6 +1872,20 @@
|
||||
"Title": "EchoHub.Core.Models.ChannelMembership",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.Models.InviteCode.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.Models.InviteCode.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.Models.InviteCode",
|
||||
"Summary": "<p sourcefile=\"_api_meta/core/EchoHub.Core.Models.InviteCode.yml\" sourcestartlinenumber=\"1\">A registration invite code. When the server runs with <code>Server:Registration = "invite"</code>,\nnew accounts (REST and IRC alike) require a valid, unexpired, not-fully-used code.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.Models.Message.yml",
|
||||
@@ -1872,6 +2026,20 @@
|
||||
"Title": "EchoHub.Core.Security",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.Services.AsciiBannerService.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/core/EchoHub.Core.Services.AsciiBannerService.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Core.Services.AsciiBannerService",
|
||||
"Summary": "<p sourcefile=\"_api_meta/core/EchoHub.Core.Services.AsciiBannerService.yml\" sourcestartlinenumber=\"1\">Renders short text as a 5-row block-character banner (the <code>/banner</code> command).\nEntirely local — a hand-rolled figlet-style font, no dependencies, no network.\nOutput is plain message content, so it travels (and encrypts) like any other text.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/core/EchoHub.Core.Services.FileValidationHelper.yml",
|
||||
@@ -2082,6 +2250,34 @@
|
||||
"Title": "EchoHub.Server.Auth",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Config.ServerLogsOptions.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Config.ServerLogsOptions.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Config.ServerLogsOptions",
|
||||
"Summary": "<p sourcefile=\"_api_meta/server/EchoHub.Server.Config.ServerLogsOptions.yml\" sourcestartlinenumber=\"1\">Live server-log room settings, bound from the "ServerLogs" config section (env override:\n<code>ServerLogs__Enabled</code> etc.). When enabled, a read-only system channel is auto-created\nand log events are streamed to it live — log lines are never stored as messages in the\ndatabase; the rolling Serilog log files remain the only persistence.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Config.SpamOptions.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Config.SpamOptions.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Config.SpamOptions",
|
||||
"Summary": "<p sourcefile=\"_api_meta/server/EchoHub.Server.Config.SpamOptions.yml\" sourcestartlinenumber=\"1\">Anti-spam thresholds, bound from the "Spam" config section. Defaults are lenient enough\nthat a fast typist never trips them; Mods and above are always exempt.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Config.UploadLimits.yml",
|
||||
@@ -2152,6 +2348,20 @@
|
||||
"Title": "EchoHub.Server.Controllers.FilesController",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Controllers.InvitesController.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Controllers.InvitesController.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Controllers.InvitesController",
|
||||
"Summary": "<p sourcefile=\"_api_meta/server/EchoHub.Server.Controllers.InvitesController.yml\" sourcestartlinenumber=\"1\">Invite-code management for invite-gated registration (Admin+ only).\nCodes live in this server's own database — there is no central service.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Controllers.ModerationController.yml",
|
||||
@@ -2264,6 +2474,20 @@
|
||||
"Title": "EchoHub.Server.Data.Migrations.AddChannelIsPublic",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Data.Migrations.AddChannelIsSystem.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Data.Migrations.AddChannelIsSystem.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Data.Migrations.AddChannelIsSystem",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Data.Migrations.AddChannelMembership.yml",
|
||||
@@ -2306,6 +2530,20 @@
|
||||
"Title": "EchoHub.Server.Data.Migrations.AddEncryptionSupport",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Data.Migrations.AddInvitesAndReplies.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Data.Migrations.AddInvitesAndReplies.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Data.Migrations.AddInvitesAndReplies",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Data.Migrations.AddMessageAttachments.yml",
|
||||
@@ -2572,6 +2810,76 @@
|
||||
"Title": "EchoHub.Server.Services.ServerDirectoryService",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.ServerLogs.LogBacklogEntry.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Services.ServerLogs.LogBacklogEntry.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Services.ServerLogs.LogBacklogEntry",
|
||||
"Summary": "<p sourcefile=\"_api_meta/server/EchoHub.Server.Services.ServerLogs.LogBacklogEntry.yml\" sourcestartlinenumber=\"1\">A backlog entry read from the log file: one timestamped log line plus any continuation\nlines (exception stack traces) that followed it.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.ServerLogs.ServerLogsService.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Services.ServerLogs.ServerLogsService.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Services.ServerLogs.ServerLogsService",
|
||||
"Summary": "<p sourcefile=\"_api_meta/server/EchoHub.Server.Services.ServerLogs.ServerLogsService.yml\" sourcestartlinenumber=\"1\">Shared logic for the live log room: room identity, the role gate, and reading the backlog\ntail from the current rolling log file. The file stays the only persistence — log lines\nare never stored as messages.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.ServerLogs.ServerLogsSink.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Services.ServerLogs.ServerLogsSink.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Services.ServerLogs.ServerLogsSink",
|
||||
"Summary": "<p sourcefile=\"_api_meta/server/EchoHub.Server.Services.ServerLogs.ServerLogsSink.yml\" sourcestartlinenumber=\"1\">Serilog sink feeding the live log room. Events are queued in a bounded drop-oldest buffer\nand consumed by <xref href=\"EchoHub.Server.Services.ServerLogs.ServerLogsStreamService\" data-throw-if-not-resolved=\"false\"></xref>; nothing is written to the database.\nEvents emitted by the streaming pipeline itself (the stream service and SignalR transport\ninternals) are dropped here so a broadcast that logs — e.g. a transport warning on a dead\nconnection — can never enter a log → broadcast → log feedback loop.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Services.ServerLogs.ServerLogsStreamService",
|
||||
"Summary": "<p sourcefile=\"_api_meta/server/EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.yml\" sourcestartlinenumber=\"1\">Streams queued log events to the live log room as ephemeral messages: SignalR only (the\nIRC gateway never sees them) and no database rows. Ensures the room exists before\nstreaming, recreating it on the fly if it was deleted.</p>\n<p sourcefile=\"_api_meta/server/EchoHub.Server.Services.ServerLogs.ServerLogsStreamService.yml\" sourcestartlinenumber=\"5\">This class must never log from its streaming path — its namespace is excluded by\n<xref href=\"EchoHub.Server.Services.ServerLogs.ServerLogsSink\" data-throw-if-not-resolved=\"false\"></xref> as a second line of defense, but the primary rule is simply\nnot to log per event, otherwise every streamed line would spawn another.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.ServerLogs.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Services.ServerLogs.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Services.ServerLogs",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.SignalRBroadcaster.yml",
|
||||
@@ -2586,6 +2894,48 @@
|
||||
"Title": "EchoHub.Server.Services.SignalRBroadcaster",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.SpamGuard.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Services.SpamGuard.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Services.SpamGuard",
|
||||
"Summary": "<p sourcefile=\"_api_meta/server/EchoHub.Server.Services.SpamGuard.yml\" sourcestartlinenumber=\"1\">In-memory, per-user spam protection consulted from <xref href=\"EchoHub.Server.Services.ChatService\" data-throw-if-not-resolved=\"false\"></xref> (messages,\njoins) and <xref href=\"EchoHub.Server.Services.ChannelService\" data-throw-if-not-resolved=\"false\"></xref> (channel creation), so every ingress protocol —\nSignalR and IRC alike — shares the same limits. State is per-process and never persisted;\nauto-mutes land in the normal mute store. Operates only on content the server already\nstores (for end-to-end encrypted rooms that is ciphertext) — nothing is decrypted.</p>\n"
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.SpamVerdict.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Services.SpamVerdict.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Services.SpamVerdict",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.SpamVerdictKind.yml",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/server/EchoHub.Server.Services.SpamVerdictKind.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "EchoHub.Server.Services.SpamVerdictKind",
|
||||
"Summary": null
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "_api_meta/server/EchoHub.Server.Services.UserService.yml",
|
||||
@@ -3008,6 +3358,16 @@
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "changelog/v0.2.15.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "changelog/v0.2.15.html"
|
||||
}
|
||||
},
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "changelog/v0.2.2.md",
|
||||
|
||||
+3627
-255
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user