pushex v0.2.3 API Reference

Modules

Facade module to access Pushex functionalities.

This module defines types to work with APNS

Pushex.APNS.App represents an APNS application.

Module defining the behaviour to send requests to APNS..

Pushex.APNS.Request represents a request that will be sent to APNS. It contains the notification, and all the metadata that can be sent with it.

Pushex.APNS.Response represents a result to an APNS request

Pushex.AppManager is used to retreive applications from their name.

An in memory implementation using a GenServer for Pushex.AppManager

This module defines utilities to handle events when sending notification.

The event handler used when sandbox mode is activated.

This module defines types to work with GCM

Pushex.GCM.App represents a GCM application.

Module defining the behaviour to send requests to GCM.

Implementation of Pushex.GCM.Client sending HTTP requests to the GCM API

Pushex.GCM.Request represents a request that will be sent to GCM. It contains the notification, and all the metadata that can be sent with it.

Pushex.GCM.Response represents a GCM response.

Module containing helpers functions to use Pushex functionalities easily.

Sandbox where notifications get saved when the application is running in sandbox mode.

Ensure the value has the correct type.

Exceptions

Pushex.AppNotFoundError is raised when the app to send the request do not exist.

Pushex.GCM.HTTPError represents a failed request to GCM API.

Pushex.ValidationError is raised when a request contains invalid or incomplete data