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
gh-pages
Claper/Claper.Polls.html

785 lines
35 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.Polls — 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/polls.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.Polls</span>
<small class="app-vsn" translate="no">(Claper v1.7.0)</small>
</h1>
<section id="moduledoc">
<p>The Polls 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_poll_opt/1" translate="no">add_poll_opt(changeset)</a>
</div>
<div class="summary-synopsis"><p>Add an empty poll opt to a poll changeset.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_poll/2" translate="no">change_poll(poll, attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Returns an <code class="inline">%Ecto.Changeset{}</code> for tracking poll changes.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_poll/1" translate="no">create_poll(attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Creates a poll.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_poll_vote/1" translate="no">create_poll_vote(attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Creates a poll_vote.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_poll/2" translate="no">delete_poll(event_uuid, poll)</a>
</div>
<div class="summary-synopsis"><p>Deletes a poll.</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_poll!/1" translate="no">get_poll!(id)</a>
</div>
<div class="summary-synopsis"><p>Gets a single poll and set percentages for each poll options.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_poll_current_position/2" translate="no">get_poll_current_position(presentation_file_id, position)</a>
</div>
<div class="summary-synopsis"><p>Gets a single poll for a given position.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_poll_vote/2" translate="no">get_poll_vote(user_id, poll_id)</a>
</div>
<div class="summary-synopsis"><p>Gets a all poll_vote.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_polls/1" translate="no">list_polls(presentation_file_id)</a>
</div>
<div class="summary-synopsis"><p>Returns the list of polls for a given presentation file.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_polls_at_position/2" translate="no">list_polls_at_position(presentation_file_id, position)</a>
</div>
<div class="summary-synopsis"><p>Returns the list of polls for a given presentation file and a given position.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#remove_poll_opt/2" translate="no">remove_poll_opt(changeset, poll_opt)</a>
</div>
<div class="summary-synopsis"><p>Remove a poll opt from a poll changeset.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#set_percentages/1" translate="no">set_percentages(poll)</a>
</div>
<div class="summary-synopsis"><p>Calculate percentage of all poll options for a given poll.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#set_status/4" translate="no">set_status(id, presentation_file_id, position, status)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_poll/3" translate="no">update_poll(event_uuid, poll, attrs)</a>
</div>
<div class="summary-synopsis"><p>Updates a poll.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#vote/4" translate="no">vote(user_id, event_uuid, poll_opts, poll_id)</a>
</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_poll_opt/1">
<div class="detail-header">
<a href="#add_poll_opt/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_poll_opt(changeset)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L205" 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 poll opt to a poll changeset.</p>
</section>
</section>
<section class="detail" id="change_poll/2">
<span id="change_poll/1"></span>
<div class="detail-header">
<a href="#change_poll/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_poll(poll, attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L198" 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 poll changes.</p><h2 id="change_poll/2-examples" class="section-heading">
<a href="#change_poll/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_poll</span><span class="p" data-group-id="9648597265-1">(</span><span class="n">poll</span><span class="p" data-group-id="9648597265-1">)</span><span class="w">
</span><span class="p" data-group-id="9648597265-2">%</span><span class="nc" data-group-id="9648597265-2">Ecto.Changeset</span><span class="p" data-group-id="9648597265-2">{</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9648597265-3">%</span><span class="nc" data-group-id="9648597265-3">Poll</span><span class="p" data-group-id="9648597265-3">{</span><span class="p" data-group-id="9648597265-3">}</span><span class="p" data-group-id="9648597265-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="create_poll/1">
<span id="create_poll/0"></span>
<div class="detail-header">
<a href="#create_poll/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_poll(attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L141" 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 poll.</p><h2 id="create_poll/1-examples" class="section-heading">
<a href="#create_poll/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_poll</span><span class="p" data-group-id="1169426688-1">(</span><span class="p" data-group-id="1169426688-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="1169426688-2">}</span><span class="p" data-group-id="1169426688-1">)</span><span class="w">
</span><span class="p" data-group-id="1169426688-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1169426688-4">%</span><span class="nc" data-group-id="1169426688-4">Poll</span><span class="p" data-group-id="1169426688-4">{</span><span class="p" data-group-id="1169426688-4">}</span><span class="p" data-group-id="1169426688-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_poll</span><span class="p" data-group-id="1169426688-5">(</span><span class="p" data-group-id="1169426688-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="1169426688-6">}</span><span class="p" data-group-id="1169426688-5">)</span><span class="w">
</span><span class="p" data-group-id="1169426688-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1169426688-8">%</span><span class="nc" data-group-id="1169426688-8">Ecto.Changeset</span><span class="p" data-group-id="1169426688-8">{</span><span class="p" data-group-id="1169426688-8">}</span><span class="p" data-group-id="1169426688-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="create_poll_vote/1">
<span id="create_poll_vote/0"></span>
<div class="detail-header">
<a href="#create_poll_vote/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_poll_vote(attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L346" 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 poll_vote.</p><h2 id="create_poll_vote/1-examples" class="section-heading">
<a href="#create_poll_vote/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_poll_vote</span><span class="p" data-group-id="3097791683-1">(</span><span class="p" data-group-id="3097791683-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="3097791683-2">}</span><span class="p" data-group-id="3097791683-1">)</span><span class="w">
</span><span class="p" data-group-id="3097791683-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3097791683-4">%</span><span class="nc" data-group-id="3097791683-4">PollVote</span><span class="p" data-group-id="3097791683-4">{</span><span class="p" data-group-id="3097791683-4">}</span><span class="p" data-group-id="3097791683-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_poll_vote</span><span class="p" data-group-id="3097791683-5">(</span><span class="p" data-group-id="3097791683-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="3097791683-6">}</span><span class="p" data-group-id="3097791683-5">)</span><span class="w">
</span><span class="p" data-group-id="3097791683-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3097791683-8">%</span><span class="nc" data-group-id="3097791683-8">Ecto.Changeset</span><span class="p" data-group-id="3097791683-8">{</span><span class="p" data-group-id="3097791683-8">}</span><span class="p" data-group-id="3097791683-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="delete_poll/2">
<div class="detail-header">
<a href="#delete_poll/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_poll(event_uuid, poll)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.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">
<p>Deletes a poll.</p><h2 id="delete_poll/2-examples" class="section-heading">
<a href="#delete_poll/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_poll</span><span class="p" data-group-id="5419145467-1">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">poll</span><span class="p" data-group-id="5419145467-1">)</span><span class="w">
</span><span class="p" data-group-id="5419145467-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5419145467-3">%</span><span class="nc" data-group-id="5419145467-3">Poll</span><span class="p" data-group-id="5419145467-3">{</span><span class="p" data-group-id="5419145467-3">}</span><span class="p" data-group-id="5419145467-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">delete_poll</span><span class="p" data-group-id="5419145467-4">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">poll</span><span class="p" data-group-id="5419145467-4">)</span><span class="w">
</span><span class="p" data-group-id="5419145467-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5419145467-6">%</span><span class="nc" data-group-id="5419145467-6">Ecto.Changeset</span><span class="p" data-group-id="5419145467-6">{</span><span class="p" data-group-id="5419145467-6">}</span><span class="p" data-group-id="5419145467-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/polls.ex#L271" 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_poll!/1">
<div class="detail-header">
<a href="#get_poll!/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_poll!(id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L63" 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 poll and set percentages for each poll options.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.10.1/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Poll does not exist.</p><h2 id="get_poll!/1-examples" class="section-heading">
<a href="#get_poll!/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">get_poll!</span><span class="p" data-group-id="0474665619-1">(</span><span class="mi">123</span><span class="p" data-group-id="0474665619-1">)</span><span class="w">
</span><span class="p" data-group-id="0474665619-2">%</span><span class="nc" data-group-id="0474665619-2">Poll</span><span class="p" data-group-id="0474665619-2">{</span><span class="p" data-group-id="0474665619-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_poll!</span><span class="p" data-group-id="0474665619-3">(</span><span class="mi">456</span><span class="p" data-group-id="0474665619-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_poll_current_position/2">
<div class="detail-header">
<a href="#get_poll_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_poll_current_position(presentation_file_id, position)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L84" 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 poll for a given position.</p><h2 id="get_poll_current_position/2-examples" class="section-heading">
<a href="#get_poll_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_poll!</span><span class="p" data-group-id="4635412161-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="4635412161-1">)</span><span class="w">
</span><span class="p" data-group-id="4635412161-2">%</span><span class="nc" data-group-id="4635412161-2">Poll</span><span class="p" data-group-id="4635412161-2">{</span><span class="p" data-group-id="4635412161-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_poll_vote/2">
<div class="detail-header">
<a href="#get_poll_vote/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_poll_vote(user_id, poll_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L318" 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 all poll_vote.</p><h2 id="get_poll_vote/2-examples" class="section-heading">
<a href="#get_poll_vote/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_poll_vote!</span><span class="p" data-group-id="4239251830-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="4239251830-1">)</span><span class="w">
</span><span class="p" data-group-id="4239251830-2">[</span><span class="p" data-group-id="4239251830-3">%</span><span class="nc" data-group-id="4239251830-3">PollVote</span><span class="p" data-group-id="4239251830-3">{</span><span class="p" data-group-id="4239251830-3">}</span><span class="p" data-group-id="4239251830-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="list_polls/1">
<div class="detail-header">
<a href="#list_polls/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_polls(presentation_file_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.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 polls for a given presentation file.</p><h2 id="list_polls/1-examples" class="section-heading">
<a href="#list_polls/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_polls</span><span class="p" data-group-id="5083753671-1">(</span><span class="mi">123</span><span class="p" data-group-id="5083753671-1">)</span><span class="w">
</span><span class="p" data-group-id="5083753671-2">[</span><span class="p" data-group-id="5083753671-3">%</span><span class="nc" data-group-id="5083753671-3">Poll</span><span class="p" data-group-id="5083753671-3">{</span><span class="p" data-group-id="5083753671-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="5083753671-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="list_polls_at_position/2">
<div class="detail-header">
<a href="#list_polls_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_polls_at_position(presentation_file_id, position)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L40" 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 polls for a given presentation file and a given position.</p><h2 id="list_polls_at_position/2-examples" class="section-heading">
<a href="#list_polls_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_polls_at_position</span><span class="p" data-group-id="6970272503-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="6970272503-1">)</span><span class="w">
</span><span class="p" data-group-id="6970272503-2">[</span><span class="p" data-group-id="6970272503-3">%</span><span class="nc" data-group-id="6970272503-3">Poll</span><span class="p" data-group-id="6970272503-3">{</span><span class="p" data-group-id="6970272503-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="6970272503-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="remove_poll_opt/2">
<div class="detail-header">
<a href="#remove_poll_opt/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_poll_opt(changeset, poll_opt)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L216" 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 poll opt from a poll changeset.</p>
</section>
</section>
<section class="detail" id="set_percentages/1">
<div class="detail-header">
<a href="#set_percentages/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">set_percentages(poll)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L110" 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>Calculate percentage of all poll options for a given poll.</p><h2 id="set_percentages/1-examples" class="section-heading">
<a href="#set_percentages/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">set_percentages</span><span class="p" data-group-id="1695314604-1">(</span><span class="n">poll</span><span class="p" data-group-id="1695314604-1">)</span><span class="w">
</span><span class="p" data-group-id="1695314604-2">%</span><span class="nc" data-group-id="1695314604-2">Poll</span><span class="p" data-group-id="1695314604-2">{</span><span class="p" data-group-id="1695314604-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="set_status/4">
<div class="detail-header">
<a href="#set_status/4" 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_status(id, presentation_file_id, position, status)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L278" 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_poll/3">
<div class="detail-header">
<a href="#update_poll/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_poll(event_uuid, poll, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.ex#L159" 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 poll.</p><h2 id="update_poll/3-examples" class="section-heading">
<a href="#update_poll/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_poll</span><span class="p" data-group-id="5753207108-1">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">poll</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5753207108-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="5753207108-2">}</span><span class="p" data-group-id="5753207108-1">)</span><span class="w">
</span><span class="p" data-group-id="5753207108-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5753207108-4">%</span><span class="nc" data-group-id="5753207108-4">Poll</span><span class="p" data-group-id="5753207108-4">{</span><span class="p" data-group-id="5753207108-4">}</span><span class="p" data-group-id="5753207108-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">update_poll</span><span class="p" data-group-id="5753207108-5">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">poll</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5753207108-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="5753207108-6">}</span><span class="p" data-group-id="5753207108-5">)</span><span class="w">
</span><span class="p" data-group-id="5753207108-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5753207108-8">%</span><span class="nc" data-group-id="5753207108-8">Ecto.Changeset</span><span class="p" data-group-id="5753207108-8">{</span><span class="p" data-group-id="5753207108-8">}</span><span class="p" data-group-id="5753207108-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="vote/4">
<div class="detail-header">
<a href="#vote/4" 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">vote(user_id, event_uuid, poll_opts, poll_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/polls.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">
</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