CodeNameRaven.ChannelDisplay behaviour (raven_observer_display_sdk v0.4.0)

Copy Markdown

Behaviour for notification channel display modules.

Renders a channel's own dashboard panel (e.g. delivery history). Paired with a CodeNameRaven.Channel module the same way CodeNameRaven.Display pairs with CodeNameRaven.Monitor — self-bundled in one module, or as a separate package-sibling module declaring compatible_channels/0.

Summary

Callbacks

compatible_channels()
display_name()
prepare_assigns(map)
render(map)

Functions

channel_display_module?(module)

Returns true if the module implements the ChannelDisplay behaviour.

Callbacks

compatible_channels()

@callback compatible_channels() :: [module()]

display_name()

@callback display_name() :: String.t()

prepare_assigns(map)

@callback prepare_assigns(map()) :: map()

render(map)

@callback render(map()) :: Phoenix.LiveView.Rendered.t()

Functions

channel_display_module?(module)

Returns true if the module implements the ChannelDisplay behaviour.