mirror of
https://github.com/plausible/analytics.git
synced 2024-11-30 00:58:54 +03:00
501 lines
15 KiB
HTML
501 lines
15 KiB
HTML
<!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.31.1">
|
||
<meta name="project" content="Plausible v0.0.1">
|
||
|
||
|
||
<title>Plausible.Teams — Plausible v0.0.1</title>
|
||
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
|
||
|
||
|
||
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
|
||
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
|
||
<script src="dist/sidebar_items-E74E240A.js"></script>
|
||
|
||
<script src="docs_config.js"></script>
|
||
|
||
<script async src="dist/html-L4O5OK2K.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 id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
|
||
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
|
||
</button>
|
||
|
||
<div class="background-layer"></div>
|
||
|
||
<nav id="sidebar" class="sidebar">
|
||
|
||
<div class="sidebar-header">
|
||
<div class="sidebar-projectInfo">
|
||
|
||
<a href="readme.html" class="sidebar-projectImage">
|
||
<img src="assets/logo.png" alt="Plausible" />
|
||
</a>
|
||
|
||
<div>
|
||
<a href="readme.html" class="sidebar-projectName" translate="no">
|
||
Plausible
|
||
</a>
|
||
<div class="sidebar-projectVersion" translate="no">
|
||
v0.0.1
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
|
||
<li>
|
||
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
|
||
Pages
|
||
</button>
|
||
</li>
|
||
|
||
<li>
|
||
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
|
||
Modules
|
||
</button>
|
||
</li>
|
||
|
||
|
||
<li>
|
||
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
|
||
<span translate="no">Mix</span> Tasks
|
||
</button>
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
|
||
<ul id="extras-full-list" class="full-list"></ul>
|
||
</div>
|
||
|
||
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
|
||
<ul id="modules-full-list" class="full-list"></ul>
|
||
</div>
|
||
|
||
|
||
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
|
||
<ul id="tasks-full-list" class="full-list"></ul>
|
||
</div>
|
||
|
||
</nav>
|
||
|
||
<main class="content">
|
||
<output role="status" id="toast"></output>
|
||
<div class="content-outer">
|
||
<div id="content" class="content-inner">
|
||
<div class="top-search">
|
||
<div class="search-settings">
|
||
<form class="search-bar" action="search.html">
|
||
<label class="search-label">
|
||
<span class="sr-only">Search documentation of Plausible</span>
|
||
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
|
||
</label>
|
||
<button type="submit" class="search-button" aria-label="Submit Search">
|
||
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
|
||
</button>
|
||
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
|
||
<i class="ri-close-line ri-lg" title="Cancel search"></i>
|
||
</button>
|
||
</form>
|
||
<div class="autocomplete">
|
||
</div>
|
||
<button class="icon-settings display-settings">
|
||
<i class="ri-settings-3-line"></i>
|
||
<span class="sr-only">Settings</span>
|
||
</button>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.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.Teams</span>
|
||
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
|
||
|
||
</h1>
|
||
|
||
|
||
<section id="moduledoc">
|
||
<p>Core context of teams.</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>
|
||
</a>
|
||
<span class="text">Summary</span>
|
||
</h1>
|
||
<div class="summary-functions summary">
|
||
<h2>
|
||
<a href="#functions">Functions</a>
|
||
</h2>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#get_by_owner/1" translate="no">get_by_owner(user)</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#get_or_create/1" translate="no">get_or_create(user)</a>
|
||
|
||
</div>
|
||
|
||
<div class="summary-synopsis"><p>Get or create user's team.</p></div>
|
||
|
||
</div>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#load_for_site/1" translate="no">load_for_site(site)</a>
|
||
|
||
</div>
|
||
|
||
<div class="summary-synopsis"><p>Create (when necessary) and load team relation for provided site.</p></div>
|
||
|
||
</div>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#on_trial?/1" translate="no">on_trial?(team)</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#owned_sites/1" translate="no">owned_sites(team)</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#read_team_schemas?/1" translate="no">read_team_schemas?(user)</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#sync_team/1" translate="no">sync_team(user)</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#trial_days_left/1" translate="no">trial_days_left(team)</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="summary-row">
|
||
<div class="summary-signature">
|
||
<a href="#with_subscription/1" translate="no">with_subscription(team)</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
<section id="functions" class="details-list">
|
||
<h1 class="section-heading">
|
||
<a class="hover-link" href="#functions">
|
||
<i class="ri-link-m" aria-hidden="true"></i>
|
||
</a>
|
||
<span class="text">Functions</span>
|
||
</h1>
|
||
<div class="functions-list">
|
||
<section class="detail" id="get_by_owner/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#get_by_owner/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_by_owner(user)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.ex#L94" class="icon-action" rel="help" title="View Source">
|
||
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
||
<span class="sr-only">View Source</span>
|
||
</a>
|
||
|
||
|
||
</div>
|
||
|
||
<section class="docstring">
|
||
|
||
|
||
</section>
|
||
</section>
|
||
<section class="detail" id="get_or_create/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#get_or_create/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_or_create(user)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.ex#L74" 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 or create user's team.</p><p>If the user has no non-guest membership yet, an implicit "My Team" team is
|
||
created with them as an owner.</p><p>If the user already has an owner membership in an existing team,
|
||
that team is returned.</p><p>If the user has a non-guest membership other than owner, <code class="inline">:no_team</code> error
|
||
is returned.</p>
|
||
</section>
|
||
</section>
|
||
<section class="detail" id="load_for_site/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#load_for_site/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">load_for_site(site)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.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>Create (when necessary) and load team relation for provided site.</p><p>Used for sync logic to work smoothly during transitional period.</p>
|
||
</section>
|
||
</section>
|
||
<section class="detail" id="on_trial?/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#on_trial?/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">on_trial?(team)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.ex#L14" 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> on_trial?(<a href="Plausible.Teams.Team.html#t:t/0">Plausible.Teams.Team.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
</section>
|
||
<section class="detail" id="owned_sites/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#owned_sites/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">owned_sites(team)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.ex#L37" 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="read_team_schemas?/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#read_team_schemas?/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">read_team_schemas?(user)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.ex#L29" 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="sync_team/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#sync_team/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">sync_team(user)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.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">
|
||
|
||
|
||
</section>
|
||
</section>
|
||
<section class="detail" id="trial_days_left/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#trial_days_left/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">trial_days_left(team)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.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">
|
||
|
||
<div class="specs">
|
||
|
||
<pre translate="no"><span class="attribute">@spec</span> trial_days_left(<a href="Plausible.Teams.Team.html#t:t/0">Plausible.Teams.Team.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()</pre>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
</section>
|
||
<section class="detail" id="with_subscription/1">
|
||
|
||
<div class="detail-header">
|
||
<a href="#with_subscription/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">with_subscription(team)</h1>
|
||
|
||
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/teams.ex#L33" class="icon-action" rel="help" title="View Source">
|
||
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
||
<span class="sr-only">View Source</span>
|
||
</a>
|
||
|
||
|
||
</div>
|
||
|
||
<section class="docstring">
|
||
|
||
|
||
</section>
|
||
</section>
|
||
|
||
</div>
|
||
</section>
|
||
|
||
<footer class="footer">
|
||
<p>
|
||
|
||
<span class="line">
|
||
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
|
||
Search HexDocs
|
||
</button>
|
||
|
||
<a href="Plausible.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.31.1) for the
|
||
|
||
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
|
||
|
||
</p>
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</main>
|
||
</div>
|
||
|
||
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
||
<script>mermaid.initialize({startOnLoad: true})</script>
|
||
|
||
</body>
|
||
</html>
|