bonfire-app/ActivityPub.Object.html
2024-04-16 21:21:08 +00:00

1586 lines
46 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.Object — 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/object.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.Object</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-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="#actor_from_data/1" translate="no">actor_from_data(actor)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#actor_id_from_data/1" translate="no">actor_id_from_data(id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#all/1" translate="no">all(filters)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#changeset/1" translate="no">changeset(attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#changeset/2" translate="no">changeset(object, attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#common_changeset/1" translate="no">common_changeset(object)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete/1" translate="no">delete(object)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#do_insert/1" translate="no">do_insert(attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#do_update_existing/2" translate="no">do_update_existing(object, attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#fetch_latest_block/2" translate="no">fetch_latest_block(map1, map2)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#fetch_latest_follow/2" translate="no">fetch_latest_follow(follower_id, followed_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_activity_for_object_ap_id/2" translate="no">get_activity_for_object_ap_id(ap_id, verb \\ &quot;Create&quot;)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_ap_id/1" translate="no">get_ap_id(_)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_cached/1" translate="no">get_cached(id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_cached!/1" translate="no">get_cached!(opts)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_existing_announce/2" translate="no">get_existing_announce(actor, map)</a>
</div>
<div class="summary-synopsis"><p>Retruns an existing announce activity if the notice has already been announced</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_existing_like/2" translate="no">get_existing_like(actor, object_id)</a>
</div>
<div class="summary-synopsis"><p>Returns an existing like if a user already liked an object</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_follow_activity/2" translate="no">get_follow_activity(follow_object, followed)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_inbox/2" translate="no">get_inbox(all_or_instance_or_actor_url, page \\ 1)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_outbox_for_actor/2" translate="no">get_outbox_for_actor(ap_id, page \\ 1)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_outbox_for_instance/1" translate="no">get_outbox_for_instance(page \\ 1)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_uncached/1" translate="no">get_uncached(opts)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#hard_delete/1" translate="no">hard_delete(object)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#hashtags/1" translate="no">hashtags(arg1)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#invalidate_cache/1" translate="no">invalidate_cache(object)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#is_deleted?/1" translate="no">is_deleted?(data)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#make_tombstone/2" translate="no">make_tombstone(map, deleted \\ DateTime.utc_now())</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#maybe_fetch/2" translate="no">maybe_fetch(ap_id, arg2)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#maybe_upsert/3" translate="no">maybe_upsert(arg1, existing_object, attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#normalise_tos/1" translate="no">normalise_tos(object)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#normalize/3" translate="no">normalize(object, fetch_remote? \\ true, pointer \\ nil)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#normalize_actors/1" translate="no">normalize_actors(params)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#normalize_params/3" translate="no">normalize_params(params, activity_id \\ nil, pointer \\ nil)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#object_url/1" translate="no">object_url(id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#prepare_data/4" translate="no">prepare_data(data, local \\ false, pointer \\ nil, associated_activity \\ nil)</a>
</div>
<div class="summary-synopsis"><p>Prepares a struct to be inserted into the objects table</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#query/1" translate="no">query(list)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#self_replies_ids/2" translate="no">self_replies_ids(object, limit)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#set_cache/1" translate="no">set_cache(object)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#swap_object_with_tombstone/1" translate="no">swap_object_with_tombstone(object)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_and_set_cache/1" translate="no">update_and_set_cache(changeset)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_changeset/2" translate="no">update_changeset(object, attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_existing/2" translate="no">update_existing(object_id, attrs)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#update_state/3" translate="no">update_state(activity, type, state)</a>
</div>
<div class="summary-synopsis"><p>Updates a follow activity's state (for locked accounts).</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>
</a>
<span class="text">Types</span>
</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/bonfire-networks/activity_pub/blob/main/lib/object.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() :: %ActivityPub.Object{
__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>(),
data: <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>(),
inserted_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
is_object: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
local: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
object: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
pointer: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
pointer_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
public: <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>()
}</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>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="actor_from_data/1">
<div class="detail-header">
<a href="#actor_from_data/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">actor_from_data(actor)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L545" 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="actor_id_from_data/1">
<div class="detail-header">
<a href="#actor_id_from_data/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">actor_id_from_data(id)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L574" 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="all/1">
<div class="detail-header">
<a href="#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">all(filters)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L429" 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="changeset/1">
<div class="detail-header">
<a href="#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">changeset(attrs)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L348" 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="changeset/2">
<div class="detail-header">
<a href="#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">changeset(object, attrs)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L353" 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="common_changeset/1">
<div class="detail-header">
<a href="#common_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">common_changeset(object)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L365" 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="delete/1">
<div class="detail-header">
<a href="#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">delete(object)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L684" 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="do_insert/1">
<div class="detail-header">
<a href="#do_insert/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">do_insert(attrs)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L293" 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="do_update_existing/2">
<div class="detail-header">
<a href="#do_update_existing/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">do_update_existing(object, attrs)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L382" 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="fetch_latest_block/2">
<div class="detail-header">
<a href="#fetch_latest_block/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">fetch_latest_block(map1, map2)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L863" 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="fetch_latest_follow/2">
<div class="detail-header">
<a href="#fetch_latest_follow/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">fetch_latest_follow(follower_id, followed_id)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L798" 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_activity_for_object_ap_id/2">
<span id="get_activity_for_object_ap_id/1"></span>
<div class="detail-header">
<a href="#get_activity_for_object_ap_id/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_activity_for_object_ap_id(ap_id, verb \\ &quot;Create&quot;)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L179" 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_ap_id/1">
<div class="detail-header">
<a href="#get_ap_id/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_ap_id(_)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L533" 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_cached/1">
<div class="detail-header">
<a href="#get_cached/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_cached(id)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L42" 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_cached!/1">
<div class="detail-header">
<a href="#get_cached!/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_cached!(opts)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.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">
</section>
</section>
<section class="detail" id="get_existing_announce/2">
<div class="detail-header">
<a href="#get_existing_announce/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_existing_announce(actor, map)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L843" 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>Retruns an existing announce activity if the notice has already been announced</p>
</section>
</section>
<section class="detail" id="get_existing_like/2">
<div class="detail-header">
<a href="#get_existing_like/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_existing_like(actor, object_id)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L818" 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 existing like if a user already liked an object</p>
</section>
</section>
<section class="detail" id="get_follow_activity/2">
<div class="detail-header">
<a href="#get_follow_activity/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_follow_activity(follow_object, followed)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L782" 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_inbox/2">
<span id="get_inbox/1"></span>
<div class="detail-header">
<a href="#get_inbox/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_inbox(all_or_instance_or_actor_url, page \\ 1)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L729" 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_outbox_for_actor/2">
<span id="get_outbox_for_actor/1"></span>
<div class="detail-header">
<a href="#get_outbox_for_actor/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_outbox_for_actor(ap_id, page \\ 1)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L699" 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_outbox_for_instance/1">
<span id="get_outbox_for_instance/0"></span>
<div class="detail-header">
<a href="#get_outbox_for_instance/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_outbox_for_instance(page \\ 1)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L719" 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_uncached/1">
<div class="detail-header">
<a href="#get_uncached/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_uncached(opts)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.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">
</section>
</section>
<section class="detail" id="hard_delete/1">
<div class="detail-header">
<a href="#hard_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">hard_delete(object)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L691" 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="hashtags/1">
<div class="detail-header">
<a href="#hashtags/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">hashtags(arg1)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L885" 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="invalidate_cache/1">
<div class="detail-header">
<a href="#invalidate_cache/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">invalidate_cache(object)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L338" 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="is_deleted?/1">
<div class="detail-header">
<a href="#is_deleted?/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">is_deleted?(data)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L663" 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="make_tombstone/2">
<span id="make_tombstone/1"></span>
<div class="detail-header">
<a href="#make_tombstone/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">make_tombstone(map, deleted \\ DateTime.utc_now())</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L651" 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="maybe_fetch/2">
<div class="detail-header">
<a href="#maybe_fetch/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">maybe_fetch(ap_id, arg2)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L521" 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="maybe_upsert/3">
<div class="detail-header">
<a href="#maybe_upsert/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">maybe_upsert(arg1, existing_object, attrs)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L299" 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="normalise_tos/1">
<div class="detail-header">
<a href="#normalise_tos/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">normalise_tos(object)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L618" 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="normalize/3">
<span id="normalize/1"></span>
<span id="normalize/2"></span>
<div class="detail-header">
<a href="#normalize/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">normalize(object, fetch_remote? \\ true, pointer \\ nil)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L484" 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="normalize_actors/1">
<div class="detail-header">
<a href="#normalize_actors/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">normalize_actors(params)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L603" 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="normalize_params/3">
<span id="normalize_params/1"></span>
<span id="normalize_params/2"></span>
<div class="detail-header">
<a href="#normalize_params/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">normalize_params(params, activity_id \\ nil, pointer \\ nil)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L592" 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="object_url/1">
<div class="detail-header">
<a href="#object_url/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">object_url(id)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L767" 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="prepare_data/4">
<span id="prepare_data/1"></span>
<span id="prepare_data/2"></span>
<span id="prepare_data/3"></span>
<div class="detail-header">
<a href="#prepare_data/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">prepare_data(data, local \\ false, pointer \\ nil, associated_activity \\ nil)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L436" 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>Prepares a struct to be inserted into the objects table</p>
</section>
</section>
<section class="detail" id="query/1">
<div class="detail-header">
<a href="#query/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">query(list)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L154" 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="self_replies_ids/2">
<div class="detail-header">
<a href="#self_replies_ids/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">self_replies_ids(object, limit)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L906" 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="set_cache/1">
<div class="detail-header">
<a href="#set_cache/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">set_cache(object)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.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">
</section>
</section>
<section class="detail" id="swap_object_with_tombstone/1">
<div class="detail-header">
<a href="#swap_object_with_tombstone/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">swap_object_with_tombstone(object)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L676" 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_and_set_cache/1">
<div class="detail-header">
<a href="#update_and_set_cache/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_and_set_cache(changeset)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L389" 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_changeset/2">
<div class="detail-header">
<a href="#update_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">update_changeset(object, attrs)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L359" 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_existing/2">
<div class="detail-header">
<a href="#update_existing/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_existing(object_id, attrs)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L372" 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_state/3">
<div class="detail-header">
<a href="#update_state/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_state(activity, type, state)</h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/lib/object.ex#L403" 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 a follow activity's state (for locked accounts).</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="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>