FirebaseInstanceIdService

public class FirebaseInstanceIdService extends Service

This class is deprecated.
In favour of overriding onNewToken in FirebaseMessagingService. Once that has been implemented, this service can be safely removed.

Base class to handle Firebase Instance ID token refresh events.

Any app interested in the Instance ID, or using Instance ID tokens, can extend this class and implement onTokenRefresh() to receive token refresh events.

To enable your FirebaseInstanceIdService include the following code in the manifest:

<!-- FirebaseInstanceIdService performs security checks at runtime,
      no need for explicit permissions despite exported="true"             -->
 <service android:name=".MyFirebaseInstanceIdService" android:exported="true">
     <intent-filter>
         <action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
     </intent-filter>
 </service>

Inherited Constant Summary

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
int STOP_FOREGROUND_DETACH
int STOP_FOREGROUND_REMOVE
String ACCESSIBILITY_SERVICE
String ACCOUNT_SERVICE
String ACTIVITY_SERVICE
String ALARM_SERVICE
String APPWIDGET_SERVICE
String APP_OPS_SERVICE
String APP_PREDICTION_SERVICE
String AUDIO_SERVICE
String BACKUP_SERVICE
String BATTERY_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_EXTERNAL_SERVICE
int BIND_IMPORTANT
int BIND_INCLUDE_CAPABILITIES
int BIND_NOT_FOREGROUND
int BIND_WAIVE_PRIORITY
String BIOMETRIC_SERVICE
String BLUETOOTH_SERVICE
String CAMERA_SERVICE
String CAPTIONING_SERVICE
String CARRIER_CONFIG_SERVICE
String CLIPBOARD_SERVICE
String COMPANION_DEVICE_SERVICE
String CONNECTIVITY_SERVICE
String CONSUMER_IR_SERVICE
String CONTENT_SUGGESTIONS_SERVICE
String CONTEXTHUB_SERVICE
int CONTEXT_IGNORE_SECURITY
int CONTEXT_INCLUDE_CODE
int CONTEXT_RESTRICTED
String CROSS_PROFILE_APPS_SERVICE
String DEVICE_POLICY_SERVICE
String DISPLAY_SERVICE
String DOWNLOAD_SERVICE
String DROPBOX_SERVICE
String EUICC_CARD_SERVICE
String EUICC_SERVICE
String FINGERPRINT_SERVICE
String HARDWARE_PROPERTIES_SERVICE
String HDMI_CONTROL_SERVICE
String INPUT_METHOD_SERVICE
String INPUT_SERVICE
String IPSEC_SERVICE
String JOB_SCHEDULER_SERVICE
String KEYGUARD_SERVICE
String LAUNCHER_APPS_SERVICE
String LAYOUT_INFLATER_SERVICE
String LOCATION_SERVICE
String MEDIA_PROJECTION_SERVICE
String MEDIA_ROUTER_SERVICE
String MEDIA_SESSION_SERVICE
String MIDI_SERVICE
int MODE_APPEND
int MODE_ENABLE_WRITE_AHEAD_LOGGING
int MODE_MULTI_PROCESS
int MODE_NO_LOCALIZED_COLLATORS
int MODE_PRIVATE
int MODE_WORLD_READABLE
int MODE_WORLD_WRITEABLE
String NETD_SERVICE
String NETWORK_SCORE_SERVICE
String NETWORK_STATS_SERVICE
String NFC_SERVICE
String NOTIFICATION_SERVICE
String NSD_SERVICE
String OEM_LOCK_SERVICE
String PERMISSION_SERVICE
String PERSISTENT_DATA_BLOCK_SERVICE
String POWER_SERVICE
String PRINT_SERVICE
int RECEIVER_VISIBLE_TO_INSTANT_APPS
String RESTRICTIONS_SERVICE
String ROLE_SERVICE
String ROLLBACK_SERVICE
String SEARCH_SERVICE
String SECURE_ELEMENT_SERVICE
String SENSOR_SERVICE
String SHORTCUT_SERVICE
String STATS_MANAGER
String STATUS_BAR_SERVICE
String STORAGE_SERVICE
String STORAGE_STATS_SERVICE
String SYSTEM_HEALTH_SERVICE
String SYSTEM_UPDATE_SERVICE
String TELECOM_SERVICE
String TELEPHONY_SERVICE
String TELEPHONY_SUBSCRIPTION_SERVICE
String TEXT_CLASSIFICATION_SERVICE
String TEXT_SERVICES_MANAGER_SERVICE
String TV_INPUT_SERVICE
String UI_MODE_SERVICE
String USAGE_STATS_SERVICE
String USB_SERVICE
String USER_SERVICE
String VIBRATOR_SERVICE
String VR_SERVICE
String WALLPAPER_SERVICE
String WIFI_AWARE_SERVICE
String WIFI_P2P_SERVICE
String WIFI_RTT_RANGING_SERVICE
String WIFI_RTT_SERVICE
String WIFI_SCANNING_SERVICE
String WIFI_SERVICE
String WINDOW_SERVICE
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

Public Constructor Summary

Public Method Summary

void
onTokenRefresh()
This method is deprecated. In favour of overriding onNewToken in FirebaseMessagingService. This method will be invoked on token changes even if onNewToken is also used.

Inherited Method Summary

void
dump(FileDescriptor arg0, PrintWriter arg1, String[] arg2)
final Application
getApplication()
final int
getForegroundServiceType()
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
startForeground(int arg0, Notification arg1, int arg2)
final void
stopForeground(int arg0)
final void
stopForeground(boolean arg0)
final void
stopSelf()
final void
stopSelf(int arg0)
final boolean
stopSelfResult(int arg0)
void
attachBaseContext(Context arg0)
boolean
bindIsolatedService(Intent arg0, int arg1, String arg2, Executor arg3, ServiceConnection arg4)
boolean
bindService(Intent arg0, int arg1, Executor arg2, ServiceConnection arg3)
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
checkSelfPermission(String arg0)
int
checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5)
int
checkUriPermission(Uri arg0, int arg1, int arg2, int arg3)
void
clearWallpaper()
Context
createConfigurationContext(Configuration arg0)
Context
createContextForSplit(String arg0)
Context
createCredentialProtectedStorageContext()
Context
createDeviceProtectedStorageContext()
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)
boolean
deleteSharedPreferences(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, String arg1, String arg2, int arg3, int arg4, int arg5, String arg6)
void
enforceUriPermission(Uri arg0, int arg1, int arg2, int arg3, String arg4)
String[]
fileList()
Context
getApplicationContext()
ApplicationInfo
getApplicationInfo()
AssetManager
getAssets()
Context
getBaseContext()
File
getCacheDir()
ClassLoader
getClassLoader()
File
getCodeCacheDir()
ContentResolver
getContentResolver()
File
getDataDir()
File
getDatabasePath(String arg0)
File
getDir(String arg0, int arg1)
File
getExternalCacheDir()
File[]
getExternalCacheDirs()
File
getExternalFilesDir(String arg0)
File[]
getExternalFilesDirs(String arg0)
File[]
getExternalMediaDirs()
File
getFileStreamPath(String arg0)
File
getFilesDir()
Executor
getMainExecutor()
Looper
getMainLooper()
File
getNoBackupFilesDir()
File
getObbDir()
File[]
getObbDirs()
String
getOpPackageName()
String
getPackageCodePath()
PackageManager
getPackageManager()
String
getPackageName()
String
getPackageResourcePath()
File
getPreloadsFileCache()
Resources
getResources()
SharedPreferences
getSharedPreferences(String arg0, int arg1)
Object
getSystemService(String arg0)
String
getSystemServiceName(Class<?> arg0)
Resources.Theme
getTheme()
Drawable
getWallpaper()
int
getWallpaperDesiredMinimumHeight()
int
getWallpaperDesiredMinimumWidth()
void
grantUriPermission(String arg0, Uri arg1, int arg2)
boolean
isCredentialProtectedStorage()
boolean
isDeviceProtectedStorage()
boolean
isRestricted()
boolean
moveDatabaseFrom(Context arg0, String arg1)
boolean
moveSharedPreferencesFrom(Context arg0, String arg1)
FileInputStream
openFileInput(String arg0)
FileOutputStream
openFileOutput(String arg0, int arg1)
SQLiteDatabase
openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2, DatabaseErrorHandler arg3)
SQLiteDatabase
openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2)
Drawable
peekWallpaper()
Intent
registerReceiver(BroadcastReceiver arg0, IntentFilter arg1)
Intent
registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, int arg2)
Intent
registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3, int arg4)
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
revokeUriPermission(String arg0, Uri arg1, int arg2)
void
sendBroadcast(Intent arg0, String arg1, Bundle arg2)
void
sendBroadcast(Intent arg0, String arg1)
void
sendBroadcast(Intent arg0)
void
sendBroadcastAsUser(Intent arg0, UserHandle arg1)
void
sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2, Bundle arg3)
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, Bundle arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)
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, Bundle arg1)
void
startActivities(Intent[] arg0)
void
startActivity(Intent arg0)
void
startActivity(Intent arg0, Bundle arg1)
void
startActivityAsUser(Intent arg0, UserHandle arg1)
ComponentName
startForegroundService(Intent arg0)
boolean
startInstrumentation(ComponentName arg0, String arg1, Bundle arg2)
void
startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4)
void
startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5)
ComponentName
startService(Intent arg0)
boolean
stopService(Intent arg0)
void
unbindService(ServiceConnection arg0)
void
unregisterReceiver(BroadcastReceiver arg0)
void
updateServiceGroup(ServiceConnection arg0, int arg1, int arg2)
boolean
bindIsolatedService(Intent arg0, int arg1, String arg2, Executor arg3, ServiceConnection arg4)
boolean
bindService(Intent arg0, int arg1, Executor arg2, ServiceConnection arg3)
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
checkSelfPermission(String arg0)
abstract int
checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5)
abstract int
checkUriPermission(Uri arg0, int arg1, int arg2, int arg3)
abstract void
clearWallpaper()
abstract Context
createConfigurationContext(Configuration arg0)
abstract Context
createContextForSplit(String arg0)
abstract Context
createCredentialProtectedStorageContext()
abstract Context
createDeviceProtectedStorageContext()
abstract Context
createDisplayContext(Display arg0)
abstract Context
createPackageContext(String arg0, int arg1)
Context
createPackageContextAsUser(String arg0, int arg1, UserHandle arg2)
abstract String[]
databaseList()
abstract boolean
deleteDatabase(String arg0)
abstract boolean
deleteFile(String arg0)
abstract boolean
deleteSharedPreferences(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, String arg1, String arg2, int arg3, int arg4, int arg5, String arg6)
abstract void
enforceUriPermission(Uri arg0, int arg1, int arg2, int arg3, String arg4)
abstract String[]
fileList()
abstract Context
getApplicationContext()
abstract ApplicationInfo
getApplicationInfo()
abstract AssetManager
getAssets()
abstract File
getCacheDir()
abstract ClassLoader
getClassLoader()
abstract File
getCodeCacheDir()
final int
getColor(int arg0)
final ColorStateList
getColorStateList(int arg0)
abstract ContentResolver
getContentResolver()
abstract File
getDataDir()
abstract File
getDatabasePath(String arg0)
abstract File
getDir(String arg0, int arg1)
final Drawable
getDrawable(int arg0)
abstract File
getExternalCacheDir()
abstract File[]
getExternalCacheDirs()
abstract File
getExternalFilesDir(String arg0)
abstract File[]
getExternalFilesDirs(String arg0)
abstract File[]
getExternalMediaDirs()
abstract File
getFileStreamPath(String arg0)
abstract File
getFilesDir()
Executor
getMainExecutor()
abstract Looper
getMainLooper()
abstract File
getNoBackupFilesDir()
abstract File
getObbDir()
abstract File[]
getObbDirs()
String
getOpPackageName()
abstract String
getPackageCodePath()
abstract PackageManager
getPackageManager()
abstract String
getPackageName()
abstract String
getPackageResourcePath()
abstract File
getPreloadsFileCache()
abstract Resources
getResources()
abstract SharedPreferences
getSharedPreferences(String arg0, int arg1)
final String
getString(int arg0, Object... arg1)
final String
getString(int arg0)
final <T> T
getSystemService(Class<T> arg0)
abstract Object
getSystemService(String arg0)
abstract String
getSystemServiceName(Class<?> 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)
abstract boolean
isCredentialProtectedStorage()
abstract boolean
isDeviceProtectedStorage()
boolean
isRestricted()
abstract boolean
moveDatabaseFrom(Context arg0, String arg1)
abstract boolean
moveSharedPreferencesFrom(Context arg0, String arg1)
final TypedArray
obtainStyledAttributes(AttributeSet arg0, int[] arg1)
final TypedArray
obtainStyledAttributes(AttributeSet arg0, int[] arg1, int arg2, int arg3)
final TypedArray
obtainStyledAttributes(int arg0, int[] arg1)
final TypedArray
obtainStyledAttributes(int[] arg0)
abstract FileInputStream
openFileInput(String arg0)
abstract FileOutputStream
openFileOutput(String arg0, int arg1)
abstract SQLiteDatabase
openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2, DatabaseErrorHandler arg3)
abstract SQLiteDatabase
openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2)
abstract Drawable
peekWallpaper()
void
registerComponentCallbacks(ComponentCallbacks arg0)
abstract Intent
registerReceiver(BroadcastReceiver arg0, IntentFilter arg1)
abstract Intent
registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, int arg2)
abstract Intent
registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3, int arg4)
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
revokeUriPermission(String arg0, Uri arg1, int arg2)
abstract void
sendBroadcast(Intent arg0, String arg1, Bundle arg2)
abstract void
sendBroadcast(Intent arg0, String arg1)
abstract void
sendBroadcast(Intent arg0)
abstract void
sendBroadcastAsUser(Intent arg0, UserHandle arg1)
abstract void
sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2, Bundle arg3)
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, Bundle arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)
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, Bundle arg1)
abstract void
startActivities(Intent[] arg0)
abstract void
startActivity(Intent arg0)
abstract void
startActivity(Intent arg0, Bundle arg1)
void
startActivityAsUser(Intent arg0, UserHandle arg1)
abstract ComponentName
startForegroundService(Intent arg0)
abstract boolean
startInstrumentation(ComponentName arg0, String arg1, Bundle arg2)
abstract void
startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4)
abstract void
startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5)
abstract ComponentName
startService(Intent arg0)
abstract boolean
stopService(Intent arg0)
abstract void
unbindService(ServiceConnection arg0)
void
unregisterComponentCallbacks(ComponentCallbacks arg0)
abstract void
unregisterReceiver(BroadcastReceiver arg0)
void
updateServiceGroup(ServiceConnection arg0, int arg1, int arg2)
Object
clone()
boolean
equals(Object arg0)
void
finalize()
final Class<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()
abstract void
onTrimMemory(int arg0)
abstract void
onConfigurationChanged(Configuration arg0)
abstract void
onLowMemory()

Public Constructors

public FirebaseInstanceIdService ()

Public Methods

public void onTokenRefresh ()

This method is deprecated.
In favour of overriding onNewToken in FirebaseMessagingService. This method will be invoked on token changes even if onNewToken is also used.

Called when the system determines that the tokens need to be refreshed. The application should call getToken() and send the tokens to all application servers.

This will not be called very frequently, it is needed for key rotation and to handle Instance ID changes due to:

  • App deletes Instance ID
  • App is restored on a new device
  • User uninstalls/reinstall the app
  • User clears app data

The system will throttle the refresh event across all devices to avoid overloading application servers with token updates.