org.aerogear.mobile.push

Class PushService

java.lang.Object

org.aerogear.mobile.push.PushService

All Implemented Interfaces:

org.aerogear.mobile.core.ServiceModule

public class PushService
extends java.lang.Object
implements org.aerogear.mobile.core.ServiceModule

The entry point for communication with Unified Push Server

Constructor Summary

Constructors

Constructor and Description
PushService()

Method Summary

Modifier and Type	Method and Description
void	configure(org.aerogear.mobile.core.MobileCore core, org.aerogear.mobile.core.configuration.ServiceConfiguration serviceConfiguration)
static void	notifyHandlers(android.content.Context context, java.util.Map<java.lang.String,java.lang.String> message) Notify all registered handlers.
void	refreshToken() Update the device token on Unified Push Server
static void	registerBackgroundThreadHandler(MessageHandler handler) When a push message is received, all background thread handlers will be notified on a non UI thread.
org.aerogear.mobile.core.reactive.Request<java.lang.Boolean>	registerDevice() Register the device on Unified Push Server
org.aerogear.mobile.core.reactive.Request<java.lang.Boolean>	registerDevice(UnifiedPushConfig unifiedPushConfig) Register the device on Unified Push Server
static void	registerMainThreadHandler(MessageHandler handler) When a push message is received, all main thread handlers will be notified on the main(UI) thread.
boolean	requiresConfiguration()
java.lang.String	type()
static void	unregisterBackgroundThreadHandler(MessageHandler handler) This will remove the given handler from the collection of background thread handlers.
org.aerogear.mobile.core.reactive.Request<java.lang.Boolean>	unregisterDevice() Unregister the device on Unified Push Server
static void	unregisterMainThreadHandler(MessageHandler handler) This will remove the given handler from the collection of main thread handlers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushService

public PushService()

Method Detail

type

public java.lang.String type()

Specified by:

type in interface org.aerogear.mobile.core.ServiceModule

configure

public void configure(org.aerogear.mobile.core.MobileCore core,
                      org.aerogear.mobile.core.configuration.ServiceConfiguration serviceConfiguration)

Specified by:

configure in interface org.aerogear.mobile.core.ServiceModule

requiresConfiguration

public boolean requiresConfiguration()

Specified by:

requiresConfiguration in interface org.aerogear.mobile.core.ServiceModule

registerDevice

public org.aerogear.mobile.core.reactive.Request<java.lang.Boolean> registerDevice()

Register the device on Unified Push Server

Returns:

a request for a device registration

registerDevice

public org.aerogear.mobile.core.reactive.Request<java.lang.Boolean> registerDevice(UnifiedPushConfig unifiedPushConfig)

Register the device on Unified Push Server

Parameters:

unifiedPushConfig - Unified Push configuration to be send to the Unified Push Server

Returns:

a request for a device registration

unregisterDevice

public org.aerogear.mobile.core.reactive.Request<java.lang.Boolean> unregisterDevice()

Unregister the device on Unified Push Server

Returns:

a response to monitor the unregistration process.

refreshToken

public void refreshToken()

Update the device token on Unified Push Server

registerMainThreadHandler

public static void registerMainThreadHandler(MessageHandler handler)

When a push message is received, all main thread handlers will be notified on the main(UI) thread. This is very convenient for Activities and Fragments.

Parameters:

handler - a handler to added to the list of handlers to be notified.

registerBackgroundThreadHandler

public static void registerBackgroundThreadHandler(MessageHandler handler)

When a push message is received, all background thread handlers will be notified on a non UI thread. This should be used by classes which need to update internal state or preform some action which doesn't change the UI.

Parameters:

handler - a handler to added to the list of handlers to be notified.

unregisterMainThreadHandler

public static void unregisterMainThreadHandler(MessageHandler handler)

This will remove the given handler from the collection of main thread handlers. This MUST be called when a Fragment or activity is backgrounded via onPause.

Parameters:

handler - a handler to be removed to the list of handlers

unregisterBackgroundThreadHandler

public static void unregisterBackgroundThreadHandler(MessageHandler handler)

This will remove the given handler from the collection of background thread handlers.

Parameters:

handler - a handler to be removed to the list of handlers

notifyHandlers

public static void notifyHandlers(android.content.Context context,
                                  java.util.Map<java.lang.String,java.lang.String> message)

Notify all registered handlers.

Parameters:

context - the Android context

message - the push message