View Source Mobilizon.Federation.ActivityPub.Types.Entity behaviour (Mobilizon v4.1.0-alpha.1)

ActivityPub entity behaviour

Summary

Types

t()

Callbacks

create(data, additionnal)

delete(structure, actor, local, additionnal)

update(structure, attrs, additionnal)

Types

t()

@type t() :: %{:id => any(), optional(:url) => String.t(), optional(atom()) => any()}

Callbacks

create(data, additionnal)

@callback create(data :: any(), additionnal :: map()) ::
  {:ok, t(), Mobilizon.Federation.ActivityStream.t()} | {:error, any()}

delete(structure, actor, local, additionnal)

@callback delete(
  structure :: t(),
  actor :: Mobilizon.Actors.Actor.t(),
  local :: boolean(),
  additionnal :: map()
) ::
  {:ok, Mobilizon.Federation.ActivityStream.t(), Mobilizon.Actors.Actor.t(),
   t()}
  | {:error, any()}

update(structure, attrs, additionnal)

@callback update(structure :: t(), attrs :: map(), additionnal :: map()) ::
  {:ok, t(), Mobilizon.Federation.ActivityStream.t()} | {:error, any()}