mirror of
https://github.com/RedWizardsLab/EchoHub.git
synced 2026-09-04 08:36:11 +02:00
251 lines
12 KiB
HTML
251 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Namespace EchoHub.Client.Services | EchoHub Documentation </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Namespace EchoHub.Client.Services | 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.Client.Services">
|
|
|
|
<h1 id="EchoHub_Client_Services" data-uid="EchoHub.Client.Services" class="text-break">Namespace EchoHub.Client.Services</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.Client.Services.ApiClient.html">ApiClient</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.AsyncRunner.html">AsyncRunner</a></dt>
|
|
<dd><p>Eliminates repeated Task.Run/try/catch/app.Invoke(ShowError) boilerplate.
|
|
Runs async work on a background thread and routes exceptions to the UI.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.AudioPlaybackService.html">AudioPlaybackService</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.BackupInfo.html">BackupInfo</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.ChannelPasswordRequiredException.html">ChannelPasswordRequiredException</a></dt>
|
|
<dd><p>Thrown when joining a channel fails because a password is required or incorrect.
|
|
The UI catches this to prompt the user and retry.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.ClientEncryptionService.html">ClientEncryptionService</a></dt>
|
|
<dd><p>Client-side encryption service. Uses the same AES-256-GCM format as the server
|
|
so messages are encrypted end-to-end between client and server.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.ClipboardFiles.html">ClipboardFiles</a></dt>
|
|
<dd><p>Reads file paths that live on the OS clipboard as a <em>file list</em> (e.g. after copying a file in
|
|
Explorer/Finder/Nautilus), which terminals do not paste as text. Lets Ctrl+V attach a copied
|
|
file directly instead of requiring the user to paste a raw path.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.ClipboardImage.html">ClipboardImage</a></dt>
|
|
<dd><p>Reads raw image data from the OS clipboard (e.g. an image copied from a browser, or a
|
|
Win+Shift+S screenshot), which terminals cannot paste as text. Always returns PNG bytes:
|
|
clipboard PNG data is passed through, clipboard bitmaps (CF_DIB) are re-encoded.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.EchoHubConnection.html">EchoHubConnection</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.FolderPickResult.html">FolderPickResult</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.JoinOutcome.html">JoinOutcome</a></dt>
|
|
<dd><p>Result of joining a channel: decrypted history plus, for end-to-end encrypted
|
|
channels, the key envelope needed to unlock the room content key.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.NativeFolderPicker.html">NativeFolderPicker</a></dt>
|
|
<dd><p>Opens the OS-native folder chooser (Windows Explorer, macOS Finder, Linux GTK/KDE) by shelling
|
|
out, so the TUI doesn't need a GUI toolkit reference. Returns <a class="xref" href="EchoHub.Client.Services.PickerOutcome.html#EchoHub_Client_Services_PickerOutcome_Unavailable">Unavailable</a>
|
|
when no native dialog can run, so callers can fall back to a configured path.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.NotificationSoundService.html">NotificationSoundService</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.OutgoingAttachment.html">OutgoingAttachment</a></dt>
|
|
<dd><p>One file to upload as part of a message. For end-to-end encrypted channels the stream
|
|
is already ciphertext, <a class="xref" href="EchoHub.Client.Services.OutgoingAttachment.html#EchoHub_Client_Services_OutgoingAttachment_DeclaredKind">DeclaredKind</a> is set (image/audio/file), and
|
|
<a class="xref" href="EchoHub.Client.Services.OutgoingAttachment.html#EchoHub_Client_Services_OutgoingAttachment_EncryptedPreview">EncryptedPreview</a> holds the room-encrypted ASCII art for images.
|
|
For normal channels only <a class="xref" href="EchoHub.Client.Services.OutgoingAttachment.html#EchoHub_Client_Services_OutgoingAttachment_Stream">Stream</a> and <a class="xref" href="EchoHub.Client.Services.OutgoingAttachment.html#EchoHub_Client_Services_OutgoingAttachment_FileName">FileName</a> are set.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.PathSetup.html">PathSetup</a></dt>
|
|
<dd><p>Ensures the application's directory is on the system PATH so users
|
|
can run 'echohub' from any terminal session.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.RoomKeyProtector.html">RoomKeyProtector</a></dt>
|
|
<dd><p>Encrypts cached room content keys at rest so the client config never holds them as
|
|
plain base64. Windows uses DPAPI (current-user scope, format prefix "dp1:"). On other
|
|
platforms the keys are AES-GCM encrypted with a per-user master key file stored next
|
|
to the config with 0600 permissions (prefix "k1:") — without an OS keychain that is
|
|
file-permission-level protection, not zero-knowledge: anyone who can read both the
|
|
config and the key file can recover the room keys. Values with no recognized prefix
|
|
are legacy plain-base64 keys from older clients; they load once and are re-encrypted.
|
|
The room passphrase itself is never stored in any form.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.RoomKeyStore.html">RoomKeyStore</a></dt>
|
|
<dd><p>Holds room content keys for end-to-end encrypted channels: in-memory for the
|
|
active session, persisted per-server in the client config (like saved sessions)
|
|
so users don't retype the passphrase every launch. Keys never leave this machine
|
|
and are encrypted at rest by <a class="xref" href="EchoHub.Client.Services.RoomKeyProtector.html">RoomKeyProtector</a>. Also tracks which
|
|
channels are known to be end-to-end encrypted, so senders can refuse to emit
|
|
plaintext into a room whose key isn't cached yet.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.RoomLockedException.html">RoomLockedException</a></dt>
|
|
<dd><p>Thrown when sending into an end-to-end encrypted channel whose room key isn't cached:
|
|
without the key the message would leave the client as plaintext, which must never happen.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.UpdateBackupService.html">UpdateBackupService</a></dt>
|
|
<dd><p>Manages pre-update backups and rollback restoration for the auto-updater.
|
|
Backup location: ~/.echohub/update-backup/</p>
|
|
</dd>
|
|
</dl>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.UpdateChecker.html">UpdateChecker</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
<h3 id="enums">
|
|
Enums
|
|
</h3>
|
|
<dl class="jumplist">
|
|
<dt><a class="xref" href="EchoHub.Client.Services.PickerOutcome.html">PickerOutcome</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>
|