Bonfire
v0.9.11-social-beta.6
Pages
Modules
Mix
Tasks
API Reference
Modules
GraphQL Introduction
Mix Tasks
Bonfire Networks
Main characteristics
How to get the most out of the documentation
Prerequisite knowledge
Join our community
Funding
Copyright and License
Getting Started
Development setup
Status: beta - have fun and provide feedback 🙏
System Requirements
Download
Configure
Light a fire!
Onboarding
The Bonfire environment
Documentation
Additional information
Troubleshooting
Hosting guide
Security Warning
Step 1 - Decide how you want to deploy and manage the app
Preparing the config (in .env)
Notes on running the app
Handy commands
Admin tools
Troubleshooting
Bonfire Changelog
[0.3.5-beta (2022-09-23)]
[0.3.4-beta.8 (2022-08-26)]
[0.3.4-beta.6 (2022-08-19)]
[0.3.4 (2022-08-09)]
[0.3.3 (2022-08-02)]
[0.3.2 (2022-07-30)]
0.3.1-beta.9 (2022-07-22)
0.3.1-beta (2022-07-19)
Building on Bonfire
Add a new widget
Let’s code!
Adding Settings
Next Steps
Bonfire Navigation Sidebar
Overview
Key Concepts
Creating a New Navigation Menu
Using the Default Navigation Menu
Overriding Default Navigation with a Custom Menu
Add a new extension settings
Create a new extension
Create your Bonfire extension
Create a new page
Make changes to an extension
Fork the extension
Enable the extension
Make and test your changes
Push changes
Great works 🎉🎉🎉
What is a Bonfire extension
Using extensions
Extension helpers
Project structure
Routing
Add a new route
What is a Bonfire flavour?
Working with flavour
Licenses
AGPL-3.0-only
CC0-1.0
Concepts
Bonfire Architecture
Hacking
Design Decisions
Stack
The Bonfire Environment
Code Structure
Naming
Federation libraries
Bonfire-flavoured Elixir
Arrows
Untangle
Error handling
Design Guidelines
Just commands
General Setup Related Commands
LiveView optimizations
Minimize dynamic parts
Minimize re-rendering
Minimize server/client communication (<-- this seems also crucial for bonfire)
Bonfire.API.GraphQL
GraphQL Introduction
Absinthe Introduction
Copyright and License
Email Delivery in Bonfire
Before You Begin
Choosing an Email Delivery Method
1. Default Behaviour: Direct SMTP Delivery
Copyright and License
Boundaries for Access Control
Glossary
Users and Circles
Verbs
Permissions
ACLs
Controlled - Applying boundaries to an object
Practical example: Surprise birthday party
Copyright and License
Needles and Pointers: Universal foreign keys, virtual schemas, and shared data fields for Ecto
Intro
What is Needle?
Identifying objects - the UID type
It's just a table
Installation
Declaring Object Types
Adding re-usable fields
Writing Migrations
Configuration and overrides
Referencing Pointables
Dereferencing Pointables
Inserting data
Querying Needle
Tradeoffs
Copyright and License
Data schemas
Bonfire.Data.Assort
Copyright and License
Bonfire.Data.AccessControl
Copyright and License
Bonfire.Data.ActivityPub
Copyright and License
Bonfire.Data.Identity
Copyright and License
Bonfire.Data.Social
Copyright and License
Bonfire.Data.Edges
UI extensions
Bonfire.UI.Messages
Copyright and License
Bonfire.UI.Reactions
Copyright and License
Bonfire.UI.Common
Handy commands
Copyright and License
Bonfire.UI.Boundaries
How to use it
Copyright and License
Bonfire.UI.Me
Copyright and License
Bonfire.UI.Social
Copyright and License
Bonfire.UI.Social.Graph
Copyright and License
Bonfire.UI.Posts
Copyright and License
Bonfire.UI.Moderation
Copyright and License
Bonfire utilities
Bonfire.Common
Handy commands
Copyright and License
Bonfire.Epics
Key components and concepts:
How it works
1. How to write an Act
2. How to define an Epic
3. How to run an Epic
Copyright and License
Bonfire.Ecto
Introduction
Feature extensions
Bonfire.Messages
Handy commands
Copyright and License
Bonfire.Poll
Copyright and License
Bonfire.Label
Features
Copyright and License
Bonfire.Classify
Handy commands
Copyright and License
Bonfire.Search
Development & Deployment Documentation
Copyright and License
Bonfire.Invite.Links
Handy commands
Copyright and License
Bonfire.OpenID
Copyright and License
Bonfire.Federate.ActivityPub
Testing
Handy commands
Copyright and License
Bonfire.Editor.Milkdown
ROADMAP
Copyright and License
Bonfire.Me
Handy commands
Copyright and License
Bonfire.Social
Handy commands
Copyright and License
Bonfire.Social.Graph
Handy commands
Copyright and License
Bonfire.Posts
Handy commands
Copyright and License
Bonfire.Tag
Handy commands
Copyright and License
Other utilities
ActivityPub
Installation
Needle.UID
Installation
Copyright and License
Needle.ULID
Installation
Copyright and License
EctoSparkles
proload documentation
Example using proload
Example using join_preload
reusable_join documentation
Copyright
Entrepôt
Concepts
Built-in Integrations
Storages
uploads
EntrepôtEcto
EntrepôtEcto
Entrepot.Ecto.Type
Entrepot.Ecto.upload
Upload cleanup
Testing
Paginator
Why?
Getting started
Install
Usage
Security Considerations
Indexes
Caveats
Documentation
Contributing
LICENSE
Voodoo
Untangle
Logging/inspecting
Timing functions
Installation
In config/config.exs
Copyright and License
Arrows
Installation
Documentation
Exto
Usage
Copyright and License
Data schemas
Bonfire.Data
.AccessControl.Acl
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.AccessControl.Circle
Summary
Functions
changeset/2
delete/2
get/3
put/3
.AccessControl.Controlled
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.AccessControl.Encircle
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.AccessControl.Grant
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.AccessControl.InstanceAdmin
Summary
Types
t/0
Functions
changeset/3
delete/2
get/3
put/3
.AccessControl.Stereotyped
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.AccessControl.Verb
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.ActivityPub.Actor
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.ActivityPub.Actor.Migration
Summary
Functions
create_actor_table/0
create_actor_table/1
drop_actor_table/0
migrate_actor/0
migrate_actor/1
.ActivityPub.Peer
Summary
Types
t/0
Functions
changeset/3
delete/2
get/3
put/3
.ActivityPub.Peered
Summary
Types
t/0
Functions
changeset/3
delete/2
get/3
put/3
.Assort.Ranked
Summary
Functions
changeset/2
.Assort.Ranked.Migration
Summary
Functions
create_ranked_table/0
create_ranked_table/1
create_unique_index/1
drop_ranked_table/0
drop_unique_index/1
migrate_ranked/0
migrate_ranked/1
.Edges.Edge
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Edges.EdgeTotal
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Identity.Account
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Identity.Accounted
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Identity.Alias
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Identity.AuthSecondFactor
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
valid_totp?/2
.Identity.CareClosure
Summary
Functions
by_branch/1
.Identity.Caretaker
Summary
Types
t/0
Functions
changeset/3
delete/2
get/3
put/3
.Identity.Character
Summary
Types
t/0
Functions
changeset/3
changeset_basic/2
delete/2
get/3
hash/1
put/3
uniform/1
.Identity.Credential
Summary
Types
t/0
Functions
changeset/2
check_password/2
confirmation_changeset/2
delete/2
dummy_check/0
get/3
hash_password/1
hasher_module/0
put/3
.Identity.Credential.Migration
Summary
Functions
create_credential_table/0
create_credential_table/1
drop_credential_table/0
migrate_credential/0
migrate_credential/1
.Identity.Email
Summary
Types
t/0
Functions
changeset/3
confirm/1
delete/2
get/3
may_confirm?/2
may_request_confirm_email?/2
put/3
put_token/1
should_request_or_refresh?/2
.Identity.ExtraInfo
Summary
Types
t/0
Functions
changeset/3
delete/2
get/3
put/3
.Identity.Named
Summary
Types
t/0
Functions
changeset/3
delete/2
get/3
normalize_name/1
put/3
.Identity.Self
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Identity.Settings
Summary
Types
t/0
Functions
changeset/3
delete/2
get/3
put/3
.Identity.SettingsJSONSerdeData
Summary
Functions
cast/1
cast/2
dump/1
embed_as/1
equal?/2
load/1
type/0
.Identity.User
Summary
Functions
changeset/2
delete/2
get/3
maybe_redact/1
put/3
.Social.APActivity
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Social.Activity
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Social.Bookmark
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Boost
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Created
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Social.Emoji
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Feed
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.FeedPublish
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Social.Flag
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Follow
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Like
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Message
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Pin
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Post
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.PostContent
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Social.Profile
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Social.Replied
Summary
Types
t/0
Functions
ancestor_ids/1
ancestors/1
arrange/2
build_child/1
changeset/2
children/1
delete/2
depth/1
descendants/1
get/3
make_child_of/2
parent/1
parent_id/1
path/1
path_ids/1
put/3
root/1
root?/1
root_id/1
siblings/1
subtree/1
where_depth/2
.Social.Request
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Social.Seen
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Social.Sensitive
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
UI extensions
Bonfire
.UI.Boundaries
Sections
How to use it
Copyright and License
Summary
Functions
repo/0
.UI.Boundaries.ExcludeBoundaries
Summary
Functions
handle_event/3
.UI.Boundaries.Fake
.UI.Boundaries.Routes
.UI.Boundaries.RuntimeConfig
Summary
Functions
config/0
config_module/0
.UI.Common
Sections
Handy commands
Copyright and License
Summary
Functions
assign_error/3
assign_flash/5
assign_generic/2
assign_generic/3
assign_generic_global/2
assign_global/2
assign_global/3
assigns/1
assigns_clean/1
assigns_merge/2
assigns_merge/3
assigns_minimal/1
assigns_subscribe/2
batch_update_many_async/3
batch_update_many_async/4
can?/4
cast_public/2
cast_self/2
component_data/1
component_props/1
copy_go/1
current_url/3
current_user_or_remote_interaction/3
declared_extension/0
filename_for_module_template/1
go_query/1
hero_icons_list/0
live_aliases/5
live_render_component/2
live_render_with_conn/2
live_upload_files/5
markdown/1
maybe_apply_or_ret/3
maybe_assign/3
maybe_assign_context/2
maybe_component/2
maybe_consume_uploaded_entries/3
maybe_consume_uploaded_entry/3
maybe_cute_gif/0
maybe_last_sentry_event_id/0
maybe_push_event/3
maybe_send_update/4
maybe_stream_insert/4
module_default_assigns/1
opts_for_update_many_async/2
patch_to/3
path_fallback/2
random_dom_id/0
redirect_self/1
redirect_to/3
redirect_to_previous_go/4
render_inline/2
render_sface_or_native/1
rich/2
self_subscribe/2
send_self/2
send_self_global/2
set_go_after/2
socket_connected?/1
templated/2
templated_or_remote_markdown/2
the_object/1
undead_mount/2
undead_on_mount/2
undead_render/2
undead_update/2
uniq_assign/2
update_many_async/2
update_many_async/3
.UI.Common.ComponentID
Summary
Functions
new/3
send_assigns/5
send_updates/4
.UI.Common.CoreComponents
Summary
Functions
back/1
button/1
error_msg/1
flash/1
flash_group/1
header/1
hide/2
hide_modal/2
input/1
label/1
list/1
modal/1
show/2
show_modal/2
simple_form/1
table/1
.UI.Common.Endpoint.LiveReload
.UI.Common.EndpointTemplate
Summary
Functions
session_options/0
.UI.Common.ErrorHandling
Summary
Functions
undead/3
.UI.Common.ErrorHelpers
Summary
Functions
error_tag/2
translate_error/1
translate_errors/2
.UI.Common.ErrorReportingPlug
.UI.Common.LiveHandlers
Summary
Functions
assign_attrs/2
handle_event/5
handle_info/4
handle_params/5
handle_progress/5
maybe_from_json/1
mod_delegate/5
sigil_p/2
.UI.Common.LivePlugModule
Summary
Callbacks
mount/3
on_mount/4
pipeline_name/0
Functions
app_modules/0
modules/0
pipeline_function_error/2
pipeline_names/1
.UI.Common.LivePlugs
Summary
Functions
maybe_send_persistent_assigns/2
on_mount/4
.UI.Common.LivePlugs.AllowTestSandbox
Summary
Functions
mount/3
on_mount/4
.UI.Common.LivePlugs.Csrf
Summary
Functions
mount/3
on_mount/4
.UI.Common.LivePlugs.Helpers
Summary
Functions
on_mount/4
.UI.Common.LivePlugs.Locale
Summary
Functions
assign_put_locale/2
assign_put_locale/3
default/2
mount/3
on_mount/4
.UI.Common.LivePlugs.StaticChanged
Summary
Functions
mount/3
on_mount/4
.UI.Common.MaybeStaticGeneratorPlug
Summary
Functions
call/2
init/1
maybe_make_request_path_static/2
maybe_serve_static/2
.UI.Common.Modularity.DeclareHelpers
Summary
Functions
component_props/1
component_type/1
declare_module_optional/2
declare_nav_component/2
declare_nav_link/2
declare_settings/3
declare_settings_component/2
declare_settings_nav_component/2
declare_settings_nav_link/2
declare_widget/2
.UI.Common.MultiTenancyPlug
.UI.Common.MultiselectLive.LiveHandler
Summary
Functions
handle_event/3
sigil_p/2
.UI.Common.NavModule
Summary
Callbacks
declared_nav/0
Functions
app_modules/0
modules/0
nav/0
nav/1
nav_function_error/2
.UI.Common.Notifications
Summary
Functions
assign_notification/2
handle_event/3
handle_info/2
notify_broadcast/2
notify_broadcast/5
notify_me/4
receive_flash/3
receive_notification/2
sigil_p/2
.UI.Common.PlugProtect
Summary
Functions
allow_action/3
block_action/3
call/2
init/1
.UI.Common.Plugs.ActivityPub
Summary
Functions
call/2
init/1
maybe_redirect/1
with_headers/3
.UI.Common.Presence
Summary
Functions
child_spec/1
fetch/2
fetchers_pids/0
get_by_key/2
handle_info/2
list/0
list/1
list_and_maybe_subscribe_to_presence/1
present!/2
present?/2
present_meta/2
track/3
track/4
untrack/2
untrack/3
update/3
update/4
.UI.Common.PreviewContentLive
Sections
Properties
Slots
Summary
Functions
handle_event/3
mount/1
render/1
sigil_p/2
update/2
.UI.Common.ReusableModalLive
Sections
Properties
Slots
Summary
Functions
default_assigns/0
handle_event/3
modal_id/1
mount/1
render/1
set/3
sigil_p/2
update/2
.UI.Common.Routes
Summary
Functions
early_hints_authed/0
early_hints_guest/0
early_hints_shared/0
gon_js_config/0
.UI.Common.RoutesModule
Summary
Callbacks
declare_routes/0
Functions
app_modules/0
modules/0
use_modules/0
.UI.Common.SEO
Summary
Functions
config/0
open_graph_config/1
site_config/1
twitter_config/1
.UI.Common.SEOImage
Summary
Functions
generate_path/6
.UI.Common.SettingsModule
Summary
Callbacks
declared_component/0
declared_nav/0
Functions
app_modules/0
component_function_error/2
components/0
components/1
extension_has_components?/2
modules/0
modules_component/1
modules_nav/1
nav/0
nav/1
nav_function_error/2
.UI.Common.SmartInput.LiveHandler
Summary
Functions
active_smart_input_component/2
active_smart_input_components/2
activity_type_or_reply/1
all_smart_input_components/0
assign_open/2
close_smart_input/1
confirm_close_smart_input/2
handle_event/3
max_length/0
maximize/1
maybe_from_json/1
maybe_from_json_string/1
minimize/1
open/2
open_type/4
open_with_text_suggestion/3
replace_input_next_time/1
reply_to_param/1
reset_input/1
set/2
set_smart_input_text/2
show_main/2
sigil_p/2
smart_input_name/1
switch_smart_input_type/2
toggle_expanded/4
.UI.Common.SmartInputModule
Summary
Callbacks
smart_input_module/0
Functions
app_modules/0
modules/0
smart_input_modules_types/0
.UI.Common.StaticGenerator
Summary
Functions
base_path/0
batch/0
file_exists_age/1
file_exists_not_expired/1
generate/2
get/3
maybe_generate/2
.UI.Common.StaticGeneratorPlug
Summary
Functions
call/2
init/1
make_request_path_static/2
.UI.Common.Testing.Helpers
Summary
Functions
assert_field_error/3
assert_field_good/2
assert_flash/3
assert_flash_kind/2
assert_flash_message/2
assert_form_field_error/3
assert_form_field_good/3
conn/0
conn/1
conn/2
fake_account!/2
fake_admin!/3
fake_user!/3
fake_user_and_conn!/1
fancy_fake_user!/2
fancy_fake_user_on_test_instance/1
find_flash/1
find_form_error/2
find_form_field_error/2
floki_attr/2
floki_click/3
floki_live/2
floki_redirect/2
floki_response/2
floki_submit/4
live_async_wait/1
live_pubsub_wait/1
live_sockets_disconnect/1
live_view_stop/1
qualifiers_to_input_name/1
render_stateful/3
render_stateless/3
session_conn/1
.UI.Common.ThemeHelper
Summary
Functions
current_theme/1
.UI.Common.WidgetModule
Summary
Callbacks
declared_widget/0
Functions
app_modules/0
modules/0
widget/1
widget_function_error/2
widgets/0
widgets/1
.UI.Me
Sections
Copyright and License
Summary
Functions
mailer/0
repo/0
.UI.Me.LivePlugs.AccountRequired
Summary
Functions
mount/3
on_mount/4
.UI.Me.LivePlugs.AdminRequired
Summary
Functions
mount/3
on_mount/4
.UI.Me.LivePlugs.LoadCurrentAccount
Summary
Functions
mount/3
on_mount/4
.UI.Me.LivePlugs.LoadCurrentAccountUsers
Summary
Functions
mount/3
on_mount/4
.UI.Me.LivePlugs.LoadCurrentUser
Summary
Functions
get_current/2
mount/3
on_mount/4
.UI.Me.LivePlugs.LoadCurrentUserCircles
Summary
Functions
mount/3
on_mount/4
.UI.Me.LivePlugs.UserRequired
Summary
Functions
mount/3
on_mount/4
pipeline_name/0
.UI.Me.Plugs.AccountRequired
Summary
Functions
call/2
init/1
.UI.Me.Plugs.AdminRequired
Summary
Functions
call/2
init/1
.UI.Me.Plugs.GuestOnly
Summary
Functions
call/2
init/1
.UI.Me.Plugs.LoadCurrentAccount
Summary
Functions
call/2
init/1
.UI.Me.Plugs.LoadCurrentAccountUsers
Summary
Functions
call/2
init/1
.UI.Me.Plugs.LoadCurrentUser
Summary
Functions
call/2
init/1
.UI.Me.Plugs.UserRequired
Summary
Functions
call/2
init/1
.UI.Me.Routes
.UI.Me.RuntimeConfig
Summary
Functions
config/0
config_module/0
.UI.Messages.Routes
.UI.Messages.RuntimeConfig
Summary
Functions
config/0
config_module/0
.UI.Moderation.RuntimeConfig
Summary
Functions
config/0
config_module/0
.UI.Posts.Routes
.UI.Posts.RuntimeConfig
Summary
Functions
config/0
config_module/0
.UI.Reactions.Routes
.UI.Reactions.RuntimeConfig
Summary
Functions
config/0
config_module/0
declared_extension/0
.UI.Social.Benchmark
Summary
Functions
feed_backend/0
feed_component/0
feed_full_backend/0
feed_full_get/1
feed_page/0
feed_queries_without_benchee/0
feed_query_methods/0
feed_render_page/0
live_feed/1
misc/0
render_feed/2
.UI.Social.Graph.RuntimeConfig
Summary
Functions
config/0
config_module/0
.UI.Social.Integration
Summary
Functions
mailer/0
repo/0
.UI.Social.Routes
.UI.Social.RuntimeConfig
Summary
Functions
config/0
config_module/0
Bonfire utilities
AnimalAvatarGenerator
Summary
Functions
avatar/2
avatar_face/2
brows/0
clamp/3
create_background/3
create_blackout/1
create_svg/2
darken/2
ears/0
empty_shape/0
eyes/0
faces/0
hairs/0
muzzles/0
patterns/0
Arrows
Sections
Installation
Documentation
Summary
Functions
<~>/2
from_ok/1
ok/1
ok_or/2
to_ok/1
|>/2
|||/2
~>/2
EctoSparkles
Sections
proload documentation
Example using proload
Example using join_preload
reusable_join documentation
Copyright
Summary
Functions
join_preload/2
proload/3
reusable_join/5
EctoSparkles.AutoMigrator
Summary
Functions
child_spec/1
init/1
start_link/1
startup_migrations/0
EctoSparkles.Changesets.Errors
Summary
Functions
changeset_errors_string/2
error/2
EctoSparkles.DataMigration
Summary
Callbacks
base_query/0
config/0
migrate/1
EctoSparkles.DataMigration.Config
EctoSparkles.DataMigration.Runner
Summary
Functions
run/1
EctoSparkles.ErlangTermBinary
Summary
Functions
cast/1
cast/2
dump/1
embed_as/1
equal?/2
load/1
type/0
EctoSparkles.JSONSerdeData
Summary
Functions
cast/1
cast/2
dump/1
embed_as/1
equal?/2
load/1
type/0
EctoSparkles.Log
Summary
Functions
check_if_n_plus_1/1
format_log/3
handle_event/4
inline_params/3
log_query/3
setup/1
EctoSparkles.Migrator
Summary
Functions
create/0
create/2
migrate/0
migrate/1
rollback/2
rollback_all/0
rollback_all/1
rollback_to/1
rollback_to/2
status/0
EctoSparkles.NPlus1Detector
Summary
Functions
check/1
do_check/2
EctoSparkles.SanitiseStrings
Summary
Functions
clean_html/2
sanitise_strings/2
strip_all_tags/2
Exto
Sections
Usage
Copyright and License
Summary
Functions
flex_schema/1
Needle
Sections
Intro
What is Needle?
Identifying objects - the UID type
It's just a table
Installation
Declaring Object Types
Adding re-usable fields
Writing Migrations
Configuration and overrides
Referencing Pointables
Dereferencing Pointables
Inserting data
Querying Needle
Tradeoffs
Copyright and License
Summary
Functions
is_needle?/2
Needle.Changesets
Summary
Functions
build_assoc/3
built?/1
cast/3
cast_assoc/3
cast_belongs_to/4
cast_has_many/4
cast_has_one/4
config_for/3
deleted?/1
get_field/2
insert_verb/1
loaded?/1
merge_child_errors/1
put_assoc/3
put_assoc!/3
put_id_on_mixins/3
put_new_id/2
state/1
update_data/2
valid?/1
Needle.Form
Summary
Functions
form_schema/1
using/2
Needle.Migration
Summary
Types
pointer_type/0
Functions
add_is_not_deleted/1
create_mixin_table/3
create_pointable_table/2
create_pointable_table/3
create_pointable_table/4
create_random_table/3
create_virtual/1
create_virtual/2
create_virtual_trigger_function/0
drop_mixin_table/1
drop_pointable_table/1
drop_pointable_table/2
drop_random_table/1
drop_table/1
drop_virtual/1
drop_virtual/2
init_pointers/0
init_pointers/1
init_pointers_ulid_extra/0
migrate_virtual/1
migrate_virtual/2
migrate_virtual/3
pointer/2
strong_pointer/1
unbreakable_pointer/1
weak_pointer/1
Needle.Mixin
Summary
Functions
mixin_schema/1
using/2
Needle.NotFound
Summary
Types
t/0
Functions
new/1
Needle.Pointable
Sections
Sample Usage
Overriding with configuration
Introspection
Summary
Functions
pointable_schema/1
Needle.Pointer
Summary
Functions
create/2
delete/2
get/3
put/3
Needle.Pointers
Summary
Functions
assert_points_to!/2
cast!/1
get_table_id!/1
plan/1
query_base/1
schema/1
table/1
Needle.Random
Summary
Functions
random_schema/1
using/2
Needle.Table
Summary
Types
t/0
Functions
delete/2
get/3
put/3
Needle.Tables
Summary
Types
query/0
Functions
child_spec/1
data/0
id/1
id!/1
ids!/1
mixin_modules/0
schema/1
schema!/1
schema?/1
schema_modules/0
start_link/1
table/1
table!/1
Needle.UID
Sections
Installation
Copyright and License
Summary
Functions
cast/2
cast!/2
dump/3
dump!/3
generate/1
is_pride?/2
is_ulid?/1
is_uuid?/2
load/3
synthesise!/1
timestamp/1
type/1
valid?/2
Needle.ULID
Sections
Installation
Copyright and License
Summary
Functions
bingenerate/1
bintimestamp/1
cast/1
cast!/1
decode/1
dump/1
dump!/1
embed_as/1
encode/2
encoded_randomness/1
encoded_timestamp/1
equal?/2
generate/1
load/1
synthesise!/1
timestamp/1
type/0
valid?/1
Needle.ULID.Migration
Summary
Functions
init_pointers_ulid_extra/0
init_pointers_ulid_extra/1
Needle.Unpointable
Summary
Functions
unpointable_schema/1
using/2
Needle.Virtual
Sections
Sample Usage
Overriding with configuration
Introspection
Summary
Functions
virtual_schema/1
Releaser.Git
Summary
Functions
add_commit_and_tag/1
Releaser.Publish
Summary
Functions
publish!/0
Releaser.Tests
Summary
Functions
run_tests!/0
Releaser.VersionUtils
Summary
Functions
bump_major/1
bump_minor/1
bump_patch/1
bump_pre/2
get_version/1
set_version/2
update_version/2
version_to_string/1
Untangle
Sections
Logging/inspecting
Timing functions
Installation
In config/config.exs
Copyright and License
Summary
Functions
custom_dbg/3
debug/3
dump/3
error/3
format_application_location/3
format_location/2
format_stacktrace/1
format_stacktrace_entry/1
format_stacktrace_label/2
format_stacktrace_sliced/3
info/3
log_level?/1
maybe_dbg/3
maybe_info/3
module_name/1
smart/3
warn/3
Untangle.Time
Summary
Functions
time/0
time/2
Voodoo
Summary
Functions
def_reverse_router/2
router/1
Bonfire
.API.GraphQL
Sections
GraphQL Introduction
Absinthe Introduction
Copyright and License
Summary
Functions
admin_or/2
admin_or_empty_page/1
admin_or_not_permitted/1
cast_int_ulid_id/1
cast_nonnegint/1
cast_posint/1
cast_ulid/1
current_account/1
current_user/1
current_user_or/2
current_user_or_empty_page/1
current_user_or_not_found/1
current_user_or_not_logged_in/1
empty_page/0
equals_or/4
equals_or_not_permitted/2
full_page_opts/3
guest_only/1
in_list?/1
invalid_credential/0
is_authenticated/1
limit_page_opts/2
list_depth/1
not_found/0
not_in_list_or/2
not_in_list_or_empty_page/1
not_logged_in/0
not_permitted/1
parent_name/1
predicated/1
predicated/2
reproject/2
reverse_path/1
validate_cursor/2
wanted/2
.API.GraphQL.Auth
Summary
Functions
account_by/1
build_context/1
login/3
select_user/3
set_context_from_resolution/2
set_session_from_context/2
token_new/1
token_verify/1
user_by/1
user_by/2
username/1
.API.GraphQL.CommonResolver
Summary
Functions
canonical_url_edge/3
context_edge/3
context_edges/3
created_at_edge/3
delete/2
display_username_edge/3
fetch_context_edge/2
fetch_context_edges/3
is_deleted_edge/3
is_disabled_edge/3
is_hidden_edge/3
is_local_edge/3
is_public_edge/3
.API.GraphQL.CommonSchema
.API.GraphQL.Cursor
.API.GraphQL.FetchFields
Summary
Types
t/0
Functions
run/1
.API.GraphQL.FetchPage
Summary
Types
t/0
Functions
run/1
.API.GraphQL.FetchPages
Summary
Types
t/0
Functions
run/1
.API.GraphQL.Fields
Summary
Types
t/0
Functions
get/3
getter/2
new/2
new/3
.API.GraphQL.JSON
.API.GraphQL.MastoCompatible.Router
Summary
Functions
include_masto_api/0
.API.GraphQL.Middleware.CollapseErrors
Summary
Functions
call/2
collapse/1
collapse/2
.API.GraphQL.Middleware.Debug
Summary
Functions
call/2
.API.GraphQL.Middleware.RenderLists
Summary
Functions
call/2
collapse/1
.API.GraphQL.Page
Summary
Types
t/0
Functions
new/4
.API.GraphQL.PageInfo
Summary
Types
t/0
Functions
new/4
.API.GraphQL.Pages
Summary
Types
counts/0
data/0
t/0
Functions
get/2
getter/1
new/4
new/5
.API.GraphQL.Pagination
Summary
Functions
connection_paginate/3
page/7
page_all/7
pages/8
pagination_args_filter/1
.API.GraphQL.PlugPipelines
Summary
Functions
default_pipeline/2
run/2
.API.GraphQL.Plugs.GraphQLContext
Summary
Functions
call/2
init/1
.API.GraphQL.QueryHelper
Summary
Functions
apply_overrides/2
camelize/1
do_format_fields/3
document_for/4
fields_for/3
format_fields/4
get_fields/3
maybe_debug_api/4
padding/1
query_with_id/4
run_query_id/6
.API.GraphQL.ResolveField
Summary
Functions
run/1
.API.GraphQL.ResolveFields
Summary
Types
getter/0
t/0
Functions
default_getter/2
run/1
.API.GraphQL.ResolvePage
Summary
Functions
run/1
.API.GraphQL.ResolvePages
Summary
Functions
run/1
.API.GraphQL.ResolveRootPage
Summary
Functions
run/1
.API.GraphQL.RestAdapter
Summary
Functions
endpoint/3
error_fn/2
return/4
success_fn/2
transform_data/1
transform_data/2
.API.GraphQL.RestAdapter.EndpointConfig
.API.GraphQL.Router
.API.GraphQL.SchemaPipelines
Summary
Functions
pipeline/1
run/2
.API.GraphQL.SchemaUtils
Summary
Functions
context_types/0
hydrations_merge/1
.API.GraphQL.Test.GraphQLAssertions
Summary
Functions
assert_binary/1
assert_boolean/1
assert_created_at/2
assert_cursor/1
assert_cursors/1
assert_datetime/1
assert_datetime/2
assert_display_username/1
assert_email/1
assert_eq/1
assert_field/3
assert_float/1
assert_int/1
assert_invalid_credential/2
assert_list/0
assert_list/1
assert_list/2
assert_location/1
assert_maps_eq/3
assert_maps_eq/4
assert_maps_eq/5
assert_non_neg/1
assert_not_found/2
assert_not_logged_in/2
assert_not_permitted/3
assert_object/4
assert_optional/1
assert_optional_field/3
assert_page/0
assert_page/1
assert_page/6
assert_page_info/1
assert_pos/1
assert_ulid/1
assert_updated_at/2
assert_url/1
assert_username/1
assert_uuid/1
uncamel_map/1
.API.GraphQL.UserSocket
Summary
Functions
build_context_from_params/2
connect/2
id/1
.Boundaries
Sections
Glossary
Users and Circles
Verbs
Permissions
ACLs
Controlled - Applying boundaries to an object
Practical example: Surprise birthday party
Copyright and License
Summary
Functions
acls_from_preset_boundary_names/1
boundaries_normalise/1
boundaries_or_default/2
can?/4
default_boundaries/1
find_caretaker_stereotype/3
find_caretaker_stereotypes/3
list_grants_on/1
list_grants_on/2
list_object_acls/2
list_object_boundaries/2
load_pointer/2
load_pointers/2
load_pointers!/2
pointer_permitted?/2
preset_boundary_from_acl/2
preset_boundary_tuple_from_acl/2
preset_name/2
set_boundaries/3
take_care_of!/2
user_default_boundaries/1
users_grants_on/2
users_grants_on/3
.Boundaries.Acls
Summary
Functions
acl_grants_to_tuples/2
acl_id/1
acls/0
acls_from_preset/3
base_acls_from_preset/3
built_in_ids/0
cast/3
changeset/3
create/2
default_exclude_ids/1
delete/2
edit/3
exclude_stereotypes/1
get/1
get!/1
get_for_caretaker/3
get_for_caretaker_q/3
get_id/1
get_id!/1
get_object_custom_acl/1
get_or_create_object_custom_acl/2
grant_tuples_from_preset/3
is_built_in?/1
is_object_custom?/1
is_stereotype?/1
is_stereotyped?/1
list/1
list_built_ins/1
list_my/2
list_my_q/2
list_my_with_counts/2
list_q/1
maybe_by_ids/2
maybe_search/2
opts_for_dropdown/0
opts_for_list/0
prepare_cast/3
preset_acl_ids/0
preset_acl_ids/2
preview/2
remote_public_acl_ids/0
set/3
simple_create/2
soft_delete/2
stereotype_ids/0
user_default_acl/2
user_default_acls/1
.Boundaries.Acts.SetBoundaries
Summary
Functions
run/2
.Boundaries.Blocks
Summary
Functions
ap_receive_activity/3
block/3
federation_module/0
instance_wide_block/2
instance_wide_circles/1
is_blocked?/3
list/2
types_blocked/1
unblock/3
unblock_all/2
user_block_circles/2
.Boundaries.Blocks.LiveHandler
Summary
Functions
handle_event/3
preload_one/2
sigil_p/2
.Boundaries.Circles
Summary
Functions
add_to_circles/2
built_in_ids/0
changeset/2
changeset/3
circle_ids/1
circles/0
create/2
create_stereotype_circle/2
delete/2
edit/3
empty_circles/1
exists?/2
get/1
get/2
get!/1
get_by_name/2
get_for_caretaker/3
get_for_instance/2
get_id/1
get_id!/1
get_or_create/2
get_or_create_stereotype_circle/2
get_stereotype_circles/2
get_tuple/1
is_built_in?/1
is_encircled_by?/2
is_stereotype?/1
leave_all_circles/1
list_built_ins/0
list_by_ids/1
list_my/2
list_my_defaults/1
list_my_with_counts/2
list_my_with_global/2
list_visible/2
preload_encircled_by/3
query/1
query_my/2
query_my_by_id/3
query_visible/2
remove_from_circles/2
stereotype_ids/0
stereotypes/1
to_circle_ids/1
.Boundaries.Circles.LiveHandler
Summary
Functions
add_member/2
sigil_p/2
.Boundaries.Controlleds
Summary
Functions
add_acls/2
changeset/2
create/1
get_preset_on_object/1
grant_role/4
list_acls_on_object/2
list_grants_by_verbs/3
list_on_object/2
list_on_objects_by_subject/2
list_presets_on_objects/1
list_q/1
list_subjects_by_verb/3
remove_acls/2
.Boundaries.Debug
Summary
Functions
debug_grants_on/1
debug_grants_on/2
debug_my_grants_on/2
debug_object_acls/1
debug_user_acls/2
debug_user_circles/1
.Boundaries.Grants
Summary
Functions
change_role/4
create/2
get/1
grant/5
grant_role/4
grants/0
grants_to_tuples/2
list/1
list_for_acl/2
list_my/1
list_q/1
remove_role/4
remove_subject_from_acl/2
subject_grants/1
subject_verb_grants/1
subjects/1
upsert_or_delete/2
verb_subject_grant/1
.Boundaries.Integration
Summary
Functions
is_local?/2
many/3
repo/0
.Boundaries.LiveHandler
Summary
Functions
acl_create/2
boundaries_on_objects/2
circle_create/2
handle_event/3
maybe_check_boundaries/2
maybe_redirect_to/3
my_acls/2
my_circles_paginated/2
prepare_assigns/1
remove_from_circle_tuples/2
scope_origin/2
set_circles_tuples/3
sigil_p/2
subject_name/1
unblock/4
update_many/2
update_many_opts/1
.Boundaries.Queries
Summary
Functions
add_perms/2
agg_perms/1
base_summary_query/1
boundarise/3
object_boundarised/2
permitted/1
permitted/2
query_with_summary/2
query_with_summary/3
skip_boundary_check?/2
.Boundaries.Roles
Summary
Functions
cannot_role_from_verb/5
create/2
create/3
delete/2
edit_details/4
edit_verb_permission/4
get/2
preset_boundary_role_from_acl/1
reset_instance_roles/0
role_from_grants/2
role_from_verb/5
role_verbs/2
roles_for_dropdown/2
split_tuples_can_cannot/1
verbs_for_role/2
.Boundaries.RuntimeConfig
Summary
Functions
config/0
config_module/0
.Boundaries.Scaffold
Summary
Functions
create_default_boundaries/2
create_missing_boundaries/1
insert/0
.Boundaries.Scaffold.Instance
Summary
Functions
activity_pub_circle/0
admin_circle/0
custom_acl/0
fixtures/0
global_circles/0
insert/0
instance_acl/0
mod_circle/0
upsert_verbs/0
.Boundaries.Scaffold.Users
Summary
Functions
down/0
up/0
.Boundaries.Summary
Summary
Functions
base_summary_query/0
drop_views/1
migrate/1
migrate_functions/0
migrate_views/0
refresh/0
refresh_material_view/0
repo/0
source/0
.Boundaries.Users
Summary
Functions
create_default_boundaries/2
create_missing_boundaries/1
.Boundaries.Users.PreparedBoundaries
Summary
Functions
from_config/2
.Boundaries.Verbs
Summary
Functions
changeset/2
create/1
get/2
get!/2
get_id/2
get_id!/2
get_slug/2
get_tuple/2
ids/2
list/2
list_verbs_debug/0
slugs/0
verbs/0
verbs_count/0
.Common
Sections
Handy commands
Copyright and License
Summary
Functions
maybe_fallback/2
.Common.AntiSpam
Summary
Functions
service/0
.Common.AntiSpam.Akismet
.Common.AntiSpam.BumblebeeAdapter
.Common.AntiSpam.Mock
.Common.AntiSpam.Provider
Sections
Supported backends
Summary
Types
result/0
spam_result/0
Callbacks
check_comment/3
check_current_user/1
check_object/2
check_profile/2
ready?/0
report_ham/2
report_spam/2
.Common.Benchmark
Summary
Functions
apply_timed/1
apply_timed/2
apply_timed/3
.Common.Cache
Summary
Functions
cache_store/1
cached_preloads_for_objects/3
get/2
get!/2
maybe_apply_cached/3
put/3
remove/2
remove_all/1
reset/3
.Common.Cache.DiskCache
.Common.Changelog.Github.DataGrabber
Summary
Functions
fetch_issues/1
format_issue/1
prepare_data/2
.Common.Config
Summary
Functions
compilation_error/1
delete/2
endpoint_module/0
env/0
get/3
get!/2
get_ext/1
get_ext/3
get_ext!/1
get_ext!/2
get_for_process/1
keys_tree/1
module_enabled?/1
put/1
put/3
repo/0
require_extension_config!/1
top_level_otp_app/0
.Common.Config.Error
.Common.Config.LoadExtensionsConfig
Summary
Functions
child_spec/1
load_configs/1
start_link/1
.Common.ConfigModule
Summary
Callbacks
config/0
config_module/0
Functions
modules/0
.Common.ContextModule
Summary
Callbacks
context_module/0
query_module/0
schema_module/0
Functions
apply_error/2
context_function_error/2
context_module/1
context_module!/1
context_modules/1
linked_query_modules/0
linked_schema_modules/0
maybe_apply/4
maybe_context_module/1
modules/0
.Common.Crypto
Summary
Functions
decrypt_with_auth_key/3
encrypt_with_auth_key/2
encrypt_with_auth_key/3
.Common.DatesTimes
Summary
Functions
available_format_keys/2
available_formats/2
date_from_now/2
date_from_pointer/1
format/2
format_date/2
future?/1
maybe_generate_ulid/1
now/0
past/2
past?/1
relative_date/2
remove/3
to_date/1
to_date_time/1
.Common.E
Summary
Functions
e/2
e/3
e/4
e/5
e/6
e/7
e/8
ed/2
ed/3
ed/4
ed/5
ed/6
ed/7
ed/8
pathex_fallback/3
.Common.Enums
Summary
Functions
access_keys/2
all_ok?/1
all_oks_or_error/1
attr_get_id/2
count_where/2
deep_merge/3
deep_merge_reduce/2
enum_get/3
filter_empty/2
filter_empty/3
first!/1
flatter/1
fun/3
get_in_access_keys/3
get_in_access_keys!/3
group/2
group_map/2
has_duplicates?/2
has_error?/1
has_ok?/1
has_tuple_key?/2
id/1
ids/1
input_to_atoms/2
input_to_value/7
map_filter_empty/1
map_key_replace/4
map_key_replace_existing/4
map_new/2
map_put_default/3
map_put_in/3
maybe_append/2
maybe_elem/3
maybe_flatten/1
maybe_get/3
maybe_list/2
maybe_merge_to_struct/2
maybe_put/3
maybe_to_keyword_list/3
maybe_to_map/2
maybe_to_struct/2
maybe_to_structs/3
merge_as_map/3
merge_changesets/2
merge_keeping_only_first_keys/2
merge_structs_as_map/2
merge_to_struct/3
merge_uniq/2
naughty_to_atoms!/2
nested_structs_to_maps/1
put_new_in/3
schema_type/1
stringify_keys/2
struct_to_map/2
uniq_by_id/1
unwrap_tuples/2
.Common.EnvConfig
Sections
Features
Summary
Functions
cast/2
maybe_want/3
parse/2
.Common.Errors
Summary
Functions
debug_banner_with_trace/4
debug_exception/5
debug_log/5
error_msg/1
format_banner/4
format_location/1
format_mfa/3
format_stacktrace/2
format_stacktrace_entry/2
format_stacktrace_entry_sliced/2
last_stacktrace/0
map_error/2
maybe_ok_error/2
mf_maybe_link_to_code/4
module_maybe_link_to_code/3
replace_error/2
.Common.Extend
Summary
Functions
application_for_module/1
beam_file_from_object_code/1
deps_tree/0
deps_tree_flat/1
disabled_value?/1
extend_module/1
extension_enabled?/2
extension_loaded?/1
fetch_docs_as_markdown/1
fetch_docs_as_markdown/2
file_code/1
function_ast/3
function_code/3
function_line_number/3
function_line_numbers/3
generate_reverse_router!/0
has_extension_config?/1
import_if_enabled/3
inject_function/3
loaded_applications_map/1
loaded_applications_names/1
macro_inspect/1
maybe_extension_loaded/1
maybe_extension_loaded!/1
maybe_module/2
maybe_module!/2
maybe_module_loaded/1
maybe_schema_or_pointer/1
module_ast_normalize/3
module_available?/1
module_beam_code/2
module_behaviour?/2
module_behaviours/1
module_code/2
module_code_from_ast/3
module_code_from_object_code/1
module_enabled?/2
module_exists?/1
module_file/1
module_file_code/2
module_file_from_object_code/1
module_not_disabled?/2
module_object_byte_code/1
module_object_code_tuple/1
quoted_import_if_enabled/4
quoted_require_if_enabled/4
quoted_use_if_enabled/4
quoted_use_many_if_enabled/1
require_if_enabled/3
return_file/1
tar_file_code/1
use_if_enabled/3
use_many_if_enabled/1
.Common.ExtensionBehaviour
Summary
Callbacks
modules/0
Functions
adopters_of_behaviour/2
app_modules_to_scan/1
apply_modules/2
apply_modules_cached/2
apps_to_scan/1
behaviour_app_modules/2
behaviour_modules/2
behaviours/0
cached_behaviours/0
child_spec/1
find_adopters_of_behaviours/2
find_extension_behaviours/1
populate/0
start_link/1
.Common.ExtensionModule
Summary
Callbacks
declared_extension/0
Functions
app_modules/0
declared_extension/1
declared_extensions/1
default_nav/0
default_nav/1
default_nav_apps/0
extension/1
extension_function_error/2
modules/0
.Common.Extensions
Summary
Functions
all_deps/0
data/0
dep_name/1
get_branch/1
get_code_link/1
get_link/1
get_version/1
get_version_link/1
global_disable/1
global_enable/1
loaded_deps/1
loaded_deps_names/1
.Common.Extensions.Diff
Summary
Functions
analyse_repo_latest_diff_stream/1
generate_diff/2
git!/4
git_add_all/1
git_fetch/1
git_generate_diff/4
git_pre_configure/1
parse_repo_latest_diff/1
repo_latest_diff/3
root/0
tmp_path/1
.Common.HTTP
Summary
Types
t/0
Functions
delete/4
get/3
get_cached/1
patch/4
post/4
put/4
request/5
.Common.HTTP.Connection
Summary
Functions
adapter_options/2
new/1
.Common.HTTP.RequestBuilder
Summary
Functions
add_param/4
headers/2
method/2
opts/2
url/2
.Common.Localise
Summary
Functions
default_locale/0
get_locale/0
get_locale_id/0
known_locales/0
locale_name/1
put_locale/1
set_locale_config/0
.Common.Localise.Cldr
Summary
Functions
available_locale_name?/1
default_locale/0
default_territory/0
ellipsis/2
get_locale/0
known_calendars/0
known_currencies/0
known_gettext_locale_name/1
known_gettext_locale_name?/1
known_gettext_locale_names/0
known_locale_name/1
known_locale_name?/1
known_locale_names/0
known_number_system_types/0
known_number_systems/0
known_rbnf_locale_name/1
known_rbnf_locale_name?/1
known_rbnf_locale_names/0
known_territories/0
normalize_lenient_parse/3
put_gettext_locale/1
put_locale/1
quote/2
unknown_locale_names/0
validate_calendar/1
validate_currency/1
validate_locale/1
validate_number_system/1
validate_number_system_type/1
validate_territory/1
with_locale/2
.Common.Localise.Cldr.AcceptLanguage
Summary
Functions
best_match/1
parse/1
parse!/1
.Common.Localise.Cldr.Calendar
Summary
Functions
calendar_from_locale/1
calendar_from_territory/1
cyclic_years/2
day_periods/2
days/2
eras/2
localize/1
localize/2
localize/3
month_patterns/2
months/2
quarters/2
strftime_options!/2
.Common.Localise.Cldr.Currency
Summary
Functions
currencies_for_locale/3
currencies_for_locale!/3
currency_for_code/2
currency_for_code!/2
currency_from_locale/1
currency_history_for_locale/1
currency_strings/3
currency_strings!/3
current_currency_from_locale/1
current_territory_currencies/0
known_currencies/0
known_currency?/1
known_currency_code/1
known_currency_code?/1
known_currency_codes/0
new/2
pluralize/3
strings_for_currency/2
.Common.Localise.Cldr.Date
Summary
Functions
to_string/2
to_string!/2
.Common.Localise.Cldr.Date.Interval
Summary
Functions
do_to_string!/3
to_string/3
to_string!/3
.Common.Localise.Cldr.DateTime
Summary
Functions
to_string/2
to_string!/2
.Common.Localise.Cldr.DateTime.Format
Summary
Types
calendar/0
formats/0
Functions
calendars_for/1
common_date_time_format_names/0
date_available_formats/2
date_formats/2
date_time_at_formats/2
date_time_available_formats/2
date_time_formats/2
date_time_interval_fallback/2
date_time_interval_formats/2
day_period_for/2
gmt_format/1
gmt_zero_format/1
hour_format/1
language_has_noon_and_midnight?/1
time_available_formats/2
time_formats/2
.Common.Localise.Cldr.DateTime.Formatter
Summary
Functions
format/4
gmt_tz_format/3
.Common.Localise.Cldr.DateTime.Interval
Summary
Functions
do_to_string/3
do_to_string!/3
to_string/3
to_string!/3
.Common.Localise.Cldr.DateTime.Relative
Summary
Functions
to_string/2
to_string!/2
.Common.Localise.Cldr.Interval
Summary
Functions
to_string/2
to_string/3
to_string!/2
to_string!/3
.Common.Localise.Cldr.Language
Summary
Types
styles/0
Functions
available_languages/1
known_languages/1
to_string/2
.Common.Localise.Cldr.List
Summary
Functions
intersperse/2
intersperse/3
intersperse!/2
list_formats_for/1
list_patterns_for/1
to_string/2
to_string!/2
.Common.Localise.Cldr.Locale
Summary
Functions
fallback_locale_names/1
fallback_locales/1
locale_for_territory/1
locale_from_host/2
new/1
new!/1
script_direction_from_locale/1
territory_from_host/1
territory_from_locale/1
timezone_from_locale/1
.Common.Localise.Cldr.LocaleDisplay
Summary
Functions
display_name/2
display_name!/2
display_names/1
time_zone_names/1
.Common.Localise.Cldr.Number
Summary
Functions
parse/2
resolve_currencies/2
resolve_currency/2
resolve_per/2
resolve_pers/2
scan/2
to_approx_string/2
to_at_least_string/2
to_at_most_string/2
to_range_string/2
to_string/2
to_string!/2
validate_number_system/2
.Common.Localise.Cldr.Number.Cardinal
Summary
Functions
available_locale_names/0
known_locale_names/0
plural_rule/3
plural_rules/0
plural_rules_for/1
pluralize/3
.Common.Localise.Cldr.Number.Format
Sections
Number Pattern Examples
Summary
Functions
all_formats_for/1
all_formats_for!/1
currency_spacing/2
decimal_format_list/0
decimal_format_list_for/1
default_grouping_for/1
default_grouping_for!/1
formats_for/2
formats_for!/2
minimum_grouping_digits_for/1
minimum_grouping_digits_for!/1
.Common.Localise.Cldr.Number.Formatter.Decimal
Summary
Functions
metadata!/1
to_string/3
.Common.Localise.Cldr.Number.Ordinal
Summary
Functions
available_locale_names/0
known_locale_names/0
plural_rule/3
plural_rules/0
plural_rules_for/1
pluralize/3
.Common.Localise.Cldr.Number.PluralRule.Range
Summary
Functions
plural_rule/3
.Common.Localise.Cldr.Number.Symbol
Summary
Functions
all_decimal_symbols/0
all_decimal_symbols_class/0
all_grouping_symbols/0
all_grouping_symbols_class/0
number_symbols_for/1
number_symbols_for/2
.Common.Localise.Cldr.Number.System
Summary
Functions
number_system_for/2
number_system_from_locale/1
number_system_names_for/1
number_system_names_for!/1
number_system_types_for/1
number_systems_for/1
number_systems_for!/1
number_systems_like/2
system_name_from/2
to_system/2
to_system!/2
.Common.Localise.Cldr.Number.Transliterate
Summary
Functions
transliterate/3
transliterate!/3
transliterate_digits/3
.Common.Localise.Cldr.Rbnf.NumberSystem
Summary
Functions
all_rule_sets/0
armenian_lower/1
armenian_lower/2
armenian_upper/1
armenian_upper/2
cyrillic_lower/1
cyrillic_lower/2
cyrillic_lower_1_10/2
cyrillic_lower_final/2
cyrillic_lower_post/2
cyrillic_lower_thousands/2
ethiopic/1
ethiopic/2
ethiopic_p1/2
ethiopic_p2/2
ethiopic_p3/2
ethiopic_p/2
georgian/1
georgian/2
greek_lower/1
greek_lower/2
greek_numeral_majuscules/2
greek_numeral_minuscules/2
greek_upper/1
greek_upper/2
hebrew/1
hebrew/2
hebrew_0_99/2
hebrew_item/1
hebrew_item/2
hebrew_item_hundreds/2
hebrew_thousands/2
roman_lower/1
roman_lower/2
roman_upper/1
roman_upper/2
rule_sets/0
rule_sets/1
tamil/1
tamil/2
tamil_thousands/2
zz_default/1
zz_default/2
.Common.Localise.Cldr.Rbnf.Ordinal
Summary
Functions
all_rule_sets/0
digits_ordinal/2
digits_ordinal_feminine/2
digits_ordinal_feminine_plural/2
digits_ordinal_indicator_m/2
digits_ordinal_masculine/2
digits_ordinal_masculine_adjective/2
digits_ordinal_masculine_plural/2
dord_femabbrev/2
dord_mascabbrev/2
rule_sets/0
rule_sets/1
.Common.Localise.Cldr.Rbnf.Spellout
Summary
Functions
after_hundred/2
after_thousand_or_more/2
all_rule_sets/0
and/2
and_o/2
cents_f/2
cents_m/2
cents_o/2
commas/2
commas_o/2
et_un/2
et_une/2
et_unieme/2
fem_with_a/2
fem_with_i/2
fem_with_o/2
lenient_parse/2
mille_o/2
msc_no_final/2
msc_with_a/2
msc_with_a_nofinal/2
msc_with_i/2
msc_with_i_nofinal/2
msc_with_o/2
msc_with_o_nofinal/2
msco_with_a/2
msco_with_i/2
msco_with_o/2
ordinal_esima/2
ordinal_esima_with_a/2
ordinal_esima_with_i/2
ordinal_esima_with_o/2
ordinal_esime/2
ordinal_esime_with_a/2
ordinal_esime_with_i/2
ordinal_esime_with_o/2
ordinal_esimi/2
ordinal_esimi_with_a/2
ordinal_esimi_with_i/2
ordinal_esimi_with_o/2
ordinal_esimo/2
ordinal_esimo_with_a/2
ordinal_esimo_with_i/2
ordinal_esimo_with_o/2
r2d_year/2
rule_sets/0
rule_sets/1
spellout_cardinal/2
spellout_cardinal_feminine/2
spellout_cardinal_feminine_cents/2
spellout_cardinal_masculine/2
spellout_cardinal_masculine_cents/2
spellout_cardinal_verbose/2
spellout_leading/2
spellout_numbering/2
spellout_numbering_cents/2
spellout_numbering_verbose/2
spellout_numbering_year/2
spellout_ordinal/2
spellout_ordinal_feminine/2
spellout_ordinal_feminine_cont/2
spellout_ordinal_feminine_conts/2
spellout_ordinal_feminine_plural/2
spellout_ordinal_masculine/2
spellout_ordinal_masculine_adjective/2
spellout_ordinal_masculine_cont/2
spellout_ordinal_masculine_conts/2
spellout_ordinal_masculine_plural/2
spellout_ordinal_verbose/2
subcents_f/2
subcents_m/2
subcents_o/2
teen/2
th/2
tieth/2
x_ty/2
.Common.Localise.Cldr.Territory
Summary
Functions
available_styles/0
available_subdivisions/1
available_territories/1
children/2
children!/2
contains?/2
country_codes/1
from_language_tag/2
from_language_tag!/2
from_subdivision_code/2
from_subdivision_code!/2
from_territory_code/2
from_territory_code!/2
info/1
info!/1
inverted_subdivisions/1
inverted_territories/1
known_subdivisions/1
known_territories/1
known_territory_subdivisions/1
parent/2
parent!/2
subdivision_aliases/0
to_currency_code/2
to_currency_code!/2
to_currency_codes/2
to_currency_codes!/2
to_unicode_flag/1
to_unicode_flag!/1
translate_language_tag/2
translate_language_tag!/2
translate_subdivision/4
translate_subdivision!/4
translate_territory/4
translate_territory!/4
.Common.Localise.Cldr.Time
Summary
Functions
to_string/2
to_string!/2
.Common.Localise.Cldr.Time.Interval
Summary
Functions
do_to_string/3
do_to_string!/3
to_string/3
to_string!/3
.Common.Localise.Cldr.Unit
Summary
Functions
add/2
add!/2
compatible?/2
convert/2
convert!/2
decompose/2
default_gender/1
default_style/0
display_name/2
div/2
div!/2
grammatical_features/1
grammatical_gender/1
known_styles/0
known_unit_categories/0
known_units/0
localize/1
localize/2
measurement_system?/2
measurement_system_for/1
measurement_system_for/2
measurement_system_for_territory/1
measurement_system_for_territory/2
measurement_system_from_locale/1
measurement_system_from_locale/2
measurement_system_from_locale/3
measurement_systems_for_unit/1
mult/2
mult!/2
new/2
new!/2
parse/2
parse!/2
parse_unit_name/2
parse_unit_name!/2
preferred_units/2
preferred_units!/2
round/1
round/2
round/3
styles/0
sub/2
sub!/2
to_iolist/2
to_iolist!/2
to_string/2
to_string!/2
unit_category/1
unit_strings_for/1
validate_style/1
validate_unit/1
value/1
zero/1
zero?/1
.Common.Localise.Gettext
Summary
Functions
handle_missing_bindings/2
handle_missing_plural_translation/7
handle_missing_translation/5
.Common.Localise.Gettext.Helpers
Summary
Functions
l/4
localise_dynamic/2
localise_strings/2
lp/6
.Common.Localise.Gettext.Plural
Summary
Functions
nplurals/1
plural/2
.Common.Media
Summary
Functions
avatar_fallback/1
avatar_media/1
avatar_url/1
banner_fallback/0
banner_url/1
extract_tar/2
image_url/1
maybe_dominant_color/4
media_url/1
read_tar_files/3
thumbnail_url/1
.Common.MemoryMonitor
Summary
Functions
child_spec/1
get_memory_usage/2
handle_info/2
start_link/2
.Common.Mix.Tasks.Helpers
Summary
Functions
ext_path_for_module/5
igniter_copy/4
igniter_path_for_module/5
list_extensions/0
.Common.Modularity.DeclareHelpers
Summary
Functions
app/1
declare_extension/2
generate_link/3
.Common.Module.Override
Summary
Functions
clone/2
clone_original/2
module_name_atom/1
module_name_string/1
module_original_name_atom/2
module_original_name_str/2
.Common.Needles
Summary
Functions
dataloader/1
exists?/2
filter_one/1
filters/3
follow!/2
follow_function_error/2
forge!/1
forge!/2
get/2
get!/2
id_binary/1
id_filter/2
list!/2
list_by_type!/3
list_ids/0
many/2
many!/2
maybe_forge/1
maybe_forge!/1
maybe_resolve/4
one/2
one!/2
pointer_preloads/2
pointer_query/2
preload!/2
query/3
.Common.Needles.Pointers.Queries
Summary
Functions
filter/2
query/1
query/2
query_incl_deleted/0
schema_module/0
.Common.Needles.Preload
Summary
Functions
access_key/2
custom_access_key_fun/3
maybe_preload_nested_pointers/3
maybe_preload_pointer/2
maybe_preload_pointers/3
.Common.Needles.Tables
Summary
Functions
assoc_mixin_of?/2
list_ids/0
list_schemas/0
list_tables/1
list_tables_debug/0
many/1
maybe_assoc_mixin_module/2
maybe_assoc_module/2
module_mixin_of?/2
one/1
one!/1
schema_mixin_assocs/1
schema_mixin_modules/1
schema_mixins_not_loaded/1
schema_or_table!/1
table!/1
table_fields/1
table_fields_meta/1
.Common.Needles.Tables.Queries
Summary
Functions
filter/2
query/1
query/2
.Common.Opts
Summary
Functions
maybe_from_opts/3
to_options/1
.Common.PubSub
Summary
Functions
broadcast/2
broadcast_with_telemetry/2
broadcast_with_telemetry/3
current_function/1
subscribe/2
.Common.PubSub.Event
.Common.QueryModule
Summary
Callbacks
context_module/0
query_module/0
schema_module/0
Functions
app_modules/0
apply_error/2
linked_context_modules/0
linked_schema_modules/0
maybe_query/3
maybe_query_module/1
modules/0
query_function_error/3
query_module/1
query_module!/1
query_modules/1
.Common.Repo
Summary
Functions
aggregate/3
aggregate/4
all/2
checked_out?/0
checkout/2
child_spec/1
config/0
custom_preload_fun/1
default_options/1
default_repo_opts/0
delete/2
delete!/2
delete_all/2
delete_many/1
disconnect_all/2
exists?/2
explain/3
fetch/2
fetch_all/2
fetch_by/2
find/3
get/3
get!/3
get_by/3
get_by!/3
get_dynamic_repo/0
in_transaction?/0
insert/2
insert!/2
insert_all/3
insert_all_or_ignore/2
insert_or_ignore/1
insert_or_ignore/2
insert_or_update/2
insert_or_update!/2
load/2
make_subquery/1
many/2
many_paginated/3
maybe_one/2
maybe_preload/3
maybe_where_ilike/5
migrate/0
one/2
one!/2
paginate/2
pluck/3
preload/3
preload_all/2
preload_mixins/2
prepare_query/3
put/1
put_dynamic_repo/1
put_many/1
query/3
query!/3
query_many/3
query_many!/3
reject_preload_ids/1
reload/2
reload!/2
rollback/1
single/1
sql/3
start_link/1
stop/1
stream/2
to_sql/2
trace/1
transact_many/1
transact_with/2
transaction/2
update/2
update!/2
update_all/3
upsert/3
upsert_all/3
.Common.Repo.Delete
Summary
Functions
deletion_result/1
deletion_result!/1
hard_delete/1
hard_delete!/1
schema/1
soft_delete/1
soft_delete!/1
soft_delete_changeset/4
undelete/1
.Common.Repo.Filter
Summary
Functions
query_filter/4
.Common.Repo.Preload
Summary
Functions
maybe_preload/3
maybe_preloads_per_nested_schema/4
maybe_preloads_per_schema/3
preload_all/2
preload_mixins/2
.Common.Repo.Utils
Summary
Functions
change_disabled/1
change_muted/1
change_public/1
change_synced_timestamp/3
change_synced_timestamps/5
match_admin/0
validate_email/2
validate_email_domain/2
validate_exactly_one/3
validate_http_url/2
validate_not_expired/4
.Common.RepoTemplate
.Common.RuntimeConfig
Summary
Functions
config/0
config_module/0
skip_test_tags/1
test_formatters/0
test_formatters/1
.Common.SchemaModule
Summary
Callbacks
context_module/0
query_module/0
schema_module/0
Functions
app_modules/0
linked_context_modules/0
linked_query_modules/0
modules/0
.Common.Settings
Summary
Functions
check_scope/2
delete/2
do_get_in/2
get/3
get!/2
get_for_process/1
get_settings/4
load_instance_settings/0
put/3
put_raw/3
reset_all/0
reset_instance/0
set/2
.Common.Settings.LiveHandler
Summary
Functions
handle_event/3
input_name/1
maybe_assign_input_value_from_keys/1
scoped/2
sigil_p/2
.Common.Settings.LoadInstanceConfig
Summary
Functions
child_spec/1
load_config/0
start_link/1
.Common.Simulation
Summary
Functions
ap_url_base/0
base64/0
bool/0
canonical_url/0
content_type/0
content_url/0
date_of_birth/0
domain/0
email/0
email_user/0
falsehood/0
float/0
future_date/0
future_datetime/0
future_datetime_iso/0
icon/0
image/0
integer/0
license/0
location/0
long_count/0
long_list/1
markdown/0
maybe_bool/0
maybe_one_of/1
med_count/0
med_list/1
name/0
neg_integer/0
one_of/1
paragraph/0
password/0
past_date/0
past_datetime/0
past_datetime_iso/0
path/0
pos_integer/0
preferred_username/0
short_count/0
short_list/1
signing_key/0
some/2
summary/0
title/0
truth/0
uid/1
ulid/0
url/0
username/0
uuid/0
verb/0
website/0
.Common.StartupTimer
Summary
Functions
run/1
.Common.Telemetry
Summary
Functions
handle_event/4
setup/2
setup_oban/0
setup_opentelemetry/2
.Common.Telemetry.Metrics
Summary
Functions
child_spec/1
metrics/0
oban_worker_memory/0
start_link/1
.Common.Telemetry.Storage
Summary
Functions
child_spec/1
handle_event/4
metrics_history/1
start_link/1
.Common.Telemetry.SystemMonitor
Summary
Functions
format_percent/1
handle_alarm/2
handle_event/2
init/1
.Common.Test.Interactive
Summary
Functions
child_spec/1
run_all_tests/1
run_failed_tests/1
run_stale_tests/1
setup_test_repo/1
start_link/0
unlock/0
unwatch_tests/0
watch_tests/1
.Common.Test.Interactive.Helpers
Summary
Functions
f/1
ready/0
s/1
ta/1
uw/0
w/1
.Common.Test.Interactive.Observer
Summary
Functions
child_spec/1
.Common.TestInstanceRepo
Summary
Functions
aggregate/3
aggregate/4
all/2
apply/1
checked_out?/0
checkout/2
child_spec/1
config/0
custom_preload_fun/1
default_endpoint/0
default_options/1
default_repo/0
default_repo_opts/0
delete/2
delete!/2
delete_all/2
delete_many/1
disconnect_all/2
exists?/2
explain/3
fetch/2
fetch_all/2
fetch_by/2
find/3
get/3
get!/3
get_by/3
get_by!/3
get_dynamic_repo/0
in_transaction?/0
insert/2
insert!/2
insert_all/3
insert_all_or_ignore/2
insert_or_ignore/1
insert_or_ignore/2
insert_or_update/2
insert_or_update!/2
load/2
make_subquery/1
many/2
many_paginated/3
maybe_declare_test_instance/1
maybe_one/2
maybe_preload/3
maybe_where_ilike/5
one/2
one!/2
paginate/2
pluck/3
preload/3
preload_all/2
preload_mixins/2
prepare_query/3
process_put/1
put/1
put_dynamic_repo/1
put_many/1
query/3
query!/3
query_many/3
query_many!/3
reject_preload_ids/1
reload/2
reload!/2
rollback/1
single/1
sql/3
start_link/1
stop/1
stream/2
to_sql/2
trace/1
transact_many/1
transact_with/2
transaction/2
update/2
update!/2
update_all/3
upsert/3
upsert_all/3
.Common.Testing
Summary
Functions
configure_start_test/1
.Common.Testing.InsecurePW
Summary
Functions
no_user_verify/0
.Common.Text
Summary
Functions
blank?/1
camelise/1
code_syntax/2
contains?/2
contains_html?/1
hash/2
list_checkboxes/1
list_checked_boxes/1
list_unchecked_boxes/1
make_local_links_live/1
markdown_checkboxes/1
maybe_emote/3
maybe_markdown_to_html/2
maybe_normalize_html/1
maybe_other_custom_emoji/2
maybe_render_templated/2
maybe_sane_html/1
maybe_to_snake/1
normalise_links/2
random_string/1
regex_list/2
sentence_truncate/3
slug/1
split_lines/1
strlen/1
text_only/1
truncate/3
underscore_truncate/2
unique_integer/0
unique_string/0
upcase_first/1
verb_infinitive/1
.Common.TextExtended
Summary
Functions
blank?/1
camelise/1
code_syntax/2
contains?/2
contains_html?/1
hash/1
hash/2
list_checkboxes/1
list_checked_boxes/1
list_unchecked_boxes/1
make_local_links_live/1
markdown_checkboxes/1
maybe_emote/1
maybe_emote/2
maybe_emote/3
maybe_markdown_to_html/1
maybe_markdown_to_html/2
maybe_normalize_html/1
maybe_other_custom_emoji/2
maybe_render_templated/2
maybe_sane_html/1
maybe_to_snake/1
normalise_links/1
normalise_links/2
random_string/0
random_string/1
regex_list/2
sentence_truncate/1
sentence_truncate/2
sentence_truncate/3
slug/1
split_lines/1
strlen/1
text_only/1
truncate/1
truncate/2
truncate/3
underscore_truncate/1
underscore_truncate/2
unique_integer/0
unique_string/0
upcase_first/1
verb_infinitive/1
.Common.Types
Summary
Functions
all_object_type_names/0
defines_struct?/1
is_numeric/1
is_uid?/2
maybe_convert_ulids/1
maybe_to_atom/1
maybe_to_atom!/1
maybe_to_atom_or_module/3
maybe_to_float/2
maybe_to_integer/2
maybe_to_module/2
maybe_to_snake_atom/1
maybe_to_string/1
module_to_human_readable/1
module_to_str/1
object_type/2
object_type_display/1
sanitise_name/1
table_id/1
table_type/1
table_types/1
typeof/1
uid/2
uid!/1
uid_or_uids/1
uids/2
uids_or/2
.Common.URIs
Summary
Functions
base_domain/1
base_uri/1
base_url/1
based_url/2
canonical_url/1
display_url/1
fallback/1
fallback/2
fallback/3
maybe_generate_canonical_url/1
path/3
path_by_id/4
remote_canonical_url/1
static_path/2
url_path/2
valid_url?/1
validate_uri/1
.Common.Utils
Summary
Functions
apply_error/3
apply_task/3
apply_task_supervised/3
common_utils/1
current_account/2
current_account_and_or_user_ids/1
current_account_auth!/2
current_account_id/2
current_user/2
current_user_auth!/2
current_user_id/2
current_user_required!/1
declared_extension/0
empty?/1
maybe/2
maybe_apply/4
maybe_apply_fallback/3
maybe_from_opts/3
nothing?/1
ok_unwrap/2
round_nearest/1
round_nearest/2
to_options/1
.Ecto
Sections
Introduction
.Ecto.Acts.Begin
Summary
Functions
run/2
.Ecto.Acts.Commit
Summary
Functions
run/2
.Ecto.Acts.Delete
Summary
Functions
maybe_delete/2
run/2
.Ecto.Acts.Work
Summary
Functions
add/2
run/2
.Epics
Sections
Key components and concepts:
How it works
1. How to write an Act
2. How to define an Epic
3. How to run an Epic
Copyright and License
Summary
Functions
maybe_debug/3
maybe_debug/4
run_epic/3
smart/4
.Epics.Act
Summary
Types
ret/0
t/0
Callbacks
run/2
Functions
debug/3
new/1
new/2
new/3
.Epics.Debug
Summary
Functions
do_maybe_debug/4
opts/2
.Epics.Epic
Summary
Types
t/0
Functions
add_error/2
add_error/5
append/2
assign/3
debug/3
from_config!/2
from_spec!/1
maybe_debug/3
new/1
prepend/2
render_errors/1
run/1
update/4
.Epics.Error
Summary
Functions
message/1
.Epics.Test
Summary
Functions
assert_epic_ok/1
debug_error/1
.Mailer
Sections
Before You Begin
Choosing an Email Delivery Method
1. Default Behaviour: Direct SMTP Delivery
Copyright and License
Summary
Functions
app_name/0
deliver_async/1
deliver_inline/1
from/2
handle_error/2
html_body/2
new/1
send/4
send_app_feedback/3
send_async/3
send_now/3
start/2
subject/2
text_body/2
to/2
.Mailer.Bamboo
Summary
Functions
deliver/1
deliver_async/1
deliver_inline/1
deliver_later/2
deliver_later!/2
deliver_now/2
deliver_now!/2
from/2
html_body/2
new/1
subject/2
text_body/2
to/2
.Mailer.Behaviour
Summary
Types
email/0
Callbacks
deliver_async/1
deliver_inline/1
from/2
html_body/2
new/0
new/1
subject/2
text_body/2
to/2
.Mailer.Checker
Summary
Types
error_reason/0
Functions
validate_domain/1
validate_email/1
.Mailer.Render
Summary
Functions
default_layout/0
maybe_with_layout/4
new_templated/3
render_templated/6
render_to_string/3
render_to_string/4
templated/4
.Mailer.RuntimeConfig
Summary
Functions
bamboo_service/2
config/0
config_module/0
mail_blackhole/1
mailer/0
swoosh_service/2
.Mailer.Swoosh
Summary
Functions
deliver/2
deliver!/2
deliver_async/1
deliver_inline/1
deliver_many/2
from/2
html_body/2
new/1
subject/2
text_body/2
to/2
Feature extensions
Bonfire
.Classify
Sections
Handy commands
Copyright and License
Summary
Functions
arrange_categories_tree/1
ensure_update_allowed/2
maybe_index/1
maybe_unindex/1
my_followed_tree/2
publish/5
.Classify.Categories
Summary
Functions
ap_publish_activity/3
ap_receive_activity/3
attrs_prepare_tree/2
attrs_with_username/1
by_username/2
clean_username/1
create/3
create_remote/1
federation_module/0
format_actor/1
get/2
indexing_object_format/1
indexing_object_format_name/1
indexing_object_format_parent/1
list/2
list_tree/2
moderators/1
name_already_taken?/1
one/2
put_attrs_with_parent_category/2
put_generated_username/2
query_module/0
schema_module/0
soft_delete/2
try_several_usernames/4
update/4
update_local_actor/2
update_remote_actor/2
username_with_parent/2
.Classify.Category
Summary
Types
t/0
Functions
base_create_changeset/2
context_module/0
create_changeset/3
delete/2
follow_filters/0
get/3
put/3
query_module/0
update_changeset/3
.Classify.Category.Queries
Summary
Functions
filter/2
join_to/3
queries/4
query/1
query/2
.Classify.LiveHandler
Summary
Functions
declared_extension/0
handle_event/3
handle_params/3
mounted/3
new/3
set_image/5
sigil_p/2
.Classify.RuntimeConfig
Summary
Functions
config/0
config_module/0
.Classify.Simulate
Summary
Functions
category/1
fake_category!/3
.Classify.Tree
Summary
Types
t/0
Functions
ancestor_ids/1
ancestors/1
arrange/2
build_child/1
changeset/2
children/1
delete/2
depth/1
descendants/1
get/3
make_child_of/2
parent/1
parent_id/1
path/1
path_ids/1
put/3
put_tree/3
root/1
root?/1
root_id/1
siblings/1
subtree/1
where_depth/2
.Federate.ActivityPub
Sections
Testing
Handy commands
Copyright and License
Summary
Functions
disable/1
do_not_federate_user_ids/0
federating?/1
federating_default?/0
repo/0
set_federating/2
.Federate.ActivityPub.Adapter
Summary
Functions
base_url/0
external_followers_for_activity/2
federate_actor?/3
get_actor_by_ap_id/1
get_actor_by_id/1
get_actor_by_username/1
get_follower_local_ids/1
get_following_local_ids/1
get_locale/0
get_or_create_service_actor/0
get_redirect_url/1
handle_activity/1
local_actor_updated/2
maybe_create_remote_actor/1
maybe_publish_object/2
redirect_to_actor/1
update_local_actor/2
update_remote_actor/1
update_remote_actor/2
.Federate.ActivityPub.AdapterUtils
Summary
Functions
all_actors/1
all_recipients/2
ap_base_url/0
apply_fun_style/3
character_module/1
character_to_actor/1
create_author_object/1
create_remote_actor/1
determine_recipients/2
determine_recipients/3
determine_recipients/4
format_actor/2
get_actor_by_ap_id/2
get_actor_username/1
get_author/1
get_by_url_ap_id_or_username/2
get_character/2
get_character_by_ap_id/1
get_character_by_ap_id!/1
get_character_by_id/2
get_character_by_username/1
get_context_ap_id/1
get_creator_ap_id/1
get_different_creator_ap_id/1
get_in_reply_to/1
get_local_actor_by_ap_id/1
get_local_character_by_ap_id/2
get_object_ap_id/1
get_object_ap_id!/1
get_object_or_actor_by_ap_id!/1
get_or_create_service_character/2
get_or_fetch_and_create_by_uri/2
get_or_fetch_and_create_by_username/1
get_or_fetch_character_by_ap_id/1
get_pointer_id_by_ap_id/1
id_or_object_id/1
is_follow?/1
is_local?/2
is_local_collection?/1
is_local_collection_or_built_in?/1
local_actor_ids/1
log/1
maybe_add_aliases/2
maybe_attach_property_value/2
maybe_create_banner_object/2
maybe_create_icon_object/2
maybe_create_image_object/2
maybe_fix_image_object/1
maybe_format_image_object_from_path/1
maybe_pointer_for_ap_id/1
preload_peered/1
public_uri/0
return_pointable/2
return_pointer/2
service_character_id/0
service_character_username/0
the_ap_id/1
.Federate.ActivityPub.BoundariesMRF
Summary
Functions
actor_blocked?/3
.Federate.ActivityPub.FederationModules
Summary
Callbacks
federation_module/0
Functions
app_modules/0
federation_module/2
federation_module!/2
federation_modules/1
federation_modules_data_types/0
maybe_federation_module/2
modules/0
.Federate.ActivityPub.Incoming
Summary
Functions
no_federation_module_match/2
receive_activity/1
receive_activity/2
receive_object/2
.Federate.ActivityPub.Instances
Summary
Functions
get/1
get_by_domain/1
get_by_id/1
get_instance_circle/1
get_or_create/1
get_or_create_instance_circle/1
instance_blocked?/3
list/0
list_by_domains/1
list_paginated/1
list_query/0
.Federate.ActivityPub.NodeinfoAdapter
Summary
Functions
base_url/0
gather_nodeinfo_data/0
.Federate.ActivityPub.Outgoing
Summary
Functions
ap_activity!/1
federate_outgoing?/1
maybe_federate/4
preparation_error/2
push_actor_update/1
push_now!/1
.Federate.ActivityPub.Peered
Summary
Functions
actor_blocked?/3
get/1
get_canonical_uri/1
list/0
save_canonical_uri/3
.Federate.ActivityPub.RuntimeConfig
Summary
Functions
config/0
config_module/0
.Federate.ActivityPub.Simulate
Summary
Functions
actor_json/1
fake_remote_user/1
webfingered/0
.Invite.Links
Sections
Handy commands
Copyright and License
Summary
Functions
create/2
date_expires/1
delete/2
expired?/1
get/2
list_paginated/2
one/2
query/2
redeem/1
redeemable?/1
.Invite.Links.Fake
.Invite.Links.Integration
Summary
Functions
repo/0
.Invite.Links.LiveHandler
Summary
Functions
handle_event/3
sigil_p/2
.Invite.Links.Web.Routes
.InviteLink
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Label
Sections
Features
Copyright and License
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Label.Acts.LabelObject
.Label.ContentLabels
Summary
Functions
built_in_ids/0
built_ins/0
can_label?/3
labels/0
labels_under/1
parent_label_id/0
.Label.Fake
.Label.Labelling
Summary
Functions
ap_publish_activity/3
count/2
date_last_labelled/2
get/3
get!/3
label_object/3
labelled?/2
list_by/2
list_my/1
list_of/2
list_paginated/2
query/2
query_module/0
run_epic/4
schema_module/0
unlabel/3
.Label.Labels
Summary
Functions
create/4
get/2
get_or_create/4
repo/0
top_label_id/0
.Label.LiveHandler
Summary
Functions
handle_event/3
maybe_tag/4
sigil_p/2
.Label.RuntimeConfig
Summary
Functions
config/0
config_module/0
.Label.Web.Routes
.Me
Sections
Handy commands
Copyright and License
Summary
Functions
make_account_and_user/4
make_account_only/3
make_admin/1
.Me.Accounts
Summary
Types
changeset_name/0
Functions
allow_signup?/1
change_email/3
change_password/3
change_password/4
changeset/3
confirm_email/2
confirm_email_manually/1
count/0
delete/2
do_signup/2
enqueue_delete/1
fetch_current/1
get_by_email/1
get_current/1
instance_is_invite_only?/0
is_admin?/1
is_first_account?/0
login/2
login_valid?/2
make_account/2
maybe_redeem_invite/2
prepare_signup_opts/1
redeemable_invite?/1
request_confirm_email/2
request_forgot_password/1
signup/2
update_is_admin/3
.Me.Accounts.ChangeEmailFields
Summary
Functions
changeset/2
.Me.Accounts.ChangePasswordFields
Summary
Functions
changeset/3
.Me.Accounts.ConfirmEmailFields
Summary
Functions
changeset/2
.Me.Accounts.ForgotPasswordFields
Summary
Functions
changeset/2
.Me.Accounts.LoginFields
Summary
Functions
changeset/2
.Me.Accounts.Queries
Summary
Functions
by_confirm_token/1
by_email/1
count/1
current/1
login_by_account_id/1
login_by_email/1
login_by_username/1
.Me.Accounts.SecondFactors
Summary
Functions
changeset/3
delete_account_totp/1
enabled?/0
format_secret/1
get_account_totp/1
maybe_authenticate/2
maybe_cast_totp_changeset/3
new/0
new_qrcode/1
new_struct/1
new_uri/1
validate_account_totp/2
.Me.Acts.Caretaker
Summary
Functions
run/2
.Me.Acts.Creator
.Me.Archive.LiveHandler
Summary
Functions
handle_event/3
sigil_p/2
.Me.Characters
Summary
Functions
by_username/1
by_username!/1
by_username_q/1
changeset/3
character_mention_prefix/1
character_url/1
clean_username/1
display_username/4
get/1
hash_available?/1
hash_delete/1
indexing_object_format/1
q_by_id/1
remote_changeset/2
schema_module/0
update/2
username_available?/1
.Me.DeleteWorker
Summary
Functions
delete/2
delete_now/1
delete_structs_now/1
enqueue_delete/1
perform/1
.Me.Fake
Summary
Functions
fake_account!/2
fake_user!/3
.Me.Fake.Helpers
Summary
Functions
atusername/0
avatar_url/0
avatar_url/1
character_subform/1
confirm_token/0
create_user_form/1
credential_subform/1
email_subform/1
icon_url/1
image/1
image_url/1
profile_subform/1
signup_form/1
user_live/1
.Me.Integration
Summary
Functions
declared_extension/0
indexing_format_created/1
indexing_format_creator/1
is_local?/2
mailer/0
maybe_index/2
repo/0
.Me.Mails
Summary
Functions
confirm_email/2
forgot_password/1
mailer/0
render/3
signup_confirm_email/1
.Me.Mails.EmailView
Summary
Functions
render_template/2
.Me.Profiles
Summary
Functions
changeset/2
changeset_simple/2
indexing_object_format/1
schema_module/0
set_profile_image/3
spam?/2
spam_check!/2
.Me.Profiles.LiveHandler
Summary
Functions
default_assigns/1
get/1
handle_event/3
init/2
maybe_assign_aliases/2
set_image_setting/5
set_profile_image/5
sigil_p/2
user_assigns/3
.Me.RuntimeConfig
Summary
Functions
config/0
config_module/0
.Me.Users
Summary
Types
changeset_extra/0
changeset_name/0
Functions
ap_receive_activity/3
by_account/1
by_account!/1
by_ap_id/1
by_ap_id!/1
by_canonical_uri/1
by_id/2
by_user_and_account/2
by_username/2
by_username!/1
changeset/4
check_active/1
check_active!/1
count/1
create/2
create_remote/2
enqueue_delete/1
federation_module/0
fetch_current/1
flatten/1
format_actor/1
get_current/1
get_current/2
get_only_in_account/1
get_or_create_service_character/3
get_or_create_service_user/2
ids_by_account/1
indexing_object_format/1
is_active?/1
is_first_user?/0
list/1
list_admins/0
list_boundarised_query/1
list_paginated/1
make_admin/1
make_user/3
maybe_count/1
maybe_index_user/2
query_module/0
revoke_admin/1
schema_module/0
search/2
search_query/2
update/3
update_local_actor/2
update_remote_actor/2
.Me.Users.LiveHandler
Summary
Functions
disconnect_account_session/1
disconnect_sockets/1
disconnect_user_session/1
handle_event/3
sigil_p/2
to_tuple/1
.Me.Users.Queries
Summary
Functions
admins/1
base_by_id/1
base_query/0
by_account/1
by_canonical_uri/2
by_id/2
by_user_and_account/2
by_username_or_id/2
by_username_query/2
context_module/0
count/1
current/1
current/2
join_peered/1
list/1
query/2
schema_module/0
search/2
.Messages
Sections
Handy commands
Copyright and License
Summary
Functions
ap_publish_activity/3
ap_receive_activity/3
changeset/3
draft/2
federation_module/0
filter/3
list/3
list/4
maybe_index_message/1
maybe_spam_check/3
read/2
schema_module/0
send/3
.Messages.Fake
Summary
Functions
fake_comment!/4
fake_post!/4
fake_remote_user!/0
.Messages.Integration
Summary
Functions
declared_extension/0
mailer/0
repo/0
.Messages.LiveHandler
Summary
Functions
handle_event/3
handle_params/3
list_threads/3
live_more/3
send_message/2
sigil_p/2
thread_meta/4
thread_meta/5
thread_participants/4
threads_widget/3
.OpenID
Sections
Copyright and License
Summary
Functions
get_user/1
.OpenID.Client
Summary
Functions
oauth2_providers/0
open_id_connect_providers/0
providers_authorization_urls/1
.OpenID.Fake
Summary
Functions
fake_account!/2
fake_user!/2
.OpenID.Plugs.AuthRequired
Summary
Functions
require_auth/2
.OpenID.Plugs.Authorize
Summary
Functions
authorize/2
load_authorization/2
maybe_load_authorization/2
.OpenID.Plugs.ClientID
Summary
Functions
validate_client_id/2
.OpenID.Provider.ClientApps
Summary
Functions
get/1
get/3
get_or_new/1
get_or_new/2
init_test_client_app/2
list_active_tokens/0
list_clients/0
list_scopes/0
new/1
new/2
prepare_redirect_uri/1
prepare_redirect_uris/1
.OpenID.Provider.OAuth
Summary
Functions
redirect_uri_validate/1
.OpenID.RuntimeConfig
Summary
Functions
config/0
config_module/0
.OpenID.Web.Routes
.Poll
Sections
Copyright and License
Summary
Functions
repo/0
.Poll.Acts.Choices.Upsert
.Poll.Choice
Summary
Functions
changeset/2
delete/2
get/3
put/3
.Poll.Choices
Summary
Functions
put_choice/3
simple_create_and_put/4
.Poll.Fake
.Poll.LiveHandler
Summary
Functions
handle_event/3
negative_score_info/0
sigil_p/2
.Poll.Question
Summary
Types
t/0
Functions
delete/2
get/3
put/3
.Poll.Question.Create
.Poll.Questions
Summary
Functions
changeset/2
create/1
create_simple/1
list_by/2
list_paginated/2
query/2
query_paginated/2
read/2
run_epic/4
.Poll.RuntimeConfig
Summary
Functions
config/0
config_module/0
.Poll.Vote
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
.Poll.Votes
Summary
Functions
by_voter/2
calculate_total/3
count/2
get/3
get!/3
get_average_base_score/2
get_average_emoji/4
get_score/2
query/2
register_vote_choice/4
scores/0
send_vote_activity/4
vote/4
.Poll.Web.Routes
.Posts
Sections
Handy commands
Copyright and License
Summary
Functions
ap_publish_activity/3
ap_receive_activity/3
changeset/4
count_total/0
delete/2
draft/2
federation_module/0
indexing_object_format/1
list_by/2
list_paginated/2
prepare_post_attrs/1
publish/1
query/2
query_module/0
query_paginated/2
read/2
run_epic/3
schema_module/0
search/2
search_query/2
.Posts.Acts.Posts.Publish
.Posts.Fake
Summary
Functions
fake_comment!/4
fake_post!/4
fake_remote_user!/0
.Posts.Integration
Summary
Functions
declared_extension/0
mailer/0
repo/0
.Posts.LiveHandler
Summary
Functions
handle_event/3
post_changeset/2
sigil_p/2
write_feedback/2
.Search
Sections
Development & Deployment Documentation
Copyright and License
Summary
Functions
adapter/0
maybe_boundarise/3
search/2
search/4
search_by_type/3
.Search.Acts.Queue
Summary
Functions
maybe_unindex/1
prepare_object/1
.Search.Adapter
Summary
Types
facets/0
index/0
object/0
search_opts/0
search_result/0
Callbacks
create_index/2
delete/2
index_exists/1
put_documents/2
search/2
search/4
search_by_type/2
set_facets/2
set_searchable_fields/2
.Search.DB
Summary
Functions
base_query/0
default_types/1
run_search_db/3
search/4
search_by_type/2
.Search.Fuzzy
Summary
Functions
do_search/4
search/4
search_filtered/2
.Search.HTTP
Summary
Functions
http_adapter/0
http_error/5
http_request/4
.Search.Indexer
Summary
Functions
host/1
index_name/1
init_index/4
maybe_delete_object/2
maybe_index_object/2
maybe_indexable_and_discoverable/2
maybe_indexable_object/1
.Search.LiveHandler
Summary
Functions
handle_event/3
live_search/5
sigil_p/2
.Search.MeiliLib
Summary
Functions
create_index/2
delete/2
facet_from_map/1
get_client/0
index_exists/1
list_facets/1
put_documents/2
search/2
search/3
search/4
search_by_type/2
set_facets/2
set_searchable_fields/2
settings/2
wait_for_task/3
.Search.RuntimeConfig
Summary
Functions
config/0
config_module/0
.Search.Stopwords
Summary
Functions
filter/2
split_sentences/1
split_words/1
stop_words/1
.Search.Web.Routes
.Social
Sections
Handy commands
Copyright and License
Summary
Functions
automod_id/0
declared_extension/0
federate_outgoing?/1
federating?/1
get_or_create_automod/0
is_local?/2
mailer/0
many/3
maybe_federate/5
maybe_federate_and_gift_wrap_activity/3
repo/0
.Social.APActivities
Summary
Functions
ap_receive_activity/3
create/4
.Social.Activities
Summary
Functions
activity_preloads/2
activity_preloads/3
activity_under_media/1
activity_under_media/2
activity_under_object/1
activity_under_object/2
all_verb_names/0
all_verb_names_extra/0
as_permitted_for/3
build_assoc/3
build_assoc/4
by_subject_verb_object_q/3
cast/4
count_total/0
create/4
delete/1
delete_by_object/1
delete_by_subject_verb_object/3
fetch_cursor_value_fun/2
get/2
load_object/2
maybe_filter/3
maybe_join_creator/2
maybe_join_subject/2
maybe_remove_for_deleters_feeds/1
maybe_with_labelled/0
object_from_activity/1
object_preload_activity/2
object_preload_create_activity/1
object_under_activity/2
order_cursor_fields/2
order_pagination_opts/2
put_assoc/3
put_assoc/4
query/2
query_module/0
query_object_preload_activity/4
query_object_preload_create_activity/2
query_order/4
read/2
read_query/2
reply_to_as_permitted_for/3
schema_module/0
verb_congugate/1
verb_display/1
verb_id/1
verb_maybe_modify/2
verb_name/1
.Social.Acts.Activity
Summary
Functions
run/2
.Social.Acts.Activity.UnderObject
Summary
Functions
run/2
.Social.Acts.AntiSpam
Summary
Functions
all_text_content/2
check!/3
run/2
spam?/3
.Social.Acts.Federate
Summary
Functions
run/2
.Social.Acts.Feeds
Summary
Functions
run/2
thread_id/1
.Social.Acts.LivePush
Summary
Functions
run/2
.Social.Acts.Objects.Delete
.Social.Acts.PostContents
Summary
Functions
run/2
.Social.Acts.Sensitivity
Summary
Functions
run/2
.Social.Acts.Threaded
Summary
Functions
run/2
.Social.Answers
.Social.Bookmarks
Summary
Functions
bookmark/3
bookmarked?/2
by_bookmarked/2
by_bookmarker/2
count/2
get/3
get!/3
list_by/2
list_my/1
list_of/2
query/2
query_module/0
schema_module/0
unbookmark/3
.Social.Bookmarks.LiveHandler
Summary
Functions
bookmarker_count/1
do_bookmark/3
handle_event/3
sigil_p/2
update_many/2
update_many_opts/1
.Social.Boosts
Summary
Functions
ap_publish_activity/3
ap_receive_activity/3
boost/3
boosted?/2
count/2
date_last_boosted/2
federation_module/0
get/3
get!/3
list_by/2
list_my/1
list_of/2
list_paginated/2
maybe_boost/3
query/2
query_module/0
schema_module/0
unboost/3
.Social.Boosts.LiveHandler
Summary
Functions
do_boost/3
handle_event/3
sigil_p/2
update_many/2
update_many_opts/1
.Social.Edges
Summary
Functions
changeset/5
changeset_base/4
changeset_base_with_creator/4
changeset_extra/5
changeset_without_caretaker/5
count/3
count_for_subject/4
delete_by_both/3
delete_by_object/1
delete_by_subject/1
edge_module_query/2
exists?/4
filters_from_opts/1
get/4
get!/4
insert/3
insert/5
last/4
last_date/4
put_edge_assoc/3
put_edge_assoc/4
query/2
query_parent/3
.Social.Fake
Summary
Functions
fake_remote_user!/0
.Social.FeedActivities
Summary
Functions
base_query/1
cast/2
cast/3
count_total/0
delete/1
delete/2
feed/2
feeds_for_activity/1
get_feed_publishes/1
get_publish_feed_ids/1
mark_all_seen/2
maybe_feed_publish/5
maybe_preload_replied/1
publish/4
put_feed_publishes/2
query_maybe_exclude_mine/2
query_module/0
query_order/3
schema_module/0
the_object/1
unseen_count/2
.Social.FeedFilters
Summary
Types
t/0
Functions
changeset/2
delete/2
get/3
put/3
supported_filters/0
validate/1
.Social.FeedFilters.AtomOrStringList
Summary
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
.Social.FeedFilters.StringList
Summary
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
.Social.FeedLoader
Summary
Functions
contextual_preloads_from_filters/3
count/2
count_subjects/2
default_feed_name/1
feed/2
feed/3
feed_contains?/3
feed_contains_single?/3
feed_filtered/3
feed_ids_and_opts/2
feed_many_paginated/3
feed_name_or_default/2
feed_paginated/2
feed_with_object/3
filter_already_preloaded/2
map_activity_preloads/3
matches_filter?/2
my_feed/2
parameterize_filters/3
preload_presets/0
preloads_by_context_rules/0
preloads_from_filters/2
preloads_from_filters_rules/0
prepare_filters_and_opts/2
preset_feed_filters/2
query/3
query_extras_boundarised/3
query_object_extras_boundarised/3
replace_parameters/3
skip_types_default/0
skip_verbs_default/0
.Social.Feeds
Summary
Types
feed_name/0
Functions
admin_notifications/1
admins_notifications/0
admins_notifications/1
feed_id/2
feed_id!/2
feed_ids/2
feed_ids_to_publish/4
feed_presets/0
inbox_of_obj_creator/1
maybe_create_feed/2
maybe_creator_notification/3
maybe_custom_feeds/1
maybe_my_outbox_feed_id/2
my_feed_id/2
my_home_feed_ids/2
named_feed_id/2
reply_and_or_mentions_notifications_feeds/5
reply_and_or_mentions_to_notify/5
schema_module/0
target_feeds/3
.Social.Feeds.LiveHandler
Summary
Functions
actions_update_many/2
activity_preloads_tuple_from_filters/2
activity_update_many/2
activity_with_object_from_assigns/1
assign_feed/3
feed_assigns_maybe_async/4
feed_assigns_non_live/4
feed_default_assigns/2
feed_extra_preloads_list/2
feed_live_update_many_preload_mode/0
handle_event/3
handle_info/2
handle_params/3
insert_feed/3
load_user_feed_assigns/3
load_user_feed_assigns/4
object_preloads/0
paginate_feed/4
paginate_fetch_assign_default/2
paginate_opts/3
preload_activity_and_object_assocs/3
remove_activity/1
reply_to_activity/2
sigil_p/2
user_feed_assign_or_load_async/4
.Social.Flags
Summary
Functions
ap_publish_activity/3
ap_receive_activity/3
by_flagged/1
by_flagger/1
federation_module/0
flag/3
flagged?/2
get/3
get!/3
instance_moderators/0
list/1
list_by/2
list_my/1
list_of/2
list_paginated/2
list_preloaded/1
moderators/1
query/2
query_module/0
schema_module/0
unflag/2
.Social.Flags.LiveHandler
Summary
Functions
handle_event/3
sigil_p/2
.Social.Graph
Sections
Handy commands
Copyright and License
Summary
Functions
child_spec/1
graph_add/3
graph_clear/0
graph_conn/0
graph_distance/2
graph_distances/1
graph_query/2
graph_remove/3
init/1
init_and_load/0
load_from_db/0
maybe_applications/0
start_link/1
.Social.Graph.Aliases
Summary
Functions
add/3
all_by_object/2
all_by_subject/2
all_objects_by_subject/2
all_subjects_by_object/2
also_known_as?/2
ap_publish_activity/3
ap_receive_activity/3
exists?/2
federation_module/0
get/3
get!/3
list_aliased/2
list_aliases/2
list_my_aliased/2
list_my_aliases/2
move/2
query/2
query_module/0
remove/2
schema_module/0
.Social.Graph.Aliases.LiveHandler
Summary
Functions
handle_event/3
sigil_p/2
.Social.Graph.Fake
Summary
Functions
fake_follow!/0
fake_incoming_follow!/0
fake_outgoing_follow!/0
fake_remote_user!/0
.Social.Graph.Follows
Summary
Functions
accept/2
accept_from/2
all_by_object/2
all_by_subject/2
all_followed_outboxes/2
all_objects_by_subject/2
all_subjects_by_object/2
ap_publish_activity/3
ap_receive_activity/3
batch_follow/3
do_side_effects/4
federation_module/0
follow/3
following?/2
get/3
get!/3
ignore/2
list_followed/2
list_followers/2
list_my_followed/2
list_my_followers/2
query/2
query_module/0
requested?/2
schema_module/0
unfollow/3
.Social.Graph.Follows.LiveHandler
Summary
Functions
handle_event/3
sigil_p/2
update_many/2
update_many_opts/1
.Social.Graph.Import
Summary
Functions
import_from_csv_file/3
perform/1
perform/3
.Social.Graph.Integration
Summary
Functions
declared_extension/0
mailer/0
repo/0
.Social.Likes
Summary
Functions
ap_publish_activity/3
ap_receive_activity/3
by_liked/2
by_liker/2
count/2
do_like/3
federation_module/0
get/3
get!/3
get_or_create_emoji/2
like/3
liked?/2
list_by/2
list_my/1
list_of/2
list_paginated/2
query/2
query_module/0
schema_module/0
unlike/3
.Social.Likes.LiveHandler
Summary
Functions
do_like/3
handle_event/3
liker_count/1
sigil_p/2
update_many/2
update_many_opts/1
.Social.LivePush
Summary
Functions
hide_activity/2
notify/2
notify/4
notify_of_message/4
notify_users/4
prepare_activity/2
push_activity/3
push_activity_object/4
.Social.Objects
Summary
Functions
ap_maybe_delete/2
ap_receive_activity/3
as_permitted_for/3
care_closures/1
care_taken/1
cast/4
cast_acl/3
cast_basic/4
cast_caretaker/2
cast_creator/2
cast_creator_caretaker/2
cast_mini/4
cast_publish/4
cast_sensitivity/2
changeset_named/2
delete/2
delete_apply_error/2
delete_caretaken/1
do_delete/2
federation_module/0
list_paginated/2
list_query/2
maybe_filter/3
maybe_generic_delete/3
maybe_preload_activity_object/2
maybe_unindex/1
object_creator/1
permalink/1
preload_creator/1
preload_reply_creator/1
prepare_exclude_object_types/2
publish/5
query_base/1
query_maybe_time_limit/2
read/2
reset_preset_boundary/5
run_epic/3
set_boundaries/4
set_name/3
set_sensitivity/2
.Social.Objects.LiveHandler
Summary
Functions
handle_event/3
load_object_assigns/1
load_object_assigns/2
not_found_fallback/3
sigil_p/2
.Social.Pins
Summary
Functions
ap_publish_activity/3
by_pinned/2
by_pinner/2
federation_module/0
get/3
get!/3
list_by/2
list_instance_pins/1
list_my/1
list_of/2
pin/4
pinned?/2
query/2
query_module/0
rank_pin/3
schema_module/0
unpin/3
.Social.Pins.LiveHandler
Summary
Functions
do_pin/3
handle_event/3
sigil_p/2
.Social.PostContents
Summary
Functions
all_text_content/1
ap_receive_activity/3
ap_receive_attrs_prepare/4
base_query/0
cast/5
changeset/2
diff/2
edit/3
editor_output_content_type/1
federation_module/0
get/2
get_versions/2
get_versions_diffed/2
indexing_object_format/1
maybe_detect_languages/2
maybe_prepare_contents/4
merge_with_body_or_nil/2
no_known_output/2
one/2
prepare_text/3
query/2
query_base/0
search_query/2
versioning_enabled?/1
.Social.Requests
Summary
Functions
accept/2
all_by_object/3
all_by_subject/3
all_objects_by_subject/3
all_requested_outboxes/3
all_subjects_by_object/3
ap_publish_activity/3
exists?/4
get/2
get/4
get!/4
ignore/2
list_my_requested/1
list_my_requesters/1
list_requested/2
list_requesters/2
many/2
query/3
query_module/0
request/4
requested/2
requested?/3
schema_module/0
unrequest/3
.Social.RuntimeConfig
Summary
Functions
config/0
config_module/0
.Social.Seen
Summary
Functions
get/3
get!/3
last_date/2
mark_seen/3
mark_unseen/2
query/2
query_module/0
schema_module/0
seen?/2
.Social.Tags
Summary
Functions
auto_boost/2
indexing_format_tags/1
maybe_auto_boost/3
maybe_boostable_categories/2
maybe_cast/4
maybe_process/3
.Social.Threads
Summary
Functions
ap_prepare/2
arrange_replies/2
arrange_replies_tree/2
base_query/0
cast/4
changeset/2
count_participants/2
create_parent_replied/3
filter/3
find_reply_to/2
find_thread/2
init_parent_replied/1
list_participants/3
list_replies/2
mark_all_seen/2
maybe_re_order_result/2
maybe_with_pins/3
query/2
query_module/0
re_order_using_subquery/2
read/2
schema_module/0
unseen_count/2
unseen_query/2
.Social.Threads.LiveHandler
Summary
Functions
handle_event/3
handle_info/2
handle_params/3
insert_comments/3
live_more/3
load_thread/1
load_thread_assigns/2
load_thread_maybe_async/3
max_depth/1
maybe_subscribe/2
reply/3
send_thread_updates/4
sigil_p/2
thread_init/1
.Tag
Sections
Handy commands
Copyright and License
Summary
Functions
cast/4
context_module/0
find/2
format_tag/1
format_tags/1
get/2
get_hashtag/1
get_hashtags_from_changeset/1
get_mentions_from_changeset/1
get_or_create_hashtag/1
indexing_object_format/1
indexing_object_format_name/1
list_trending/2
list_trending_reset/2
list_trending_without_cache/2
many/2
maybe_find_tag/3
maybe_find_tags/3
maybe_lookup_tag/2
maybe_put_tree_parent/3
maybe_tag/4
maybe_taxonomy_tag/2
one/2
query_module/0
search_hashtag/2
search_hashtag_query/2
tag_ids/1
tag_something/4
tag_things_changeset/2
thing_tags_changeset/2
.Tag.Acts.Tag
Summary
Functions
run/2
.Tag.Autocomplete
Summary
Functions
api_tag_lookup/3
api_tag_lookup_public/4
filter_results/1
find_all_tags/1
maybe_find_tags/2
maybe_search/4
prefix_index/1
search_or_lookup/3
search_prefix/2
search_type/2
tag_add_field/4
tag_hit_prepare/4
tag_lookup_public/4
tag_search/2
tag_search_from_tags/1
tag_search_from_text/2
tags_split/1
try_all_prefixes/1
try_prefixes/1
try_tag_search/1
try_tag_search/2
.Tag.GraphQL.TagResolver
Summary
Functions
fetch_tag/2
name/3
summary/3
tag/2
tag_prepare/3
tag_something/2
tagged_things_edges/3
tags_edges/3
.Tag.Hashtag
Summary
Functions
changeset/2
delete/2
get/3
normalize_name/1
put/3
.Tag.LiveHandler
Summary
Functions
declared_extension/0
handle_event/3
maybe_tag/4
sigil_p/2
.Tag.Queries
Summary
Functions
filter/2
join_to/3
list_trending/2
queries/4
query/1
query/2
.Tag.Simulate
.Tag.Tagged
Summary
Types
t/0
Functions
all/0
changeset/2
delete/2
get/3
latest/1
put/3
q_with_tag/1
q_with_thing/1
q_with_type/1
search_query/2
thing_tags_insert/2
with_tag/1
with_thing/1
with_type/1
.Tag.TextContent.Formatter
Summary
Functions
linkify/2
nothing_handler/3
tag_handler/4
url_handler/3
.Tag.TextContent.Process
Summary
Functions
html_escape/2
process/3
.Tag.Web.Routes
.Tags.Acts.AutoBoost
Summary
Functions
run/2
Federation
ActivityPub
Sections
Installation
Summary
Functions
accept/1
accept_activity/1
announce/1
block/1
create/1
delete/3
flag/1
follow/1
like/1
move/4
reject/1
unannounce/1
unblock/1
unfollow/1
unlike/1
update/1
.Actor
Summary
Types
ap_id/0
id/0
pointer/0
pointer_id/0
t/0
username/0
Functions
actor?/1
actor_url/1
also_known_as?/2
check_actor_is_active/1
deactivate/1
delete/2
fetch_by_username/2
format_remote_actor/1
format_username/1
format_username/2
get_cached/1
get_cached!/1
get_cached_or_fetch/1
get_external_followers/1
get_followers/1
get_followings/1
get_non_cached/1
invalidate_cache/1
maybe_create_actor_from_object/1
reactivate/1
save_actor_tombstone/2
set_cache/1
swap_or_create_actor_tombstone/1
update_actor/1
update_actor/2
.Config
Summary
Functions
actors_and_collections/0
collection_types/0
delete/1
env/0
federating?/0
get/1
get/2
get!/1
is_in/2
public_uri/0
public_uris/0
put/2
supported_activity_types/0
supported_actor_types/0
.Config.Error
.Federator
Summary
Functions
perform/3
publish/2
.Federator.APPublisher
Summary
Functions
determine_inbox/4
gather_webfinger_links/1
is_representable?/1
maybe_federate_to_search_index/2
publish/3
publish_one/1
.Federator.Adapter
Summary
Callbacks
base_url/0
external_followers_for_activity/2
get_actor_by_ap_id/1
get_actor_by_id/1
get_actor_by_username/1
get_follower_local_ids/1
get_following_local_ids/1
get_locale/0
get_or_create_service_actor/0
get_redirect_url/1
handle_activity/1
maybe_create_remote_actor/1
maybe_publish_object/2
update_local_actor/2
update_remote_actor/1
Functions
adapter/0
base_url/0
call_or/3
external_followers_for_activity/2
federate_actor?/3
get_actor_by_ap_id/1
get_actor_by_id/1
get_actor_by_username/1
get_follower_local_ids/1
get_following_local_ids/1
get_locale/0
get_or_create_service_actor/0
get_redirect_url/1
handle_activity/1
maybe_create_remote_actor/1
maybe_handle_activity/1
maybe_publish_object/2
update_local_actor/2
update_remote_actor/1
update_remote_actor/2
.Federator.Fetcher
Summary
Functions
allowed_recursion?/2
cache_fetch_error/1
enqueue_fetch/2
fetch_collection/2
fetch_fresh_object_from_id/2
fetch_object_from_id/2
fetch_objects_from_id/2
fetch_outbox/2
fetch_remote_object_from_id/2
fetch_replies/2
fetch_thread/2
get_cached_object_or_fetch_ap_id/2
get_cached_object_or_fetch_pointer_id/2
maybe_fetch/2
maybe_parse_header_url/2
.Federator.HTTP
Summary
Types
t/0
Functions
delete/4
get/3
http_request/5
post/4
put/4
.Federator.HTTP.Connection
Summary
Functions
adapter_options/2
new/1
.Federator.HTTP.RateLimit
.Federator.HTTP.RequestBuilder
Summary
Functions
add_param/4
headers/2
method/2
opts/2
url/2
.Federator.HTTP.RetryAfter
.Federator.HTTP.Tesla
Summary
Types
option/0
Functions
delete/3
delete!/3
get/3
get!/3
head/3
head!/3
options/3
options!/3
patch/4
patch!/4
post/4
post!/4
put/4
put!/4
request/2
request!/2
trace/3
trace!/3
.Federator.Publisher
Summary
Callbacks
gather_webfinger_links/1
is_representable?/1
publish/2
publish_one/1
Functions
enqueue_one/2
gather_webfinger_links/1
publish/2
.Federator.Transformer
Summary
Functions
add_emoji_tags/1
fix_actor/1
fix_addressing/1
fix_attachments/1
fix_content_map/1
fix_context/2
fix_emoji/1
fix_in_reply_to/2
fix_object/2
fix_quote_url/2
fix_replies/2
fix_summary/1
fix_tag/1
fix_url/1
format_input/3
handle_incoming/2
maybe_handle_other_activity/1
prepare_outgoing/1
preserve_privacy_of_outgoing/2
replies/1
set_replies/1
take_emoji_tags/1
.Federator.WebFinger
Summary
Functions
base_url/1
finger/1
output/1
represent_user/1
webfinger_from_json/1
.Federator.Worker
Summary
Functions
worker_args/1
.Federator.Workers.PublisherWorker
Summary
Functions
enqueue/3
enqueueable/3
.Federator.Workers.ReceiverWorker
Summary
Functions
enqueue/3
enqueueable/3
.Federator.Workers.RemoteFetcherWorker
Summary
Functions
enqueue/3
enqueueable/3
.Fixtures
Summary
Functions
file/1
fixtures/0
fixtures_generic/0
fixtures_get/0
get/4
head/4
insert/1
insert_all/0
insert_file/1
insert_json/1
maybe_get_local/4
mock_global/1
none/4
post/4
request/1
.Instances
Summary
Functions
filter_reachable/1
host/1
reachability_datetime_threshold/0
reachable?/1
scrape_nodeinfo/1
set_consistently_unreachable/1
set_reachable/1
set_unreachable/2
.Instances.Instance
Summary
Functions
changeset/2
do_set_reachable/1
filter_reachable/1
host/1
reachable?/1
set_reachable/1
set_unreachable/2
.MRF
Sections
Writing your own MRF Policy
Summary
Callbacks
filter/2
Functions
filter/2
filter/3
get_policies/0
subdomain_match?/2
subdomains_regex/1
.MRF.SimplePolicy
Summary
Functions
check_reject/2
.Object
Summary
Types
t/0
Functions
actor_from_data/1
actor_id_from_data/1
all/1
changeset/1
changeset/2
common_changeset/1
delete/1
do_insert/1
do_update_existing/2
fetch_latest_block/2
fetch_latest_follow/2
get_activity_for_object_ap_id/2
get_ap_id/1
get_cached/1
get_cached!/1
get_existing_announce/2
get_existing_like/2
get_follow_activity/2
get_inbox/2
get_outbox_for_actor/2
get_outbox_for_instance/1
get_uncached/1
hard_delete/1
hashtags/1
invalidate_cache/1
is_deleted?/1
make_tombstone/2
maybe_fetch/2
maybe_upsert/3
normalise_tos/1
normalize/3
normalize_actors/1
normalize_params/3
object_url/1
prepare_data/4
query/1
self_replies_ids/2
set_cache/1
swap_object_with_tombstone/1
update_and_set_cache/1
update_changeset/2
update_existing/2
update_state/3
.Pruner
Summary
Functions
prune_all/1
prune_deletes/1
prune_objects/1
prune_orphaned_activities/0
prune_removes/1
prune_stale_follow_requests/1
prune_tombstones/1
prune_undos/1
remove_embedded_objects/0
.Pruner.PruneDatabaseWorker
.Queries
Summary
Types
query/0
Functions
activity_by_object_ap_id/2
by_actor/2
by_ap_id/2
by_id/2
by_object_id/2
by_object_in_reply_to_id/3
by_type/2
exclude_type/2
find_by_object_ap_id/2
last_follow/2
ordered/1
replies/2
self_replies/1
with_joined_activity/3
with_joined_object/2
with_preloaded_object/2
.Safety.Containment
Summary
Functions
contain_child/1
contain_origin/2
contain_origin_from_id/2
contain_uri/2
get_object/1
restrict_unauthenticated_access?/1
restrict_unauthenticated_access?/2
visible_for_user?/2
.Safety.Encryption
Summary
Functions
decrypt/2
encrypt/2
.Safety.HTTP.Signatures
Summary
Functions
fetch_fresh_public_key/1
fetch_public_key/1
get_public_key/1
.Safety.Keys
Summary
Functions
add_public_key/2
cast_uri/1
ensure_keys_present/1
fetch_public_key_for_ap_id/1
generate_rsa_pem/0
get_public_key_for_ap_id/1
http_host/1
key_id_to_actor_id/1
keypair_from_pem/1
maybe_add_fetch_signature_headers/3
public_key_decode/1
public_key_from_data/1
sign/2
.Utils
Summary
Functions
activitypub_object_headers/0
adapter_fallback/0
ap_base_url/0
ap_id/1
as_local_public/0
cache_clear/0
cachex_fetch/4
error_json/3
format_date/1
generate_id/1
generate_object_id/0
get_with_cache/4
has_as_public?/1
is_uid?/1
is_ulid?/1
is_uuid?/1
json_with_cache/6
label_in_collection?/2
make_date/0
make_json_ld_header/1
maybe_put/3
maybe_to_atom/1
maybe_to_string/1
ok_unwrap/2
public?/1
public?/2
put_if_present/4
repo/0
request_ip/1
return_json/4
safe_put_in/3
service_actor/0
service_actor!/0
set_repo/1
single_ap_id/1
single_ap_id_or_object/1
stringify_keys/2
uid/1
.Web
Summary
Functions
__using__/1
base_url/0
channel/0
controller/0
rate_limit_reached/2
router/0
view/0
.ActivityPubController
Summary
Functions
actor/2
ap_route_helper/1
followers/2
following/2
json_object_with_cache/3
maybe_inbox/2
object/2
outbox/2
.ActorView
Summary
Functions
actor_json/1
collection/4
render/2
.Endpoint
Summary
Functions
broadcast/3
broadcast!/3
broadcast_from/4
broadcast_from!/4
call/2
child_spec/1
config/2
config_change/2
host/0
init/1
local_broadcast/3
local_broadcast_from/4
path/1
script_name/0
server_info/1
start_link/1
static_integrity/1
static_lookup/1
static_path/1
static_url/0
struct_url/0
subscribe/2
unsubscribe/1
url/0
.ErrorHelpers
Summary
Functions
error_tag/2
.ErrorView
Summary
Functions
render/2
template_not_found/2
.IncomingActivityPubController
Summary
Functions
inbox/2
outbox_info/2
.LayoutView
Summary
Functions
render/2
.ObjectView
Summary
Functions
collection/4
render/2
.Plugs.DigestPlug
Summary
Functions
read_body/2
.Plugs.EnsureHTTPSignaturePlug
Summary
Functions
call/2
ignore/1
init/1
maybe_reject!/2
unauthorized/1
.Plugs.FetchHTTPSignaturePlug
Summary
Functions
call/2
init/1
.Plugs.HTTPSignaturePlug
Summary
Functions
call/2
init/1
.Plugs.MappedSignatureToIdentityPlug
Summary
Functions
call/2
init/1
.RedirectController
Summary
Functions
actor/2
object/2
remote_interaction/2
.Router
.Telemetry
Summary
Functions
child_spec/1
metrics/0
start_link/1
.UserSocket
.WebFingerController
Summary
Functions
webfinger/2
Utilities
ConsoleHelpers
DaisyTheme
Summary
Functions
adjust/5
clamp/3
darken/2
darker/5
default_theme/0
generate/1
is_dark?/1
keys/0
lighten/2
style_attr/1
theme/1
DummyAdapter
Entrepot
Sections
Concepts
Built-in Integrations
Storages
uploads
EntrepôtEcto
Summary
Functions
add_metadata/2
add_metadata/3
copy/3
storage!/1
Entrepot.Ecto
Sections
Entrepot.Ecto.Type
Entrepot.Ecto.upload
Upload cleanup
Testing
Summary
Functions
upload/4
upload/5
Entrepot.Ecto.Type
Summary
Functions
cast/1
dump/1
embed_as/1
equal?/2
load/1
type/0
Entrepot.Errors.InvalidLocator
Entrepot.Errors.InvalidStorage
Entrepot.Locator
Summary
Types
t/0
Functions
new/1
new!/1
Entrepot.Storage
Summary
Types
locator_id/0
option/0
Callbacks
delete/1
delete/2
path/1
path/2
put/1
put/2
read/1
read/2
stream/1
stream/2
url/1
url/2
Entrepot.Storages.Disk
Summary
Functions
clone/3
Entrepot.Storages.RAM
Summary
Functions
clone/3
Entrepot.Storages.S3
Summary
Functions
clone/3
Entrepot.Upload
Summary
Types
t/0
Functions
contents/1
name/1
path/1
Entrepot.Uploader
Summary
Types
option/0
storage/0
Callbacks
build_metadata/3
build_options/3
store/3
Import2Alias
Summary
Functions
import2alias/2
Import2Alias.CallerTracer
Summary
Functions
trace/2
Import2Alias.Server
Summary
Functions
child_spec/1
entries/0
record/6
start_link/1
Nebulex.DiskAdapter
Nebulex.DiskAdapter.DiskCacheHelper
Summary
Functions
cache_path/3
child_spec/1
disk_clear/2
disk_delete/3
disk_get/4
disk_list/2
disk_put/4
init/1
start_link/1
Paginator
Sections
Usage
Options
Summary
Callbacks
paginate/3
Functions
cursor_for_record/3
default_fetch_cursor_value/2
paginated_query/2
Paginator.Page
Sections
Fields
Summary
Types
t/0
Paginator.PageInfo
Sections
Fields
Summary
Types
opaque_cursor/0
t/0
UserAuthLiveMount
Summary
Functions
on_mount/4
Utilities
mix bonfire.account.new
Sections
Usage
Summary
Functions
get/4
password/1
password/3
run/1
mix bonfire.extension.compile
Summary
Functions
force_compile/2
loaded_by_name/3
run/1
touch_manifests/0
try_compile/2
mix bonfire.extension.copy_migrations
Summary
Functions
run/1
mix bonfire.extension.installer
Summary
Functions
igniter/2
install/2
mix bonfire.full_docs
Sections
Command line options
mix bonfire.gen.component
Summary
Functions
gen_component/4
igniter/2
mix bonfire.gen.extension
mix bonfire.gen.extension.ui
mix bonfire.gen.routes_module
Summary
Functions
igniter/2
mix bonfire.gen.ui
mix bonfire.gen.view
Summary
Functions
igniter/2
mix bonfire.gen.widget
Summary
Functions
igniter/2
mix bonfire.install.copy_configs
Summary
Functions
copy_all/2
copy_for_extensions/3
igniter/2
simple_copy/3
mix bonfire.install.copy_migrations
Summary
Functions
copy_all/2
copy_for_extensions/3
igniter/2
simple_copy/3
mix bonfire.install.extension
Summary
Functions
add_dep/4
fetch_and_run_installers/3
igniter/2
install/4
mix bonfire.localise.extract
Summary
Functions
run/1
mix bonfire.release
Summary
Functions
main/1
run/1
mix bonfire.secrets
Summary
Functions
main/1
print/1
mix bonfire.user.admin.promote
Sections
Usage
Summary
Functions
run/1
mix bonfire.user.new
Sections
Usage
Summary
Functions
run/1
mix import2alias
Search documentation of Bonfire
Settings
View Source
Bonfire.OpenID.Plugs.AuthRequired
(Bonfire v0.9.11-social-beta.6)
Summary
Functions
require_auth(conn, opts)
Functions
require_auth(conn, opts)
×