NotificationCompat.InboxStyle

Added in 1.1.0

class NotificationCompat.InboxStyle : NotificationCompat.Style


Helper class for generating large-format notifications that include a list of (up to 5) strings. If the platform does not provide large-format notifications, this method has no effect. The user will always see the normal notification view. This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like so:

Notification notification = new Notification.Builder()
    .setContentTitle("5 New mails from " + sender.toString())
    .setContentText(subject)
    .setSmallIcon(R.drawable.new_mail)
    .setLargeIcon(aBitmap)
    .setStyle(new Notification.InboxStyle()
        .addLine(str1)
        .addLine(str2)
        .setContentTitle("")
        .setSummaryText("+3 more"))
    .build();
See also
bigContentView

Summary

Public constructors

Public functions

NotificationCompat.InboxStyle

Append a line to the digest section of the Inbox notification.

NotificationCompat.InboxStyle

Overrides ContentTitle in the big form of the template.

NotificationCompat.InboxStyle

Set the first line of text after the detail section in the big form of the template.

Inherited functions

From androidx.core.app.NotificationCompat.Style
Notification?

If this Style object has been set on a notification builder, this method will build that notification and return it.

Unit

Link this rich notification style with a notification builder.

Public constructors

InboxStyle

Added in 1.1.0
InboxStyle()

InboxStyle

Added in 1.1.0
InboxStyle(builder: NotificationCompat.Builder?)

Public functions

addLine

Added in 1.1.0
fun addLine(cs: CharSequence?): NotificationCompat.InboxStyle

Append a line to the digest section of the Inbox notification.

setBigContentTitle

Added in 1.1.0
fun setBigContentTitle(title: CharSequence?): NotificationCompat.InboxStyle

Overrides ContentTitle in the big form of the template. This defaults to the value passed to setContentTitle().

setSummaryText

Added in 1.1.0
fun setSummaryText(cs: CharSequence?): NotificationCompat.InboxStyle

Set the first line of text after the detail section in the big form of the template.