View Source Mobilizon.Actors (Mobilizon v4.1.0-alpha.1)

Gets an actor by its URL (ActivityPub ID). The :preload option allows to preload the followers relation. Raises Ecto.NoResultsError if the actor does not exist.

get_actor_by_url_2(url)

New function to replace Mobilizon.Actors.get_actor_by_url/1 with better signature

get_actor_with_preload(id, include_suspended \\ false)

Gets an actor with preloaded relations.

get_actor_with_preload!(id)

get_bot!(id)

Gets a single bot. Raises Ecto.NoResultsError if the bot does not exist.

get_bot_for_actor(actor)

Gets the bot associated to an actor.

get_default_member_role(actor)

Gets the default member role depending on the event join options.

get_follower(id)

Gets a single follower.

get_follower!(id)

Gets a single follower. Raises Ecto.NoResultsError if the follower does not exist.

get_follower_by_followed_and_following(actor1, actor2)

Gets a follower by the followed actor and following actor

get_follower_by_url(url)

Get a follower by the url.

get_group_by_actor_id(actor_id)

Gets a group by its actor id.

get_group_by_members_url(members_url)

get_group_by_title(title)

Gets a group by its title.

get_local_actor_by_name(name)

Gets a local actor by its preferred username.

get_local_actor_by_name_with_preload(name)

Gets a local actor by its preferred username and preloaded relations (organized events, followers and followings).

get_local_actor_with_preload(id)

Gets a local actor with preloaded relations.

get_local_group_by_url(group_url)

get_member(id)

Gets a single member.

get_member(actor_id, parent_id)

Gets a single member of an actor (for example a group).

get_member(actor_id, parent_id, roles)

get_member!(id)

Gets a single member. Raises Ecto.NoResultsError if the member does not exist.

get_member_by_url(url)

Gets a single member of an actor (for example a group).

get_or_create_internal_actor(username)

get_relay(domain)

Returns a relay actor, either relay@domain (Mobilizon) or domain@domain (Mastodon)

get_single_group_member_actor(group_id)

get_single_group_moderator_actor(group_id)

last_group_created()

list_actors(type \\ :Person, preferred_username \\ "", name \\ "", domain \\ "", local \\ true, suspended \\ false, page \\ nil, limit \\ nil)

Returns the list of actors.

list_actors_to_notify_from_group_event(actor)

list_all_administrator_members_for_group(id)

Returns the complete list of administrator members for a group.

list_all_local_members_for_group(group)

list_external_actors_members_for_group(actor)

list_external_followers_for_actor(actor)

Returns the list of external followers for an actor.

list_external_followers_for_actor_paginated(actor, page \\ nil, limit \\ nil)

Returns the paginated list of external followers for an actor.

list_external_followings_for_actor_paginated(actor, page \\ nil, limit \\ nil)

Returns the list of external followings for an actor.

list_external_groups()

Lists the groups.

list_group_ids_where_last_administrator(actor_id)

Returns the list of all group ids where the actor_id is the last administrator.

list_groups_for_stream()

Lists the groups.

list_groups_member_of(actor)

Returns the list of groups an actor is member of.

list_internal_actors_members_for_group(actor, roles \\ [])

list_local_actor_by_username(username)

Returns the list of local actors by their username.

list_members_for_actor(actor, page \\ nil, limit \\ nil)

Returns the list of members for an actor.

list_members_for_group(actor, name \\ nil, roles \\ [], page \\ nil, limit \\ nil)

Returns a paginated list of members for a group.

list_memberships_for_user(user_id, name, page, limit)

Returns the list of memberships for an user.

list_paginated_followers_for_actor(actor, approved \\ nil, page \\ nil, limit \\ nil)

Returns a paginated list of followers for an actor.

list_paginated_follows_for_actor(actor, page \\ nil, limit \\ nil)

list_suspended_actors_to_purge(options)

member?(actor_id, parent_id)

Returns whether the actor_id is a confirmed member for the group parent_id

moderator?(actor_id, parent_id)

Returns whether the actor_id is a moderator for the group parent_id

needs_update?(actor)

Whether the actor needs to be updated.

new_person(args, default_actor \\ false)

Creates a new person actor.

only_administrator?(member_id, group_id)

Returns whether the member is the last administrator for a group

register_bot(map)

Registers a new bot.

schedule_key_rotation(actor, delay)

search_actors(term, options \\ [], page \\ nil, limit \\ nil)

Builds a page struct for actors by their name or displayed name.

should_rotate_actor_key(actor)

stream_persons(preferred_username \\ "", name \\ "", domain \\ "", local \\ true, suspended \\ false, chunk_size \\ 500)

unfollow(followed, follower)

Unfollows an actor (removes a Follower record).

update_actor(actor, attrs)

Updates an actor.

update_bot(bot, attrs)

Updates a bot.

update_follower(follower, attrs)

Updates a follower.

update_member(member, attrs)

Updates a member.

upsert_actor(data, preload \\ false)

Upserts an actor. Conflicts on actor's URL/AP ID, replaces keys, avatar and banner, name and summary.

Functions

actor_key_rotation(actor)

@spec actor_key_rotation(Mobilizon.Actors.Actor.t()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, Ecto.Changeset.t()}

administrator?(actor_id, parent_id)

@spec administrator?(integer() | String.t(), integer() | String.t()) :: boolean()

Returns whether the actor_id is an administrator for the group parent_id

build_followers_for_actor(actor, page \\ nil, limit \\ nil)

@spec build_followers_for_actor(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Actors.Follower.t())

Build a page struct for followers of an actor.

build_followings_for_actor(actor, page \\ nil, limit \\ nil)

@spec build_followings_for_actor(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Actors.Follower.t())

Build a page struct for followings of an actor.

check_follow(follower_actor, followed_actor)

@spec check_follow(Mobilizon.Actors.Actor.t(), Mobilizon.Actors.Actor.t()) ::
  Mobilizon.Actors.Follower.t() | nil

Checks whether an actor is following another actor.

count_followers_for_actor(actor)

@spec count_followers_for_actor(Mobilizon.Actors.Actor.t()) :: integer()

Returns the number of followers for an actor

count_followings_for_actor(actor)

@spec count_followings_for_actor(Mobilizon.Actors.Actor.t()) :: integer()

Returns the number of followings for an actor

count_groups()

@spec count_groups() :: integer()

Counts all the groups

count_local_groups()

@spec count_local_groups() :: integer()

Counts the local groups

count_members_for_group(actor, roles \\ [:member, :moderator, :creator, :administrator])

Returns the number of members for a group

create_actor(attrs \\ %{})

@spec create_actor(map()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, Ecto.Changeset.t()}

Creates an actor.

create_bot(attrs \\ %{})

@spec create_bot(attrs :: map()) ::
  {:ok, Mobilizon.Actors.Bot.t()} | {:error, Ecto.Changeset.t()}

Creates a bot.

create_follower(attrs \\ %{})

@spec create_follower(attrs :: map()) ::
  {:ok, Mobilizon.Actors.Follower.t()} | {:error, Ecto.Changeset.t()}

Creates a follower.

create_group(attrs \\ %{})

@spec create_group(map()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, Ecto.Changeset.t()}

Creates a group.

If the group is local, creates an admin actor as well from creator_actor_id.

create_member(attrs \\ %{})

@spec create_member(map()) ::
  {:ok, Mobilizon.Actors.Member.t()} | {:error, Ecto.Changeset.t()}

Creates a member.

delete_actor(actor, options \\ [reserve_username: true, suspension: false])

@spec delete_actor(Mobilizon.Actors.Actor.t(), Keyword.t()) ::
  {:error, Ecto.Changeset.t()} | {:ok, Oban.Job.t()}

delete_bot(bot)

@spec delete_bot(Mobilizon.Actors.Bot.t()) ::
  {:ok, Mobilizon.Actors.Bot.t()} | {:error, Ecto.Changeset.t()}

Deletes a bot.

delete_follower(follower)

@spec delete_follower(Mobilizon.Actors.Follower.t()) ::
  {:ok, Mobilizon.Actors.Follower.t()} | {:error, Ecto.Changeset.t()}

Deletes a follower.

delete_follower_by_followed_and_following(followed, following)

@spec delete_follower_by_followed_and_following(
  Mobilizon.Actors.Actor.t(),
  Mobilizon.Actors.Actor.t()
) ::
  {:ok, Mobilizon.Actors.Follower.t()} | {:error, Ecto.Changeset.t()}

Deletes a follower by followed and following actors.

delete_member(member)

@spec delete_member(Mobilizon.Actors.Member.t()) ::
  {:ok, Mobilizon.Actors.Member.t()} | {:error, Ecto.Changeset.t()}

Deletes a member.

follow(followed, follower, url \\ nil, approved \\ true)

@spec follow(
  followed :: Mobilizon.Actors.Actor.t(),
  follower :: Mobilizon.Actors.Actor.t(),
  url :: String.t() | nil,
  approved :: boolean() | nil
) ::
  {:ok, Mobilizon.Actors.Follower.t()}
  | {:error,
     :already_following
     | :follow_pending
     | :followed_suspended
     | Ecto.Changeset.t()}

Makes an actor following another actor.

get_actor(id)

@spec get_actor(integer() | String.t()) :: Mobilizon.Actors.Actor.t() | nil

Gets a single actor.

get_actor!(id)

@spec get_actor!(integer() | String.t()) :: Mobilizon.Actors.Actor.t()

Gets a single actor. Raises Ecto.NoResultsError if the actor does not exist.

get_actor_by_followers_url(followers_url)

@spec get_actor_by_followers_url(String.t()) :: Mobilizon.Actors.Actor.t() | nil

get_actor_by_name(name, type \\ nil)

@spec get_actor_by_name(String.t(), atom() | nil) :: Mobilizon.Actors.Actor.t() | nil

Gets an actor by name.

get_actor_by_name_with_preload(name, type \\ nil)

@spec get_actor_by_name_with_preload(String.t(), atom() | nil) ::
  Mobilizon.Actors.Actor.t() | nil

Gets an actor by name and preloads the organized events.

get_actor_by_url(url, preload \\ false)

@spec get_actor_by_url(String.t(), boolean()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, :actor_not_found}

Gets an actor by its URL (ActivityPub ID). The :preload option allows to preload the followers relation.

get_actor_by_url!(url, preload \\ false)

@spec get_actor_by_url!(String.t(), boolean()) :: Mobilizon.Actors.Actor.t()

Gets an actor by its URL (ActivityPub ID). The :preload option allows to preload the followers relation. Raises Ecto.NoResultsError if the actor does not exist.

get_actor_by_url_2(url)

@spec get_actor_by_url_2(String.t()) :: Mobilizon.Actors.Actor.t() | nil

New function to replace Mobilizon.Actors.get_actor_by_url/1 with better signature

get_actor_with_preload(id, include_suspended \\ false)

@spec get_actor_with_preload(integer() | String.t(), boolean()) ::
  Mobilizon.Actors.Actor.t() | nil

Gets an actor with preloaded relations.

get_actor_with_preload!(id)

@spec get_actor_with_preload!(integer() | String.t()) :: Mobilizon.Actors.Actor.t()

get_bot!(id)

Gets a single bot. Raises Ecto.NoResultsError if the bot does not exist.

get_bot_for_actor(actor)

@spec get_bot_for_actor(Mobilizon.Actors.Actor.t()) :: Mobilizon.Actors.Bot.t()

Gets the bot associated to an actor.

get_default_member_role(actor)

@spec get_default_member_role(Mobilizon.Actors.Actor.t()) :: :member | :not_approved

Gets the default member role depending on the event join options.

get_follower(id)

@spec get_follower(integer() | String.t()) :: Mobilizon.Actors.Follower.t() | nil

Gets a single follower.

get_follower!(id)

@spec get_follower!(integer() | String.t()) :: Mobilizon.Actors.Follower.t()

Gets a single follower. Raises Ecto.NoResultsError if the follower does not exist.

get_follower_by_followed_and_following(actor1, actor2)

@spec get_follower_by_followed_and_following(
  Mobilizon.Actors.Actor.t(),
  Mobilizon.Actors.Actor.t()
) ::
  Mobilizon.Actors.Follower.t() | nil

Gets a follower by the followed actor and following actor

get_follower_by_url(url)

@spec get_follower_by_url(String.t()) :: Mobilizon.Actors.Follower.t()

Get a follower by the url.

get_group_by_actor_id(actor_id)

@spec get_group_by_actor_id(integer() | String.t()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, :group_not_found}

Gets a group by its actor id.

get_group_by_members_url(members_url)

@spec get_group_by_members_url(String.t()) :: Mobilizon.Actors.Actor.t() | nil

get_group_by_title(title)

@spec get_group_by_title(String.t()) :: Mobilizon.Actors.Actor.t() | nil

Gets a group by its title.

get_local_actor_by_name(name)

@spec get_local_actor_by_name(String.t()) :: Mobilizon.Actors.Actor.t() | nil

Gets a local actor by its preferred username.

get_local_actor_by_name_with_preload(name)

@spec get_local_actor_by_name_with_preload(String.t()) ::
  Mobilizon.Actors.Actor.t() | nil

Gets a local actor by its preferred username and preloaded relations (organized events, followers and followings).

get_local_actor_with_preload(id)

@spec get_local_actor_with_preload(integer() | String.t()) ::
  Mobilizon.Actors.Actor.t() | nil

Gets a local actor with preloaded relations.

get_local_group_by_url(group_url)

@spec get_local_group_by_url(String.t()) :: Mobilizon.Actors.Actor.t() | nil

get_member(id)

@spec get_member(integer() | String.t()) :: Mobilizon.Actors.Member.t() | nil

Gets a single member.

get_member(actor_id, parent_id)

@spec get_member(
  actor_id :: integer() | String.t(),
  parent_id :: integer() | String.t()
) ::
  {:ok, Mobilizon.Actors.Member.t()} | {:error, :member_not_found}

Gets a single member of an actor (for example a group).

get_member(actor_id, parent_id, roles)

@spec get_member(integer() | String.t(), integer() | String.t(), list()) ::
  {:ok, Mobilizon.Actors.Member.t()} | {:error, :member_not_found}

get_member!(id)

@spec get_member!(integer() | String.t()) :: Mobilizon.Actors.Member.t()

Gets a single member. Raises Ecto.NoResultsError if the member does not exist.

get_member_by_url(url)

@spec get_member_by_url(String.t()) :: Mobilizon.Actors.Member.t() | nil

Gets a single member of an actor (for example a group).

get_or_create_internal_actor(username)

@spec get_or_create_internal_actor(String.t()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, Ecto.Changeset.t()}

get_relay(domain)

@spec get_relay(String.t()) :: Mobilizon.Actors.Actor.t() | nil

Returns a relay actor, either relay@domain (Mobilizon) or domain@domain (Mastodon)

get_single_group_member_actor(group_id)

@spec get_single_group_member_actor(integer() | String.t()) ::
  Mobilizon.Actors.Actor.t() | nil

get_single_group_moderator_actor(group_id)

@spec get_single_group_moderator_actor(integer() | String.t()) ::
  Mobilizon.Actors.Actor.t() | nil

last_group_created()

@spec last_group_created() :: Mobilizon.Actors.Actor.t() | nil

list_actors(type \\ :Person, preferred_username \\ "", name \\ "", domain \\ "", local \\ true, suspended \\ false, page \\ nil, limit \\ nil)

@spec list_actors(
  atom(),
  String.t(),
  String.t(),
  String.t(),
  boolean() | nil,
  boolean() | nil,
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Actors.Actor.t())

Returns the list of actors.

list_actors_to_notify_from_group_event(actor)

@spec list_actors_to_notify_from_group_event(Mobilizon.Actors.Actor.t()) ::
  Mobilizon.Actors.Follower.t()

list_all_administrator_members_for_group(id)

@spec list_all_administrator_members_for_group(integer() | String.t()) :: [
  Mobilizon.Actors.Member.t()
]

Returns the complete list of administrator members for a group.

list_all_local_members_for_group(group)

@spec list_all_local_members_for_group(Mobilizon.Actors.Actor.t()) :: [
  Mobilizon.Actors.Member.t()
]

list_external_actors_members_for_group(actor)

@spec list_external_actors_members_for_group(Mobilizon.Actors.Actor.t()) :: [
  Mobilizon.Actors.Actor.t()
]

list_external_followers_for_actor(actor)

@spec list_external_followers_for_actor(Mobilizon.Actors.Actor.t()) :: [
  Mobilizon.Actors.Follower.t()
]

Returns the list of external followers for an actor.

list_external_followers_for_actor_paginated(actor, page \\ nil, limit \\ nil)

@spec list_external_followers_for_actor_paginated(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Actors.Actor.t())

Returns the paginated list of external followers for an actor.

list_external_followings_for_actor_paginated(actor, page \\ nil, limit \\ nil)

@spec list_external_followings_for_actor_paginated(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Actors.Follower.t())

Returns the list of external followings for an actor.

list_external_groups()

@spec list_external_groups() :: [Mobilizon.Actors.Actor.t()]

Lists the groups.

list_group_ids_where_last_administrator(actor_id)

@spec list_group_ids_where_last_administrator(integer() | String.t()) :: [integer()]

Returns the list of all group ids where the actor_id is the last administrator.

list_groups_for_stream()

@spec list_groups_for_stream() :: Enum.t()

Lists the groups.

list_groups_member_of(actor)

@spec list_groups_member_of(Mobilizon.Actors.Actor.t()) :: [
  Mobilizon.Actors.Actor.t()
]

Returns the list of groups an actor is member of.

list_internal_actors_members_for_group(actor, roles \\ [])

@spec list_internal_actors_members_for_group(Mobilizon.Actors.Actor.t(), list()) :: [
  Mobilizon.Actors.Actor.t()
]

list_local_actor_by_username(username)

@spec list_local_actor_by_username(String.t()) :: [Mobilizon.Actors.Actor.t()]

Returns the list of local actors by their username.

list_members_for_actor(actor, page \\ nil, limit \\ nil)

@spec list_members_for_actor(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Actors.Member.t())

Returns the list of members for an actor.

list_members_for_group(actor, name \\ nil, roles \\ [], page \\ nil, limit \\ nil)

@spec list_members_for_group(
  Mobilizon.Actors.Actor.t(),
  String.t() | nil,
  [atom()],
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Actors.Member.t())

Returns a paginated list of members for a group.

list_memberships_for_user(user_id, name, page, limit)

@spec list_memberships_for_user(
  integer(),
  String.t() | nil,
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Actors.Member.t())

Returns the list of memberships for an user.

Default behaviour is to not return :not_approved memberships

Examples

iex> list_event_participations_for_user(5)
%Page{total: 3, elements: [%Participant{}, ...]}

list_paginated_followers_for_actor(actor, approved \\ nil, page \\ nil, limit \\ nil)

@spec list_paginated_followers_for_actor(
  Mobilizon.Actors.Actor.t(),
  boolean() | nil,
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Actors.Follower.t())

Returns a paginated list of followers for an actor.

list_paginated_follows_for_actor(actor, page \\ nil, limit \\ nil)

@spec list_paginated_follows_for_actor(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Actors.Follower.t())

list_suspended_actors_to_purge(options)

@spec list_suspended_actors_to_purge(Keyword.t()) :: [Actors.t()]

member?(actor_id, parent_id)

@spec member?(integer() | String.t(), integer() | String.t()) :: boolean()

Returns whether the actor_id is a confirmed member for the group parent_id

moderator?(actor_id, parent_id)

@spec moderator?(integer() | String.t(), integer() | String.t()) :: boolean()

Returns whether the actor_id is a moderator for the group parent_id

needs_update?(actor)

@spec needs_update?(Mobilizon.Actors.Actor.t()) :: boolean()

Whether the actor needs to be updated.

Local actors obviously don't need to be updated, neither do suspended ones

new_person(args, default_actor \\ false)

@spec new_person(map(), default_actor :: boolean()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, Ecto.Changeset.t()}

Creates a new person actor.

only_administrator?(member_id, group_id)

@spec only_administrator?(integer() | String.t(), integer() | String.t()) :: boolean()

Returns whether the member is the last administrator for a group

register_bot(map)

@spec register_bot(%{name: String.t(), summary: String.t()}) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, Ecto.Changeset.t()}

Registers a new bot.

schedule_key_rotation(actor, delay)

@spec schedule_key_rotation(Mobilizon.Actors.Actor.t(), integer()) :: :ok

search_actors(term, options \\ [], page \\ nil, limit \\ nil)

@spec search_actors(
  String.t(),
  Keyword.t(),
  integer() | nil,
  integer() | nil
) :: Mobilizon.Storage.Page.t(Mobilizon.Actors.Actor.t())

Builds a page struct for actors by their name or displayed name.

should_rotate_actor_key(actor)

@spec should_rotate_actor_key(Mobilizon.Actors.Actor.t()) :: boolean()

stream_persons(preferred_username \\ "", name \\ "", domain \\ "", local \\ true, suspended \\ false, chunk_size \\ 500)

@spec stream_persons(
  String.t(),
  String.t(),
  String.t(),
  boolean() | nil,
  boolean() | nil,
  integer()
) :: Enum.t()

unfollow(followed, follower)

@spec unfollow(Mobilizon.Actors.Actor.t(), Mobilizon.Actors.Actor.t()) ::
  {:ok, Mobilizon.Actors.Follower.t()}
  | {:error, Ecto.Changeset.t() | String.t()}

Unfollows an actor (removes a Follower record).

update_actor(actor, attrs)

@spec update_actor(Mobilizon.Actors.Actor.t(), map()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, Ecto.Changeset.t()}

Updates an actor.

update_bot(bot, attrs)

@spec update_bot(Mobilizon.Actors.Bot.t(), map()) ::
  {:ok, Mobilizon.Actors.Bot.t()} | {:error, Ecto.Changeset.t()}

Updates a bot.

update_follower(follower, attrs)

@spec update_follower(Mobilizon.Actors.Follower.t(), map()) ::
  {:ok, Mobilizon.Actors.Follower.t()} | {:error, Ecto.Changeset.t()}

Updates a follower.

update_member(member, attrs)

@spec update_member(Mobilizon.Actors.Member.t(), map()) ::
  {:ok, Mobilizon.Actors.Member.t()} | {:error, Ecto.Changeset.t()}

Updates a member.

upsert_actor(data, preload \\ false)

@spec upsert_actor(map(), boolean()) ::
  {:ok, Mobilizon.Actors.Actor.t()} | {:error, Ecto.Changeset.t()}

Upserts an actor. Conflicts on actor's URL/AP ID, replaces keys, avatar and banner, name and summary.