braze-android-sdk/com.braze.push/BrazeFirebaseMessagingService

BrazeFirebaseMessagingService

open class BrazeFirebaseMessagingService : FirebaseMessagingService

FirebaseMessagingService implementation that routes incoming Firebase Cloud Messaging (FCM) push notifications and token refreshes to the Braze SDK.

Register this service (or a subclass) in your AndroidManifest to enable automatic handling of Braze push messages delivered through FCM.

Constructors

BrazeFirebaseMessagingService

constructor()

Types

object Companion

Properties

val application: Application?

applicationContext

open val applicationContext: Context?

applicationInfo

open val applicationInfo: ApplicationInfo?

open val assets: AssetManager?

attributionSource

open val attributionSource: AttributionSource

open val attributionTag: String?

open val baseContext: Context?

open val cacheDir: File?

open val classLoader: ClassLoader?

open val codeCacheDir: File?

contentResolver

open val contentResolver: ContentResolver?

open val dataDir: File?

open val deviceId: Int

open val display: Display?

externalCacheDir

open val externalCacheDir: File?

externalCacheDirs

open val externalCacheDirs: Array<out File?>?

externalMediaDirs

open val externalMediaDirs: Array<out File?>?

open val filesDir: File?

foregroundServiceType

val foregroundServiceType: Int

isDeviceProtectedStorage

open val isDeviceProtectedStorage: Boolean

open val isRestricted: Boolean

open val isUiContext: Boolean

open val mainExecutor: Executor?

open val mainLooper: Looper?

noBackupFilesDir

open val noBackupFilesDir: File?

open val obbDir: File?

open val obbDirs: Array<out File?>?

open val opPackageName: String

packageCodePath

open val packageCodePath: String?

open val packageManager: PackageManager?

open val packageName: String?

packageResourcePath

open val packageResourcePath: String?

open val params: ContextParams?

open val resources: Resources?

open val theme: Resources.Theme?

updateableFlags

open val updateableFlags: Context.BindServiceFlags

open val wallpaper: Drawable?

wallpaperDesiredMinimumHeight

open val wallpaperDesiredMinimumHeight: Int

wallpaperDesiredMinimumWidth

open val wallpaperDesiredMinimumWidth: Int

Functions

bindIsolatedService

open fun bindIsolatedService(service: Intent, flags: Context.BindServiceFlags, instanceName: String, executor: Executor, conn: ServiceConnection): Boolean

open fun bindIsolatedService(service: Intent, flags: Int, instanceName: String, executor: Executor, conn: ServiceConnection): Boolean

open fun bindService(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags): Boolean

open fun bindService(service: Intent, conn: ServiceConnection, flags: Int): Boolean

open fun bindService(service: Intent, flags: Context.BindServiceFlags, executor: Executor, conn: ServiceConnection): Boolean

open fun bindService(service: Intent, flags: Int, executor: Executor, conn: ServiceConnection): Boolean

bindServiceAsUser

open fun bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags, user: UserHandle): Boolean

open fun bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Int, user: UserHandle): Boolean

checkCallingOrSelfPermission

open fun checkCallingOrSelfPermission(permission: String): Int

checkCallingOrSelfUriPermission

open fun checkCallingOrSelfUriPermission(uri: Uri?, modeFlags: Int): Int

checkCallingOrSelfUriPermissions

open fun checkCallingOrSelfUriPermissions(uris: List<Uri?>, modeFlags: Int): IntArray

checkCallingPermission

open fun checkCallingPermission(permission: String): Int

checkCallingUriPermission

open fun checkCallingUriPermission(uri: Uri?, modeFlags: Int): Int

checkCallingUriPermissions

open fun checkCallingUriPermissions(uris: List<Uri?>, modeFlags: Int): IntArray

checkContentUriPermissionFull

open fun checkContentUriPermissionFull(uri: Uri, pid: Int, uid: Int, modeFlags: Int): Int

checkPermission

open fun checkPermission(permission: String, pid: Int, uid: Int): Int

checkSelfPermission

open fun checkSelfPermission(permission: String): Int

checkUriPermission

open fun checkUriPermission(uri: Uri?, pid: Int, uid: Int, modeFlags: Int): Int

open fun checkUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int): Int

checkUriPermissions

open fun checkUriPermissions(uris: List<Uri?>, pid: Int, uid: Int, modeFlags: Int): IntArray

open fun ~~clearWallpaper~~()

createAttributionContext

open fun createAttributionContext(attributionTag: String?): Context

createConfigurationContext

open fun createConfigurationContext(overrideConfiguration: Configuration): Context?

open fun createContext(contextParams: ContextParams): Context

createContextForSplit

open fun createContextForSplit(splitName: String?): Context?

createDeviceContext

open fun createDeviceContext(deviceId: Int): Context

createDeviceProtectedStorageContext

open fun createDeviceProtectedStorageContext(): Context?

createDisplayContext

open fun createDisplayContext(display: Display): Context?

createPackageContext

open fun createPackageContext(packageName: String?, flags: Int): Context?

createWindowContext

open fun createWindowContext(type: Int, options: Bundle?): Context

open fun createWindowContext(display: Display, type: Int, options: Bundle?): Context

open fun databaseList(): Array<out String?>?

open fun deleteDatabase(name: String?): Boolean

open fun deleteFile(name: String?): Boolean

deleteSharedPreferences

open fun deleteSharedPreferences(name: String?): Boolean

enforceCallingOrSelfPermission

open fun enforceCallingOrSelfPermission(permission: String, message: String?)

enforceCallingOrSelfUriPermission

open fun enforceCallingOrSelfUriPermission(uri: Uri?, modeFlags: Int, message: String?)

enforceCallingPermission

open fun enforceCallingPermission(permission: String, message: String?)

enforceCallingUriPermission

open fun enforceCallingUriPermission(uri: Uri?, modeFlags: Int, message: String?)

enforcePermission

open fun enforcePermission(permission: String, pid: Int, uid: Int, message: String?)

enforceUriPermission

open fun enforceUriPermission(uri: Uri?, pid: Int, uid: Int, modeFlags: Int, message: String?)

open fun enforceUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int, message: String?)

open fun fileList(): Array<out String?>?

fun getColor(id: Int): Int

getColorStateList

fun getColorStateList(id: Int): ColorStateList

getDatabasePath

open fun getDatabasePath(name: String?): File?

open fun getDir(name: String?, mode: Int): File?

fun getDrawable(id: Int): Drawable?

getExternalFilesDir

open fun getExternalFilesDir(type: String?): File?

getExternalFilesDirs

open fun getExternalFilesDirs(type: String?): Array<out File?>?

getFileStreamPath

open fun getFileStreamPath(name: String?): File?

getSharedPreferences

open fun getSharedPreferences(name: String?, mode: Int): SharedPreferences?

fun getString(resId: Int): String

fun getString(resId: Int, vararg formatArgs: Any?): String

getSystemService

fun <T : Any?> getSystemService(serviceClass: Class<T?>): T?

open fun getSystemService(name: String): Any?

getSystemServiceName

open fun getSystemServiceName(serviceClass: Class<*>): String?

fun getText(resId: Int): CharSequence

grantUriPermission

open fun grantUriPermission(toPackage: String?, uri: Uri?, modeFlags: Int)

open fun handleIntent(intent: Intent?)

handleIntentOnMainThread

open fun handleIntentOnMainThread(intent: Intent?): Boolean

fun Context?.hasPermission(permission: String): Boolean

Helper method for checking if a permission is allowed. In case of error the permission is reported as denied.

moveDatabaseFrom

open fun moveDatabaseFrom(sourceContext: Context?, name: String?): Boolean

moveSharedPreferencesFrom

open fun moveSharedPreferencesFrom(sourceContext: Context?, name: String?): Boolean

obtainStyledAttributes

fun obtainStyledAttributes(attrs: IntArray): TypedArray

fun obtainStyledAttributes(set: AttributeSet?, attrs: IntArray): TypedArray

fun obtainStyledAttributes(resid: Int, attrs: IntArray): TypedArray

fun obtainStyledAttributes(set: AttributeSet?, attrs: IntArray, defStyleAttr: Int, defStyleRes: Int): TypedArray

fun onBind(intent: Intent?): IBinder?

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration)

open fun onCreate()

onDeletedMessages

open fun onDeletedMessages()

open fun onDestroy()

open fun onLowMemory()

onMessageReceived

open override fun onMessageReceived(remoteMessage: RemoteMessage)

open fun ~~onMessageSent~~(@NonNull msgId: String)

open override fun onNewToken(newToken: String)

open fun onRebind(intent: Intent?)

open fun ~~onSendError~~(@NonNull msgId: String, @NonNull exception: Exception)

open fun ~~onStart~~(intent: Intent?, startId: Int)

fun onStartCommand(originalIntent: Intent?, flags: Int, startId: Int): Int

open fun onTaskRemoved(rootIntent: Intent?)

open fun onTimeout(startId: Int)

open fun onTimeout(startId: Int, fgsType: Int)

open fun onTrimMemory(level: Int)

open fun onUnbind(intent: Intent?): Boolean

open fun openFileInput(name: String?): FileInputStream?

open fun openFileOutput(name: String?, mode: Int): FileOutputStream?

openOrCreateDatabase

open fun openOrCreateDatabase(name: String?, mode: Int, factory: SQLiteDatabase.CursorFactory?): SQLiteDatabase?

open fun openOrCreateDatabase(name: String?, mode: Int, factory: SQLiteDatabase.CursorFactory?, errorHandler: DatabaseErrorHandler?): SQLiteDatabase?

open fun ~~peekWallpaper~~(): Drawable?

open fun rebindService(conn: ServiceConnection, flags: Context.BindServiceFlags)

registerComponentCallbacks

open fun registerComponentCallbacks(callback: ComponentCallbacks?)

registerDeviceIdChangeListener

open fun registerDeviceIdChangeListener(executor: Executor, listener: IntConsumer)

registerReceiver

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, flags: Int): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, broadcastPermission: String?, scheduler: Handler?): Intent?

open fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter?, broadcastPermission: String?, scheduler: Handler?, flags: Int): Intent?

removeStickyBroadcast

open fun ~~removeStickyBroadcast~~(intent: Intent?)

removeStickyBroadcastAsUser

open fun ~~removeStickyBroadcastAsUser~~(intent: Intent?, user: UserHandle?)

revokeSelfPermissionOnKill

open fun revokeSelfPermissionOnKill(permName: String)

revokeSelfPermissionsOnKill

open fun revokeSelfPermissionsOnKill(permissions: Collection<String?>)

revokeUriPermission

open fun revokeUriPermission(uri: Uri?, modeFlags: Int)

open fun revokeUriPermission(targetPackage: String?, uri: Uri?, modeFlags: Int)

open fun sendBroadcast(intent: Intent?)

open fun sendBroadcast(intent: Intent?, receiverPermission: String?)

open fun sendBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)

sendBroadcastAsUser

open fun sendBroadcastAsUser(intent: Intent?, user: UserHandle?)

open fun sendBroadcastAsUser(intent: Intent?, user: UserHandle?, receiverPermission: String?)

sendBroadcastWithMultiplePermissions

open fun sendBroadcastWithMultiplePermissions(intent: Intent, receiverPermissions: Array<out String?>)

sendOrderedBroadcast

open fun sendOrderedBroadcast(intent: Intent?, receiverPermission: String?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun sendOrderedBroadcast(intent: Intent, initialCode: Int, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialData: String?, initialExtras: Bundle?, options: Bundle?)

sendOrderedBroadcastAsUser

open fun sendOrderedBroadcastAsUser(intent: Intent?, user: UserHandle?, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

sendStickyBroadcast

open fun ~~sendStickyBroadcast~~(intent: Intent?)

open fun ~~sendStickyBroadcast~~(intent: Intent, options: Bundle?)

sendStickyBroadcastAsUser

open fun ~~sendStickyBroadcastAsUser~~(intent: Intent?, user: UserHandle?)

sendStickyOrderedBroadcast

open fun ~~sendStickyOrderedBroadcast~~(intent: Intent?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

sendStickyOrderedBroadcastAsUser

open fun ~~sendStickyOrderedBroadcastAsUser~~(intent: Intent?, user: UserHandle?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

open fun setTheme(resid: Int)

open fun ~~setWallpaper~~(bitmap: Bitmap?)

open fun ~~setWallpaper~~(data: InputStream?)

startActivities

open fun startActivities(intents: Array<out Intent?>?)

open fun startActivities(intents: Array<out Intent?>?, options: Bundle?)

open fun startActivity(intent: Intent?)

open fun startActivity(intent: Intent?, options: Bundle?)

startForeground

fun startForeground(id: Int, notification: Notification?)

fun startForeground(id: Int, notification: Notification, foregroundServiceType: Int)

startForegroundService

open fun startForegroundService(service: Intent?): ComponentName?

startInstrumentation

open fun startInstrumentation(className: ComponentName, profileFile: String?, arguments: Bundle?): Boolean

startIntentSender

open fun startIntentSender(intent: IntentSender?, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int)

open fun startIntentSender(intent: IntentSender?, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)

open fun startService(service: Intent?): ComponentName?

fun ~~stopForeground~~(removeNotification: Boolean)

fun stopForeground(notificationBehavior: Int)

fun stopSelf(startId: Int)

fun stopSelfResult(startId: Int): Boolean

open fun stopService(name: Intent?): Boolean

open fun unbindService(conn: ServiceConnection)

unregisterComponentCallbacks

open fun unregisterComponentCallbacks(callback: ComponentCallbacks?)

unregisterDeviceIdChangeListener

open fun unregisterDeviceIdChangeListener(listener: IntConsumer)

unregisterReceiver

open fun unregisterReceiver(receiver: BroadcastReceiver?)

updateServiceBindings

open fun updateServiceBindings(params: Collection<Context.UpdateBindingParams?>)

updateServiceGroup

open fun updateServiceGroup(conn: ServiceConnection, group: Int, importance: Int)