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

1066 lines
55 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.Accounts — 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/accounts.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.Accounts</span>
<small class="app-vsn" translate="no">(Claper v1.7.0)</small>
</h1>
<section id="moduledoc">
<p>The Accounts 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="#apply_user_email/2" translate="no">apply_user_email(user, attrs)</a>
</div>
<div class="summary-synopsis"><p>Emulates that the email will change without actually changing
it in the database.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_user_email/2" translate="no">change_user_email(user, attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Returns an <code class="inline">%Ecto.Changeset{}</code> for changing the user email.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_user_password/2" translate="no">change_user_password(user, attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Returns an <code class="inline">%Ecto.Changeset{}</code> for changing the user password.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_user_registration/2" translate="no">change_user_registration(user, attrs \\ %{})</a>
</div>
<div class="summary-synopsis"><p>Returns an <code class="inline">%Ecto.Changeset{}</code> for tracking user changes.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#confirm_magic/1" translate="no">confirm_magic(token)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#confirm_user/1" translate="no">confirm_user(token)</a>
</div>
<div class="summary-synopsis"><p>Confirms a user by the given token.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete_session_token/1" translate="no">delete_session_token(token)</a>
</div>
<div class="summary-synopsis"><p>Deletes the signed token with the given context.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#deliver_magic_link/2" translate="no">deliver_magic_link(email, magic_link_url_fun)</a>
</div>
<div class="summary-synopsis"><p>Delivers the magic link email to the given user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#deliver_update_email_instructions/3" translate="no">deliver_update_email_instructions(user, current_email, update_email_url_fun)</a>
</div>
<div class="summary-synopsis"><p>Delivers the update email instructions to the given user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#deliver_user_confirmation_instructions/2" translate="no">deliver_user_confirmation_instructions(user, confirmation_url_fun)</a>
</div>
<div class="summary-synopsis"><p>Delivers the confirmation email instructions to the given user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#deliver_user_reset_password_instructions/2" translate="no">deliver_user_reset_password_instructions(user, reset_password_url_fun)</a>
</div>
<div class="summary-synopsis"><p>Delivers the reset password email to the given user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#generate_user_session_token/1" translate="no">generate_user_session_token(user)</a>
</div>
<div class="summary-synopsis"><p>Generates a session token.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_user!/1" translate="no">get_user!(id)</a>
</div>
<div class="summary-synopsis"><p>Gets a single user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_user_by_email/1" translate="no">get_user_by_email(email)</a>
</div>
<div class="summary-synopsis"><p>Gets a user by email.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_user_by_email_and_password/2" translate="no">get_user_by_email_and_password(email, password)</a>
</div>
<div class="summary-synopsis"><p>Gets a user by email and password.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_user_by_reset_password_token/1" translate="no">get_user_by_reset_password_token(token)</a>
</div>
<div class="summary-synopsis"><p>Gets the user by reset password token.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_user_by_session_token/1" translate="no">get_user_by_session_token(token)</a>
</div>
<div class="summary-synopsis"><p>Gets the user with the given signed token.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#magic_token_valid?/1" translate="no">magic_token_valid?(email)</a>
</div>
<div class="summary-synopsis"><p>Verify the token for a given user email is valid.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#register_user/1" translate="no">register_user(attrs)</a>
</div>
<div class="summary-synopsis"><p>Registers a user.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#reset_user_password/2" translate="no">reset_user_password(user, attrs)</a>
</div>
<div class="summary-synopsis"><p>Resets the user password.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_user_email/2" translate="no">update_user_email(user, token)</a>
</div>
<div class="summary-synopsis"><p>Updates the user email using the given token.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_user_password/2" translate="no">update_user_password(user, attrs)</a>
</div>
<div class="summary-synopsis"><p>Updates the user password.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_user_password/3" translate="no">update_user_password(user, password, attrs)</a>
</div>
<div class="summary-synopsis"><p>Updates the user password.</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="apply_user_email/2">
<div class="detail-header">
<a href="#apply_user_email/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">apply_user_email(user, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L124" 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>Emulates that the email will change without actually changing
it in the database.</p><h2 id="apply_user_email/2-examples" class="section-heading">
<a href="#apply_user_email/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">apply_user_email</span><span class="p" data-group-id="4275597051-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;valid password&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4275597051-2">%{</span><span class="ss">email</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="4275597051-2">}</span><span class="p" data-group-id="4275597051-1">)</span><span class="w">
</span><span class="p" data-group-id="4275597051-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4275597051-4">%</span><span class="nc" data-group-id="4275597051-4">User</span><span class="p" data-group-id="4275597051-4">{</span><span class="p" data-group-id="4275597051-4">}</span><span class="p" data-group-id="4275597051-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">apply_user_email</span><span class="p" data-group-id="4275597051-5">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;invalid password&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4275597051-6">%{</span><span class="ss">email</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="4275597051-6">}</span><span class="p" data-group-id="4275597051-5">)</span><span class="w">
</span><span class="p" data-group-id="4275597051-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="4275597051-8">%</span><span class="nc" data-group-id="4275597051-8">Ecto.Changeset</span><span class="p" data-group-id="4275597051-8">{</span><span class="p" data-group-id="4275597051-8">}</span><span class="p" data-group-id="4275597051-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="change_user_email/2">
<span id="change_user_email/1"></span>
<div class="detail-header">
<a href="#change_user_email/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_user_email(user, attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L107" 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 changing the user email.</p><h2 id="change_user_email/2-examples" class="section-heading">
<a href="#change_user_email/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_user_email</span><span class="p" data-group-id="2185190294-1">(</span><span class="n">user</span><span class="p" data-group-id="2185190294-1">)</span><span class="w">
</span><span class="p" data-group-id="2185190294-2">%</span><span class="nc" data-group-id="2185190294-2">Ecto.Changeset</span><span class="p" data-group-id="2185190294-2">{</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2185190294-3">%</span><span class="nc" data-group-id="2185190294-3">User</span><span class="p" data-group-id="2185190294-3">{</span><span class="p" data-group-id="2185190294-3">}</span><span class="p" data-group-id="2185190294-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="change_user_password/2">
<span id="change_user_password/1"></span>
<div class="detail-header">
<a href="#change_user_password/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_user_password(user, attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L223" 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 changing the user password.</p><h2 id="change_user_password/2-examples" class="section-heading">
<a href="#change_user_password/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_user_password</span><span class="p" data-group-id="8624874443-1">(</span><span class="n">user</span><span class="p" data-group-id="8624874443-1">)</span><span class="w">
</span><span class="p" data-group-id="8624874443-2">%</span><span class="nc" data-group-id="8624874443-2">Ecto.Changeset</span><span class="p" data-group-id="8624874443-2">{</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8624874443-3">%</span><span class="nc" data-group-id="8624874443-3">User</span><span class="p" data-group-id="8624874443-3">{</span><span class="p" data-group-id="8624874443-3">}</span><span class="p" data-group-id="8624874443-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="change_user_registration/2">
<span id="change_user_registration/1"></span>
<div class="detail-header">
<a href="#change_user_registration/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_user_registration(user, attrs \\ %{})</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L92" 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 user changes.</p><h2 id="change_user_registration/2-examples" class="section-heading">
<a href="#change_user_registration/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_user_registration</span><span class="p" data-group-id="9506288857-1">(</span><span class="n">user</span><span class="p" data-group-id="9506288857-1">)</span><span class="w">
</span><span class="p" data-group-id="9506288857-2">%</span><span class="nc" data-group-id="9506288857-2">Ecto.Changeset</span><span class="p" data-group-id="9506288857-2">{</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9506288857-3">%</span><span class="nc" data-group-id="9506288857-3">User</span><span class="p" data-group-id="9506288857-3">{</span><span class="p" data-group-id="9506288857-3">}</span><span class="p" data-group-id="9506288857-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="confirm_magic/1">
<div class="detail-header">
<a href="#confirm_magic/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">confirm_magic(token)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L399" 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="confirm_user/1">
<div class="detail-header">
<a href="#confirm_user/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">confirm_user(token)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L383" 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>Confirms a user by the given token.</p><p>If the token matches, the user account is marked as confirmed
and the token is deleted.</p>
</section>
</section>
<section class="detail" id="delete_session_token/1">
<div class="detail-header">
<a href="#delete_session_token/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_session_token(token)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L285" 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 the signed token with the given context.</p>
</section>
</section>
<section class="detail" id="deliver_magic_link/2">
<div class="detail-header">
<a href="#deliver_magic_link/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">deliver_magic_link(email, magic_link_url_fun)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.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">
<p>Delivers the magic link email to the given user.</p><h2 id="deliver_magic_link/2-examples" class="section-heading">
<a href="#deliver_magic_link/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">deliver_magic_link</span><span class="p" data-group-id="9922409573-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="nc">Routes</span><span class="o">.</span><span class="n">user_confirmation_url</span><span class="p" data-group-id="9922409573-2">(</span><span class="n">conn</span><span class="p">,</span><span class="w"> </span><span class="ss">:confirm_magic</span><span class="p">,</span><span class="w"> </span><span class="ni">&amp;1</span><span class="p" data-group-id="9922409573-2">)</span><span class="p" data-group-id="9922409573-1">)</span><span class="w">
</span><span class="p" data-group-id="9922409573-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9922409573-4">%{</span><span class="ss">to</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="9922409573-4">}</span><span class="p" data-group-id="9922409573-3">}</span></code></pre>
</section>
</section>
<section class="detail" id="deliver_update_email_instructions/3">
<div class="detail-header">
<a href="#deliver_update_email_instructions/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">deliver_update_email_instructions(user, current_email, update_email_url_fun)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L206" 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>Delivers the update email instructions to the given user.</p><h2 id="deliver_update_email_instructions/3-examples" class="section-heading">
<a href="#deliver_update_email_instructions/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">deliver_update_email_instructions</span><span class="p" data-group-id="1078305978-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="n">current_email</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="nc">Routes</span><span class="o">.</span><span class="n">user_update_email_url</span><span class="p" data-group-id="1078305978-2">(</span><span class="n">conn</span><span class="p">,</span><span class="w"> </span><span class="ss">:edit</span><span class="p">,</span><span class="w"> </span><span class="ni">&amp;1</span><span class="p" data-group-id="1078305978-2">)</span><span class="p" data-group-id="1078305978-1">)</span><span class="w">
</span><span class="p" data-group-id="1078305978-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1078305978-4">%{</span><span class="ss">to</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="1078305978-4">}</span><span class="p" data-group-id="1078305978-3">}</span></code></pre>
</section>
</section>
<section class="detail" id="deliver_user_confirmation_instructions/2">
<div class="detail-header">
<a href="#deliver_user_confirmation_instructions/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">deliver_user_confirmation_instructions(user, confirmation_url_fun)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L304" 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>Delivers the confirmation email instructions to the given user.</p><h2 id="deliver_user_confirmation_instructions/2-examples" class="section-heading">
<a href="#deliver_user_confirmation_instructions/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">deliver_user_confirmation_instructions</span><span class="p" data-group-id="6245243131-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="nc">Routes</span><span class="o">.</span><span class="n">user_confirmation_url</span><span class="p" data-group-id="6245243131-2">(</span><span class="n">conn</span><span class="p">,</span><span class="w"> </span><span class="ss">:edit</span><span class="p">,</span><span class="w"> </span><span class="ni">&amp;1</span><span class="p" data-group-id="6245243131-2">)</span><span class="p" data-group-id="6245243131-1">)</span><span class="w">
</span><span class="p" data-group-id="6245243131-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6245243131-4">%{</span><span class="ss">to</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="6245243131-4">}</span><span class="p" data-group-id="6245243131-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">deliver_user_confirmation_instructions</span><span class="p" data-group-id="6245243131-5">(</span><span class="n">confirmed_user</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="nc">Routes</span><span class="o">.</span><span class="n">user_confirmation_url</span><span class="p" data-group-id="6245243131-6">(</span><span class="n">conn</span><span class="p">,</span><span class="w"> </span><span class="ss">:edit</span><span class="p">,</span><span class="w"> </span><span class="ni">&amp;1</span><span class="p" data-group-id="6245243131-6">)</span><span class="p" data-group-id="6245243131-5">)</span><span class="w">
</span><span class="p" data-group-id="6245243131-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="ss">:already_confirmed</span><span class="p" data-group-id="6245243131-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="deliver_user_reset_password_instructions/2">
<div class="detail-header">
<a href="#deliver_user_reset_password_instructions/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">deliver_user_reset_password_instructions(user, reset_password_url_fun)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L326" 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>Delivers the reset password email to the given user.</p><h2 id="deliver_user_reset_password_instructions/2-examples" class="section-heading">
<a href="#deliver_user_reset_password_instructions/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">deliver_user_reset_password_instructions</span><span class="p" data-group-id="6499256774-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="nc">Routes</span><span class="o">.</span><span class="n">user_reset_password_url</span><span class="p" data-group-id="6499256774-2">(</span><span class="n">conn</span><span class="p">,</span><span class="w"> </span><span class="ss">:edit</span><span class="p">,</span><span class="w"> </span><span class="ni">&amp;1</span><span class="p" data-group-id="6499256774-2">)</span><span class="p" data-group-id="6499256774-1">)</span><span class="w">
</span><span class="p" data-group-id="6499256774-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6499256774-4">%{</span><span class="ss">to</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p">,</span><span class="w"> </span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="6499256774-4">}</span><span class="p" data-group-id="6499256774-3">}</span></code></pre>
</section>
</section>
<section class="detail" id="generate_user_session_token/1">
<div class="detail-header">
<a href="#generate_user_session_token/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">generate_user_session_token(user)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L260" 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>Generates a session token.</p>
</section>
</section>
<section class="detail" id="get_user!/1">
<div class="detail-header">
<a href="#get_user!/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_user!(id)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L61" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Gets a single user.</p><p>Raises <a href="https://hexdocs.pm/ecto/3.10.1/Ecto.NoResultsError.html"><code class="inline">Ecto.NoResultsError</code></a> if the User does not exist.</p><h2 id="get_user!/1-examples" class="section-heading">
<a href="#get_user!/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_user!</span><span class="p" data-group-id="7192138092-1">(</span><span class="mi">123</span><span class="p" data-group-id="7192138092-1">)</span><span class="w">
</span><span class="p" data-group-id="7192138092-2">%</span><span class="nc" data-group-id="7192138092-2">User</span><span class="p" data-group-id="7192138092-2">{</span><span class="p" data-group-id="7192138092-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_user!</span><span class="p" data-group-id="7192138092-3">(</span><span class="mi">456</span><span class="p" data-group-id="7192138092-3">)</span><span class="w">
</span><span class="gt">** (Ecto.NoResultsError)</span></code></pre>
</section>
</section>
<section class="detail" id="get_user_by_email/1">
<div class="detail-header">
<a href="#get_user_by_email/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_user_by_email(email)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L25" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Gets a user by email.</p><h2 id="get_user_by_email/1-examples" class="section-heading">
<a href="#get_user_by_email/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_user_by_email</span><span class="p" data-group-id="3474587744-1">(</span><span class="s">&quot;foo@example.com&quot;</span><span class="p" data-group-id="3474587744-1">)</span><span class="w">
</span><span class="p" data-group-id="3474587744-2">%</span><span class="nc" data-group-id="3474587744-2">User</span><span class="p" data-group-id="3474587744-2">{</span><span class="p" data-group-id="3474587744-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_user_by_email</span><span class="p" data-group-id="3474587744-3">(</span><span class="s">&quot;unknown@example.com&quot;</span><span class="p" data-group-id="3474587744-3">)</span><span class="w">
</span><span class="no">nil</span></code></pre>
</section>
</section>
<section class="detail" id="get_user_by_email_and_password/2">
<div class="detail-header">
<a href="#get_user_by_email_and_password/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_user_by_email_and_password(email, password)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L41" 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 user by email and password.</p><h2 id="get_user_by_email_and_password/2-examples" class="section-heading">
<a href="#get_user_by_email_and_password/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_user_by_email_and_password</span><span class="p" data-group-id="3955219363-1">(</span><span class="s">&quot;foo@example.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;correct_password&quot;</span><span class="p" data-group-id="3955219363-1">)</span><span class="w">
</span><span class="p" data-group-id="3955219363-2">%</span><span class="nc" data-group-id="3955219363-2">User</span><span class="p" data-group-id="3955219363-2">{</span><span class="p" data-group-id="3955219363-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_user_by_email_and_password</span><span class="p" data-group-id="3955219363-3">(</span><span class="s">&quot;foo@example.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;invalid_password&quot;</span><span class="p" data-group-id="3955219363-3">)</span><span class="w">
</span><span class="no">nil</span></code></pre>
</section>
</section>
<section class="detail" id="get_user_by_reset_password_token/1">
<div class="detail-header">
<a href="#get_user_by_reset_password_token/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_user_by_reset_password_token(token)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L345" 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 the user by reset password token.</p><h2 id="get_user_by_reset_password_token/1-examples" class="section-heading">
<a href="#get_user_by_reset_password_token/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_user_by_reset_password_token</span><span class="p" data-group-id="2138543272-1">(</span><span class="s">&quot;validtoken&quot;</span><span class="p" data-group-id="2138543272-1">)</span><span class="w">
</span><span class="p" data-group-id="2138543272-2">%</span><span class="nc" data-group-id="2138543272-2">User</span><span class="p" data-group-id="2138543272-2">{</span><span class="p" data-group-id="2138543272-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">get_user_by_reset_password_token</span><span class="p" data-group-id="2138543272-3">(</span><span class="s">&quot;invalidtoken&quot;</span><span class="p" data-group-id="2138543272-3">)</span><span class="w">
</span><span class="no">nil</span></code></pre>
</section>
</section>
<section class="detail" id="get_user_by_session_token/1">
<div class="detail-header">
<a href="#get_user_by_session_token/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_user_by_session_token(token)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L269" 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 the user with the given signed token.</p>
</section>
</section>
<section class="detail" id="magic_token_valid?/1">
<div class="detail-header">
<a href="#magic_token_valid?/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">magic_token_valid?(email)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L277" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Verify the token for a given user email is valid.</p>
</section>
</section>
<section class="detail" id="register_user/1">
<div class="detail-header">
<a href="#register_user/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">register_user(attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L77" 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>Registers a user.</p><h2 id="register_user/1-examples" class="section-heading">
<a href="#register_user/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">register_user</span><span class="p" data-group-id="3397506826-1">(</span><span class="p" data-group-id="3397506826-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="3397506826-2">}</span><span class="p" data-group-id="3397506826-1">)</span><span class="w">
</span><span class="p" data-group-id="3397506826-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3397506826-4">%</span><span class="nc" data-group-id="3397506826-4">User</span><span class="p" data-group-id="3397506826-4">{</span><span class="p" data-group-id="3397506826-4">}</span><span class="p" data-group-id="3397506826-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">register_user</span><span class="p" data-group-id="3397506826-5">(</span><span class="p" data-group-id="3397506826-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="3397506826-6">}</span><span class="p" data-group-id="3397506826-5">)</span><span class="w">
</span><span class="p" data-group-id="3397506826-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="3397506826-8">%</span><span class="nc" data-group-id="3397506826-8">Ecto.Changeset</span><span class="p" data-group-id="3397506826-8">{</span><span class="p" data-group-id="3397506826-8">}</span><span class="p" data-group-id="3397506826-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="reset_user_password/2">
<div class="detail-header">
<a href="#reset_user_password/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">reset_user_password(user, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L366" 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>Resets the user password.</p><h2 id="reset_user_password/2-examples" class="section-heading">
<a href="#reset_user_password/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">reset_user_password</span><span class="p" data-group-id="9689645102-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9689645102-2">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;new long password&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">password_confirmation</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;new long password&quot;</span><span class="p" data-group-id="9689645102-2">}</span><span class="p" data-group-id="9689645102-1">)</span><span class="w">
</span><span class="p" data-group-id="9689645102-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9689645102-4">%</span><span class="nc" data-group-id="9689645102-4">User</span><span class="p" data-group-id="9689645102-4">{</span><span class="p" data-group-id="9689645102-4">}</span><span class="p" data-group-id="9689645102-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">reset_user_password</span><span class="p" data-group-id="9689645102-5">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9689645102-6">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;valid&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">password_confirmation</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;not the same&quot;</span><span class="p" data-group-id="9689645102-6">}</span><span class="p" data-group-id="9689645102-5">)</span><span class="w">
</span><span class="p" data-group-id="9689645102-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9689645102-8">%</span><span class="nc" data-group-id="9689645102-8">Ecto.Changeset</span><span class="p" data-group-id="9689645102-8">{</span><span class="p" data-group-id="9689645102-8">}</span><span class="p" data-group-id="9689645102-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="update_user_email/2">
<div class="detail-header">
<a href="#update_user_email/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_user_email(user, token)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L136" 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 the user email using the given token.</p><p>If the token matches, the user email is updated and the token is deleted.
The confirmed_at date is also updated to the current time.</p>
</section>
</section>
<section class="detail" id="update_user_password/2">
<div class="detail-header">
<a href="#update_user_password/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_user_password(user, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L239" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Updates the user password.</p><h2 id="update_user_password/2-examples" class="section-heading">
<a href="#update_user_password/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_user_password</span><span class="p" data-group-id="8448264011-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;valid password&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8448264011-2">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="8448264011-2">}</span><span class="p" data-group-id="8448264011-1">)</span><span class="w">
</span><span class="p" data-group-id="8448264011-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8448264011-4">%</span><span class="nc" data-group-id="8448264011-4">User</span><span class="p" data-group-id="8448264011-4">{</span><span class="p" data-group-id="8448264011-4">}</span><span class="p" data-group-id="8448264011-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">update_user_password</span><span class="p" data-group-id="8448264011-5">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;invalid password&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8448264011-6">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="8448264011-6">}</span><span class="p" data-group-id="8448264011-5">)</span><span class="w">
</span><span class="p" data-group-id="8448264011-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8448264011-8">%</span><span class="nc" data-group-id="8448264011-8">Ecto.Changeset</span><span class="p" data-group-id="8448264011-8">{</span><span class="p" data-group-id="8448264011-8">}</span><span class="p" data-group-id="8448264011-7">}</span></code></pre>
</section>
</section>
<section class="detail" id="update_user_password/3">
<div class="detail-header">
<a href="#update_user_password/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_user_password(user, password, attrs)</h1>
<a href="https://github.com/ClaperCo/Claper/blob/main/lib/claper/accounts.ex#L164" 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 the user password.</p><h2 id="update_user_password/3-examples" class="section-heading">
<a href="#update_user_password/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_user_password</span><span class="p" data-group-id="8032280878-1">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;valid password&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8032280878-2">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="8032280878-2">}</span><span class="p" data-group-id="8032280878-1">)</span><span class="w">
</span><span class="p" data-group-id="8032280878-3">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8032280878-4">%</span><span class="nc" data-group-id="8032280878-4">User</span><span class="p" data-group-id="8032280878-4">{</span><span class="p" data-group-id="8032280878-4">}</span><span class="p" data-group-id="8032280878-3">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">update_user_password</span><span class="p" data-group-id="8032280878-5">(</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;invalid password&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8032280878-6">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="n">...</span><span class="p" data-group-id="8032280878-6">}</span><span class="p" data-group-id="8032280878-5">)</span><span class="w">
</span><span class="p" data-group-id="8032280878-7">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="8032280878-8">%</span><span class="nc" data-group-id="8032280878-8">Ecto.Changeset</span><span class="p" data-group-id="8032280878-8">{</span><span class="p" data-group-id="8032280878-8">}</span><span class="p" data-group-id="8032280878-7">}</span></code></pre>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Claper.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.4) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink