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

DefaultNotificationHandler

open class ~~DefaultNotificationHandler~~(application: Application, notificationPermissionHandler: NotificationPermissionHandler = DefaultNotificationPermissionHandler .createDefaultNotificationPermissionHandler(application), val hideRingingNotificationInForeground: Boolean = false, @DrawableRes val notificationIconRes: Int = android.R.drawable.ic_menu_call) : NotificationHandler, NotificationPermissionHandler

Deprecated

This class is deprecated. Use the notification interceptors instead.

Constructors

constructor(application: Application, notificationPermissionHandler: NotificationPermissionHandler = DefaultNotificationPermissionHandler .createDefaultNotificationPermissionHandler(application), hideRingingNotificationInForeground: Boolean = false, @DrawableRes notificationIconRes: Int = android.R.drawable.ic_menu_call)

Types

Companion

object Companion

Properties

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.

intentResolver

val intentResolver: DefaultStreamIntentResolver

notificationIconRes

val notificationIconRes: Int

The notification icon for call notifications.

Functions

addCallActions

open fun NotificationCompat.Builder.addCallActions(acceptCallPendingIntent: PendingIntent, rejectCallPendingIntent: PendingIntent, callDisplayName: String?): NotificationCompat.Builder

addHangUpAction

open fun NotificationCompat.Builder.addHangUpAction(hangUpIntent: PendingIntent, callDisplayName: String, remoteParticipantCount: Int): NotificationCompat.Builder

createIncomingCallChannel

open fun createIncomingCallChannel(channelId: String, showAsHighPriority: Boolean)

createMinimalMediaStyleNotification

open override fun createMinimalMediaStyleNotification(callId: StreamCallId, mediaNotificationConfig: MediaNotificationConfig, remoteParticipantCount: Int): NotificationCompat.Builder?

createOnGoingChannel

open fun createOnGoingChannel(ongoingCallsChannelId: String)

getAcceptAction

open fun getAcceptAction(intent: PendingIntent): NotificationCompat.Action

getChannelDescription

open fun getChannelDescription(): String

getChannelId

open fun getChannelId(): String

getChannelName

open fun getChannelName(): String

getIncomingCallNotification

open override fun getIncomingCallNotification(fullScreenPendingIntent: PendingIntent, acceptCallPendingIntent: PendingIntent, rejectCallPendingIntent: PendingIntent, callerName: String?, shouldHaveContentIntent: Boolean, payload: Map<String, Any?>): Notification

Customize the notification when you receive a push notification for ringing call with type RingingState.Incoming

getLeaveAction

open fun getLeaveAction(intent: PendingIntent): NotificationCompat.Action

getMediaNotificationConfig

open override fun getMediaNotificationConfig(): MediaNotificationConfig

getMissedCallNotification

open override fun getMissedCallNotification(callId: StreamCallId, callDisplayName: String?, payload: Map<String, Any?>): Notification?

Customize the notification when you receive a push notification for Missed Call

getNotification

open fun getNotification(builder: NotificationCompat.Builder.() -> Unit): Notification

getNotificationUpdates

open override fun getNotificationUpdates(coroutineScope: CoroutineScope, call: Call, localUser: User, onUpdate: (Notification) -> Unit)

Get subsequent updates to notifications. Initially, notifications are posted by one of the other methods, and then this method can be used to re-post them with updated content.

getOngoingCallNotification

open override fun getOngoingCallNotification(callId: StreamCallId, callDisplayName: String?, isOutgoingCall: Boolean, remoteParticipantCount: Int, payload: Map<String, Any?>): Notification?

Customize the notification when you receive a push notification for ringing call with type RingingState.Outgoing and RingingState.Active

getRejectAction

open fun getRejectAction(intent: PendingIntent): NotificationCompat.Action

getRingingCallNotification

open override fun getRingingCallNotification(ringingState: RingingState, callId: StreamCallId, callDisplayName: String?, shouldHaveContentIntent: Boolean, payload: Map<String, Any?>): Notification?

Customize the notification when you receive a push notification for ringing call

getSettingUpCallNotification

open override fun getSettingUpCallNotification(): Notification?

Temporary notification. Sometimes the system needs to show a notification while the call is not ready. This is the notification that will be shown.

getStreamNotificationDispatcher

open override fun getStreamNotificationDispatcher(): NotificationDispatcher

isInForeground

open fun isInForeground(): Boolean

maybeCreateChannel

open fun maybeCreateChannel(channelId: String, context: Context, configure: NotificationChannel.() -> Unit = { })

onCallNotificationUpdate

open suspend override fun onCallNotificationUpdate(call: Call): Notification?

Get subsequent updates to notifications. Initially, notifications are posted by one of the other methods, and then this method can be used to re-post them with updated content.

onLiveCall

open override fun onLiveCall(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>)

Customize the notification when you receive a push notification for Live Call

onMissedCall

open override fun onMissedCall(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>)

Customize the notification when you receive a push notification for Missed Call

onNotification

open override fun onNotification(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>)

Customize the notification when you receive a push notification for general usage

onRingingCall

open override fun onRingingCall(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>)

Customize the notification when you receive a push notification for ringing call, which has further two types RingingState.Incoming and RingingState.Outgoing

showLiveCallNotification

open fun ~~showLiveCallNotification~~(liveCallPendingIntent: PendingIntent, callDisplayName: String, notificationId: Int)

open fun showLiveCallNotification(liveCallPendingIntent: PendingIntent, callDisplayName: String, notificationId: Int, payload: Map<String, Any?>)

showMissedCallNotification

open fun ~~showMissedCallNotification~~(notificationPendingIntent: PendingIntent, callDisplayName: String, notificationId: Int)

open fun showMissedCallNotification(notificationPendingIntent: PendingIntent, callDisplayName: String, notificationId: Int, payload: Map<String, Any?>)

showNotificationCallNotification

open fun ~~showNotificationCallNotification~~(notificationPendingIntent: PendingIntent, callDisplayName: String, notificationId: Int)

open fun showNotificationCallNotification(notificationPendingIntent: PendingIntent, callDisplayName: String, notificationId: Int, payload: Map<String, Any?>)

updateIncomingCallNotification

open suspend override fun updateIncomingCallNotification(call: Call, callDisplayName: String): Notification?

Update the ringing call notification.

updateOngoingCallNotification

open suspend override fun updateOngoingCallNotification(call: Call, callDisplayName: String): Notification?

Update the ongoing call notification.

updateOutgoingCallNotification

open suspend override fun updateOutgoingCallNotification(call: Call, callDisplayName: String?): Notification?

Update the ringing call notification.

Inherited functions

getIncomingCallNotification

open fun ~~getIncomingCallNotification~~(fullScreenPendingIntent: PendingIntent, acceptCallPendingIntent: PendingIntent, rejectCallPendingIntent: PendingIntent, callerName: String?, shouldHaveContentIntent: Boolean): Notification?

Customize the notification when you receive a push notification for ringing call with type RingingState.Incoming

getMissedCallNotification

open fun ~~getMissedCallNotification~~(callId: StreamCallId, callDisplayName: String? = null): Notification?

Customize the notification when you receive a push notification for Missed Call

getOngoingCallNotification

open fun ~~getOngoingCallNotification~~(callId: StreamCallId, callDisplayName: String? = null, isOutgoingCall: Boolean = false, remoteParticipantCount: Int = 0): Notification?

Customize the notification when you receive a push notification for ringing call with type RingingState.Outgoing and RingingState.Active

getRingingCallNotification

open fun ~~getRingingCallNotification~~(ringingState: RingingState, callId: StreamCallId, callDisplayName: String? = null, shouldHaveContentIntent: Boolean = true): Notification?

Customize the notification when you receive a push notification for ringing call

onLiveCall

open fun ~~onLiveCall~~(callId: StreamCallId, callDisplayName: String)

Customize the notification when you receive a push notification for Live Call

onMissedCall

open fun ~~onMissedCall~~(callId: StreamCallId, callDisplayName: String)

Customize the notification when you receive a push notification for Missed Call

onNotification

open fun ~~onNotification~~(callId: StreamCallId, callDisplayName: String)

Customize the notification when you receive a push notification for general usage

onPermissionDenied

open override fun onPermissionDenied()

onPermissionGranted

open override fun onPermissionGranted()

onPermissionRationale

open override fun onPermissionRationale()

onPermissionRequested

open override fun onPermissionRequested()

onRingingCall

open fun ~~onRingingCall~~(callId: StreamCallId, callDisplayName: String)

Customize the notification when you receive a push notification for ringing call, which has further two types RingingState.Incoming and RingingState.Outgoing