ravenx v1.1.0 Ravenx.Notification

Base module for notifications implemented using Ravenx strategies.

Summary

Functions

Function used to send a notification synchronously using a configuration tuple like the ones that get_notifications_config should return

Function used to send a notification synchronously using a configuration tuple like the ones that get_notifications_config should return

Macros

Macro to inject notification features in application’s modules

Functions

dispatch_async_notification(notification)
dispatch_async_notification(Ravenx.notif_config) :: Ravenx.notif_result

Function used to send a notification synchronously using a configuration tuple like the ones that get_notifications_config should return.

The tuple should have this objects:

  1. Strategy atom: defining which strategy to use
  2. Payload map: including the payload data of the notification.
  3. Options map (optional): the special configuration of the notification

It will respond with a tuple, with an atom that could be :ok or :error and the result of the operation, as an standard notification dispatch returns.

dispatch_notification(notification)
dispatch_notification(Ravenx.notif_config) :: Ravenx.notif_result

Function used to send a notification synchronously using a configuration tuple like the ones that get_notifications_config should return.

The tuple should have this objects:

  1. Strategy atom: defining which strategy to use
  2. Payload map: including the payload data of the notification.
  3. Options map (optional): the special configuration of the notification

It will respond with a tuple, with an atom that could be :ok or :error and the result of the operation, as an standard notification dispatch returns.

Macros

__using__()

Macro to inject notification features in application’s modules.