mirror of
https://github.com/bonfire-networks/bonfire-app.git
synced 2024-05-17 08:32:41 +00:00
743 lines
24 KiB
HTML
743 lines
24 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.2">
|
|
<meta name="project" content="bonfire_umbrella v0.9.10-cooperation-beta.62">
|
|
|
|
|
|
<title>ActivityPub — 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/activity_pub/blob/main/lib/activity_pub.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">ActivityPub</span>
|
|
<small class="app-vsn" translate="no">(bonfire_umbrella v0.9.10-cooperation-beta.62)</small>
|
|
|
|
</h1>
|
|
|
|
|
|
<section id="moduledoc">
|
|
<p>Entrypoint to the ActivityPub API for processing incoming and outgoing federated objects (normalising, saving the the Object storage, passing them to the adapter, and queueing outgoing activities to be pushed out).</p><p>In general, the functions in this module take object-like map.
|
|
That includes a struct as the input for actor parameters. Use the functions in the <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Actor.html"><code class="inline">ActivityPub.Actor</code></a> module (<a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Actor.html#get_cached/1"><code class="inline">ActivityPub.Actor.get_cached/1</code></a> for example) to retrieve those.</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="#accept/1" translate="no">accept(params)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Generates and federates an Accept activity via the data passed through <code class="inline">params</code>.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#accept_activity/1" translate="no">accept_activity(params)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#announce/1" translate="no">announce(params)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#block/1" translate="no">block(params)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#create/1" translate="no">create(params)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Generates and federates a Create activity via the data passed through <code class="inline">params</code>.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#delete/3" translate="no">delete(object, is_local?, opts \\ [])</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#flag/1" translate="no">flag(params)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#follow/1" translate="no">follow(params)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Generates and federates a Follow activity.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#like/1" translate="no">like(params)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Record a Like</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#move/4" translate="no">move(origin, target, local \\ true, recursing \\ false)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#reject/1" translate="no">reject(params)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Generates and federates a Reject activity via the data passed through <code class="inline">params</code>.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#unannounce/1" translate="no">unannounce(params)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#unblock/1" translate="no">unblock(params)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#unfollow/1" translate="no">unfollow(params)</a>
|
|
|
|
</div>
|
|
|
|
<div class="summary-synopsis"><p>Generates and federates an Unfollow activity.</p></div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#unlike/1" translate="no">unlike(params)</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="summary-row">
|
|
<div class="summary-signature">
|
|
<a href="#update/1" translate="no">update(params)</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="accept/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#accept/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">accept(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L153" class="icon-action" rel="help" title="View Source">
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
<span class="sr-only">View Source</span>
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
|
<section class="docstring">
|
|
|
|
<div class="specs">
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> accept(%{
|
|
:to => [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()],
|
|
:actor => <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Actor.html#t:t/0">ActivityPub.Actor.t</a>(),
|
|
:object => <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(),
|
|
optional(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()) => <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()
|
|
}) :: {:ok, <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Object.html#t:t/0">ActivityPub.Object.t</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()}</pre>
|
|
|
|
</div>
|
|
|
|
<p>Generates and federates an Accept activity via the data passed through <code class="inline">params</code>.</p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="accept_activity/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#accept_activity/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">accept_activity(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.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="announce/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#announce/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">announce(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L275" 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="block/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#block/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">block(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L381" 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/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#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">create(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L63" 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(%{
|
|
:to => [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()],
|
|
:actor => <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Actor.html#t:t/0">ActivityPub.Actor.t</a>(),
|
|
:context => <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(),
|
|
:object => <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>(),
|
|
optional(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()) => <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()
|
|
}) :: {:ok, <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Object.html#t:t/0">ActivityPub.Object.t</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()}</pre>
|
|
|
|
</div>
|
|
|
|
<p>Generates and federates a Create activity via the data passed through <code class="inline">params</code>.</p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="delete/3">
|
|
|
|
<span id="delete/2"></span>
|
|
|
|
<div class="detail-header">
|
|
<a href="#delete/3" class="detail-link" title="Link to this function">
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
<span class="sr-only">Link to this function</span>
|
|
</a>
|
|
<h1 class="signature" translate="no">delete(object, is_local?, opts \\ [])</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L425" 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="flag/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#flag/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">flag(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L507" 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> flag(%{
|
|
:actor => <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Actor.html#t:t/0">ActivityPub.Actor.t</a>(),
|
|
:context => <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(),
|
|
:account => <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Actor.html#t:t/0">ActivityPub.Actor.t</a>(),
|
|
:statuses => [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()],
|
|
:content => <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(),
|
|
optional(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()) => <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()
|
|
}) :: {:ok, <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Object.html#t:t/0">ActivityPub.Object.t</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()}</pre>
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="follow/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#follow/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">follow(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.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">
|
|
|
|
<p>Generates and federates a Follow activity.</p><p>Note: the follow should be reflected as a Follow on the host database side only after receiving an <code class="inline">Accept</code> activity in response (though you could register it as a Request if your app has that concept)</p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="like/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#like/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">like(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L216" 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>Record a Like</p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="move/4">
|
|
|
|
<span id="move/2"></span>
|
|
|
|
<span id="move/3"></span>
|
|
|
|
<div class="detail-header">
|
|
<a href="#move/4" 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">move(origin, target, local \\ true, recursing \\ false)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L528" 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="reject/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#reject/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">reject(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L184" 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> reject(%{to: [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()], actor: <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Actor.html#t:t/0">ActivityPub.Actor.t</a>(), object: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>()}) ::
|
|
{:ok, <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.Object.html#t:t/0">ActivityPub.Object.t</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()}</pre>
|
|
|
|
</div>
|
|
|
|
<p>Generates and federates a Reject activity via the data passed through <code class="inline">params</code>.</p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="unannounce/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#unannounce/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">unannounce(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L311" 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="unblock/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#unblock/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">unblock(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L407" 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="unfollow/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#unfollow/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">unfollow(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.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>Generates and federates an Unfollow activity.</p>
|
|
</section>
|
|
</section>
|
|
<section class="detail" id="unlike/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#unlike/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">unlike(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L245" 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/1">
|
|
|
|
<div class="detail-header">
|
|
<a href="#update/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">update(params)</h1>
|
|
|
|
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/activity_pub.ex#L343" 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="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>
|