MongoosePush

v2.1.0

MongoosePush v2.1.0 MongoosePush.Service behaviour View Source

Generic interface for push notifications services.

Link to this section Summary

Types

error()

Error tuple with unified internal representation and exact reason returned by service

error_reason()
error_type()
notification()
options()

Callbacks

choose_pool(arg1, list)
prepare_notification(arg1, arg2, arg3)
push(notification, arg2, arg3, options)
supervisor_entry(arg1)

Link to this section Types

Link to this type

error()

View Source

Specs

error() :: {error_type(), error_reason()}

Error tuple with unified internal representation and exact reason returned by service

Link to this type

error_reason()

View Source

Specs

error_reason() :: atom()
Link to this type

error_type()

View Source

Specs

error_type() ::
  :invalid_request
  | :internal_config
  | :auth
  | :unregistered
  | :too_many_requests
  | :unspecified
  | :service_internal
  | :payload_too_large
  | :unknown
Link to this type

notification()

View Source

Specs

notification() :: term()
Link to this type

options()

View Source

Specs

options() :: [Keyword.t()]

Link to this section Callbacks

Link to this callback

choose_pool(arg1, list)

View Source

Specs

choose_pool(MongoosePush.mode(), [atom()]) ::
  MongoosePush.Application.pool_name() | nil
Link to this callback

prepare_notification(arg1, arg2, arg3)

View Source

Specs

prepare_notification(
  String.t(),
  MongoosePush.request(),
  MongoosePush.Application.pool_name()
) :: notification()
Link to this callback

push(notification, arg2, arg3, options)

View Source

Specs

push(
  notification(),
  String.t(),
  MongoosePush.Application.pool_name(),
  options()
) :: :ok | {:error, error()} | {:error, MongoosePush.error()}
Link to this callback

supervisor_entry(arg1)

View Source

Specs

supervisor_entry([MongoosePush.Application.pool_definition()] | nil) ::
  {module(), term()}