Packages

express

1.2.1
1.3.3 1.3.2 1.3.1 1.3.0 1.2.13 1.2.12 1.2.11 1.2.10 1.2.9 1.2.7 1.2.6 1.2.5 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0 1.1.3 1.1.2 1.1.1 1.1.0 1.0.0

Library for sending push notifications. Supports Apple APNS (with either ssl certificate or JWT) and Google FCM services.

HexDocs

Current section

Files

Jump to
Readme
22 Versions
8 Dependencies
Dependants
Files
Activity
express lib express express.ex
Raw

lib/express/express.ex 

defmodule Express do

  @moduledoc """

  Library for sending push notifications.

  Supports Apple APNS and Google FCM services.

  """



  alias Express.APNS

  alias Express.FCM



  @type push_result :: {:ok, %{status: pos_integer(), body: any()}} |

                        {:error, %{status: pos_integer(), body: any()}}



  @type callback_fun :: ((PushMessage.t, Express.push_result) -> any())



  @doc """

  Pushes a message with options and callback function (which are optional).

  Returns a response from a provider (via callback function).

  """

  @callback push(APNS.PushMessage.t | FCM.PushMessage.t,

                 Keyword.t,

                 callback_fun | nil) :: {:noreply, map()}

end