Mirrors/Claper
1
0
Fork 0
mirror of https://github.com/ClaperCo/Claper.git synced 2026-02-24 04:01:04 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Claper/Claper.Presentations.html

457 lines
22 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.29.4">
<meta name="project" content="Claper v1.7.0">
<title>Claper.Presentations — Claper v1.7.0</title>
<link rel="stylesheet" href="dist/html-elixir-HHVY3JYD.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
<script src="dist/sidebar_items-E6912480.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-JDI3AVDD.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<a href="https://claper.co">
<img src="assets/logo.png" alt="Claper" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="https://claper.co" class="sidebar-projectName" translate="no">
Claper
</a>
<div class="sidebar-projectVersion" translate="no">
v1.7.0
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">GUIDES</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/presentations.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">Claper.Presentations</span>
<small class="app-vsn" translate="no">(Claper v1.7.0)</small>
</h1>
<section id="moduledoc">
<p>The Presentations context.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_presentation_file/1" translate="no">create_presentation_file(attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Creates a presentation_files.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_presentation_state/1" translate="no">create_presentation_state(attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Creates a presentation_state.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_presentation_file!/2" translate="no">get_presentation_file!(id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Gets a single presentation_files.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_presentation_file_by_hash!/1" translate="no">get_presentation_file_by_hash!(hash)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscribe/1" translate="no">subscribe(presentation_file_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_presentation_file/2" translate="no">update_presentation_file(presentation_file, attrs)</a>
</div>
<div class="summary-synopsis"><p>Updates a presentation_files.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_presentation_state/2" translate="no">update_presentation_state(presentation_state, attrs)</a>
</div>
<div class="summary-synopsis"><p>Updates a presentation_state.</p></div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="functions-list">
<section class="detail" id="create_presentation_file/1">
<span id="create_presentation_file/0"></span>
<div class="detail-header">
<a href="#create_presentation_file/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_presentation_file(attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/presentations.ex#L43" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Creates a presentation_files.</p><h2 id="create_presentation_file/1-examples" class="section-heading">
<a href="#create_presentation_file/1-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">create_presentation_file</span><span class="p" data-group-id="3761760146-1">(</span><span class="p" data-group-id="3761760146-2">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">value</span><span class="p" data-group-id="3761760146-2">}</span><span class="p" data-group-id="3761760146-1">)</span><span class="w">
</span><span class="p" data-group-id="3761760146-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3761760146-4">%</span><span class="nc" data-group-id="3761760146-4">PresentationFile</span><span class="p" data-group-id="3761760146-4">{</span><span class="p" data-group-id="3761760146-4">}</span><span class="p" data-group-id="3761760146-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_presentation_file</span><span class="p" data-group-id="3761760146-5">(</span><span class="p" data-group-id="3761760146-6">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">bad_value</span><span class="p" data-group-id="3761760146-6">}</span><span class="p" data-group-id="3761760146-5">)</span><span class="w">
</span><span class="p" data-group-id="3761760146-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3761760146-8">%</span><span class="nc" data-group-id="3761760146-8">Ecto.Changeset</span><span class="p" data-group-id="3761760146-8">{</span><span class="p" data-group-id="3761760146-8">}</span><span class="p" data-group-id="3761760146-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="create_presentation_state/1">
<span id="create_presentation_state/0"></span>
<div class="detail-header">
<a href="#create_presentation_state/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">create_presentation_state(attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/presentations.ex#L85" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Creates a presentation_state.</p><h2 id="create_presentation_state/1-examples" class="section-heading">
<a href="#create_presentation_state/1-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">create_presentation_state</span><span class="p" data-group-id="3911538890-1">(</span><span class="p" data-group-id="3911538890-2">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">value</span><span class="p" data-group-id="3911538890-2">}</span><span class="p" data-group-id="3911538890-1">)</span><span class="w">
</span><span class="p" data-group-id="3911538890-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3911538890-4">%</span><span class="nc" data-group-id="3911538890-4">PresentationState</span><span class="p" data-group-id="3911538890-4">{</span><span class="p" data-group-id="3911538890-4">}</span><span class="p" data-group-id="3911538890-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_presentation_state</span><span class="p" data-group-id="3911538890-5">(</span><span class="p" data-group-id="3911538890-6">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">bad_value</span><span class="p" data-group-id="3911538890-6">}</span><span class="p" data-group-id="3911538890-5">)</span><span class="w">
</span><span class="p" data-group-id="3911538890-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3911538890-8">%</span><span class="nc" data-group-id="3911538890-8">Ecto.Changeset</span><span class="p" data-group-id="3911538890-8">{</span><span class="p" data-group-id="3911538890-8">}</span><span class="p" data-group-id="3911538890-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_presentation_file!/2">
<span id="get_presentation_file!/1"></span>
<div class="detail-header">
<a href="#get_presentation_file!/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_presentation_file!(id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/presentations.ex#L25" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Gets a single presentation_files.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.10.1/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Presentation files does not exist.</p><h2 id="get_presentation_file!/2-examples" class="section-heading">
<a href="#get_presentation_file!/2-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">get_presentation_file!</span><span class="p" data-group-id="7370858320-1">(</span><span class="mi">123</span><span class="p" data-group-id="7370858320-1">)</span><span class="w">
</span><span class="p" data-group-id="7370858320-2">%</span><span class="nc" data-group-id="7370858320-2">PresentationFile</span><span class="p" data-group-id="7370858320-2">{</span><span class="p" data-group-id="7370858320-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_presentation_file!</span><span class="p" data-group-id="7370858320-3">(</span><span class="mi">456</span><span class="p" data-group-id="7370858320-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_presentation_file_by_hash!/1">
<div class="detail-header">
<a href="#get_presentation_file_by_hash!/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_presentation_file_by_hash!(hash)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/presentations.ex#L28" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="subscribe/1">
<div class="detail-header">
<a href="#subscribe/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">subscribe(presentation_file_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/presentations.ex#L67" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="update_presentation_file/2">
<div class="detail-header">
<a href="#update_presentation_file/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">update_presentation_file(presentation_file, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/presentations.ex#L61" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Updates a presentation_files.</p><h2 id="update_presentation_file/2-examples" class="section-heading">
<a href="#update_presentation_file/2-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">update_presentation_file</span><span class="p" data-group-id="3757380043-1">(</span><span class="n">presentation_file</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3757380043-2">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">new_value</span><span class="p" data-group-id="3757380043-2">}</span><span class="p" data-group-id="3757380043-1">)</span><span class="w">
</span><span class="p" data-group-id="3757380043-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3757380043-4">%</span><span class="nc" data-group-id="3757380043-4">PresentationFile</span><span class="p" data-group-id="3757380043-4">{</span><span class="p" data-group-id="3757380043-4">}</span><span class="p" data-group-id="3757380043-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">update_presentation_file</span><span class="p" data-group-id="3757380043-5">(</span><span class="n">presentation_file</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3757380043-6">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">bad_value</span><span class="p" data-group-id="3757380043-6">}</span><span class="p" data-group-id="3757380043-5">)</span><span class="w">
</span><span class="p" data-group-id="3757380043-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3757380043-8">%</span><span class="nc" data-group-id="3757380043-8">Ecto.Changeset</span><span class="p" data-group-id="3757380043-8">{</span><span class="p" data-group-id="3757380043-8">}</span><span class="p" data-group-id="3757380043-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="update_presentation_state/2">
<div class="detail-header">
<a href="#update_presentation_state/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">update_presentation_state(presentation_state, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/presentations.ex#L103" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Updates a presentation_state.</p><h2 id="update_presentation_state/2-examples" class="section-heading">
<a href="#update_presentation_state/2-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">examples</p>
</a>
Examples
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">update_presentation_state</span><span class="p" data-group-id="4260762785-1">(</span><span class="n">presentation_state</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4260762785-2">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">new_value</span><span class="p" data-group-id="4260762785-2">}</span><span class="p" data-group-id="4260762785-1">)</span><span class="w">
</span><span class="p" data-group-id="4260762785-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4260762785-4">%</span><span class="nc" data-group-id="4260762785-4">PresentationState</span><span class="p" data-group-id="4260762785-4">{</span><span class="p" data-group-id="4260762785-4">}</span><span class="p" data-group-id="4260762785-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">update_presentation_state</span><span class="p" data-group-id="4260762785-5">(</span><span class="n">presentation_state</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4260762785-6">%{</span><span class="ss">field</span><span class="p">:</span><span class="w"> </span><span class="n">bad_value</span><span class="p" data-group-id="4260762785-6">}</span><span class="p" data-group-id="4260762785-5">)</span><span class="w">
</span><span class="p" data-group-id="4260762785-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4260762785-8">%</span><span class="nc" data-group-id="4260762785-8">Ecto.Changeset</span><span class="p" data-group-id="4260762785-8">{</span><span class="p" data-group-id="4260762785-8">}</span><span class="p" data-group-id="4260762785-7">}</span></code></pre>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Claper.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.4) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink