View Source MongoosePush.Service behaviour (MongoosePush v2.2.0-dev)

Generic interface for push notifications services.

Summary

Types

error()

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

error_reason()

error_type()

notification()

options()

Callbacks

choose_pool(mode, list)

prepare_notification(t, request, pool_name)

push(notification, t, pool_name, options)

supervisor_entry(arg1)

Types

error()

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

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

error_reason()

@type error_reason() :: atom()

error_type()

@type error_type() ::
  :invalid_request
  | :internal_config
  | :auth
  | :unregistered
  | :too_many_requests
  | :unspecified
  | :service_internal
  | :payload_too_large
  | :unknown

notification()

@type notification() :: term()

options()

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

Callbacks

choose_pool(mode, list)

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

prepare_notification(t, request, pool_name)

@callback prepare_notification(
  String.t(),
  MongoosePush.request(),
  MongoosePush.Application.pool_name()
) :: notification()

push(notification, t, pool_name, options)

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

supervisor_entry(arg1)

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