Current section

Files

Jump to
smart_city lib smart_city event.ex
Raw

lib/smart_city/event.ex

defmodule SmartCity.Event do
@moduledoc """
Defines macros for encoding event types the Smart City platform
will respond to in any of the various micro service components
in a central location shared by all components.
"""
@doc """
Defines an update event to a dataset within the system. The
system treats create events as a subset of updates.
"""
defmacro dataset_update(), do: quote(do: "dataset:update")
@doc """
Defines an update event to an organization within the system.
The system treats create events as a subset of updates.
"""
defmacro organization_update(), do: quote(do: "organization:update")
@doc """
Signals that a new file has been uploaded to the object store
and made available for the rest of the system.
"""
defmacro file_upload(), do: quote(do: "file:upload")
end