com.google.android.gcm

Class GCMBaseIntentService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

android.app.IntentService

com.google.android.gcm.GCMBaseIntentService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2

Direct Known Subclasses:

PushManager.PushReceiver

public abstract class GCMBaseIntentService
extends android.app.IntentService

Skeleton for application-specific IntentServices responsible for handling communication from Google Cloud Messaging service.

The abstract methods in this class are called from its worker thread, and hence should run in a limited amount of time. If they execute long operations, they should spawn new threads, otherwise the worker thread will be blocked.

Subclasses must provide a public no-arg constructor.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, AUDIO_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, KEYGUARD_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_ROUTER_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, TELEPHONY_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, UI_MODE_SERVICE, USB_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GCMBaseIntentService() Constructor that does not set a sender id, useful when the sender id is context-specific.
protected	GCMBaseIntentService(java.lang.String... senderIds) Constructor used when the sender id(s) is fixed.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String[]	getSenderIds(android.content.Context context) Gets the sender ids.
protected void	onDeletedMessages(android.content.Context context, int total) Called when the GCM server tells pending messages have been deleted because the device was idle.
protected abstract void	onError(android.content.Context context, java.lang.String errorId) Called on registration or unregistration error.
void	onHandleIntent(android.content.Intent intent)
protected abstract void	onMessage(android.content.Context context, android.content.Intent intent) Called when a cloud message has been received.
protected boolean	onRecoverableError(android.content.Context context, java.lang.String errorId) Called on a registration error that could be retried.
protected abstract void	onRegistered(android.content.Context context, java.lang.String registrationId) Called after a device has been registered.
protected abstract void	onUnregistered(android.content.Context context, java.lang.String registrationId) Called after a device has been unregistered.

Methods inherited from class android.app.IntentService

onBind, onCreate, onDestroy, onStart, onStartCommand, setIntentRedelivery

Methods inherited from class android.app.Service

dump, getApplication, onConfigurationChanged, onLowMemory, onRebind, onTaskRemoved, onTrimMemory, onUnbind, startForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

attachBaseContext, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkUriPermission, checkUriPermission, clearWallpaper, createPackageContext, databaseList, deleteDatabase, deleteFile, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getContentResolver, getDatabasePath, getDir, getExternalCacheDir, getExternalFilesDir, getFilesDir, getFileStreamPath, getMainLooper, getObbDir, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isRestricted, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, revokeUriPermission, sendBroadcast, sendBroadcast, sendOrderedBroadcast, sendOrderedBroadcast, sendStickyBroadcast, sendStickyOrderedBroadcast, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getString, getString, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

GCMBaseIntentService

protected GCMBaseIntentService()

Constructor that does not set a sender id, useful when the sender id is context-specific.

When using this constructor, the subclass must override getSenderIds(Context), otherwise methods such as onHandleIntent(Intent) will throw an IllegalStateException on runtime.

GCMBaseIntentService

protected GCMBaseIntentService(java.lang.String... senderIds)

Constructor used when the sender id(s) is fixed.

Method Detail

getSenderIds

protected java.lang.String[] getSenderIds(android.content.Context context)

Gets the sender ids.

By default, it returns the sender ids passed in the constructor, but it could be overridden to provide a dynamic sender id.

Throws:

java.lang.IllegalStateException - if sender id was not set on constructor.

onMessage

protected abstract void onMessage(android.content.Context context,
             android.content.Intent intent)

Called when a cloud message has been received.

Parameters:

context - application's context.

intent - intent containing the message payload as extras.

onDeletedMessages

protected void onDeletedMessages(android.content.Context context,
                     int total)

Called when the GCM server tells pending messages have been deleted because the device was idle.

Parameters:

context - application's context.

total - total number of collapsed messages

onRecoverableError

protected boolean onRecoverableError(android.content.Context context,
                         java.lang.String errorId)

Called on a registration error that could be retried.

By default, it does nothing and returns true, but could be overridden to change that behavior and/or display the error.

Parameters:

context - application's context.

errorId - error id returned by the GCM service.

Returns:

if true, failed operation will be retried (using exponential backoff).

onError

protected abstract void onError(android.content.Context context,
           java.lang.String errorId)

Called on registration or unregistration error.

Parameters:

context - application's context.

errorId - error id returned by the GCM service.

onRegistered

protected abstract void onRegistered(android.content.Context context,
                java.lang.String registrationId)

Called after a device has been registered.

Parameters:

context - application's context.

registrationId - the registration id returned by the GCM service.

onUnregistered

protected abstract void onUnregistered(android.content.Context context,
                  java.lang.String registrationId)

Called after a device has been unregistered.

Parameters:

registrationId - the registration id that was previously registered.

context - application's context.

onHandleIntent

public final void onHandleIntent(android.content.Intent intent)

Specified by:

onHandleIntent in class android.app.IntentService