Files
Claper/Claper.Posts.html

681 lines
30 KiB
HTML
Raw Permalink Normal View 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.Posts — 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/posts.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.Posts</span>
<small class="app-vsn" translate="no">(Claper v1.7.0)</small>
</h1>
<section id="moduledoc">
<p>The Posts context.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_post/2" translate="no">create_post(event, attrs)</a>
</div>
<div class="summary-synopsis"><p>Creates a post.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create_reaction/1" translate="no">create_reaction(attrs)</a>
</div>
<div class="summary-synopsis"><p>Creates a reaction.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_all_posts/3" translate="no">delete_all_posts(atom, attendee_identifier, event)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_post/1" translate="no">delete_post(post)</a>
</div>
<div class="summary-synopsis"><p>Deletes a post.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_reaction/1" translate="no">delete_reaction(params)</a>
</div>
<div class="summary-synopsis"><p>Deletes a reaction.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_post!/2" translate="no">get_post!(id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Gets a single post.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_reaction!/1" translate="no">get_reaction!(id)</a>
</div>
<div class="summary-synopsis"><p>Gets a single reaction.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_pinned_posts/2" translate="no">list_pinned_posts(event_id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Get only the pinned event posts.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_posts/2" translate="no">list_posts(event_id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Get event posts</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#list_unpinned_posts/2" translate="no">list_unpinned_posts(event_id, preload \\ [])</a>
</div>
<div class="summary-synopsis"><p>Get only the unpinned event posts.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#reacted_posts/3" translate="no">reacted_posts(event_id, user_id, icon)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#toggle_pin_post/1" translate="no">toggle_pin_post(post)</a>
</div>
<div class="summary-synopsis"><p>Pins or unpins a post based on its current state.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_post/2" translate="no">update_post(post, attrs)</a>
</div>
<div class="summary-synopsis"><p>Updates a post.</p></div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="functions-list">
<section class="detail" id="create_post/2">
<div class="detail-header">
<a href="#create_post/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_post(event, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L113" 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 post.</p><h2 id="create_post/2-examples" class="section-heading">
<a href="#create_post/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_post</span><span class="p" data-group-id="4453854790-1">(</span><span class="n">event</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4453854790-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="4453854790-2">}</span><span class="p" data-group-id="4453854790-1">)</span><span class="w">
</span><span class="p" data-group-id="4453854790-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4453854790-4">%</span><span class="nc" data-group-id="4453854790-4">Post</span><span class="p" data-group-id="4453854790-4">{</span><span class="p" data-group-id="4453854790-4">}</span><span class="p" data-group-id="4453854790-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_post</span><span class="p" data-group-id="4453854790-5">(</span><span class="n">event</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4453854790-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="4453854790-6">}</span><span class="p" data-group-id="4453854790-5">)</span><span class="w">
</span><span class="p" data-group-id="4453854790-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4453854790-8">%</span><span class="nc" data-group-id="4453854790-8">Ecto.Changeset</span><span class="p" data-group-id="4453854790-8">{</span><span class="p" data-group-id="4453854790-8">}</span><span class="p" data-group-id="4453854790-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="create_reaction/1">
<div class="detail-header">
<a href="#create_reaction/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_reaction(attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L243" 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 reaction.</p><h2 id="create_reaction/1-examples" class="section-heading">
<a href="#create_reaction/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_reaction</span><span class="p" data-group-id="6554758811-1">(</span><span class="p" data-group-id="6554758811-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="6554758811-2">}</span><span class="p" data-group-id="6554758811-1">)</span><span class="w">
</span><span class="p" data-group-id="6554758811-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6554758811-4">%</span><span class="nc" data-group-id="6554758811-4">Reaction</span><span class="p" data-group-id="6554758811-4">{</span><span class="p" data-group-id="6554758811-4">}</span><span class="p" data-group-id="6554758811-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">create_reaction</span><span class="p" data-group-id="6554758811-5">(</span><span class="p" data-group-id="6554758811-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="6554758811-6">}</span><span class="p" data-group-id="6554758811-5">)</span><span class="w">
</span><span class="p" data-group-id="6554758811-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6554758811-8">%</span><span class="nc" data-group-id="6554758811-8">Ecto.Changeset</span><span class="p" data-group-id="6554758811-8">{</span><span class="p" data-group-id="6554758811-8">}</span><span class="p" data-group-id="6554758811-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="delete_all_posts/3">
<div class="detail-header">
<a href="#delete_all_posts/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">delete_all_posts(atom, attendee_identifier, event)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L189" 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_post/1">
<div class="detail-header">
<a href="#delete_post/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_post(post)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L183" 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 post.</p><h2 id="delete_post/1-examples" class="section-heading">
<a href="#delete_post/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_post</span><span class="p" data-group-id="3059907668-1">(</span><span class="n">post</span><span class="p" data-group-id="3059907668-1">)</span><span class="w">
</span><span class="p" data-group-id="3059907668-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3059907668-3">%</span><span class="nc" data-group-id="3059907668-3">Post</span><span class="p" data-group-id="3059907668-3">{</span><span class="p" data-group-id="3059907668-3">}</span><span class="p" data-group-id="3059907668-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">delete_post</span><span class="p" data-group-id="3059907668-4">(</span><span class="n">post</span><span class="p" data-group-id="3059907668-4">)</span><span class="w">
</span><span class="p" data-group-id="3059907668-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3059907668-6">%</span><span class="nc" data-group-id="3059907668-6">Ecto.Changeset</span><span class="p" data-group-id="3059907668-6">{</span><span class="p" data-group-id="3059907668-6">}</span><span class="p" data-group-id="3059907668-5">}</span></code></pre>
</section>
</section>
<section class="detail" id="delete_reaction/1">
<div class="detail-header">
<a href="#delete_reaction/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_reaction(params)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.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">
<p>Deletes a reaction.</p><h2 id="delete_reaction/1-examples" class="section-heading">
<a href="#delete_reaction/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_reaction</span><span class="p" data-group-id="0493989187-1">(</span><span class="n">reaction</span><span class="p" data-group-id="0493989187-1">)</span><span class="w">
</span><span class="p" data-group-id="0493989187-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0493989187-3">%</span><span class="nc" data-group-id="0493989187-3">Reaction</span><span class="p" data-group-id="0493989187-3">{</span><span class="p" data-group-id="0493989187-3">}</span><span class="p" data-group-id="0493989187-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">delete_reaction</span><span class="p" data-group-id="0493989187-4">(</span><span class="n">reaction</span><span class="p" data-group-id="0493989187-4">)</span><span class="w">
</span><span class="p" data-group-id="0493989187-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0493989187-6">%</span><span class="nc" data-group-id="0493989187-6">Ecto.Changeset</span><span class="p" data-group-id="0493989187-6">{</span><span class="p" data-group-id="0493989187-6">}</span><span class="p" data-group-id="0493989187-5">}</span></code></pre>
</section>
</section>
<section class="detail" id="get_post!/2">
<span id="get_post!/1"></span>
<div class="detail-header">
<a href="#get_post!/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_post!(id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L99" 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 post.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.10.1/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Post does not exist.</p><h2 id="get_post!/2-examples" class="section-heading">
<a href="#get_post!/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_post!</span><span class="p" data-group-id="0769074910-1">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p" data-group-id="0769074910-1">)</span><span class="w">
</span><span class="p" data-group-id="0769074910-2">%</span><span class="nc" data-group-id="0769074910-2">Post</span><span class="p" data-group-id="0769074910-2">{</span><span class="p" data-group-id="0769074910-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_post!</span><span class="p" data-group-id="0769074910-3">(</span><span class="s">&quot;123e4567-e89b-12d3-a456-426614174123&quot;</span><span class="p" data-group-id="0769074910-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_reaction!/1">
<div class="detail-header">
<a href="#get_reaction!/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_reaction!(id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L229" 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 reaction.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.10.1/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the Reaction does not exist.</p><h2 id="get_reaction!/1-examples" class="section-heading">
<a href="#get_reaction!/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_reaction!</span><span class="p" data-group-id="9991758578-1">(</span><span class="mi">123</span><span class="p" data-group-id="9991758578-1">)</span><span class="w">
</span><span class="p" data-group-id="9991758578-2">%</span><span class="nc" data-group-id="9991758578-2">Reaction</span><span class="p" data-group-id="9991758578-2">{</span><span class="p" data-group-id="9991758578-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_reaction!</span><span class="p" data-group-id="9991758578-3">(</span><span class="mi">456</span><span class="p" data-group-id="9991758578-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="list_pinned_posts/2">
<span id="list_pinned_posts/1"></span>
<div class="detail-header">
<a href="#list_pinned_posts/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_pinned_posts(event_id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L30" 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>Get only the pinned event posts.</p>
</section>
</section>
<section class="detail" id="list_posts/2">
<span id="list_posts/1"></span>
<div class="detail-header">
<a href="#list_posts/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_posts(event_id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L15" 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>Get event posts</p>
</section>
</section>
<section class="detail" id="list_unpinned_posts/2">
<span id="list_unpinned_posts/1"></span>
<div class="detail-header">
<a href="#list_unpinned_posts/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_unpinned_posts(event_id, preload \\ [])</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L46" 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>Get only the unpinned event posts.</p>
</section>
</section>
<section class="detail" id="reacted_posts/3">
<div class="detail-header">
<a href="#reacted_posts/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">reacted_posts(event_id, user_id, icon)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L59" 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="toggle_pin_post/1">
<div class="detail-header">
<a href="#toggle_pin_post/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">toggle_pin_post(post)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L153" 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>Pins or unpins a post based on its current state.</p><h2 id="toggle_pin_post/1-examples" class="section-heading">
<a href="#toggle_pin_post/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">toggle_pin_post</span><span class="p" data-group-id="4813311999-1">(</span><span class="n">post</span><span class="p" data-group-id="4813311999-1">)</span><span class="w">
</span><span class="p" data-group-id="4813311999-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4813311999-3">%</span><span class="nc" data-group-id="4813311999-3">Post</span><span class="p" data-group-id="4813311999-3">{</span><span class="p" data-group-id="4813311999-3">}</span><span class="p" data-group-id="4813311999-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">toggle_pin_post</span><span class="p" data-group-id="4813311999-4">(</span><span class="n">invalid_post</span><span class="p" data-group-id="4813311999-4">)</span><span class="w">
</span><span class="p" data-group-id="4813311999-5">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4813311999-6">%</span><span class="nc" data-group-id="4813311999-6">Ecto.Changeset</span><span class="p" data-group-id="4813311999-6">{</span><span class="p" data-group-id="4813311999-6">}</span><span class="p" data-group-id="4813311999-5">}</span></code></pre>
</section>
</section>
<section class="detail" id="update_post/2">
<div class="detail-header">
<a href="#update_post/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_post(post, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/posts.ex#L133" 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 post.</p><h2 id="update_post/2-examples" class="section-heading">
<a href="#update_post/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_post</span><span class="p" data-group-id="9369211997-1">(</span><span class="n">post</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9369211997-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="9369211997-2">}</span><span class="p" data-group-id="9369211997-1">)</span><span class="w">
</span><span class="p" data-group-id="9369211997-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9369211997-4">%</span><span class="nc" data-group-id="9369211997-4">Post</span><span class="p" data-group-id="9369211997-4">{</span><span class="p" data-group-id="9369211997-4">}</span><span class="p" data-group-id="9369211997-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">update_post</span><span class="p" data-group-id="9369211997-5">(</span><span class="n">post</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9369211997-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="9369211997-6">}</span><span class="p" data-group-id="9369211997-5">)</span><span class="w">
</span><span class="p" data-group-id="9369211997-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9369211997-8">%</span><span class="nc" data-group-id="9369211997-8">Ecto.Changeset</span><span class="p" data-group-id="9369211997-8">{</span><span class="p" data-group-id="9369211997-8">}</span><span class="p" data-group-id="9369211997-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>