WebhooksEmitter.Interface behaviour (webhooks_emitter v0.2.0) View Source

Specification for WebhooksEmitter

Link to this section Summary

Types

emitter_config()

emitter_id()

event_name()

event_names()

event_payload()

request_id()

url()

Callbacks

attach(emitter_id, event_name, emitter_config)

attach_many(emitter_id, event_names, emitter_config)

detach(emitter_id)

emit(event_name, event_payload, request_id)

list_emitters()

pause(emitter_id)

restart(emitter_id)

started?(emitter_id)

Link to this section Types

emitter_config()

Specs

emitter_config() :: WebhooksEmitter.Config.t()

emitter_id()

Specs

emitter_id() :: term()

event_name()

Specs

event_name() :: String.t() | atom()

event_names()

Specs

event_names() :: [event_name(), ...]

event_payload()

Specs

event_payload() :: map()

request_id()

Specs

request_id() :: String.t() | nil

url()

Specs

url() :: String.t()

Link to this section Callbacks

attach(emitter_id, event_name, emitter_config)

Specs

attach(emitter_id(), event_name(), emitter_config()) ::
  :ok | {:error, :already_exists | :already_present}

attach_many(emitter_id, event_names, emitter_config)

Specs

attach_many(emitter_id(), event_names(), emitter_config()) ::
  :ok | {:error, :already_exists | :already_present}

detach(emitter_id)

Specs

detach(emitter_id()) :: :ok

emit(event_name, event_payload, request_id)

Specs

emit(event_name(), event_payload(), request_id()) :: {:ok, request_id()}

list_emitters()

Specs

list_emitters() :: [emitter_id()]

pause(emitter_id)

Specs

pause(emitter_id()) :: :ok

restart(emitter_id)

Specs

restart(emitter_id()) :: :ok | {:error, term()}

started?(emitter_id)

Specs

started?(emitter_id()) :: boolean()