to top

public abstract class

GCMBaseIntentService

extends IntentService

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.app.IntentService
				↳	com.google.android.gcm.GCMBaseIntentService

This class is deprecated.
Please use the GoogleCloudMessaging API instead.

Class Overview

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.

Summary

Constants
String	TAG	Old TAG used for logging.

[Expand]

Inherited Constants

From class android.app.Service

From class android.content.Context

String	ACCESSIBILITY_SERVICE
String	ACCOUNT_SERVICE
String	ACTIVITY_SERVICE
String	ALARM_SERVICE
String	APPWIDGET_SERVICE
String	APP_OPS_SERVICE
String	AUDIO_SERVICE
String	BACKUP_SERVICE
int	BIND_ABOVE_CLIENT
int	BIND_ADJUST_WITH_ACTIVITY
int	BIND_ALLOW_OOM_MANAGEMENT
int	BIND_AUTO_CREATE
int	BIND_DEBUG_UNBIND
int	BIND_IMPORTANT
int	BIND_NOT_FOREGROUND
int	BIND_NOT_VISIBLE
int	BIND_VISIBLE
int	BIND_WAIVE_PRIORITY
String	BLUETOOTH_SERVICE
String	CLIPBOARD_SERVICE
String	CONNECTIVITY_SERVICE
int	CONTEXT_IGNORE_SECURITY
int	CONTEXT_INCLUDE_CODE
int	CONTEXT_RESTRICTED
String	COUNTRY_DETECTOR
String	DEVICE_POLICY_SERVICE
String	DISPLAY_SERVICE
String	DOWNLOAD_SERVICE
String	DROPBOX_SERVICE
String	INPUT_METHOD_SERVICE
String	INPUT_SERVICE
String	KEYGUARD_SERVICE
String	LAYOUT_INFLATER_SERVICE
String	LOCATION_SERVICE
String	MEDIA_ROUTER_SERVICE
int	MODE_APPEND
int	MODE_ENABLE_WRITE_AHEAD_LOGGING
int	MODE_MULTI_PROCESS
int	MODE_PRIVATE
int	MODE_WORLD_READABLE
int	MODE_WORLD_WRITEABLE
String	NETWORKMANAGEMENT_SERVICE
String	NETWORK_POLICY_SERVICE
String	NETWORK_STATS_SERVICE
String	NFC_SERVICE
String	NOTIFICATION_SERVICE
String	NSD_SERVICE
String	POWER_SERVICE
String	SCHEDULING_POLICY_SERVICE
String	SEARCH_SERVICE
String	SENSOR_SERVICE
String	SERIAL_SERVICE
String	SIP_SERVICE
String	STATUS_BAR_SERVICE
String	STORAGE_SERVICE
String	TELEPHONY_SERVICE
String	TEXT_SERVICES_MANAGER_SERVICE
String	UI_MODE_SERVICE
String	UPDATE_LOCK_SERVICE
String	USB_SERVICE
String	USER_SERVICE
String	VIBRATOR_SERVICE
String	WALLPAPER_SERVICE
String	WIFI_P2P_SERVICE
String	WIFI_SERVICE
String	WINDOW_SERVICE

From interface android.content.ComponentCallbacks2

Protected Constructors
	GCMBaseIntentService() Constructor that does not set a sender id, useful when the sender id is context-specific.
	GCMBaseIntentService(String... senderIds) Constructor used when the sender id(s) is fixed.

Public Methods
final void	onHandleIntent(Intent intent)

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

[Expand]

Inherited Methods

From class android.app.IntentService

From class android.app.Service

final void	attach(Context arg0, ActivityThread arg1, String arg2, IBinder arg3, Application arg4, Object arg5)
void	dump(FileDescriptor arg0, PrintWriter arg1, String[] arg2)
final Application	getApplication()
abstract IBinder	onBind(Intent arg0)
void	onConfigurationChanged(Configuration arg0)
void	onCreate()
void	onDestroy()
void	onLowMemory()
void	onRebind(Intent arg0)
void	onStart(Intent arg0, int arg1)
int	onStartCommand(Intent arg0, int arg1, int arg2)
void	onTaskRemoved(Intent arg0)
void	onTrimMemory(int arg0)
boolean	onUnbind(Intent arg0)
final void	setForeground(boolean arg0)
final void	startForeground(int arg0, Notification arg1)
final void	stopForeground(boolean arg0)
final void	stopSelf()
final void	stopSelf(int arg0)
final boolean	stopSelfResult(int arg0)

From class android.content.ContextWrapper

void	attachBaseContext(Context arg0)
boolean	bindService(Intent arg0, ServiceConnection arg1, int arg2)
boolean	bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3)
int	checkCallingOrSelfPermission(String arg0)
int	checkCallingOrSelfUriPermission(Uri arg0, int arg1)
int	checkCallingPermission(String arg0)
int	checkCallingUriPermission(Uri arg0, int arg1)
int	checkPermission(String arg0, int arg1, int arg2)
int	checkUriPermission(Uri arg0, int arg1, int arg2, int arg3)
int	checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5)
void	clearWallpaper()
Context	createConfigurationContext(Configuration arg0)
Context	createDisplayContext(Display arg0)
Context	createPackageContext(String arg0, int arg1)
Context	createPackageContextAsUser(String arg0, int arg1, UserHandle arg2)
String[]	databaseList()
boolean	deleteDatabase(String arg0)
boolean	deleteFile(String arg0)
void	enforceCallingOrSelfPermission(String arg0, String arg1)
void	enforceCallingOrSelfUriPermission(Uri arg0, int arg1, String arg2)
void	enforceCallingPermission(String arg0, String arg1)
void	enforceCallingUriPermission(Uri arg0, int arg1, String arg2)
void	enforcePermission(String arg0, int arg1, int arg2, String arg3)
void	enforceUriPermission(Uri arg0, int arg1, int arg2, int arg3, String arg4)
void	enforceUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5, String arg6)
String[]	fileList()
Context	getApplicationContext()
ApplicationInfo	getApplicationInfo()
AssetManager	getAssets()
Context	getBaseContext()
String	getBasePackageName()
File	getCacheDir()
ClassLoader	getClassLoader()
CompatibilityInfoHolder	getCompatibilityInfo(int arg0)
ContentResolver	getContentResolver()
File	getDatabasePath(String arg0)
File	getDir(String arg0, int arg1)
File	getExternalCacheDir()
File	getExternalFilesDir(String arg0)
File	getFileStreamPath(String arg0)
File	getFilesDir()
Looper	getMainLooper()
File	getObbDir()
String	getPackageCodePath()
PackageManager	getPackageManager()
String	getPackageName()
String	getPackageResourcePath()
Resources	getResources()
SharedPreferences	getSharedPreferences(String arg0, int arg1)
File	getSharedPrefsFile(String arg0)
Object	getSystemService(String arg0)
Resources.Theme	getTheme()
int	getThemeResId()
int	getUserId()
Drawable	getWallpaper()
int	getWallpaperDesiredMinimumHeight()
int	getWallpaperDesiredMinimumWidth()
void	grantUriPermission(String arg0, Uri arg1, int arg2)
boolean	isRestricted()
FileInputStream	openFileInput(String arg0)
FileOutputStream	openFileOutput(String arg0, int arg1)
SQLiteDatabase	openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2)
SQLiteDatabase	openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2, DatabaseErrorHandler arg3)
Drawable	peekWallpaper()
Intent	registerReceiver(BroadcastReceiver arg0, IntentFilter arg1)
Intent	registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3)
Intent	registerReceiverAsUser(BroadcastReceiver arg0, UserHandle arg1, IntentFilter arg2, String arg3, Handler arg4)
void	removeStickyBroadcast(Intent arg0)
void	removeStickyBroadcastAsUser(Intent arg0, UserHandle arg1)
void	revokeUriPermission(Uri arg0, int arg1)
void	sendBroadcast(Intent arg0, String arg1)
void	sendBroadcast(Intent arg0, String arg1, int arg2)
void	sendBroadcast(Intent arg0)
void	sendBroadcastAsUser(Intent arg0, UserHandle arg1)
void	sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2)
void	sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6)
void	sendOrderedBroadcast(Intent arg0, String arg1)
void	sendOrderedBroadcast(Intent arg0, String arg1, int arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)
void	sendOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)
void	sendStickyBroadcast(Intent arg0)
void	sendStickyBroadcastAsUser(Intent arg0, UserHandle arg1)
void	sendStickyOrderedBroadcast(Intent arg0, BroadcastReceiver arg1, Handler arg2, int arg3, String arg4, Bundle arg5)
void	sendStickyOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6)
void	setTheme(int arg0)
void	setWallpaper(InputStream arg0)
void	setWallpaper(Bitmap arg0)
void	startActivities(Intent[] arg0, Bundle arg1)
void	startActivities(Intent[] arg0)
void	startActivitiesAsUser(Intent[] arg0, Bundle arg1, UserHandle arg2)
void	startActivity(Intent arg0)
void	startActivity(Intent arg0, Bundle arg1)
void	startActivityAsUser(Intent arg0, Bundle arg1, UserHandle arg2)
void	startActivityAsUser(Intent arg0, UserHandle arg1)
boolean	startInstrumentation(ComponentName arg0, String arg1, Bundle arg2)
void	startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5)
void	startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4)
ComponentName	startService(Intent arg0)
ComponentName	startServiceAsUser(Intent arg0, UserHandle arg1)
boolean	stopService(Intent arg0)
boolean	stopServiceAsUser(Intent arg0, UserHandle arg1)
void	unbindService(ServiceConnection arg0)
void	unregisterReceiver(BroadcastReceiver arg0)

From class android.content.Context

abstract boolean	bindService(Intent arg0, ServiceConnection arg1, int arg2)
boolean	bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3)
abstract int	checkCallingOrSelfPermission(String arg0)
abstract int	checkCallingOrSelfUriPermission(Uri arg0, int arg1)
abstract int	checkCallingPermission(String arg0)
abstract int	checkCallingUriPermission(Uri arg0, int arg1)
abstract int	checkPermission(String arg0, int arg1, int arg2)
abstract int	checkUriPermission(Uri arg0, int arg1, int arg2, int arg3)
abstract int	checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5)
abstract void	clearWallpaper()
abstract Context	createConfigurationContext(Configuration arg0)
abstract Context	createDisplayContext(Display arg0)
abstract Context	createPackageContext(String arg0, int arg1)
abstract Context	createPackageContextAsUser(String arg0, int arg1, UserHandle arg2)
abstract String[]	databaseList()
abstract boolean	deleteDatabase(String arg0)
abstract boolean	deleteFile(String arg0)
abstract void	enforceCallingOrSelfPermission(String arg0, String arg1)
abstract void	enforceCallingOrSelfUriPermission(Uri arg0, int arg1, String arg2)
abstract void	enforceCallingPermission(String arg0, String arg1)
abstract void	enforceCallingUriPermission(Uri arg0, int arg1, String arg2)
abstract void	enforcePermission(String arg0, int arg1, int arg2, String arg3)
abstract void	enforceUriPermission(Uri arg0, int arg1, int arg2, int arg3, String arg4)
abstract void	enforceUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5, String arg6)
abstract String[]	fileList()
abstract Context	getApplicationContext()
abstract ApplicationInfo	getApplicationInfo()
abstract AssetManager	getAssets()
abstract String	getBasePackageName()
abstract File	getCacheDir()
abstract ClassLoader	getClassLoader()
abstract CompatibilityInfoHolder	getCompatibilityInfo(int arg0)
abstract ContentResolver	getContentResolver()
abstract File	getDatabasePath(String arg0)
abstract File	getDir(String arg0, int arg1)
abstract File	getExternalCacheDir()
abstract File	getExternalFilesDir(String arg0)
abstract File	getFileStreamPath(String arg0)
abstract File	getFilesDir()
abstract Looper	getMainLooper()
abstract File	getObbDir()
abstract String	getPackageCodePath()
abstract PackageManager	getPackageManager()
abstract String	getPackageName()
abstract String	getPackageResourcePath()
abstract Resources	getResources()
abstract SharedPreferences	getSharedPreferences(String arg0, int arg1)
abstract File	getSharedPrefsFile(String arg0)
final String	getString(int arg0)
final String	getString(int arg0, Object... arg1)
abstract Object	getSystemService(String arg0)
final CharSequence	getText(int arg0)
abstract Resources.Theme	getTheme()
int	getThemeResId()
abstract int	getUserId()
abstract Drawable	getWallpaper()
abstract int	getWallpaperDesiredMinimumHeight()
abstract int	getWallpaperDesiredMinimumWidth()
abstract void	grantUriPermission(String arg0, Uri arg1, int arg2)
boolean	isRestricted()
final TypedArray	obtainStyledAttributes(int[] arg0)
final TypedArray	obtainStyledAttributes(AttributeSet arg0, int[] arg1, int arg2, int arg3)
final TypedArray	obtainStyledAttributes(AttributeSet arg0, int[] arg1)
final TypedArray	obtainStyledAttributes(int arg0, int[] arg1)
abstract FileInputStream	openFileInput(String arg0)
abstract FileOutputStream	openFileOutput(String arg0, int arg1)
abstract SQLiteDatabase	openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2)
abstract SQLiteDatabase	openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2, DatabaseErrorHandler arg3)
abstract Drawable	peekWallpaper()
void	registerComponentCallbacks(ComponentCallbacks arg0)
abstract Intent	registerReceiver(BroadcastReceiver arg0, IntentFilter arg1)
abstract Intent	registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3)
abstract Intent	registerReceiverAsUser(BroadcastReceiver arg0, UserHandle arg1, IntentFilter arg2, String arg3, Handler arg4)
abstract void	removeStickyBroadcast(Intent arg0)
abstract void	removeStickyBroadcastAsUser(Intent arg0, UserHandle arg1)
abstract void	revokeUriPermission(Uri arg0, int arg1)
abstract void	sendBroadcast(Intent arg0, String arg1)
abstract void	sendBroadcast(Intent arg0, String arg1, int arg2)
abstract void	sendBroadcast(Intent arg0)
abstract void	sendBroadcastAsUser(Intent arg0, UserHandle arg1)
abstract void	sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2)
abstract void	sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6)
abstract void	sendOrderedBroadcast(Intent arg0, String arg1)
abstract void	sendOrderedBroadcast(Intent arg0, String arg1, int arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)
abstract void	sendOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)
abstract void	sendStickyBroadcast(Intent arg0)
abstract void	sendStickyBroadcastAsUser(Intent arg0, UserHandle arg1)
abstract void	sendStickyOrderedBroadcast(Intent arg0, BroadcastReceiver arg1, Handler arg2, int arg3, String arg4, Bundle arg5)
abstract void	sendStickyOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6)
abstract void	setTheme(int arg0)
abstract void	setWallpaper(InputStream arg0)
abstract void	setWallpaper(Bitmap arg0)
abstract void	startActivities(Intent[] arg0, Bundle arg1)
abstract void	startActivities(Intent[] arg0)
void	startActivitiesAsUser(Intent[] arg0, Bundle arg1, UserHandle arg2)
abstract void	startActivity(Intent arg0)
abstract void	startActivity(Intent arg0, Bundle arg1)
void	startActivityAsUser(Intent arg0, Bundle arg1, UserHandle arg2)
void	startActivityAsUser(Intent arg0, UserHandle arg1)
abstract boolean	startInstrumentation(ComponentName arg0, String arg1, Bundle arg2)
abstract void	startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5)
abstract void	startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4)
abstract ComponentName	startService(Intent arg0)
abstract ComponentName	startServiceAsUser(Intent arg0, UserHandle arg1)
abstract boolean	stopService(Intent arg0)
abstract boolean	stopServiceAsUser(Intent arg0, UserHandle arg1)
abstract void	unbindService(ServiceConnection arg0)
void	unregisterComponentCallbacks(ComponentCallbacks arg0)
abstract void	unregisterReceiver(BroadcastReceiver arg0)

From class java.lang.Object

From interface android.content.ComponentCallbacks

From interface android.content.ComponentCallbacks2

Constants

public static final String TAG

Old TAG used for logging. Marked as deprecated since it should have been private at first place.

Constant Value: "GCMBaseIntentService"

Protected Constructors

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.

protected GCMBaseIntentService (String... senderIds)

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

Public Methods

public final void onHandleIntent (Intent intent)

Protected Methods

protected String[] getSenderIds (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

IllegalStateException	if sender id was not set on constructor.

protected void onDeletedMessages (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

protected abstract void onError (Context context, String errorId)

Called on registration or unregistration error.

Parameters

context	application's context.
errorId	error id returned by the GCM service.

protected abstract void onMessage (Context context, Intent intent)

Called when a cloud message has been received.

Parameters

context	application's context.
intent	intent containing the message payload as extras.

protected boolean onRecoverableError (Context context, 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).

protected abstract void onRegistered (Context context, String registrationId)

Called after a device has been registered.

Parameters

context	application's context.
registrationId	the registration id returned by the GCM service.

protected abstract void onUnregistered (Context context, String registrationId)

Called after a device has been unregistered.

Parameters

context	application's context.
registrationId	the registration id that was previously registered.

Results

GCMBaseIntentService

Class Overview

Summary

Constants

public static final String TAG

Protected Constructors

protected GCMBaseIntentService ()

protected GCMBaseIntentService (String... senderIds)

Public Methods

public final void onHandleIntent (Intent intent)

Protected Methods

protected String[] getSenderIds (Context context)

Throws

protected void onDeletedMessages (Context context, int total)

Parameters

protected abstract void onError (Context context, String errorId)

Parameters

protected abstract void onMessage (Context context, Intent intent)

Parameters

protected boolean onRecoverableError (Context context, String errorId)

Parameters

Returns

protected abstract void onRegistered (Context context, String registrationId)

Parameters

protected abstract void onUnregistered (Context context, String registrationId)

Parameters