9 lines
8.1 KiB
HTML
9 lines
8.1 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Profile commands: who can use this device, and how they get in."><title>jellytau_lib::commands::profiles - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="jellytau_lib" data-themes="" data-resource-suffix="" data-rustdoc-version="1.97.1 (8bab26f4f 2026-07-14)" data-channel="1.97.1" data-search-js="search-fd9372ac.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-fcd733ba.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module profiles</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../jellytau_lib/index.html">jellytau_<wbr>lib</a><span class="version">0.11.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module profiles</a></h2><h3><a href="#constants">Module Items</a></h3><ul class="block"><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In jellytau_<wbr>lib::<wbr>commands</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">jellytau_lib</a>::<wbr><a href="../index.html">commands</a></div><h1>Module <span>profiles</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/jellytau_lib/commands/profiles.rs.html#1-544">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Profile commands: who can use this device, and how they get in.</p>
|
||
<p>The rule that shapes this whole module: <strong>switching is not logging out</strong>.
|
||
<a href="../auth/fn.auth_logout.html" title="fn jellytau_lib::commands::auth::auth_logout"><code>auth_logout</code></a> calls Jellyfin’s logout endpoint,
|
||
which invalidates the token server-side — so a switch built on it would make
|
||
every switch back cost a password, which is the problem this feature exists
|
||
to solve. Nothing here calls it.</p>
|
||
<p>TRACES: UR-082, UR-083, UR-084 | DR-267, DR-268, DR-269, DR-270, DR-274</p>
|
||
</div></details><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.ASK_ON_START_KEY.html" title="constant jellytau_lib::commands::profiles::ASK_ON_START_KEY">ASK_<wbr>ON_<wbr>START_<wbr>KEY</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Settings key for “ask who’s watching on start”.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.active_user_id.html" title="fn jellytau_lib::commands::profiles::active_user_id">active_<wbr>user_<wbr>id</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.adopt_session.html" title="fn jellytau_lib::commands::profiles::adopt_session">adopt_<wbr>session</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Make the newly-active profile the session the rest of the backend acts as.</dd><dt><a class="fn" href="fn.ask_on_start.html" title="fn jellytau_lib::commands::profiles::ask_on_start">ask_<wbr>on_<wbr>start</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.current_server.html" title="fn jellytau_lib::commands::profiles::current_server">current_<wbr>server</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>The server this device is signed in to, as <code>(server_id, server_url)</code>.</dd><dt><a class="fn" href="fn.execute_switch.html" title="fn jellytau_lib::commands::profiles::execute_switch">execute_<wbr>switch</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Run a switch plan.</dd><dt><a class="fn" href="fn.profiles_add.html" title="fn jellytau_lib::commands::profiles::profiles_add">profiles_<wbr>add</a></dt><dd>Add another account from the <strong>current</strong> server to this device.</dd><dt><a class="fn" href="fn.profiles_get_ask_on_start.html" title="fn jellytau_lib::commands::profiles::profiles_get_ask_on_start">profiles_<wbr>get_<wbr>ask_<wbr>on_<wbr>start</a></dt><dd>Read the “ask who’s watching on start” setting.</dd><dt><a class="fn" href="fn.profiles_list.html" title="fn jellytau_lib::commands::profiles::profiles_list">profiles_<wbr>list</a></dt><dd>List the accounts this device knows for the current server.</dd><dt><a class="fn" href="fn.profiles_remove.html" title="fn jellytau_lib::commands::profiles::profiles_remove">profiles_<wbr>remove</a></dt><dd>Forget a profile on this device.</dd><dt><a class="fn" href="fn.profiles_set_ask_on_start.html" title="fn jellytau_lib::commands::profiles::profiles_set_ask_on_start">profiles_<wbr>set_<wbr>ask_<wbr>on_<wbr>start</a></dt><dd>Turn “ask who’s watching on start” on or off.</dd><dt><a class="fn" href="fn.profiles_set_pin.html" title="fn jellytau_lib::commands::profiles::profiles_set_pin">profiles_<wbr>set_<wbr>pin</a></dt><dd>Set, change, or clear a profile’s PIN.</dd><dt><a class="fn" href="fn.profiles_startup_target.html" title="fn jellytau_lib::commands::profiles::profiles_startup_target">profiles_<wbr>startup_<wbr>target</a></dt><dd>Whether startup should resume an account or ask who is watching.</dd><dt><a class="fn" href="fn.profiles_unlock.html" title="fn jellytau_lib::commands::profiles::profiles_unlock">profiles_<wbr>unlock</a></dt><dd>Enter a profile, with its PIN if it has one.</dd><dt><a class="fn" href="fn.profiles_unlock_with_password.html" title="fn jellytau_lib::commands::profiles::profiles_unlock_with_password">profiles_<wbr>unlock_<wbr>with_<wbr>password</a></dt><dd>Enter a profile with its Jellyfin password, for someone who has forgotten
|
||
their PIN.</dd><dt><a class="fn" href="fn.save_token.html" title="fn jellytau_lib::commands::profiles::save_token">save_<wbr>token</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.service.html" title="fn jellytau_lib::commands::profiles::service">service</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.set_active_user.html" title="fn jellytau_lib::commands::profiles::set_active_user">set_<wbr>active_<wbr>user</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html> |