GcmTaskService

Class Overview

Implemented by the client application to provide an endpoint for the GcmNetworkManager to call back to when a task is ready to be executed.

Clients must add this service to their manifest and implement onRunTask(String). This service must provide an IntentFilter on the action ACTION_TASK_EVENT. Here's an example:

The return value of onRunTask(String) will determine whether the scheduler treats this execution as a success, in which case it continues normally, as a failure, in which the task will be dropped, or whether the task is re-added to the execution queue and exponentially backed-off.

Rescheduling a task will reset the back-off counter. Once a task is running it will not be cancelled, however a newly scheduled task with the same tag will not be executed until the active task has completed. This newly scheduled task will replace the previous task, regardless of whether the previous task was meant to be rescheduled.

Bear in mind that your service may receive multiple calls from the scheduler at once (specifically if you've made multiple schedule requests that overlap), so your implementation of onRunTask(String) must be thread-safe.

The scheduler will hold a PowerManager.WakeLock for your service, however after three minutes of execution if your task has not returned it will be considered to have timed out, and the wakelock will be released. Rescheduling your task at this point will have no effect. If you suspect your task will run longer than this you should start your own service explicitly or use some other mechanism; this API is intended for relatively short time-span network operations.

Summary

[Expand] Inherited Constants
From class android.app.Service int START_CONTINUATION_MASK int START_FLAG_REDELIVERY int START_FLAG_RETRY int START_NOT_STICKY int START_REDELIVER_INTENT int START_STICKY int START_STICKY_COMPATIBILITY
From class android.content.Context String ACCESSIBILITY_SERVICE String ACCOUNT_SERVICE String ACTIVITY_SERVICE String ALARM_SERVICE String APP_OPS_SERVICE String AUDIO_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_WAIVE_PRIORITY String BLUETOOTH_SERVICE String CAPTIONING_SERVICE String CLIPBOARD_SERVICE String CONNECTIVITY_SERVICE String CONSUMER_IR_SERVICE int CONTEXT_IGNORE_SECURITY int CONTEXT_INCLUDE_CODE int CONTEXT_RESTRICTED 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 NFC_SERVICE String NOTIFICATION_SERVICE String NSD_SERVICE String POWER_SERVICE String PRINT_SERVICE String SEARCH_SERVICE String SENSOR_SERVICE String STORAGE_SERVICE String TELEPHONY_SERVICE String TEXT_SERVICES_MANAGER_SERVICE String UI_MODE_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 int TRIM_MEMORY_BACKGROUND int TRIM_MEMORY_COMPLETE int TRIM_MEMORY_MODERATE int TRIM_MEMORY_RUNNING_CRITICAL int TRIM_MEMORY_RUNNING_LOW int TRIM_MEMORY_RUNNING_MODERATE int TRIM_MEMORY_UI_HIDDEN

[Expand] Inherited Methods
From class android.app.Service 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 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) 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) 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() File getCacheDir() ClassLoader getClassLoader() ContentResolver getContentResolver() File getDatabasePath(String arg0) File getDir(String arg0, int arg1) File getExternalCacheDir() File[] getExternalCacheDirs() File getExternalFilesDir(String arg0) File[] getExternalFilesDirs(String arg0) File getFileStreamPath(String arg0) File getFilesDir() Looper getMainLooper() File getObbDir() File[] getObbDirs() String getPackageCodePath() PackageManager getPackageManager() String getPackageName() String getPackageResourcePath() Resources getResources() SharedPreferences getSharedPreferences(String arg0, int arg1) Object getSystemService(String arg0) Resources.Theme getTheme() 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) void removeStickyBroadcast(Intent arg0) void removeStickyBroadcastAsUser(Intent arg0, UserHandle arg1) void revokeUriPermission(Uri arg0, int arg1) void sendBroadcast(Intent arg0) void sendBroadcast(Intent arg0, String arg1) 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 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(Bitmap arg0) void setWallpaper(InputStream arg0) void startActivities(Intent[] arg0) void startActivities(Intent[] arg0, Bundle arg1) void startActivity(Intent arg0) void startActivity(Intent arg0, Bundle 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) boolean stopService(Intent arg0) void unbindService(ServiceConnection arg0) void unregisterReceiver(BroadcastReceiver arg0)
From class android.content.Context abstract boolean bindService(Intent arg0, ServiceConnection arg1, int arg2) 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 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 File getCacheDir() abstract ClassLoader getClassLoader() abstract ContentResolver getContentResolver() abstract File getDatabasePath(String arg0) abstract File getDir(String arg0, int arg1) abstract File getExternalCacheDir() abstract File[] getExternalCacheDirs() abstract File getExternalFilesDir(String arg0) abstract File[] getExternalFilesDirs(String arg0) abstract File getFileStreamPath(String arg0) abstract File getFilesDir() abstract Looper getMainLooper() abstract File getObbDir() abstract File[] getObbDirs() abstract String getPackageCodePath() abstract PackageManager getPackageManager() abstract String getPackageName() abstract String getPackageResourcePath() abstract Resources getResources() abstract SharedPreferences getSharedPreferences(String arg0, int arg1) 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() 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) final TypedArray obtainStyledAttributes(int arg0, int[] arg1) final TypedArray obtainStyledAttributes(AttributeSet arg0, int[] arg1, int arg2, int arg3) 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 void removeStickyBroadcast(Intent arg0) abstract void removeStickyBroadcastAsUser(Intent arg0, UserHandle arg1) abstract void revokeUriPermission(Uri arg0, int arg1) abstract void sendBroadcast(Intent arg0) abstract void sendBroadcast(Intent arg0, String arg1) 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 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(Bitmap arg0) abstract void setWallpaper(InputStream arg0) abstract void startActivities(Intent[] arg0) abstract void startActivities(Intent[] arg0, Bundle arg1) abstract void startActivity(Intent arg0) abstract void startActivity(Intent arg0, Bundle 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 boolean stopService(Intent arg0) abstract void unbindService(ServiceConnection arg0) void unregisterComponentCallbacks(ComponentCallbacks arg0) abstract void unregisterReceiver(BroadcastReceiver arg0)
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration arg0) abstract void onLowMemory()
From interface android.content.ComponentCallbacks2 abstract void onTrimMemory(int arg0)