FirebaseMessagingService

public class FirebaseMessagingService extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	com.google.firebase.messaging.FirebaseMessagingService

Base class for receiving messages from Firebase Cloud Messaging.

Extending this class is required to be able to handle downstream messages. It also provides functionality to automatically display notifications.

Override base class methods to handle any events required by the application. All methods are invoked on a background thread, and may be called when the app is in the background or not open.

Include the following in the manifest:

<service
    android:name=".YourFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>

To support receiving messages in direct boot mode, add android:directBootAware="true" to the service declaration. See Receive FCM messages in direct boot mode for more information.

Summary

Public constructors
`FirebaseMessagingService()`

Public methods
`void`	`@WorkerThread onDeletedMessages()` Called when the Firebase Cloud Messaging server deletes pending messages.
`void`	`@CallSuper onDestroy()`
`void`	`@WorkerThread onMessageReceived(@NonNull RemoteMessage message)` Called when a message is received.
`void`	`@WorkerThread onMessageSent(@NonNull String msgId)` This method is deprecated. This function is actually decommissioned along with all of FCM upstream messaging.
`void`	`@WorkerThread onNewToken(@NonNull String token)` Called when a new token for the default Firebase project is generated.
`void`	`@WorkerThread onSendError(@NonNull String msgId, @NonNull Exception exception)` This method is deprecated. This function is actually decommissioned along with all of FCM upstream messaging.

Inherited Constants

From android.content.ComponentCallbacks2

`static final int`	`TRIM_MEMORY_BACKGROUND = 40`
`static final int`	`TRIM_MEMORY_COMPLETE = 80`
`static final int`	`TRIM_MEMORY_MODERATE = 60`
`static final int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15`
`static final int`	`TRIM_MEMORY_RUNNING_LOW = 10`
`static final int`	`TRIM_MEMORY_RUNNING_MODERATE = 5`
`static final int`	`TRIM_MEMORY_UI_HIDDEN = 20`

From android.content.Context

`static final String`	`ACCESSIBILITY_SERVICE = "accessibility"`
`static final String`	`ACCOUNT_SERVICE = "account"`
`static final String`	`ACTIVITY_SERVICE = "activity"`
`static final String`	`ALARM_SERVICE = "alarm"`
`static final String`	`APPWIDGET_SERVICE = "appwidget"`
`static final String`	`APP_OPS_SERVICE = "appops"`
`static final String`	`APP_SEARCH_SERVICE = "app_search"`
`static final String`	`AUDIO_SERVICE = "audio"`
`static final String`	`BATTERY_SERVICE = "batterymanager"`
`static final int`	`BIND_ABOVE_CLIENT = 8`
`static final int`	`BIND_ADJUST_WITH_ACTIVITY = 128`
`static final int`	`BIND_ALLOW_ACTIVITY_STARTS = 512`
`static final int`	`BIND_ALLOW_OOM_MANAGEMENT = 16`
`static final int`	`BIND_AUTO_CREATE = 1`
`static final int`	`BIND_DEBUG_UNBIND = 2`
`static final int`	`BIND_EXTERNAL_SERVICE = -2147483648`
`static final long`	`BIND_EXTERNAL_SERVICE_LONG = 4611686018427387904`
`static final int`	`BIND_IMPORTANT = 64`
`static final int`	`BIND_INCLUDE_CAPABILITIES = 4096`
`static final int`	`BIND_NOT_FOREGROUND = 4`
`static final int`	`BIND_NOT_PERCEPTIBLE = 256`
`static final int`	`BIND_SHARED_ISOLATED_PROCESS = 8192`
`static final int`	`BIND_WAIVE_PRIORITY = 32`
`static final String`	`BIOMETRIC_SERVICE = "biometric"`
`static final String`	`BLOB_STORE_SERVICE = "blob_store"`
`static final String`	`BLUETOOTH_SERVICE = "bluetooth"`
`static final String`	`BUGREPORT_SERVICE = "bugreport"`
`static final String`	`CAMERA_SERVICE = "camera"`
`static final String`	`CAPTIONING_SERVICE = "captioning"`
`static final String`	`CARRIER_CONFIG_SERVICE = "carrier_config"`
`static final String`	`CLIPBOARD_SERVICE = "clipboard"`
`static final String`	`COMPANION_DEVICE_SERVICE = "companiondevice"`
`static final String`	`CONNECTIVITY_DIAGNOSTICS_SERVICE = "connectivity_diagnostics"`
`static final String`	`CONNECTIVITY_SERVICE = "connectivity"`
`static final String`	`CONSUMER_IR_SERVICE = "consumer_ir"`
`static final int`	`CONTEXT_IGNORE_SECURITY = 2`
`static final int`	`CONTEXT_INCLUDE_CODE = 1`
`static final int`	`CONTEXT_RESTRICTED = 4`
`static final String`	`CREDENTIAL_SERVICE = "credential"`
`static final String`	`CROSS_PROFILE_APPS_SERVICE = "crossprofileapps"`
`static final int`	`DEVICE_ID_DEFAULT = 0`
`static final int`	`DEVICE_ID_INVALID = -1`
`static final String`	`DEVICE_LOCK_SERVICE = "device_lock"`
`static final String`	`DEVICE_POLICY_SERVICE = "device_policy"`
`static final String`	`DISPLAY_HASH_SERVICE = "display_hash"`
`static final String`	`DISPLAY_SERVICE = "display"`
`static final String`	`DOMAIN_VERIFICATION_SERVICE = "domain_verification"`
`static final String`	`DOWNLOAD_SERVICE = "download"`
`static final String`	`DROPBOX_SERVICE = "dropbox"`
`static final String`	`EUICC_SERVICE = "euicc"`
`static final String`	`FILE_INTEGRITY_SERVICE = "file_integrity"`
`static final String`	`FINGERPRINT_SERVICE = "fingerprint"`
`static final String`	`GAME_SERVICE = "game"`
`static final String`	`GRAMMATICAL_INFLECTION_SERVICE = "grammatical_inflection"`
`static final String`	`HARDWARE_PROPERTIES_SERVICE = "hardware_properties"`
`static final String`	`HEALTHCONNECT_SERVICE = "healthconnect"`
`static final String`	`INPUT_METHOD_SERVICE = "input_method"`
`static final String`	`INPUT_SERVICE = "input"`
`static final String`	`IPSEC_SERVICE = "ipsec"`
`static final String`	`JOB_SCHEDULER_SERVICE = "jobscheduler"`
`static final String`	`KEYGUARD_SERVICE = "keyguard"`
`static final String`	`LAUNCHER_APPS_SERVICE = "launcherapps"`
`static final String`	`LAYOUT_INFLATER_SERVICE = "layout_inflater"`
`static final String`	`LOCALE_SERVICE = "locale"`
`static final String`	`LOCATION_SERVICE = "location"`
`static final String`	`MEDIA_COMMUNICATION_SERVICE = "media_communication"`
`static final String`	`MEDIA_METRICS_SERVICE = "media_metrics"`
`static final String`	`MEDIA_PROJECTION_SERVICE = "media_projection"`
`static final String`	`MEDIA_ROUTER_SERVICE = "media_router"`
`static final String`	`MEDIA_SESSION_SERVICE = "media_session"`
`static final String`	`MIDI_SERVICE = "midi"`
`static final int`	`MODE_APPEND = 32768`
`static final int`	`MODE_ENABLE_WRITE_AHEAD_LOGGING = 8`
`static final int`	`MODE_MULTI_PROCESS = 4` This field is deprecated.
`static final int`	`MODE_NO_LOCALIZED_COLLATORS = 16`
`static final int`	`MODE_PRIVATE = 0`
`static final int`	`MODE_WORLD_READABLE = 1` This field is deprecated.
`static final int`	`MODE_WORLD_WRITEABLE = 2` This field is deprecated.
`static final String`	`NETWORK_STATS_SERVICE = "netstats"`
`static final String`	`NFC_SERVICE = "nfc"`
`static final String`	`NOTIFICATION_SERVICE = "notification"`
`static final String`	`NSD_SERVICE = "servicediscovery"`
`static final String`	`OVERLAY_SERVICE = "overlay"`
`static final String`	`PEOPLE_SERVICE = "people"`
`static final String`	`PERFORMANCE_HINT_SERVICE = "performance_hint"`
`static final String`	`POWER_SERVICE = "power"`
`static final String`	`PRINT_SERVICE = "print"`
`static final int`	`RECEIVER_EXPORTED = 2`
`static final int`	`RECEIVER_NOT_EXPORTED = 4`
`static final int`	`RECEIVER_VISIBLE_TO_INSTANT_APPS = 1`
`static final String`	`RESTRICTIONS_SERVICE = "restrictions"`
`static final String`	`ROLE_SERVICE = "role"`
`static final String`	`SEARCH_SERVICE = "search"`
`static final String`	`SENSOR_SERVICE = "sensor"`
`static final String`	`SHORTCUT_SERVICE = "shortcut"`
`static final String`	`STATUS_BAR_SERVICE = "statusbar"`
`static final String`	`STORAGE_SERVICE = "storage"`
`static final String`	`STORAGE_STATS_SERVICE = "storagestats"`
`static final String`	`SYSTEM_HEALTH_SERVICE = "systemhealth"`
`static final String`	`TELECOM_SERVICE = "telecom"`
`static final String`	`TELEPHONY_IMS_SERVICE = "telephony_ims"`
`static final String`	`TELEPHONY_SERVICE = "phone"`
`static final String`	`TELEPHONY_SUBSCRIPTION_SERVICE = "telephony_subscription_service"`
`static final String`	`TEXT_CLASSIFICATION_SERVICE = "textclassification"`
`static final String`	`TEXT_SERVICES_MANAGER_SERVICE = "textservices"`
`static final String`	`TV_INPUT_SERVICE = "tv_input"`
`static final String`	`TV_INTERACTIVE_APP_SERVICE = "tv_interactive_app"`
`static final String`	`UI_MODE_SERVICE = "uimode"`
`static final String`	`USAGE_STATS_SERVICE = "usagestats"`
`static final String`	`USB_SERVICE = "usb"`
`static final String`	`USER_SERVICE = "user"`
`static final String`	`VIBRATOR_MANAGER_SERVICE = "vibrator_manager"`
`static final String`	`VIBRATOR_SERVICE = "vibrator"` This field is deprecated.
`static final String`	`VIRTUAL_DEVICE_SERVICE = "virtualdevice"`
`static final String`	`VPN_MANAGEMENT_SERVICE = "vpn_management"`
`static final String`	`WALLPAPER_SERVICE = "wallpaper"`
`static final String`	`WIFI_AWARE_SERVICE = "wifiaware"`
`static final String`	`WIFI_P2P_SERVICE = "wifip2p"`
`static final String`	`WIFI_RTT_RANGING_SERVICE = "wifirtt"`
`static final String`	`WIFI_SERVICE = "wifi"`
`static final String`	`WINDOW_SERVICE = "window"`

From android.app.Service

`static final int`	`START_CONTINUATION_MASK = 15`
`static final int`	`START_FLAG_REDELIVERY = 1`
`static final int`	`START_FLAG_RETRY = 2`
`static final int`	`START_NOT_STICKY = 2`
`static final int`	`START_REDELIVER_INTENT = 3`
`static final int`	`START_STICKY = 1`
`static final int`	`START_STICKY_COMPATIBILITY = 0`
`static final int`	`STOP_FOREGROUND_DETACH = 2`
`static final int`	`STOP_FOREGROUND_LEGACY = 0` This field is deprecated.
`static final int`	`STOP_FOREGROUND_REMOVE = 1`

Inherited methods

From android.content.Context

`final int`	`getColor(int id)`
`final ColorStateList`	`getColorStateList(int id)`
`final Drawable`	`getDrawable(int id)`
`final String`	`getString(int resId)`
`final T`	`<T> getSystemService(Class<T> serviceClass)`
`final CharSequence`	`getText(int resId)`
`final TypedArray`	`obtainStyledAttributes(int[] attrs)`
`void`	`revokeSelfPermissionOnKill(String permName)`
`void`	`sendBroadcastWithMultiplePermissions( Intent intent, String[] receiverPermissions )`

From android.content.ContextWrapper

`boolean`	`bindIsolatedService( Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn )`
`boolean`	`bindService(Intent service, ServiceConnection conn, int flags)`
`boolean`	`bindServiceAsUser( Intent service, ServiceConnection conn, int flags, UserHandle user )`
`int`	`checkCallingOrSelfPermission(String permission)`
`int`	`checkCallingOrSelfUriPermission(Uri uri, int modeFlags)`
`int[]`	`checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)`
`int`	`checkCallingPermission(String permission)`
`int`	`checkCallingUriPermission(Uri uri, int modeFlags)`
`int[]`	`checkCallingUriPermissions(List<Uri> uris, int modeFlags)`
`int`	`checkPermission(String permission, int pid, int uid)`
`int`	`checkSelfPermission(String permission)`
`int`	`checkUriPermission(Uri uri, int pid, int uid, int modeFlags)`
`int[]`	`checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)`
`void`	`clearWallpaper()` This method is deprecated.
`Context`	`createAttributionContext(String attributionTag)`
`Context`	`createConfigurationContext(Configuration overrideConfiguration)`
`Context`	`createContext(ContextParams contextParams)`
`Context`	`createContextForSplit(String splitName)`
`Context`	`createDeviceContext(int deviceId)`
`Context`	`createDeviceProtectedStorageContext()`
`Context`	`createDisplayContext(Display display)`
`Context`	`createPackageContext(String packageName, int flags)`
`Context`	`createWindowContext(int type, Bundle options)`
`String[]`	`databaseList()`
`boolean`	`deleteDatabase(String name)`
`boolean`	`deleteFile(String name)`
`boolean`	`deleteSharedPreferences(String name)`
`void`	`enforceCallingOrSelfPermission(String permission, String message)`
`void`	`enforceCallingOrSelfUriPermission( Uri uri, int modeFlags, String message )`
`void`	`enforceCallingPermission(String permission, String message)`
`void`	`enforceCallingUriPermission(Uri uri, int modeFlags, String message)`
`void`	`enforcePermission(String permission, int pid, int uid, String message)`
`void`	`enforceUriPermission( Uri uri, int pid, int uid, int modeFlags, String message )`
`String[]`	`fileList()`
`Context`	`getApplicationContext()`
`ApplicationInfo`	`getApplicationInfo()`
`AssetManager`	`getAssets()`
`AttributionSource`	`getAttributionSource()`
`String`	`getAttributionTag()`
`Context`	`getBaseContext()`
`File`	`getCacheDir()`
`ClassLoader`	`getClassLoader()`
`File`	`getCodeCacheDir()`
`ContentResolver`	`getContentResolver()`
`File`	`getDataDir()`
`File`	`getDatabasePath(String name)`
`int`	`getDeviceId()`
`File`	`getDir(String name, int mode)`
`Display`	`getDisplay()`
`File`	`getExternalCacheDir()`
`File[]`	`getExternalCacheDirs()`
`File`	`getExternalFilesDir(String type)`
`File[]`	`getExternalFilesDirs(String type)`
`File[]`	`getExternalMediaDirs()` This method is deprecated.
`File`	`getFileStreamPath(String name)`
`File`	`getFilesDir()`
`Executor`	`getMainExecutor()`
`Looper`	`getMainLooper()`
`File`	`getNoBackupFilesDir()`
`File`	`getObbDir()`
`File[]`	`getObbDirs()`
`String`	`getOpPackageName()`
`String`	`getPackageCodePath()`
`PackageManager`	`getPackageManager()`
`String`	`getPackageName()`
`String`	`getPackageResourcePath()`
`ContextParams`	`getParams()`
`Resources`	`getResources()`
`SharedPreferences`	`getSharedPreferences(String name, int mode)`
`Object`	`getSystemService(String name)`
`String`	`getSystemServiceName(Class<Object> serviceClass)`
`Resources.Theme`	`getTheme()`
`Drawable`	`getWallpaper()` This method is deprecated.
`int`	`getWallpaperDesiredMinimumHeight()` This method is deprecated.
`int`	`getWallpaperDesiredMinimumWidth()` This method is deprecated.
`void`	`grantUriPermission(String toPackage, Uri uri, int modeFlags)`
`boolean`	`isDeviceProtectedStorage()`
`boolean`	`isRestricted()`
`boolean`	`isUiContext()`
`boolean`	`moveDatabaseFrom(Context sourceContext, String name)`
`boolean`	`moveSharedPreferencesFrom(Context sourceContext, String name)`
`FileInputStream`	`openFileInput(String name)`
`FileOutputStream`	`openFileOutput(String name, int mode)`
`SQLiteDatabase`	`openOrCreateDatabase( String name, int mode, SQLiteDatabase.CursorFactory factory )`
`Drawable`	`peekWallpaper()` This method is deprecated.
`void`	`registerComponentCallbacks(ComponentCallbacks callback)`
`void`	`registerDeviceIdChangeListener(Executor executor, IntConsumer listener)`
`Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter)`
`void`	`removeStickyBroadcast(Intent intent)` This method is deprecated.
`void`	`removeStickyBroadcastAsUser(Intent intent, UserHandle user)` This method is deprecated.
`void`	`revokeSelfPermissionsOnKill(Collection<String> permissions)`
`void`	`revokeUriPermission(Uri uri, int modeFlags)`
`void`	`sendBroadcast(Intent intent)`
`void`	`sendBroadcastAsUser(Intent intent, UserHandle user)`
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission)`
`void`	`sendOrderedBroadcastAsUser( Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras )`
`void`	`sendStickyBroadcast(Intent intent)` This method is deprecated.
`void`	`sendStickyBroadcastAsUser(Intent intent, UserHandle user)` This method is deprecated.
`void`	`sendStickyOrderedBroadcast( Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras )` This method is deprecated.
`void`	`sendStickyOrderedBroadcastAsUser( Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras )` This method is deprecated.
`void`	`setTheme(int resid)`
`void`	`setWallpaper(Bitmap bitmap)` This method is deprecated.
`void`	`startActivities(Intent[] intents)`
`void`	`startActivity(Intent intent)`
`ComponentName`	`startForegroundService(Intent service)`
`boolean`	`startInstrumentation( ComponentName className, String profileFile, Bundle arguments )`
`void`	`startIntentSender( IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags )`
`ComponentName`	`startService(Intent service)`
`boolean`	`stopService(Intent name)`
`void`	`unbindService(ServiceConnection conn)`
`void`	`unregisterComponentCallbacks(ComponentCallbacks callback)`
`void`	`unregisterDeviceIdChangeListener(IntConsumer listener)`
`void`	`unregisterReceiver(BroadcastReceiver receiver)`
`void`	`updateServiceGroup(ServiceConnection conn, int group, int importance)`

From android.app.Service

`void`	`attachBaseContext(Context newBase)`
`void`	`dump(FileDescriptor fd, PrintWriter writer, String[] args)`
`final Application`	`getApplication()`
`final int`	`getForegroundServiceType()`
`abstract IBinder`	`onBind(Intent p)`
`void`	`onConfigurationChanged(Configuration newConfig)`
`void`	`onCreate()`
`void`	`onDestroy()`
`void`	`onLowMemory()`
`void`	`onRebind(Intent intent)`
`void`	`onStart(Intent intent, int startId)` This method is deprecated.
`int`	`onStartCommand(Intent intent, int flags, int startId)`
`void`	`onTaskRemoved(Intent rootIntent)`
`void`	`onTimeout(int startId)`
`void`	`onTrimMemory(int level)`
`boolean`	`onUnbind(Intent intent)`
`final void`	`startForeground(int id, Notification notification)`
`final void`	`stopForeground(boolean removeNotification)` This method is deprecated.
`final void`	`stopSelf()`
`final boolean`	`stopSelfResult(int startId)`

Public constructors

FirebaseMessagingService

public FirebaseMessagingService()

Public methods

onDeletedMessages

@WorkerThread
public void onDeletedMessages()

Called when the Firebase Cloud Messaging server deletes pending messages. This may be due to:

Too many messages stored on the Firebase Cloud Messaging server. This can occur when the app's servers send a bunch of non-collapsible messages to Firebase Cloud Messaging servers while the device is offline.
The device hasn't connected in a long time and the app server has recently (within the last 4 weeks) sent a message to the app on that device.

It is recommended that the app do a full sync with the app server after receiving this call. See here for more information.

onDestroy

@CallSuper
public void onDestroy()

onMessageReceived

@WorkerThread
public void onMessageReceived(@NonNull RemoteMessage message)

Called when a message is received.

This should complete within 20 seconds. Taking longer may interfere with your ability to complete your work and may affect pending messages.

This is also called when a notification message is received while the app is in the foreground. The notification parameters can be retrieved with getNotification.

Parameters
`@NonNull RemoteMessage message`	Remote message that has been received.

onMessageSent

@WorkerThread
public void onMessageSent(@NonNull String msgId)

Called when an upstream message has been successfully sent to the GCM connection server.

Parameters
`@NonNull String msgId`	of the upstream message sent using `send`.

onNewToken

@WorkerThread
public void onNewToken(@NonNull String token)

Called when a new token for the default Firebase project is generated.

This is invoked after app install when a token is first generated, and again if the token changes.

Parameters
`@NonNull String token`	The token used for sending messages to this application instance. This token is the same as the one retrieved by `getToken`.

onSendError

@WorkerThread
public void onSendError(@NonNull String msgId, @NonNull Exception exception)

Called when there was an error sending an upstream message.

Parameters
`@NonNull String msgId`	of the upstream message sent using `send`.
`@NonNull Exception exception`	description of the error, typically a `SendException`.