Mirrors/Claper
1
0
Fork 0
mirror of https://github.com/ClaperCo/Claper.git synced 2026-02-24 12:09:59 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f8e77947523e171dc083a674534df945ffa7d243
Claper/Claper.Forms.html

956 lines
45 KiB
HTML
Raw 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.5.0">
<title>Claper.Forms — Claper v1.5.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-F19A6797.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://get.claper.co">
<img src="assets/logo.png" alt="Claper" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="https://get.claper.co" class="sidebar-projectName" translate="no">
Claper
</a>
<div class="sidebar-projectVersion" translate="no">
v1.5.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/forms.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.Forms</span>
<small class="app-vsn" translate="no">(Claper v1.5.0)</small>
</h1>
<section id="moduledoc">
<p>The Forms 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="#add_form_field/1" translate="no">add_form_field(changeset)</a>
</div>
<div class="summary-synopsis"><p>Add an empty form field to a form changeset.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_form/2" translate="no">change_form(form, attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Returns an <code class="inline">%Ecto.Changeset{}</code> for tracking form changes.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_form_submit/2" translate="no">change_form_submit(form_submit, attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Returns an <code class="inline">%Ecto.Changeset{}</code> for tracking form submit changes.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_form/1" translate="no">create_form(attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Creates a form.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_form_submit/1" translate="no">create_form_submit(attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Creates a form submit.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_or_update_form_submit/2" translate="no">create_or_update_form_submit(event_uuid, attrs)</a>
</div>
<div class="summary-synopsis"><p>Creates or update a FormSubmit.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_or_update_form_submit/3" translate="no">create_or_update_form_submit(fs, event_uuid, attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_form/2" translate="no">delete_form(event_uuid, form)</a>
</div>
<div class="summary-synopsis"><p>Deletes a form.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_form_submit/2" translate="no">delete_form_submit(event_uuid, fs)</a>
</div>
<div class="summary-synopsis"><p>Deletes a form submit.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#disable_all/2" translate="no">disable_all(presentation_file_id, position)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_form!/2" translate="no">get_form!(id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Gets a single form.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_form_current_position/2" translate="no">get_form_current_position(presentation_file_id, position)</a>
</div>
<div class="summary-synopsis"><p>Gets a single form for a given position.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_form_submit/2" translate="no">get_form_submit(user_id, form_id)</a>
</div>
<div class="summary-synopsis"><p>Gets a single FormSubmit.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_form_submit_by_id!/2" translate="no">get_form_submit_by_id!(id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Gets a single FormSubmit by its ID.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_form_submits/1" translate="no">list_form_submits(presentation_file_id)</a>
</div>
<div class="summary-synopsis"><p>Returns the list of form submissions for a given presentation file.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_forms/1" translate="no">list_forms(presentation_file_id)</a>
</div>
<div class="summary-synopsis"><p>Returns the list of forms for a given presentation file.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_forms_at_position/2" translate="no">list_forms_at_position(presentation_file_id, position)</a>
</div>
<div class="summary-synopsis"><p>Returns the list of forms for a given presentation file and a given position.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#remove_form_field/2" translate="no">remove_form_field(changeset, field)</a>
</div>
<div class="summary-synopsis"><p>Remove a form field from a form changeset.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#set_default/3" translate="no">set_default(id, presentation_file_id, position)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_form/3" translate="no">update_form(event_uuid, form, attrs)</a>
</div>
<div class="summary-synopsis"><p>Updates a form.</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="add_form_field/1">
<div class="detail-header">
<a href="#add_form_field/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">add_form_field(changeset)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L158" 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>Add an empty form field to a form changeset.</p>
</section>
</section>
<section class="detail" id="change_form/2">
<span id="change_form/1"></span>
<div class="detail-header">
<a href="#change_form/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">change_form(form, attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L151" 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>Returns an <code class="inline">%Ecto.Changeset{}</code> for tracking form changes.</p><h2 id="change_form/2-examples" class="section-heading">
<a href="#change_form/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">change_form</span><span class="p" data-group-id="7212550996-1">(</span><span class="n">form</span><span class="p" data-group-id="7212550996-1">)</span><span class="w">
</span><span class="p" data-group-id="7212550996-2">%</span><span class="nc" data-group-id="7212550996-2">Ecto.Changeset</span><span class="p" data-group-id="7212550996-2">{</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="7212550996-3">%</span><span class="nc" data-group-id="7212550996-3">Form</span><span class="p" data-group-id="7212550996-3">{</span><span class="p" data-group-id="7212550996-3">}</span><span class="p" data-group-id="7212550996-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="change_form_submit/2">
<span id="change_form_submit/1"></span>
<div class="detail-header">
<a href="#change_form_submit/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">change_form_submit(form_submit, attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L353" 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>Returns an <code class="inline">%Ecto.Changeset{}</code> for tracking form submit changes.</p><h2 id="change_form_submit/2-examples" class="section-heading">
<a href="#change_form_submit/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">change_form_submit</span><span class="p" data-group-id="9827118520-1">(</span><span class="n">form_submit</span><span class="p" data-group-id="9827118520-1">)</span><span class="w">
</span><span class="p" data-group-id="9827118520-2">%</span><span class="nc" data-group-id="9827118520-2">Ecto.Changeset</span><span class="p" data-group-id="9827118520-2">{</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9827118520-3">%</span><span class="nc" data-group-id="9827118520-3">FormSubmit</span><span class="p" data-group-id="9827118520-3">{</span><span class="p" data-group-id="9827118520-3">}</span><span class="p" data-group-id="9827118520-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="create_form/1">
<span id="create_form/0"></span>
<div class="detail-header">
<a href="#create_form/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_form(attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L94" 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 form.</p><h2 id="create_form/1-examples" class="section-heading">
<a href="#create_form/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_form</span><span class="p" data-group-id="9379562133-1">(</span><span class="p" data-group-id="9379562133-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="9379562133-2">}</span><span class="p" data-group-id="9379562133-1">)</span><span class="w">
</span><span class="p" data-group-id="9379562133-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9379562133-4">%</span><span class="nc" data-group-id="9379562133-4">Form</span><span class="p" data-group-id="9379562133-4">{</span><span class="p" data-group-id="9379562133-4">}</span><span class="p" data-group-id="9379562133-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_form</span><span class="p" data-group-id="9379562133-5">(</span><span class="p" data-group-id="9379562133-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="9379562133-6">}</span><span class="p" data-group-id="9379562133-5">)</span><span class="w">
</span><span class="p" data-group-id="9379562133-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9379562133-8">%</span><span class="nc" data-group-id="9379562133-8">Ecto.Changeset</span><span class="p" data-group-id="9379562133-8">{</span><span class="p" data-group-id="9379562133-8">}</span><span class="p" data-group-id="9379562133-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="create_form_submit/1">
<span id="create_form_submit/0"></span>
<div class="detail-header">
<a href="#create_form_submit/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_form_submit(attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L224" 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 form submit.</p><h2 id="create_form_submit/1-examples" class="section-heading">
<a href="#create_form_submit/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_form_submit</span><span class="p" data-group-id="5975660148-1">(</span><span class="p" data-group-id="5975660148-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="5975660148-2">}</span><span class="p" data-group-id="5975660148-1">)</span><span class="w">
</span><span class="p" data-group-id="5975660148-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5975660148-4">%</span><span class="nc" data-group-id="5975660148-4">FormSubmit</span><span class="p" data-group-id="5975660148-4">{</span><span class="p" data-group-id="5975660148-4">}</span><span class="p" data-group-id="5975660148-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_form_submit</span><span class="p" data-group-id="5975660148-5">(</span><span class="p" data-group-id="5975660148-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="5975660148-6">}</span><span class="p" data-group-id="5975660148-5">)</span><span class="w">
</span><span class="p" data-group-id="5975660148-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5975660148-8">%</span><span class="nc" data-group-id="5975660148-8">Ecto.Changeset</span><span class="p" data-group-id="5975660148-8">{</span><span class="p" data-group-id="5975660148-8">}</span><span class="p" data-group-id="5975660148-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="create_or_update_form_submit/2">
<div class="detail-header">
<a href="#create_or_update_form_submit/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">create_or_update_form_submit(event_uuid, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L292" 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 or update a FormSubmit.</p><h2 id="create_or_update_form_submit/2-examples" class="section-heading">
<a href="#create_or_update_form_submit/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">create_or_update_form_submit</span><span class="p" data-group-id="7364895906-1">(</span><span class="p" data-group-id="7364895906-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="7364895906-2">}</span><span class="p" data-group-id="7364895906-1">)</span><span class="w">
</span><span class="p" data-group-id="7364895906-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7364895906-4">%</span><span class="nc" data-group-id="7364895906-4">FormSubmit</span><span class="p" data-group-id="7364895906-4">{</span><span class="p" data-group-id="7364895906-4">}</span><span class="p" data-group-id="7364895906-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_or_update_form_submit</span><span class="p" data-group-id="7364895906-5">(</span><span class="p" data-group-id="7364895906-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="7364895906-6">}</span><span class="p" data-group-id="7364895906-5">)</span><span class="w">
</span><span class="p" data-group-id="7364895906-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7364895906-8">%</span><span class="nc" data-group-id="7364895906-8">Ecto.Changeset</span><span class="p" data-group-id="7364895906-8">{</span><span class="p" data-group-id="7364895906-8">}</span><span class="p" data-group-id="7364895906-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="create_or_update_form_submit/3">
<div class="detail-header">
<a href="#create_or_update_form_submit/3" 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_or_update_form_submit(fs, event_uuid, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L308" 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="delete_form/2">
<div class="detail-header">
<a href="#delete_form/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">delete_form(event_uuid, form)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L137" 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>Deletes a form.</p><h2 id="delete_form/2-examples" class="section-heading">
<a href="#delete_form/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">delete_form</span><span class="p" data-group-id="3255382084-1">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">form</span><span class="p" data-group-id="3255382084-1">)</span><span class="w">
</span><span class="p" data-group-id="3255382084-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3255382084-3">%</span><span class="nc" data-group-id="3255382084-3">Form</span><span class="p" data-group-id="3255382084-3">{</span><span class="p" data-group-id="3255382084-3">}</span><span class="p" data-group-id="3255382084-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">delete_form</span><span class="p" data-group-id="3255382084-4">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">form</span><span class="p" data-group-id="3255382084-4">)</span><span class="w">
</span><span class="p" data-group-id="3255382084-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3255382084-6">%</span><span class="nc" data-group-id="3255382084-6">Ecto.Changeset</span><span class="p" data-group-id="3255382084-6">{</span><span class="p" data-group-id="3255382084-6">}</span><span class="p" data-group-id="3255382084-5">}</span></code></pre>
</section>
</section>
<section class="detail" id="delete_form_submit/2">
<div class="detail-header">
<a href="#delete_form_submit/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">delete_form_submit(event_uuid, fs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L336" 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>Deletes a form submit.</p><h2 id="delete_form_submit/2-examples" class="section-heading">
<a href="#delete_form_submit/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">delete_form_submit</span><span class="p" data-group-id="0411995092-1">(</span><span class="n">post</span><span class="p">,</span><span class="w"> </span><span class="n">event_id</span><span class="p" data-group-id="0411995092-1">)</span><span class="w">
</span><span class="p" data-group-id="0411995092-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0411995092-3">%</span><span class="nc" data-group-id="0411995092-3">FormSubmit</span><span class="p" data-group-id="0411995092-3">{</span><span class="p" data-group-id="0411995092-3">}</span><span class="p" data-group-id="0411995092-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">delete_form_submit</span><span class="p" data-group-id="0411995092-4">(</span><span class="n">post</span><span class="p">,</span><span class="w"> </span><span class="n">event_id</span><span class="p" data-group-id="0411995092-4">)</span><span class="w">
</span><span class="p" data-group-id="0411995092-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0411995092-6">%</span><span class="nc" data-group-id="0411995092-6">Ecto.Changeset</span><span class="p" data-group-id="0411995092-6">{</span><span class="p" data-group-id="0411995092-6">}</span><span class="p" data-group-id="0411995092-5">}</span></code></pre>
</section>
</section>
<section class="detail" id="disable_all/2">
<div class="detail-header">
<a href="#disable_all/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">disable_all(presentation_file_id, position)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L177" 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="get_form!/2">
<span id="get_form!/1"></span>
<div class="detail-header">
<a href="#get_form!/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_form!(id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.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>Gets a single form.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.10.1/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Form does not exist.</p><h2 id="get_form!/2-examples" class="section-heading">
<a href="#get_form!/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_form!</span><span class="p" data-group-id="3117371228-1">(</span><span class="mi">123</span><span class="p" data-group-id="3117371228-1">)</span><span class="w">
</span><span class="p" data-group-id="3117371228-2">%</span><span class="nc" data-group-id="3117371228-2">Poll</span><span class="p" data-group-id="3117371228-2">{</span><span class="p" data-group-id="3117371228-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_form!</span><span class="p" data-group-id="3117371228-3">(</span><span class="mi">456</span><span class="p" data-group-id="3117371228-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_form_current_position/2">
<div class="detail-header">
<a href="#get_form_current_position/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_form_current_position(presentation_file_id, position)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L73" 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 form for a given position.</p><h2 id="get_form_current_position/2-examples" class="section-heading">
<a href="#get_form_current_position/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_form!</span><span class="p" data-group-id="8418107129-1">(</span><span class="mi">123</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p" data-group-id="8418107129-1">)</span><span class="w">
</span><span class="p" data-group-id="8418107129-2">%</span><span class="nc" data-group-id="8418107129-2">Form</span><span class="p" data-group-id="8418107129-2">{</span><span class="p" data-group-id="8418107129-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_form_submit/2">
<div class="detail-header">
<a href="#get_form_submit/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_form_submit(user_id, form_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L257" 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 FormSubmit.</p><h2 id="get_form_submit/2-examples" class="section-heading">
<a href="#get_form_submit/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_form_submit!</span><span class="p" data-group-id="7300404633-1">(</span><span class="mi">321</span><span class="p">,</span><span class="w"> </span><span class="mi">123</span><span class="p" data-group-id="7300404633-1">)</span><span class="w">
</span><span class="p" data-group-id="7300404633-2">%</span><span class="nc" data-group-id="7300404633-2">FormSubmit</span><span class="p" data-group-id="7300404633-2">{</span><span class="p" data-group-id="7300404633-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_form_submit_by_id!/2">
<span id="get_form_submit_by_id!/1"></span>
<div class="detail-header">
<a href="#get_form_submit_by_id!/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_form_submit_by_id!(id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L277" 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 FormSubmit by its ID.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.10.1/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the FormSubmit does not exist.</p><h2 id="get_form_submit_by_id!/2-examples" class="section-heading">
<a href="#get_form_submit_by_id!/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_form_submit_by_id!</span><span class="p" data-group-id="2824957050-1">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p" data-group-id="2824957050-1">)</span><span class="w">
</span><span class="p" data-group-id="2824957050-2">%</span><span class="nc" data-group-id="2824957050-2">Post</span><span class="p" data-group-id="2824957050-2">{</span><span class="p" data-group-id="2824957050-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_form_submit_by_id!</span><span class="p" data-group-id="2824957050-3">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174123&quot;</span><span class="p" data-group-id="2824957050-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="list_form_submits/1">
<div class="detail-header">
<a href="#list_form_submits/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">list_form_submits(presentation_file_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L239" 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>Returns the list of form submissions for a given presentation file.</p><h2 id="list_form_submits/1-examples" class="section-heading">
<a href="#list_form_submits/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">list_form_submits</span><span class="p" data-group-id="6535999555-1">(</span><span class="mi">123</span><span class="p" data-group-id="6535999555-1">)</span><span class="w">
</span><span class="p" data-group-id="6535999555-2">[</span><span class="p" data-group-id="6535999555-3">%</span><span class="nc" data-group-id="6535999555-3">FormSubmit</span><span class="p" data-group-id="6535999555-3">{</span><span class="p" data-group-id="6535999555-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="6535999555-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="list_forms/1">
<div class="detail-header">
<a href="#list_forms/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">list_forms(presentation_file_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L22" 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>Returns the list of forms for a given presentation file.</p><h2 id="list_forms/1-examples" class="section-heading">
<a href="#list_forms/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">list_forms</span><span class="p" data-group-id="8292654971-1">(</span><span class="mi">123</span><span class="p" data-group-id="8292654971-1">)</span><span class="w">
</span><span class="p" data-group-id="8292654971-2">[</span><span class="p" data-group-id="8292654971-3">%</span><span class="nc" data-group-id="8292654971-3">Form</span><span class="p" data-group-id="8292654971-3">{</span><span class="p" data-group-id="8292654971-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="8292654971-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="list_forms_at_position/2">
<div class="detail-header">
<a href="#list_forms_at_position/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">list_forms_at_position(presentation_file_id, position)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L39" 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>Returns the list of forms for a given presentation file and a given position.</p><h2 id="list_forms_at_position/2-examples" class="section-heading">
<a href="#list_forms_at_position/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">list_forms_at_position</span><span class="p" data-group-id="0156006718-1">(</span><span class="mi">123</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p" data-group-id="0156006718-1">)</span><span class="w">
</span><span class="p" data-group-id="0156006718-2">[</span><span class="p" data-group-id="0156006718-3">%</span><span class="nc" data-group-id="0156006718-3">Form</span><span class="p" data-group-id="0156006718-3">{</span><span class="p" data-group-id="0156006718-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="0156006718-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="remove_form_field/2">
<div class="detail-header">
<a href="#remove_form_field/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">remove_form_field(changeset, field)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L169" 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>Remove a form field from a form changeset.</p>
</section>
</section>
<section class="detail" id="set_default/3">
<div class="detail-header">
<a href="#set_default/3" 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">set_default(id, presentation_file_id, position)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L184" 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_form/3">
<div class="detail-header">
<a href="#update_form/3" 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_form(event_uuid, form, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/forms.ex#L112" 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 form.</p><h2 id="update_form/3-examples" class="section-heading">
<a href="#update_form/3-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_form</span><span class="p" data-group-id="6468613168-1">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">form</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6468613168-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="6468613168-2">}</span><span class="p" data-group-id="6468613168-1">)</span><span class="w">
</span><span class="p" data-group-id="6468613168-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6468613168-4">%</span><span class="nc" data-group-id="6468613168-4">Form</span><span class="p" data-group-id="6468613168-4">{</span><span class="p" data-group-id="6468613168-4">}</span><span class="p" data-group-id="6468613168-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">update_form</span><span class="p" data-group-id="6468613168-5">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">form</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6468613168-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="6468613168-6">}</span><span class="p" data-group-id="6468613168-5">)</span><span class="w">
</span><span class="p" data-group-id="6468613168-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6468613168-8">%</span><span class="nc" data-group-id="6468613168-8">Ecto.Changeset</span><span class="p" data-group-id="6468613168-8">{</span><span class="p" data-group-id="6468613168-8">}</span><span class="p" data-group-id="6468613168-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