mirror of
https://github.com/RedWizardsLab/EchoHub.git
synced 2026-09-04 16:46:08 +02:00
316 lines
13 KiB
HTML
316 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Namespace EchoHub.Core.DTOs | EchoHub Documentation </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Namespace EchoHub.Core.DTOs | 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.Core.DTOs">
|
|
|
|
<h1 id="EchoHub_Core_DTOs" data-uid="EchoHub.Core.DTOs" class="text-break">Namespace EchoHub.Core.DTOs</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.Core.DTOs.ApiResponse.html">ApiResponse</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.ApiResponse-1.html">ApiResponse<T></a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.AssignRoleRequest.html">AssignRoleRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.AttachmentDto.html">AttachmentDto</a></dt>
|
|
<dd><p>A file attached to a message. <a class="xref" href="EchoHub.Core.DTOs.AttachmentDto.html#EchoHub_Core_DTOs_AttachmentDto_AsciiPreview">AsciiPreview</a> holds the color-tag art for
|
|
images (null otherwise). For end-to-end encrypted channels the content behind
|
|
<a class="xref" href="EchoHub.Core.DTOs.AttachmentDto.html#EchoHub_Core_DTOs_AttachmentDto_Url">Url</a> and the preview are ciphertext the server cannot read.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.AvatarUploadResponse.html">AvatarUploadResponse</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.BanRequest.html">BanRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.ChannelCryptoDto.html">ChannelCryptoDto</a></dt>
|
|
<dd><p>Public crypto metadata for a channel — enough for a client to derive its join
|
|
credential from a passphrase. Never includes the wrapped room key.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.ChannelDto.html">ChannelDto</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.ChannelMetaDto.html">ChannelMetaDto</a></dt>
|
|
<dd><p>Human-facing summary of a channel (the <code>/meta</code> command). For encrypted channels the
|
|
server still knows these figures — count, timestamps, and stored blob sizes — even though it
|
|
cannot read the content itself. <a class="xref" href="EchoHub.Core.DTOs.ChannelMetaDto.html#EchoHub_Core_DTOs_ChannelMetaDto_EstimatedSizeBytes">EstimatedSizeBytes</a> is the sum of stored
|
|
attachment blob sizes plus message text length, so it is an estimate, not an exact on-disk total.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.ChannelOperationResult.html">ChannelOperationResult</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<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>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.EncryptionKeyResponse.html">EncryptionKeyResponse</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<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>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.KickRequest.html">KickRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.LoginRequest.html">LoginRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.LoginResponse.html">LoginResponse</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.MessageDto.html">MessageDto</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.MuteRequest.html">MuteRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.PaginatedResponse-1.html">PaginatedResponse<T></a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.RefreshRequest.html">RefreshRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.RegisterRequest.html">RegisterRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<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">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.SendMessageRequest.html">SendMessageRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.SendUrlRequest.html">SendUrlRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.ServerStatusDto.html">ServerStatusDto</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.UpdateProfileRequest.html">UpdateProfileRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.UpdateStatusRequest.html">UpdateStatusRequest</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<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>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.UserOperationResult.html">UserOperationResult</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.UserPresenceDto.html">UserPresenceDto</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.UserProfileDto.html">UserProfileDto</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<h3 id="enums">
|
|
Enums
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.ChannelError.html">ChannelError</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Core.DTOs.UserError.html">UserError</a></dt>
|
|
<dd></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>
|