stream-video-android-core/io.getstream.video.android.core.notifications/NotificationConfig

NotificationConfig

data class NotificationConfig(val pushDeviceGenerators: List<PushDeviceGenerator> = emptyList(), val requestPermissionOnAppLaunch: () -> Boolean = { true }, val notificationHandler: NotificationHandler = NoOpNotificationHandler, val autoRegisterPushDevice: Boolean = true, val requestPermissionOnDeviceRegistration: () -> Boolean = { true }, val hideRingingNotificationInForeground: Boolean = false, val enableCallNotificationUpdates: Boolean = true, val mediaNotificationCallTypes: Set<String> = hashSetOf(CallType.Livestream.name), val notificationUpdateTriggers: (Call) -> Flow<*>? = { _ -> null })

Constructors

NotificationConfig

constructor(pushDeviceGenerators: List<PushDeviceGenerator> = emptyList(), requestPermissionOnAppLaunch: () -> Boolean = { true }, notificationHandler: NotificationHandler = NoOpNotificationHandler, autoRegisterPushDevice: Boolean = true, requestPermissionOnDeviceRegistration: () -> Boolean = { true }, hideRingingNotificationInForeground: Boolean = false, enableCallNotificationUpdates: Boolean = true, mediaNotificationCallTypes: Set<String> = hashSetOf(CallType.Livestream.name), notificationUpdateTriggers: (Call) -> Flow<*>? = { _ -> null })

Properties

autoRegisterPushDevice

val autoRegisterPushDevice: Boolean = true

enableCallNotificationUpdates

val enableCallNotificationUpdates: Boolean = true

If true, call notifications will receive subsequent updates, based on the number of participants and other data.

hideRingingNotificationInForeground

val hideRingingNotificationInForeground: Boolean = false

Set this to true if you want to make the ringing notifications as low-priority in case the application is in foreground. This will prevent the notification from interrupting the user while he is in the app. In this case you need to make sure to handle this call state and display an incoming call screen. NOTE: This setting has only an effect if you don't set a custom NotificationHandler!

mediaNotificationCallTypes

val mediaNotificationCallTypes: Set<String>

List of call types (as Strings) for which media notifications should be enabled. Allows support for custom user-defined call types.

notificationHandler

val notificationHandler: NotificationHandler

notificationUpdateTriggers

val notificationUpdateTriggers: (Call) -> Flow<*>?

When notification updates are triggered, the update is based on observing internal call state. This parameters enables customization on which state flows will trigger a notification update.

pushDeviceGenerators

val pushDeviceGenerators: List<PushDeviceGenerator>

requestPermissionOnAppLaunch

val requestPermissionOnAppLaunch: () -> Boolean

requestPermissionOnDeviceRegistration

val requestPermissionOnDeviceRegistration: () -> Boolean