ditto/live.ditto.transports.foregroundservice/DittoForegroundService

DittoForegroundService

abstract class DittoForegroundService : Service

Base class for the Ditto foreground service

A foreground service allows your app to continue syncing data with Ditto while running in the background.

The default implementation of this class is DefaultDittoForegroundService. It allows the foreground service notification to be customized by adding metadata to AndroidManifest.xml.

If you need further customization of the foreground service you can create your own implementation of this class.

Implementations of DittoForegroundService must override getChannelConfiguration and getNotificationConfiguration. DittoForegroundService will create a notification channel and display a foreground service notification according to the returned configurations.

Finally, the service class must be registered in AndroidManifest.xml:

<manifest>
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE"
        tools:targetApi="upside_down_cake" />
    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"
        tools:targetApi="tiramisu" />

    <application>
        <service
            android:name=".MyForegroundService"
            android:foregroundServiceType="connectedDevice"
            android:exported="false"/>
    </application>
</manifest>

The foreground service is started and stopped by DittoForegroundServiceManager.

See also

DittoSyncPermissions.missingPermissions

Inheritors

DefaultDittoForegroundService

Constructors

DittoForegroundService

constructor()

Types

ChannelConfiguration

data class ChannelConfiguration(val id: String, val name: String, val importance: Int)

NotificationConfiguration

data class NotificationConfiguration(val id: Int, val smallIconResId: Int, val title: String, val text: String)

Functions

bindIsolatedService

open override fun bindIsolatedService(p0: Intent, p1: Int, p2: String, p3: Executor, p4: ServiceConnection): Boolean

open override fun bindService(p0: Intent, p1: ServiceConnection, p2: Int): Boolean

open override fun bindService(p0: Intent, p1: Int, p2: Executor, p3: ServiceConnection): Boolean

bindServiceAsUser

open override fun bindServiceAsUser(p0: Intent, p1: ServiceConnection, p2: Int, p3: UserHandle): Boolean

checkCallingOrSelfPermission

open override fun checkCallingOrSelfPermission(p0: String): Int

checkCallingOrSelfUriPermission

open override fun checkCallingOrSelfUriPermission(p0: Uri, p1: Int): Int

checkCallingOrSelfUriPermissions

open override fun checkCallingOrSelfUriPermissions(p0: MutableList<Uri>, p1: Int): IntArray

checkCallingPermission

open override fun checkCallingPermission(p0: String): Int

checkCallingUriPermission

open override fun checkCallingUriPermission(p0: Uri, p1: Int): Int

checkCallingUriPermissions

open override fun checkCallingUriPermissions(p0: MutableList<Uri>, p1: Int): IntArray

checkPermission

open override fun checkPermission(p0: String, p1: Int, p2: Int): Int

checkSelfPermission

open override fun checkSelfPermission(p0: String): Int

checkUriPermission

open override fun checkUriPermission(p0: Uri, p1: Int, p2: Int, p3: Int): Int

open override fun checkUriPermission(p0: Uri?, p1: String?, p2: String?, p3: Int, p4: Int, p5: Int): Int

checkUriPermissions

open override fun checkUriPermissions(p0: MutableList<Uri>, p1: Int, p2: Int, p3: Int): IntArray

open override fun ~~clearWallpaper~~()

createAttributionContext

open override fun createAttributionContext(p0: String?): Context

createConfigurationContext

open override fun createConfigurationContext(p0: Configuration): Context

open override fun createContext(p0: ContextParams): Context

createContextForSplit

open override fun createContextForSplit(p0: String): Context

createDeviceProtectedStorageContext

open override fun createDeviceProtectedStorageContext(): Context

createDisplayContext

open override fun createDisplayContext(p0: Display): Context

createPackageContext

open override fun createPackageContext(p0: String, p1: Int): Context

createWindowContext

open override fun createWindowContext(p0: Int, p1: Bundle?): Context

open override fun createWindowContext(p0: Display, p1: Int, p2: Bundle?): Context

open override fun databaseList(): Array<String>

open override fun deleteDatabase(p0: String): Boolean

open override fun deleteFile(p0: String): Boolean

deleteSharedPreferences

open override fun deleteSharedPreferences(p0: String): Boolean

enforceCallingOrSelfPermission

open override fun enforceCallingOrSelfPermission(p0: String, p1: String?)

enforceCallingOrSelfUriPermission

open override fun enforceCallingOrSelfUriPermission(p0: Uri, p1: Int, p2: String)

enforceCallingPermission

open override fun enforceCallingPermission(p0: String, p1: String?)

enforceCallingUriPermission

open override fun enforceCallingUriPermission(p0: Uri, p1: Int, p2: String)

enforcePermission

open override fun enforcePermission(p0: String, p1: Int, p2: Int, p3: String?)

enforceUriPermission

open override fun enforceUriPermission(p0: Uri, p1: Int, p2: Int, p3: Int, p4: String)

open override fun enforceUriPermission(p0: Uri?, p1: String?, p2: String?, p3: Int, p4: Int, p5: Int, p6: String?)

open override fun fileList(): Array<String>

fun getApplication(): Application

getApplicationContext

open override fun getApplicationContext(): Context

getApplicationInfo

open override fun getApplicationInfo(): ApplicationInfo

open override fun getAssets(): AssetManager

getAttributionSource

open override fun getAttributionSource(): AttributionSource

getAttributionTag

open override fun getAttributionTag(): String?

open fun getBaseContext(): Context

open override fun getCacheDir(): File

getChannelConfiguration

abstract fun getChannelConfiguration(): DittoForegroundService.ChannelConfiguration

Notification channel configuration.

open override fun getClassLoader(): ClassLoader

getCodeCacheDir

open override fun getCodeCacheDir(): File

fun getColor(p0: Int): Int

getColorStateList

fun getColorStateList(p0: Int): ColorStateList

getContentResolver

open override fun getContentResolver(): ContentResolver

getDatabasePath

open override fun getDatabasePath(p0: String): File

open override fun getDataDir(): File

open override fun getDir(p0: String, p1: Int): File

open override fun getDisplay(): Display?

fun getDrawable(p0: Int): Drawable?

getExternalCacheDir

open override fun getExternalCacheDir(): File?

getExternalCacheDirs

open override fun getExternalCacheDirs(): Array<File>

getExternalFilesDir

open override fun getExternalFilesDir(p0: String?): File?

getExternalFilesDirs

open override fun getExternalFilesDirs(p0: String): Array<File>

getExternalMediaDirs

open override fun getExternalMediaDirs(): Array<File>

open override fun getFilesDir(): File

getFileStreamPath

open override fun getFileStreamPath(p0: String): File

getForegroundServiceType

fun getForegroundServiceType(): Int

getMainExecutor

open override fun getMainExecutor(): Executor

open override fun getMainLooper(): Looper

getNoBackupFilesDir

open override fun getNoBackupFilesDir(): File

getNotificationConfiguration

abstract fun getNotificationConfiguration(): DittoForegroundService.NotificationConfiguration

Notification configuration.

open override fun getObbDir(): File

open override fun getObbDirs(): Array<File>

getOpPackageName

open override fun getOpPackageName(): String

getPackageCodePath

open override fun getPackageCodePath(): String

getPackageManager

open override fun getPackageManager(): PackageManager

open override fun getPackageName(): String

getPackageResourcePath

open override fun getPackageResourcePath(): String

open override fun getParams(): ContextParams?

open override fun getResources(): Resources

getSharedPreferences

open override fun getSharedPreferences(p0: String, p1: Int): SharedPreferences

fun getString(p0: Int): String

fun getString(p0: Int, vararg p1: Any): String

getSystemService

fun <T : Any> getSystemService(p0: Class<T>): T

open override fun getSystemService(p0: String): Any

getSystemServiceName

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

fun getText(p0: Int): CharSequence

open override fun getTheme(): Resources.Theme

open override fun ~~getWallpaper~~(): Drawable

getWallpaperDesiredMinimumHeight

open override fun ~~getWallpaperDesiredMinimumHeight~~(): Int

getWallpaperDesiredMinimumWidth

open override fun ~~getWallpaperDesiredMinimumWidth~~(): Int

grantUriPermission

open override fun grantUriPermission(p0: String, p1: Uri, p2: Int)

isDeviceProtectedStorage

open override fun isDeviceProtectedStorage(): Boolean

open override fun isRestricted(): Boolean

open override fun isUiContext(): Boolean

moveDatabaseFrom

open override fun moveDatabaseFrom(p0: Context, p1: String): Boolean

moveSharedPreferencesFrom

open override fun moveSharedPreferencesFrom(p0: Context, p1: String): Boolean

obtainStyledAttributes

fun obtainStyledAttributes(p0: IntArray): TypedArray

fun obtainStyledAttributes(p0: AttributeSet?, p1: IntArray): TypedArray

fun obtainStyledAttributes(p0: Int, p1: IntArray): TypedArray

fun obtainStyledAttributes(p0: AttributeSet?, p1: IntArray, p2: Int, p3: Int): TypedArray

open override fun onBind(p0: Intent?): IBinder?

onConfigurationChanged

open override fun onConfigurationChanged(p0: Configuration)

open override fun onCreate()

open fun onDestroy()

open override fun onLowMemory()

open fun onRebind(p0: Intent)

open fun ~~onStart~~(p0: Intent, p1: Int)

open override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int

open fun onTaskRemoved(p0: Intent)

open override fun onTrimMemory(p0: Int)

open fun onUnbind(p0: Intent): Boolean

open override fun openFileInput(p0: String): FileInputStream

open override fun openFileOutput(p0: String, p1: Int): FileOutputStream

openOrCreateDatabase

open override fun openOrCreateDatabase(p0: String, p1: Int, p2: SQLiteDatabase.CursorFactory): SQLiteDatabase

open override fun openOrCreateDatabase(p0: String, p1: Int, p2: SQLiteDatabase.CursorFactory, p3: DatabaseErrorHandler?): SQLiteDatabase

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

registerComponentCallbacks

open override fun registerComponentCallbacks(p0: ComponentCallbacks)

registerReceiver

open override fun registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter): Intent?

open override fun registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter, p2: Int): Intent?

open override fun registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter, p2: String?, p3: Handler?): Intent?

open override fun registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter, p2: String?, p3: Handler?, p4: Int): Intent?

removeStickyBroadcast

open override fun ~~removeStickyBroadcast~~(p0: Intent)

removeStickyBroadcastAsUser

open override fun ~~removeStickyBroadcastAsUser~~(p0: Intent, p1: UserHandle)

revokeSelfPermissionOnKill

open fun revokeSelfPermissionOnKill(p0: String)

revokeSelfPermissionsOnKill

open override fun revokeSelfPermissionsOnKill(p0: MutableCollection<String>)

revokeUriPermission

open override fun revokeUriPermission(p0: Uri, p1: Int)

open override fun revokeUriPermission(p0: String, p1: Uri, p2: Int)

open override fun sendBroadcast(p0: Intent)

open override fun sendBroadcast(p0: Intent, p1: String?)

sendBroadcastAsUser

open override fun sendBroadcastAsUser(p0: Intent, p1: UserHandle)

open override fun sendBroadcastAsUser(p0: Intent, p1: UserHandle, p2: String?)

sendBroadcastWithMultiplePermissions

open fun sendBroadcastWithMultiplePermissions(p0: Intent, p1: Array<String>)

sendOrderedBroadcast

open override fun sendOrderedBroadcast(p0: Intent, p1: String?)

open override fun sendOrderedBroadcast(p0: Intent, p1: String?, p2: BroadcastReceiver?, p3: Handler?, p4: Int, p5: String?, p6: Bundle?)

open override fun sendOrderedBroadcast(p0: Intent, p1: String?, p2: String?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle?)

open fun sendOrderedBroadcast(p0: Intent, p1: Int, p2: String?, p3: String?, p4: BroadcastReceiver?, p5: Handler?, p6: String?, p7: Bundle?, p8: Bundle?)

sendOrderedBroadcastAsUser

open override fun sendOrderedBroadcastAsUser(p0: Intent, p1: UserHandle, p2: String?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle?)

sendStickyBroadcast

open override fun ~~sendStickyBroadcast~~(p0: Intent)

open override fun ~~sendStickyBroadcast~~(p0: Intent, p1: Bundle?)

sendStickyBroadcastAsUser

open override fun ~~sendStickyBroadcastAsUser~~(p0: Intent, p1: UserHandle)

sendStickyOrderedBroadcast

open override fun ~~sendStickyOrderedBroadcast~~(p0: Intent, p1: BroadcastReceiver?, p2: Handler?, p3: Int, p4: String?, p5: Bundle?)

sendStickyOrderedBroadcastAsUser

open override fun ~~sendStickyOrderedBroadcastAsUser~~(p0: Intent, p1: UserHandle, p2: BroadcastReceiver?, p3: Handler?, p4: Int, p5: String?, p6: Bundle?)

open override fun setTheme(p0: Int)

open override fun ~~setWallpaper~~(p0: Bitmap)

open override fun ~~setWallpaper~~(p0: InputStream)

startActivities

open override fun startActivities(p0: Array<Intent>)

open override fun startActivities(p0: Array<Intent>, p1: Bundle?)

open override fun startActivity(p0: Intent)

open override fun startActivity(p0: Intent, p1: Bundle?)

startForeground

fun startForeground(p0: Int, p1: Notification)

fun startForeground(p0: Int, p1: Notification, p2: Int)

startForegroundService

open override fun startForegroundService(p0: Intent): ComponentName?

startInstrumentation

open override fun startInstrumentation(p0: ComponentName, p1: String?, p2: Bundle?): Boolean

startIntentSender

open override fun startIntentSender(p0: IntentSender, p1: Intent?, p2: Int, p3: Int, p4: Int)

open override fun startIntentSender(p0: IntentSender, p1: Intent?, p2: Int, p3: Int, p4: Int, p5: Bundle?)

open override fun startService(p0: Intent): ComponentName?

fun ~~stopForeground~~(p0: Boolean)

fun stopForeground(p0: Int)

fun stopSelf(p0: Int)

fun stopSelfResult(p0: Int): Boolean

open override fun stopService(p0: Intent): Boolean

open override fun unbindService(p0: ServiceConnection)

unregisterComponentCallbacks

open override fun unregisterComponentCallbacks(p0: ComponentCallbacks)

unregisterReceiver

open override fun unregisterReceiver(p0: BroadcastReceiver)

updateServiceGroup

open override fun updateServiceGroup(p0: ServiceConnection, p1: Int, p2: Int)