2023-07-12 11:28:07 +03:00
<!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" >
2023-07-25 10:58:48 +03:00
< meta name = "generator" content = "ExDoc v0.30.3" >
2023-07-12 11:28:07 +03:00
< meta name = "project" content = "Plausible v0.0.1" >
< title > Plausible.Auth.GracePeriod — Plausible v0.0.1< / title >
2023-07-25 10:58:48 +03:00
< link rel = "stylesheet" href = "dist/html-elixir-P5GXSCHE.css" / >
2023-07-12 11:28:07 +03:00
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
2023-07-25 10:58:48 +03:00
< script src = "dist/handlebars.templates-NBND3S2D.js" > < / script >
2024-01-09 17:58:54 +03:00
< script src = "dist/sidebar_items-5B076C9F.js" > < / script >
2023-07-12 11:28:07 +03:00
< script src = "docs_config.js" > < / script >
2023-07-25 10:58:48 +03:00
< script async src = "dist/html-CGDDOCMI.js" > < / script >
2023-07-12 11:28:07 +03:00
< / 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 = "readme.html" >
< img src = "assets/logo.png" alt = "Plausible" class = "sidebar-projectImage" >
< / a >
< div class = "sidebar-projectDetails" >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
Plausible
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
< / div >
< ul class = "sidebar-listNav" >
< li > < a id = "extras-list-link" href = "#full-list" > Pages< / a > < / li >
< li > < a id = "modules-list-link" href = "#full-list" > Modules< / a > < / li >
< li > < a id = "tasks-list-link" href = "#full-list" > < span translate = "no" > Mix< / span > Tasks< / 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/plausible/analytics/blob/main/lib/plausible/auth/grace_period.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" > Plausible.Auth.GracePeriod< / span >
< small class = "app-vsn" translate = "no" > (Plausible v0.0.1)< / small >
< / h1 >
< section id = "moduledoc" >
< p > This embedded schema stores information about the account locking grace
period.< / p > < p > Users are given this 7-day grace period to upgrade their account after
outgrowing their subscriptions. The actual account locking happens in
background with < a href = "Plausible.Workers.LockSites.html" > < code class = "inline" > Plausible.Workers.LockSites< / code > < / a > .< / p > < p > The grace period can also be manual, without an end date, being controlled
manually from the CRM, and not by the background site locker job. This is
useful for enterprise subscriptions.< / 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 >
2023-07-25 10:58:48 +03:00
Summary
2023-07-12 11:28:07 +03:00
< / a >
< / h1 >
< div class = "summary-types summary" >
< h2 >
< a href = "#types" > Types< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:t/0" translate = "no" > t()< / a >
< / div >
< / div >
< / div >
< div class = "summary-functions summary" >
< h2 >
< a href = "#functions" > Functions< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#active?/1" translate = "no" > active?(user)< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns whether the grace period is still active for a User. Defaults to
false if the user is nil or there is no grace period.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#end_changeset/1" translate = "no" > end_changeset(user)< / a >
< / div >
< div class = "summary-synopsis" > < p > Ends an existing grace period by < code class = "inline" > setting users.grace_period.is_over< / code > to true.
This means the grace period has expired.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#expired?/1" translate = "no" > expired?(user)< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns whether the grace period has already expired for a User. Defaults to
false if the user is nil or there is no grace period.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#remove_changeset/1" translate = "no" > remove_changeset(user)< / a >
< / div >
< div class = "summary-synopsis" > < p > Removes the grace period from the User completely.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#start_changeset/2" translate = "no" > start_changeset(user, allowance_required)< / a >
< / div >
< div class = "summary-synopsis" > < p > Starts a account locking grace period of 7 days by changing the User struct.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#start_manual_lock_changeset/2" translate = "no" > start_manual_lock_changeset(user, allowance_required)< / a >
< / div >
< div class = "summary-synopsis" > < p > Starts a manual account locking grace period by changing the User struct.
Manual locking means the grace period can only be removed manually from the
CRM.< / p > < / div >
< / div >
< / div >
< / section >
< section id = "types" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#types" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
Types
2023-07-25 10:58:48 +03:00
< / a >
2023-07-12 11:28:07 +03:00
< / h1 >
< div class = "types-list" >
< section class = "detail" id = "t:t/0" >
< div class = "detail-header" >
< a href = "#t:t/0" class = "detail-link" title = "Link to this type" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this type< / span >
< / a >
< h1 class = "signature" translate = "no" > t()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/grace_period.ex#L18" 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" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @type< / span > t() :: %Plausible.Auth.GracePeriod{
allowance_required: < a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > non_neg_integer< / a > (),
end_date: < a href = "https://hexdocs.pm/elixir/Date.html#t:t/0" > Date.t< / a > () | nil,
id: < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > term< / a > (),
is_over: < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > boolean< / a > (),
manual_lock: < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > boolean< / a > ()
}< / pre >
< / div >
< / section >
< / section >
< / 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 >
Functions
2023-07-25 10:58:48 +03:00
< / a >
2023-07-12 11:28:07 +03:00
< / h1 >
< div class = "functions-list" >
< section class = "detail" id = "active?/1" >
< div class = "detail-header" >
< a href = "#active?/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" > active?(user)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/grace_period.ex#L86" 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" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > active?(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) :: < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > boolean< / a > ()< / pre >
< / div >
< p > Returns whether the grace period is still active for a User. Defaults to
false if the user is nil or there is no grace period.< / p >
< / section >
< / section >
< section class = "detail" id = "end_changeset/1" >
< div class = "detail-header" >
< a href = "#end_changeset/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" > end_changeset(user)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/grace_period.ex#L69" 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" >
< div class = "specs" >
2023-07-26 11:45:08 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > end_changeset(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) :: < a href = "https://hexdocs.pm/ecto/3.10.3/Ecto.Changeset.html#t:t/0" > Ecto.Changeset.t< / a > ()< / pre >
2023-07-12 11:28:07 +03:00
< / div >
< p > Ends an existing grace period by < code class = "inline" > setting users.grace_period.is_over< / code > to true.
This means the grace period has expired.< / p >
< / section >
< / section >
< section class = "detail" id = "expired?/1" >
< div class = "detail-header" >
< a href = "#expired?/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" > expired?(user)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/grace_period.ex#L103" 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" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > expired?(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) :: < a href = "https://hexdocs.pm/elixir/typespecs.html#built-in-types" > boolean< / a > ()< / pre >
< / div >
< p > Returns whether the grace period has already expired for a User. Defaults to
false if the user is nil or there is no grace period.< / p >
< / section >
< / section >
< section class = "detail" id = "remove_changeset/1" >
< div class = "detail-header" >
< a href = "#remove_changeset/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" > remove_changeset(user)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/grace_period.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" >
< div class = "specs" >
2023-07-26 11:45:08 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > remove_changeset(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) :: < a href = "https://hexdocs.pm/ecto/3.10.3/Ecto.Changeset.html#t:t/0" > Ecto.Changeset.t< / a > ()< / pre >
2023-07-12 11:28:07 +03:00
< / div >
< p > Removes the grace period from the User completely.< / p >
< / section >
< / section >
< section class = "detail" id = "start_changeset/2" >
< div class = "detail-header" >
< a href = "#start_changeset/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" > start_changeset(user, allowance_required)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/grace_period.ex#L36" 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" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > start_changeset(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), < a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > non_neg_integer< / a > ()) ::
2023-07-26 11:45:08 +03:00
< a href = "https://hexdocs.pm/ecto/3.10.3/Ecto.Changeset.html#t:t/0" > Ecto.Changeset.t< / a > ()< / pre >
2023-07-12 11:28:07 +03:00
< / div >
< p > Starts a account locking grace period of 7 days by changing the User struct.< / p >
< / section >
< / section >
< section class = "detail" id = "start_manual_lock_changeset/2" >
< div class = "detail-header" >
< a href = "#start_manual_lock_changeset/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" > start_manual_lock_changeset(user, allowance_required)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/auth/grace_period.ex#L53" 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" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @spec< / span > start_manual_lock_changeset(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > (), < a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > non_neg_integer< / a > ()) ::
2023-07-26 11:45:08 +03:00
< a href = "https://hexdocs.pm/ecto/3.10.3/Ecto.Changeset.html#t:t/0" > Ecto.Changeset.t< / a > ()< / pre >
2023-07-12 11:28:07 +03:00
< / div >
< p > Starts a manual account locking grace period by changing the User struct.
Manual locking means the grace period can only be removed manually from the
CRM.< / p >
< / 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 = "Plausible.epub" title = "ePub version" >
Download ePub version
< / a >
< / span >
< / p >
< p class = "built-using" >
Built using
2023-07-25 10:58:48 +03:00
< a href = "https://github.com/elixir-lang/ex_doc" title = "ExDoc" target = "_blank" rel = "help noopener" translate = "no" > ExDoc< / a > (v0.30.3) for the
2023-07-12 11:28:07 +03:00
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
< / section >
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
