ExFirebase

v0.3.1

ExFirebase v0.3.1 ExFirebase.Messaging View Source

Firebase messaging interface

Link to this section Summary

Functions

delete_queue()
get_queue()
get_queue_length()
get_queue_stats()
queue(payload)

Enqueues a message payload for immediate delivery in a GenStage pipeline

send(payload)

Sends a push notification with Firebase Cloud Messaging v1 API

Link to this section Functions

Link to this function delete_queue() View Source 
delete_queue() :: :ok
Link to this function get_queue() View Source 
get_queue() :: [map()]
Link to this function get_queue_length() View Source 
get_queue_length() :: integer()
Link to this function queue(payload) View Source 
queue(map() | [map()]) :: :ok

Enqueues a message payload for immediate delivery in a GenStage pipeline

Link to this function send(payload) View Source 
send(map()) ::
  {:ok, HTTPoison.Response.t()}
  | {:error, HTTPoison.Error.t()}
  | {:error, ExFirebase.Error.t()}

Sends a push notification with Firebase Cloud Messaging v1 API

Examples 

iex> ExFirebase.Messaging.send(%{message: %{token: "dyZHH...", notification: %{body: "Hello World"}}})
{:ok,
 %HTTPoison.Response{
   body: %{
     "name" => "projects/project-id/messages/0:1544204830625699%2575e27c2575e27c"
   },
   ...
   status_code: 200
 }}

iex> ExFirebase.Messaging.send(%{message: %{token: ""}})
{:ok,
 %HTTPoison.Response{
   body: %{
     "error" => %{
       "code" => 400,
       "details" => [...],
       "message" => "The registration token is not a valid FCM registration token",
       "status" => "INVALID_ARGUMENT"
     }
   },
   ...
   status_code: 400
 }}