core/com.arnyminerz.escalaralcoiaicomtat.core.notification/Notification/Builder

Builder

class Builder(val context: Context, var id: Int = generateNotificationId())

Creates a new instance of the Builder class.

Author

Arnau Mora

Since

20210323

Parameters

context

The context to create the notification from

The id of the notification, or if not set, a new id will be generated.

Constructors

Builder

fun Builder(context: Context, id: Int = generateNotificationId())

Functions

addAction

fun addAction(button: NotificationButton): Notification.Builder

Adds a button to the notification

fun addAction(@DrawableRes icon: Int, @StringRes text: Int, listener: Notification.Builder.() -> Unit): Notification.Builder

Adds a button to the notification.

addActions

fun addActions(vararg buttons: NotificationButton): Notification.Builder

fun addActions(buttons: Collection<NotificationButton>): Notification.Builder

Adds multiple buttons to the notification

build

fun build(): Notification

Builds the notification

buildAndShow

fun buildAndShow(): Notification

Builds the notification, and calls the show method.

setAlertOnce

fun setAlertOnce(alertOnce: Boolean = true): Notification.Builder

Sets if the notification should interrupt the user every time it's updated.

setPersistent

fun setPersistent(persistent: Boolean = true): Notification.Builder

Sets if the notification should be removable by the user

withChannelId

fun withChannelId(channelId: String): Notification.Builder

Sets a the channel id of the notification

withColor

fun withColor(color: Int): Notification.Builder

Sets the desired color to the notification.

withColorResource

fun withColorResource(@ColorRes color: Int): Notification.Builder

Sets the desired color from resources to the notification.

withIcon

fun withIcon(@DrawableRes icon: Int): Notification.Builder

Sets a the icon of the notification

withId

fun withId(id: Int): Notification.Builder

Sets an id to the notification

withInfoText

fun withInfoText(info: String): Notification.Builder

Sets the info message of the notification

fun withInfoText(@StringRes textRes: Int, vararg arguments: Any): Notification.Builder

Sets the info text of the notification from a resource

withIntent

fun withIntent(pendingIntent: PendingIntent?): Notification.Builder

Sets the action of the notification

withLongText

fun withLongText(longText: String): Notification.Builder

Sets the text of the notification when it's expanded

fun withLongText(@StringRes longTextRes: Int, vararg args: Any): Notification.Builder

Sets the text of the notification when it's expanded from a resource

withProgress

fun withProgress(progress: ValueMax<Int>, persistent: Boolean = true): Notification.Builder

fun withProgress(progress: Int, max: Int, persistent: Boolean = true): Notification.Builder

Sets the progress of the notification. If progress is set to less than 0, it will be indeterminate

withText

fun withText(text: String): Notification.Builder

Sets the message of the notification

fun withText(@StringRes messageRes: Int, vararg arguments: Any): Notification.Builder

Sets the message of the notification from a resource

withTitle

fun withTitle(title: String): Notification.Builder

Sets the title of the notification

fun withTitle(@StringRes titleRes: Int, vararg arguments: Any): Notification.Builder

Sets the title of the notification from a resource

Properties

actions

val actions: ArrayList<NotificationButton>

alertOnce

var alertOnce: Boolean = true

channelId

var channelId: String? = null

color

var color: Int? = null

context

val context: Context

icon

@DrawableRes

var icon: Int? = null

var id: Int

info

var info: String? = null

intent

var intent: PendingIntent? = null

longText

var longText: String? = null

persistent

var persistent: Boolean = false

progress

var progress: ValueMax<Int>? = null

text

var text: String? = null

title

var title: String? = null

Builder

Author

Since

See also

Parameters

Constructors

Functions

Properties