mirrors/bonfire-app
1
0
Fork 0
mirror of https://github.com/bonfire-networks/bonfire-app.git synced 2024-05-17 08:32:41 +00:00
Code Issues Projects Releases Wiki Activity
bonfire-app/ValueFlows.Proposal.Proposals.html
mayel 8c4192f0be deploy: f0e6222a43
2024-04-16 21:21:08 +00:00

726 lines
24 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.31.2">
<meta name="project" content="bonfire_umbrella v0.9.10-cooperation-beta.62">
<title>ValueFlows.Proposal.Proposals — bonfire_umbrella v0.9.10-cooperation-beta.62</title>
<link rel="stylesheet" href="dist/html-elixir-JKHCEBPC.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-A7S2WMC7.js"></script>
<script src="dist/sidebar_items-0AD831F9.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-JRPQ5PR6.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="https://bonfirenetworks.org" class="sidebar-projectImage">
<img src="assets/logo.png" alt="bonfire_umbrella" />
</a>
<div>
<a href="https://bonfirenetworks.org" class="sidebar-projectName" translate="no">
bonfire_umbrella
</a>
<div class="sidebar-projectVersion" translate="no">
v0.9.10-cooperation-beta.62
</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>
</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>
</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 bonfire_umbrella</span>
<input name="q" type="text" class="search-input" placeholder="Press / to search" 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/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L2" 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">ValueFlows.Proposal.Proposals</span>
<small class="app-vsn" translate="no">(bonfire_umbrella v0.9.10-cooperation-beta.62)</small>
</h1>
<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="#ap_publish_activity/3" translate="no">ap_publish_activity(subject, activity_name, thing)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#ap_receive_activity/3" translate="no">ap_receive_activity(creator, activity, object)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#create/2" translate="no">create(creator, attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#cursor/0" translate="no">cursor()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#federation_module/0" translate="no">federation_module()</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/bonfire_federate_activitypub/0.1.0/Bonfire.Federate.ActivityPub.FederationModules.html#c:federation_module/0"><code class="inline">Bonfire.Federate.ActivityPub.FederationModules.federation_module/0</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#fields/2" translate="no">fields(group_fn, filters \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#indexing_object_format/1" translate="no">indexing_object_format(obj)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#many/1" translate="no">many(filters \\ [])</a>
</div>
<div class="summary-synopsis"><p>Retrieves a list of them by arbitrary filters.
Used by</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#one/1" translate="no">one(filters)</a>
</div>
<div class="summary-synopsis"><p>Retrieves a single one by arbitrary filters.
Used by</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#page/5" translate="no">page(cursor_fn, page_opts, base_filters \\ [], data_filters \\ [], count_filters \\ [])</a>
</div>
<div class="summary-synopsis"><p>Retrieves an Page of proposals according to various filters</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#pages/6" translate="no">pages(cursor_fn, group_fn, page_opts, base_filters \\ [], data_filters \\ [], count_filters \\ [])</a>
</div>
<div class="summary-synopsis"><p>Retrieves an Pages of proposals according to various filters</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#preload_all/1" translate="no">preload_all(proposal)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#soft_delete/1" translate="no">soft_delete(proposal)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#test_cursor/0" translate="no">test_cursor()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update/2" translate="no">update(proposal, attrs)</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="ap_publish_activity/3">
<div class="detail-header">
<a href="#ap_publish_activity/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">ap_publish_activity(subject, activity_name, thing)</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L185" 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="ap_receive_activity/3">
<div class="detail-header">
<a href="#ap_receive_activity/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">ap_receive_activity(creator, activity, object)</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L198" 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="create/2">
<div class="detail-header">
<a href="#create/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(creator, attrs)</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L129" 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> create(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>(), attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) ::
{:ok, <a href="https://hexdocs.pm/bonfire_valueflows/0.1.0/ValueFlows.Proposal.html#t:t/0">ValueFlows.Proposal.t</a>()} | {:error, Changeset.t()}</pre>
</div>
</section>
</section>
<section class="detail" id="cursor/0">
<div class="detail-header">
<a href="#cursor/0" 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">cursor()</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L24" 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="federation_module/0">
<div class="detail-header">
<a href="#federation_module/0" 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">federation_module()</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L22" 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>Callback implementation for <a href="https://hexdocs.pm/bonfire_federate_activitypub/0.1.0/Bonfire.Federate.ActivityPub.FederationModules.html#c:federation_module/0"><code class="inline">Bonfire.Federate.ActivityPub.FederationModules.federation_module/0</code></a>.</p>
</section>
</section>
<section class="detail" id="fields/2">
<span id="fields/1"></span>
<div class="detail-header">
<a href="#fields/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">fields(group_fn, filters \\ [])</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L44" 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="indexing_object_format/1">
<div class="detail-header">
<a href="#indexing_object_format/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">indexing_object_format(obj)</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L168" 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="many/1">
<span id="many/0"></span>
<div class="detail-header">
<a href="#many/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">many(filters \\ [])</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.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>Retrieves a list of them by arbitrary filters.
Used by:</p><ul><li>Various parts of the codebase that need to query for this (inc. tests)</li></ul>
</section>
</section>
<section class="detail" id="one/1">
<div class="detail-header">
<a href="#one/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">one(filters)</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L34" 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>Retrieves a single one by arbitrary filters.
Used by:</p><ul><li>GraphQL Item queries</li><li>ActivityPub integration</li><li>Various parts of the codebase that need to query for this (inc. tests)</li></ul>
</section>
</section>
<section class="detail" id="page/5">
<span id="page/2"></span>
<span id="page/3"></span>
<span id="page/4"></span>
<div class="detail-header">
<a href="#page/5" 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">page(cursor_fn, page_opts, base_filters \\ [], data_filters \\ [], count_filters \\ [])</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L56" 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>Retrieves an Page of proposals according to various filters</p><p>Used by:</p><ul><li>GraphQL resolver single-parent resolution</li></ul>
</section>
</section>
<section class="detail" id="pages/6">
<span id="pages/3"></span>
<span id="pages/4"></span>
<span id="pages/5"></span>
<div class="detail-header">
<a href="#pages/6" 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">pages(cursor_fn, group_fn, page_opts, base_filters \\ [], data_filters \\ [], count_filters \\ [])</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L87" 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>Retrieves an Pages of proposals according to various filters</p><p>Used by:</p><ul><li>GraphQL resolver bulk resolution</li></ul>
</section>
</section>
<section class="detail" id="preload_all/1">
<div class="detail-header">
<a href="#preload_all/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">preload_all(proposal)</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L116" 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="soft_delete/1">
<div class="detail-header">
<a href="#soft_delete/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">soft_delete(proposal)</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L159" 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="test_cursor/0">
<div class="detail-header">
<a href="#test_cursor/0" 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">test_cursor()</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.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">
</section>
</section>
<section class="detail" id="update/2">
<div class="detail-header">
<a href="#update/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(proposal, attrs)</h1>
<a href="https://github.com/bonfire-networks/bonfire_valueflows/blob/main/lib/proposal/proposals.ex#L147" 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> update(
%ValueFlows.Proposal{
__meta__: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
activity: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
caretaker: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
context: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
context_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
controlled: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
created: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
creator: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
creator_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
deleted_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
direct_replies: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
disabled_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
eligible_location: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
eligible_location_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
feed_publishes: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
has_beginning: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
has_end: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
is_disabled: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
is_public: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
name: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
note: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
peered: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
proposed_to: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
published_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
publishes: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
publishes_intents: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
replied: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
tagged: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
tags: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
unit_based: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
updated_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
},
attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()
) :: {:ok, <a href="https://hexdocs.pm/bonfire_valueflows/0.1.0/ValueFlows.Proposal.html#t:t/0">ValueFlows.Proposal.t</a>()} | {:error, Changeset.t()}</pre>
</div>
</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="bonfire_umbrella.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.2) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink