urbanairship-core/com.urbanairship.push.notifications/CustomLayoutNotificationProvider

CustomLayoutNotificationProvider

class CustomLayoutNotificationProvider(context: Context, configOptions: AirshipConfigOptions, @LayoutRes layoutId: Int) : AirshipNotificationProvider(source)

A notification provider that allows the use of layout XML. The default binding will bind the following:

small icon to android.R.id.icon
title to android.R.id.title
summary/subtitle to android.R.id.summary
alert/message to android.R.id.message

Custom binding can be applied by overriding onBindContentView.

Constructors

CustomLayoutNotificationProvider

constructor(context: Context, configOptions: AirshipConfigOptions, @LayoutRes layoutId: Int)

Inherited properties

defaultAccentColor

@ColorInt

var defaultAccentColor: Int

The default accent color.

defaultNotificationChannelId

var defaultNotificationChannelId: String

The default notification channel.

defaultTitle

@StringRes

var defaultTitle: Int

The default notification title string resource.

largeIcon

@JvmField

@DrawableRes

var largeIcon: Int

The large icon drawable resource.

smallIcon

@DrawableRes

var smallIcon: Int

The small icon drawable resource.

Functions

onBindContentView

protected fun onBindContentView(context: Context, contentView: RemoteViews, arguments: NotificationArguments)

Called to bind the content view.

onExtendBuilder

protected open override fun onExtendBuilder(context: Context, builder: NotificationCompat.Builder, arguments: NotificationArguments): NotificationCompat.Builder

Override this method to extend the notification builder.

Inherited functions

getNextId

protected open fun getNextId(context: Context, message: PushMessage): Int

Gets the next notification Id.

getTitle

protected open fun getTitle(context: Context, message: PushMessage): String?

Gets the notification title.

onCreateNotification

open override fun onCreateNotification(context: Context, arguments: NotificationArguments): NotificationResult

Called to generate the NotificationResult for a push message.

onCreateNotificationArguments

open override fun onCreateNotificationArguments(context: Context, message: PushMessage): NotificationArguments

Called to generate the NotificationArguments for a push message.

onNotificationCreated

open override fun onNotificationCreated(context: Context, notification: Notification, arguments: NotificationArguments)

Called before posting the notification.