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
f04f438a71f41d9fa437545a2938e3fea916ebdb
Claper/Claper.Events.html

854 lines
40 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.28.4">
<meta name="project" content="Claper v1.2.1">
<title>Claper.Events — Claper v1.2.1</title>
<link rel="stylesheet" href="dist/elixir-b6f1ed5df9b1d42a7309.css" />
<script src="dist/sidebar_items-a1513a6c5c.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-bd1cb213813bf4825aa2.js"></script>
</head>
<body data-type="modules">
<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">
<section class="sidebar">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<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" />
</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>
<strong class="sidebar-projectVersion" translate="no">
v1.2.1
</strong>
</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" class="sidebar-fullList"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="settings 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/events.ex#L1" title="View Source" class="view-source" 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.Events</span>
<small class="app-vsn" translate="no">(Claper v1.2.1)</small>
</h1>
<section id="moduledoc">
<p>The Events context.</p><p>An activity leader is a facilitator, a user invited to manage an event.</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="#change_activity_leader/2" translate="no">change_activity_leader(activity_leader, attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Returns an <code class="inline">%Ecto.Changeset{}</code> for tracking facilitator changes.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_event/2" translate="no">change_event(event, attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Returns an <code class="inline">%Ecto.Changeset{}</code> for tracking event changes.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#count_events_month/1" translate="no">count_events_month(user_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_event/1" translate="no">create_event(attrs)</a>
</div>
<div class="summary-synopsis"><p>Creates a event.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_event/1" translate="no">delete_event(event)</a>
</div>
<div class="summary-synopsis"><p>Deletes a event.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_activity_leader!/1" translate="no">get_activity_leader!(id)</a>
</div>
<div class="summary-synopsis"><p>Gets a single facilitator.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_activity_leaders_for_event/1" translate="no">get_activity_leaders_for_event(event_id)</a>
</div>
<div class="summary-synopsis"><p>Gets all facilitators for a given event.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_different_event_with_code/2" translate="no">get_different_event_with_code(code, event_id)</a>
</div>
<div class="summary-synopsis"><p>Get a single event with the same code excluding a specific event.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_event!/2" translate="no">get_event!(id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Gets a single event.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_event_with_code!/2" translate="no">get_event_with_code!(code, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Gets a single event by code.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_event_with_code/2" translate="no">get_event_with_code(code, preload \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_managed_event!/3" translate="no">get_managed_event!(current_user, id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Gets a single managed event.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_user_event!/3" translate="no">get_user_event!(user_id, id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Gets a single user's event.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#is_leaded_by/2" translate="no">is_leaded_by(email, event)</a>
</div>
<div class="summary-synopsis"><p>Check if a user is a facilitator of a specific event.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_events/2" translate="no">list_events(user_id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Returns the list of events of a given user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_managed_events_by/2" translate="no">list_managed_events_by(email, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Returns the list of events managed by a given user email.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_event/2" translate="no">update_event(event, attrs)</a>
</div>
<div class="summary-synopsis"><p>Updates a event.</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="change_activity_leader/2">
<span id="change_activity_leader/1"></span>
<div class="detail-header">
<a href="#change_activity_leader/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_activity_leader(activity_leader, attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L336" class="view-source" 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 facilitator changes.</p><h2 id="change_activity_leader/2-examples" class="section-heading">
<a href="#change_activity_leader/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_activity_leader</span><span class="p" data-group-id="4753333762-1">(</span><span class="n">activity_leader</span><span class="p" data-group-id="4753333762-1">)</span><span class="w">
</span><span class="p" data-group-id="4753333762-2">%</span><span class="nc" data-group-id="4753333762-2">Ecto.Changeset</span><span class="p" data-group-id="4753333762-2">{</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="4753333762-3">%</span><span class="nc" data-group-id="4753333762-3">ActivityLeader</span><span class="p" data-group-id="4753333762-3">{</span><span class="p" data-group-id="4753333762-3">}</span><span class="p" data-group-id="4753333762-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="change_event/2">
<span id="change_event/1"></span>
<div class="detail-header">
<a href="#change_event/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_event(event, attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L286" class="view-source" 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 event changes.</p><h2 id="change_event/2-examples" class="section-heading">
<a href="#change_event/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_event</span><span class="p" data-group-id="3885632149-1">(</span><span class="n">event</span><span class="p" data-group-id="3885632149-1">)</span><span class="w">
</span><span class="p" data-group-id="3885632149-2">%</span><span class="nc" data-group-id="3885632149-2">Ecto.Changeset</span><span class="p" data-group-id="3885632149-2">{</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3885632149-3">%</span><span class="nc" data-group-id="3885632149-3">Event</span><span class="p" data-group-id="3885632149-3">{</span><span class="p" data-group-id="3885632149-3">}</span><span class="p" data-group-id="3885632149-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="count_events_month/1">
<div class="detail-header">
<a href="#count_events_month/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">count_events_month(user_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L51" class="view-source" 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="create_event/1">
<div class="detail-header">
<a href="#create_event/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_event(attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L209" class="view-source" 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 event.</p><h2 id="create_event/1-examples" class="section-heading">
<a href="#create_event/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_event</span><span class="p" data-group-id="3662914885-1">(</span><span class="p" data-group-id="3662914885-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="3662914885-2">}</span><span class="p" data-group-id="3662914885-1">)</span><span class="w">
</span><span class="p" data-group-id="3662914885-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3662914885-4">%</span><span class="nc" data-group-id="3662914885-4">Event</span><span class="p" data-group-id="3662914885-4">{</span><span class="p" data-group-id="3662914885-4">}</span><span class="p" data-group-id="3662914885-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_event</span><span class="p" data-group-id="3662914885-5">(</span><span class="p" data-group-id="3662914885-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="3662914885-6">}</span><span class="p" data-group-id="3662914885-5">)</span><span class="w">
</span><span class="p" data-group-id="3662914885-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3662914885-8">%</span><span class="nc" data-group-id="3662914885-8">Ecto.Changeset</span><span class="p" data-group-id="3662914885-8">{</span><span class="p" data-group-id="3662914885-8">}</span><span class="p" data-group-id="3662914885-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="delete_event/1">
<div class="detail-header">
<a href="#delete_event/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">delete_event(event)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L273" class="view-source" 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 event.</p><h2 id="delete_event/1-examples" class="section-heading">
<a href="#delete_event/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">delete_event</span><span class="p" data-group-id="9688103632-1">(</span><span class="n">event</span><span class="p" data-group-id="9688103632-1">)</span><span class="w">
</span><span class="p" data-group-id="9688103632-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9688103632-3">%</span><span class="nc" data-group-id="9688103632-3">Event</span><span class="p" data-group-id="9688103632-3">{</span><span class="p" data-group-id="9688103632-3">}</span><span class="p" data-group-id="9688103632-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">delete_event</span><span class="p" data-group-id="9688103632-4">(</span><span class="n">event</span><span class="p" data-group-id="9688103632-4">)</span><span class="w">
</span><span class="p" data-group-id="9688103632-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9688103632-6">%</span><span class="nc" data-group-id="9688103632-6">Ecto.Changeset</span><span class="p" data-group-id="9688103632-6">{</span><span class="p" data-group-id="9688103632-6">}</span><span class="p" data-group-id="9688103632-5">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_activity_leader!/1">
<div class="detail-header">
<a href="#get_activity_leader!/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_activity_leader!(id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L306" class="view-source" 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 facilitator.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.7.2/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Activity leader does not exist.</p><h2 id="get_activity_leader!/1-examples" class="section-heading">
<a href="#get_activity_leader!/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_activity_leader!</span><span class="p" data-group-id="9885305576-1">(</span><span class="mi">123</span><span class="p" data-group-id="9885305576-1">)</span><span class="w">
</span><span class="p" data-group-id="9885305576-2">%</span><span class="nc" data-group-id="9885305576-2">ActivityLeader</span><span class="p" data-group-id="9885305576-2">{</span><span class="p" data-group-id="9885305576-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_activity_leader!</span><span class="p" data-group-id="9885305576-3">(</span><span class="mi">456</span><span class="p" data-group-id="9885305576-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_activity_leaders_for_event/1">
<div class="detail-header">
<a href="#get_activity_leaders_for_event/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_activity_leaders_for_event(event_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L317" class="view-source" 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 all facilitators for a given event.</p><h2 id="get_activity_leaders_for_event/1-examples" class="section-heading">
<a href="#get_activity_leaders_for_event/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_activity_leaders_for_event!</span><span class="p" data-group-id="9291123028-1">(</span><span class="n">event</span><span class="p" data-group-id="9291123028-1">)</span><span class="w">
</span><span class="p" data-group-id="9291123028-2">[</span><span class="p" data-group-id="9291123028-3">%</span><span class="nc" data-group-id="9291123028-3">ActivityLeader</span><span class="p" data-group-id="9291123028-3">{</span><span class="p" data-group-id="9291123028-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="9291123028-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="get_different_event_with_code/2">
<div class="detail-header">
<a href="#get_different_event_with_code/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_different_event_with_code(code, event_id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L166" class="view-source" 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>Get a single event with the same code excluding a specific event.</p><h2 id="get_different_event_with_code/2-examples" class="section-heading">
<a href="#get_different_event_with_code/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_different_event_with_code</span><span class="p" data-group-id="3230426596-1">(</span><span class="s">&quot;Hello&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">123</span><span class="p" data-group-id="3230426596-1">)</span><span class="w">
</span><span class="p" data-group-id="3230426596-2">%</span><span class="nc" data-group-id="3230426596-2">Event</span><span class="p" data-group-id="3230426596-2">{</span><span class="p" data-group-id="3230426596-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_event!/2">
<span id="get_event!/1"></span>
<div class="detail-header">
<a href="#get_event!/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_event!(id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L79" class="view-source" 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 event.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.7.2/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Event does not exist.</p><h2 id="get_event!/2-examples" class="section-heading">
<a href="#get_event!/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_event!</span><span class="p" data-group-id="1049833056-1">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p" data-group-id="1049833056-1">)</span><span class="w">
</span><span class="p" data-group-id="1049833056-2">%</span><span class="nc" data-group-id="1049833056-2">Event</span><span class="p" data-group-id="1049833056-2">{</span><span class="p" data-group-id="1049833056-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_event!</span><span class="p" data-group-id="1049833056-3">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-4266141740111&quot;</span><span class="p" data-group-id="1049833056-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_event_with_code!/2">
<span id="get_event_with_code!/1"></span>
<div class="detail-header">
<a href="#get_event_with_code!/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_event_with_code!(code, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L140" class="view-source" 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 event by code.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.7.2/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Event does not exist.</p><h2 id="get_event_with_code!/2-examples" class="section-heading">
<a href="#get_event_with_code!/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_event_with_code!</span><span class="p" data-group-id="8628219539-1">(</span><span class="s">&quot;Hello&quot;</span><span class="p" data-group-id="8628219539-1">)</span><span class="w">
</span><span class="p" data-group-id="8628219539-2">%</span><span class="nc" data-group-id="8628219539-2">Event</span><span class="p" data-group-id="8628219539-2">{</span><span class="p" data-group-id="8628219539-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_event_with_code!</span><span class="p" data-group-id="8628219539-3">(</span><span class="s">&quot;Old event&quot;</span><span class="p" data-group-id="8628219539-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_event_with_code/2">
<span id="get_event_with_code/1"></span>
<div class="detail-header">
<a href="#get_event_with_code/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_event_with_code(code, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L148" class="view-source" 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_managed_event!/3">
<span id="get_managed_event!/2"></span>
<div class="detail-header">
<a href="#get_managed_event!/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">get_managed_event!(current_user, id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L96" class="view-source" 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 managed event.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.7.2/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Event does not exist.</p><h2 id="get_managed_event!/3-examples" class="section-heading">
<a href="#get_managed_event!/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">get_managed_event!</span><span class="p" data-group-id="4728867805-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p" data-group-id="4728867805-1">)</span><span class="w">
</span><span class="p" data-group-id="4728867805-2">%</span><span class="nc" data-group-id="4728867805-2">Event</span><span class="p" data-group-id="4728867805-2">{</span><span class="p" data-group-id="4728867805-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_managed_event!</span><span class="p" data-group-id="4728867805-3">(</span><span class="n">another_user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p" data-group-id="4728867805-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_user_event!/3">
<span id="get_user_event!/2"></span>
<div class="detail-header">
<a href="#get_user_event!/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">get_user_event!(user_id, id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L123" class="view-source" 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 user's event.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.7.2/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Event does not exist.</p><h2 id="get_user_event!/3-examples" class="section-heading">
<a href="#get_user_event!/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">get_user_event!</span><span class="p" data-group-id="0114169030-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p" data-group-id="0114169030-1">)</span><span class="w">
</span><span class="p" data-group-id="0114169030-2">%</span><span class="nc" data-group-id="0114169030-2">Event</span><span class="p" data-group-id="0114169030-2">{</span><span class="p" data-group-id="0114169030-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_user_event!</span><span class="p" data-group-id="0114169030-3">(</span><span class="n">another_user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p" data-group-id="0114169030-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="is_leaded_by/2">
<div class="detail-header">
<a href="#is_leaded_by/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">is_leaded_by(email, event)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L185" class="view-source" 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>Check if a user is a facilitator of a specific event.</p><h2 id="is_leaded_by/2-examples" class="section-heading">
<a href="#is_leaded_by/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">is_leaded_by</span><span class="p" data-group-id="9018426379-1">(</span><span class="s">&quot;email@example.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">123</span><span class="p" data-group-id="9018426379-1">)</span><span class="w">
</span><span class="no">true</span></code></pre>
</section>
</section>
<section class="detail" id="list_events/2">
<span id="list_events/1"></span>
<div class="detail-header">
<a href="#list_events/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_events(user_id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L22" class="view-source" 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 events of a given user.</p><h2 id="list_events/2-examples" class="section-heading">
<a href="#list_events/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_events</span><span class="p" data-group-id="2711804100-1">(</span><span class="mi">123</span><span class="p" data-group-id="2711804100-1">)</span><span class="w">
</span><span class="p" data-group-id="2711804100-2">[</span><span class="p" data-group-id="2711804100-3">%</span><span class="nc" data-group-id="2711804100-3">Event</span><span class="p" data-group-id="2711804100-3">{</span><span class="p" data-group-id="2711804100-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="2711804100-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="list_managed_events_by/2">
<span id="list_managed_events_by/1"></span>
<div class="detail-header">
<a href="#list_managed_events_by/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_managed_events_by(email, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L37" class="view-source" 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 events managed by a given user email.</p><h2 id="list_managed_events_by/2-examples" class="section-heading">
<a href="#list_managed_events_by/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_managed_events_by</span><span class="p" data-group-id="9954519121-1">(</span><span class="s">&quot;email@example.com&quot;</span><span class="p" data-group-id="9954519121-1">)</span><span class="w">
</span><span class="p" data-group-id="9954519121-2">[</span><span class="p" data-group-id="9954519121-3">%</span><span class="nc" data-group-id="9954519121-3">Event</span><span class="p" data-group-id="9954519121-3">{</span><span class="p" data-group-id="9954519121-3">}</span><span class="p">,</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="9954519121-2">]</span></code></pre>
</section>
</section>
<section class="detail" id="update_event/2">
<div class="detail-header">
<a href="#update_event/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_event(event, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/events.ex#L248" class="view-source" 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 event.</p><h2 id="update_event/2-examples" class="section-heading">
<a href="#update_event/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_event</span><span class="p" data-group-id="8467910273-1">(</span><span class="n">event</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8467910273-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="8467910273-2">}</span><span class="p" data-group-id="8467910273-1">)</span><span class="w">
</span><span class="p" data-group-id="8467910273-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8467910273-4">%</span><span class="nc" data-group-id="8467910273-4">Event</span><span class="p" data-group-id="8467910273-4">{</span><span class="p" data-group-id="8467910273-4">}</span><span class="p" data-group-id="8467910273-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">update_event</span><span class="p" data-group-id="8467910273-5">(</span><span class="n">event</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8467910273-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="8467910273-6">}</span><span class="p" data-group-id="8467910273-5">)</span><span class="w">
</span><span class="p" data-group-id="8467910273-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8467910273-8">%</span><span class="nc" data-group-id="8467910273-8">Ecto.Changeset</span><span class="p" data-group-id="8467910273-8">{</span><span class="p" data-group-id="8467910273-8">}</span><span class="p" data-group-id="8467910273-7">}</span></code></pre>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.28.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